Springside - 3.3.2 - 技术参考手册

Springside 3.3.2 技术参考手册

1. 总述

?

架构风格简述

1.概述

技术框架选型以工业化大规模软件开发为原则---主流的选型、适宜团队分工的架构，同时照顾轻量级快速开发的需求，Java版的约定大于配置的风格。

? SpringSide 3 的进步(京山游侠) 在SpringSide的官方主页上，写着SpringSide 3 中包含的主流组件：Spring 2.5 + Hibernate 3 + Struts 2 + JSP 2.0 + JQuery + JAX-WS 2 (by Apache CXF 2) +SpringSecurity 2.0。不过，如果你认为和SpringSide 2 相比，升级的只是版本号，那么你就大错特错了。

像我这样从SpringSide 2过来的人，如果能够详细对比SpringSide 2 和SpringSide 3，对于我们理解SpringSide 3肯定更加有帮助。下面的内容是我自己的一些体会，不正确的地方欢迎大家指正。

从主要的架构来，依然是那么几层，先设计数据库，再写 Entity层，再写Dao层，再写Action，然后使用JSP表现出来，其中的Entity和Dao层和Hibernate紧密相关，Action是 Struts的主要部分，Spring作为粘合剂，把这些东西连在一起，并提供了一些机制简化编写这些层的工作。SpringSide就是这样一个大的粘 合体，省去了我们自己很多的粘合工作。从SpringSide 2 到SpringSide 3，这些工作得到进一步的简化，我们开发起来就更爽了。

我 认为，我们的开发模式，主要经历了这样的简化过程： 第一阶段，代码加一大堆的配置文件 第 二阶段，代码加少量的配置文件 第三阶段，代码加基本上等于零的配置文件

这 些进步是如何实现的呢？从第一阶段到第二阶段，主要靠的是Annotation，把一些大量的配置工作转移到了Java代码中，那么从第二阶段到第三阶段 怎么实现呢？都已经Annotation了，你还有什么办法让配置文件更少？想不到吧！我也想不到，直到我看了SpringSide 3生成的项目，我才知道还有一个好东西叫自动扫描。

下面使用实际的例子进行说明。作为示例，Hibernate是个不错的选择。

第 一阶段，如果单独使用Hibernate，我们每写一个Entity类，就得同时写一个.hbm.xml文件，如果有很多Entity，就得写很 多.hbm.xml文件，每修改一次Entity，也要同时记得修改.hbm.xml文件，相当的不方便，其目录结构如下图：

第二阶段，使用 Annotation，SpringSide 2 中就是这样的方式。具体内容可以看我的另一篇博文《打通持久层的任督二脉》。所以我用SpringSide 2 进行开发的时候，写Entity也是两个步骤，但是比第一阶段要简单。就是先写一个Entity，Entity里面使用Annotation，如下图：

然后修改配置文件，SpringSide 2 中专门为Hibernate的定义开辟了一个专门的xml文件dataAccessContext-hibernate.xml，里面关于 SessionFactory的定义是我们很熟悉的。我只需要将我的Entity类加入到里面就可以了，如下图中红笔圈出来的部分：

第二阶段和第一阶段相比，配置文件简单多了，不需要维护那 么多的.hbm.xml。但是，每编写一个Entity，依然需要修改一下配置文件。

第三阶段就更了不起了，零配置文件，也就是说我们只 管写Entity就行了，不需要管配置文件（当然，项目开始的时候还是要配置一次的）。打开SpringSide 3生成的项目，果然找不到dataAccessContext-hibernate.xml文件。那么是如何实现零配置的呢？靠的就是自动扫描，如下图中 红笔圈出来的部分：

上面讲Hibernate只是为了举例说明我的观点，事 实上SpringSide 3 中的零配置可不仅仅只存在这一个地方。

Dao层也可以不用配置了。在SpringSide 2 中，我们每写一个Dao，都需要在serviceContext.xml中加入这个类，如下图：

SpringSide 3 中使用自动扫描了，如下图：

以后编写Service后，再也不用修改配置文件了，只要 我们在Service中使用如下Annotation：

事务也不用配置了，在SpringSide 2 中，事务是这样配置的：

SpringSide 3 中，事务配置是这样的：

使用Spring Security的Filter 拦截URL，使用Spirng Security的taglib 拦截页面内容。 采用 用户-角色-资源 三层控制，角色-资源关系定义于XML的简化模式。

3.7 测试

单元测试尽量采用MockObject的方式屏幕所有依赖对象/数据的访问，对于dao层与特别查询与特别数据库操作，采用集成测试连接实际数据库，基于 Spring的集成测试Context。

功能测试使用selenium测试主要用户故事的主流程及Javascript的效果， 使用Jetty嵌入式Web服务器与H2嵌入式数据库，使用DBUnit预备数据，使得整个测试可以快速运行，对测试环境没有太多的依赖。

4.常见问题

4.1 什么时候使用基于接口编程 ？

基于接口编程、Fascade层等等抽象封装都是有开发和维护的代价的，是否使用归根结底还是看在团队人员的分工情况，在大家不得不依赖这几项技术来解决 相互的接口、契约问题时，自然就用了。

4.2 Package是先分层还是先分模块

org.springside.模块A.web 还是 org.springside.web.模块A？ 同上，还是看团队人员的分工情况。如果是每人从头到尾负责一个独立模块的可以先分模块。反之，按层进行分工并鼓励层内重用的，可以考虑先分层。

?

目录结构描述

1.公共目录结构

完全采用maven的默认布局。 bin src main

main/java

命令脚本目录，详见后。 主源码目录 java源文件 Web应用目录

测试目录，结构与主源码目录相同 unit 单元测试

functional 功能测试 data 测试数据生成器

maven编译目录

main/resources 配置文件、属性文件 main/webapp

test

target

2.bin目录结构

文件

db-export / db-init convert-h2

eclipse

jetty / Jetty-debug

描述

将当前数据库数据通过dbunit导出到export-data.xml。

执行src/main/sql 中的脚本初始化数据库schema,再通过dbunit执行default-data.xml初始化数据。

将真正数据库的sql转换为测试用的H2的sql。

生成Eclipse项目文件。

用jetty快速运行本项目。 jetty-debug支持eclipse以debug方式连入，端口为8000

hibernate/generate code

从数据库逆向生成entity / dao / pojo

2. 基础框架

?

Spring: Spring Framework

1. 参考资料

? Spring资料(江南白衣博物馆) 1.图书

Spring 2.5 参考手册中文版(英文版) (满江红出品) ? 《Spring Recipes - A Problem-Solution Approach》 Apress，2008 ? 2.文章

? Introduction to the Spring Framework 2.5 (TSS) Rod 老大的Spring介绍 Spring 2.5版。 3.笔记

Spring2.5的笔记 ? 以前的笔记part1 、part2、part3 有时间会 根据Spring的最新变化重新整理。 ?

Spring 2.5 参考手册中文版(满江红出品) ? 《Spring Recipes - A Problem-Solution Approach》 Apress，2008 Spring 2中较好的参考书。 ? 2. 选型

有人说guice好，但我们用Spring不仅是为了IOC，也为了Spring对JEE所做的封装，以及整个JavaEE界众多项目 (SpringSecurity,CXF、Struts2等)对它的依赖。

3. in SpringSide 3 - Mini示例使用的基本特性

属性配置及IOC容器

? @Transcational annotation标注的事务管理功能 ? 集成测试的基类

?

3.1 IOC部分特征使用

详见Spring 笔记(江南白衣博物馆) 3.1.1 零配置文件的使用场合

Service，Dao 层在无特殊配置项时，可使用IOC Annotation进行配置 实现约定俗成大于配置的零配置文件. 而其他Database/SessionFactory ，SpringSecurity, CXF等需要进行参数配置时，仍然使用 XML 配置文件。 3.1.2 零配置文件的annotation

SpringSide3中使用@Component注释所有类别，在setter方法(不需要严格按setter命名)上 使用@Autowired 进行byType注入，如果需要byName注入则使用@Resource。 3.1.3 其他特征

使用@Required注释没有用@Autowired注释的属性，保证对象必然被注入，如果对象没有被注入则报错。

使用JSR250的@PostConstruct来定义在执行完所有setter注入后必须执行的函数。@PreDestroy来定义JDK关闭时通过 shutdownhook调用的函数。

ApplcationContext中默认设置Lazyload 与Autowired by type 仍然是必然的选择。 3.1.4 属性文件管理

在配置文件中，很有一些属性会在团队的开发环境，个人的开发环境，集成测试环境，以及生产环境集群的每台服务器中都有所不同的。详见Spring 笔记(江南白衣博物馆)

3.2 事务管理

在Service层用@Transactional 定义事务，详见Spring 笔记(江南白衣博物馆)。 注意Spring3.0 的@Transactional终于支持多个TransactionManager了, showcase里演示了多个数据源(不要求联合事务JTA)导致多个TransactionManager的情况。此时@Transactional默 认使用中指定的TransactionManager, 但也可以重新指定其他的TransactionManager的BeanName.

在AOP不到的地方，仍然有机会使用TransactionTemplate，(见Showcase的UserJdbcDao 与 LogJdbcWriter。)

3.3 集成测试的基类

详见 测试文档

4. in SpringSide3

4.1 Showcase中使用的Spring功能索引

? ? ? ? ? ?

JMX：JMX的Server端封装 JMS：JMS Template封装 Email：EMail客户端封装

Schedule:Quartz的封装，ScheduleExecutor的封装 Ehcache:Ehcache Server封装 Jdbc:Spring JdbcTemplate

4.2 SpringContextHolder

在Spring ApplicationContext启动时，先把Context放入个该类的静态变量，当模块的代码无法通过正常渠道获得Spring Context及其中的Bean时，可直接从该静态变量中获取。

4.3 AOP Aspect的写法

最新的写法，一切都写在java文件里，只要在applicationContext.xml里面定义一把scan就可以了。

?

Database: ORM-Hibernate, Jdbc-Spring JdbcTemplate, 数据库 - H2、MySQL、Oracle, 数据库连接池-DBCP

1. 资料

数据库访问资料(江南白衣博物馆) ? JPA与Hibernate笔记(江南白衣博物馆) ? 2. 选型

因为最近一年来，JPA与EJB3的应用都没有想象中的多，在国内尤其突出。所以仍然使用纯Hibernate API+JPA1.0 annotation. 支持JPA2.0的Hibernate 3.5刚出来，要再继续观察。

3. in SpringSide 3

3.1 Entity类

1.Mini-Web中的User类是entity类的典型，集中演示了缓存，默认命名策略，多对多关系的定义和fetch策略，级联操作策略，子集合的 排序和缓存、非持久化属性， 见JPA与Hibernate笔记

2.为了统一ID的列名与生成算法，编写了IdEntity基类，演示了自增序列，数据库Sequence(Oracle), UUID(多数据库)的情形。(如果要在Oracle中为每个Entity对应不同Sequence时- 重载getId()函数)。

3.2 更换MySQL或Oralce等数据库

详见数据库说明。

1. H2

1.1 选型

H2嵌入式模式是功能测试的首选。测试要求数据库运行要非常快速，而且为免测试间数据的耦合，要能在每个测试间很快速的重建数据，H2刚好满足这个需求。

H2的主要对手是Derby，对比显示H2比Derby更快，而且有着非常好用的Web管理界面(在Web界面里写SQL时居然有表名列名的动态提示....)

1.2 in Springside 3

在/tools/h2目录里带了启动H2的命令(借助于maven管理的Jar包)。

另外，H2完全兼容hsqldb的语法，一般依赖数据库的开源项目都附带有hsqldb语法的初始化脚本。

SpringSide3中在使用嵌入式H2提供快速功能测试。url为jdbc:h2:mem:mini-service;DB_CLOSE_DELAY=-1 同时运行期的数据库也使用了H2的Server模式，url为jdbc:h2:tcp://localhost/~/mini-service。

2. MySQL 与 Oracle

开发实际项目时，需要将H2更换为实际数据库，Hibernate支持大部分的数据库，其中Java程序员选用MySQL和Oracle的最多。 更换MySQL与Oracle 主要修改几个地方，SpringSide已在两个mini-example中带了示范配置，取消相应的注释符号即可。

1.pom.xml

一节jar包的groupid与artifactId，version用于下载依赖包。

注意因为版权问题，Oracle的Driver不在maven官网的仓库上，需要自行发布到团队的私服或拷贝到本机的maven仓库目录。

2.src/main/resource/applicationt.properties

用于连接池与hibernate的配置。

3. bin/build.xml

用于导出导入数据到数据库。

4. bin/hibernate/hibernate.cfg.xml

如果需要用hibernate-tools生成代码则修改此文件，否则可忽略。

5.修改entity的ID生成策略。

注意Oracle中一般会为每个主要的表创建一个Sequence，所以继承于IdEntity的子类需要重载getId()方法指定Sequence名。 当然也可以只修改IdEntity基类，所有entity共用一个sequence。

3.3 Event机制

在Showcase中的AuditListener， 演示了利用Event机制，在save与update时自动为实体加入审计信息（创建人与创建时间，最后修改人与修改时间）

3.4 @Version字段

在Showcase中演示，@Version字段用在诸如两个管理员在差不多时间里打开了同一对象的修改页面可能引发的冲突，Struts2的 Prepareable机制对其使用有些许影响，需进行编码检查, 详见UserAction.

3.5 Clob字段

在Showcase中演示，Clob字段用String表示即可，但为了达到Lazy Load的效果，必需进行byte code enhancement，见showcase中bin/hibernate/bytecode-instrument中执行的Ant指令。 @Lob

@Basic(fetch = FetchType.LAZY) public String getContent() { return content; }

3.6 继承

在Showcase中演示，为性能考虑，一般采用同表继承，另外，在基类放一个@ForceDiscriminator有时候很有用。 @Table(name = \

@Inheritance(strategy = InheritanceType.SINGLE_TABLE) @ForceDiscriminator

public abstract class Post @Entity @DiscriminatorValue(\

public class Subject extends Post

3.7自定义ID生成器

在Showcase中演示一个16位的UID生成。

3.8 关联关系大全

在mini-web中演示@ManyToMany.

在shwocase中演示，单向，双向的@OneToMany, @ManyToOne .

4. in SpringSide II --性能相关

Hibernate 其实做了很多性能相关的优化，大家可以尽量使用后，再决定要不要直接跑JDBC。

4.1 二级缓存

在Entity类及其Collection属性中都可以声明Hibernate缓存策略。Entity缓存对象实体，而Collection则缓存对象间 的关系。 注意并不是所有对象都适合缓存，需要进行精心选择，详见 Hibernate笔记。

这里使用了ehcache cache方案， 支持基于JGroups分布式二级缓存，在sessionFactory处配置了ehcache_hibernate.xml的配置文件。关于 Ehcache详见Ehcache部分。

QueryCache本身就是吃力不讨好的事情，在集群环境下更加需要注意，因此我们一般不推荐使用使用查询缓存.

4.2 不使用OpenSessionInFilter

对于性能要求较高的Web网站与WebService应用，还是应该在Service层用Hibernate.init()主动初始化对象然后关闭 Session。详见mini-service的演示。注意Hibernate.init(user)初始化user对象，而如果要同时初始化user与 user的Lob字段与关联对象，调用的是Hibernate.init(user.getRoles()), Hibernate.init(user.getDescription()).

4.3 预Fecth关联对象集合

HQL与Criteria都可以一次关联查询查出主对象与关联对象集合，需要注意的查出来的记录和我们平时用jdbc查一样，有三个子对象就会有三条重复 的主对象记录，可以用CriteriaSpecification.DISTINCT_ROOT_ENTITY去除重复。 注意，如果关联对象集合和关联对象是被缓存的，就不一定要预Fetch对象了。 详见Showcase的UserDaoTest 。

4.3 Bulk Update HQL

嗯，HQL也有Update/Delete语句的, 详见Showcase的UserDaoTest 。

4.4 扩展HQL Dialect

如果有些数据库特定的功能而Hibernate又还没提供的话，可以简单的扩展HQL Dialect. Showcase中的H2ExtDialect，为H2Dialect添加了两个新函数, 测试函数见UserDaoTest。

4.5 直接JDBC访问

如果还是不行，就在需要的地方干脆的使用JdbcTemplate吧，不要折腾什么Hibernate Native SQL了。

5. SpringSide3 封装

5.1 DAO类

1.通用的HibernateDAO

SpringSide 3 封装的泛型SimpleHibernateDAO与HibernateDAO类，前者具有通用的CRUD函 数，QBH,QBC函数，后者扩展了SpringSide的分页查询函数以及按属性过滤条件的查询函数。

因为HibernateDAO已满足一般的DAO需要，因此可以直接在Service层中直接使用，仍然定义DAO子类主要为了保存注入 sessionFactory对象(否则sessionFactory要注入到Service层) 以及 可能存在的特殊DAO操作。

这里指的特殊处理并不是指一条HQL查询或一个按属性的查询都封装出一个查询函数，而是指RoleDAO中级联删除中间表这种真正特殊的 hibernate API调用和操作。

2. 不继承于HibernateDaoSupport/HibernateTemplate

参考Spring最新的Petlinc例子，DAO不再继承于Spring复杂的HibernateDaoSupport(Spring 1.x+ Hibernate 2.xd的产物)，而是直接使用H3推荐的sessionFactorygetCurrentSession()方法与Hibernate的原生 API。

5.2 分页查询

SpringSide3封装的Page类配合Hibernate query by Criteria，可以迎合展示层Grid(表格控件)的种种需求(分页，排序，按属性查找)。

Page类分两部分：

一部分是请求参数:pageSize、pageNo、orderBy(多个排序字段以,分隔)、asc(是否升序，多个排序字段以,分隔)、 autoCount(是否自动执行count查询统计总结果数) 。

一部分是查询结果:result(分页的结果List)，totalCount(查询的总结果数)，totalPages(总页数), 以及相应的上页页号，下页页号，是否还有上一页，是否还有下一页等函数。

请求参数与结果放在同一个类里，是因为很多时候参数需要带到结果里，在页面上流转下去。

在queryByHQL的情况下，对简单HQL能够自动查询，而复杂的时候就需要自己另行执行count HQL语句查询后设置totalPages。

5.3 属性过滤条件

SpringSide封装的PropertyFitler类，可在页面中简单定义filter_EQS_name, filter_LIKES_NAME_OR_LOGIN_NAME的请求参数，可通过HibernateWebUtils的 buildPropertyFilter(ServletRequest)函数快速构造出PropertiyFilter列表并传递到 HibernateDAO的search(List)函数中，整个过程非常自动化，无需太多的特定编 码，filter的命名规则也一目了然。 其中比较类型可选 EQ, LIKE, LT, GT, LE, GE;

比较值类型可选S(String.class), I(Integer.class), L(Long.class), N(Double.class), D(Date.class), B(Boolean.class); 如果要同时比较多个属性，属性名之间用_OR_分隔.

5.4 HibernateUtils

像用户与角色，订单与订单项这些关联关系，通常需要展现到页面上的checkbox list 中，经用户重新勾勾选后，再保存回数据库。HibernateWebUtils提供了合并原有关联对象集合与勾选结果的Utils函数。

另外一个重要的函数是将页面上传来的filter_XXX参数构造成属性过滤条件列表。

Overview

无论Hibernate多么好，有时候还是需要直接的Jdbc访问。Spring的Jdbc Template提供了几个简单但实用的功能： 数据源，连接与事务的管理

? 命名查询参数的快速绑定（Map/Bean形式)。 ? 查询结果的快速转换与组装。

?

在Showcase的UserJdbcDao中，对JdbcTemplate的功能逐一做了演示，包括：

? ? ? ? ? ? ?

查询单个对象/对象列表(用RowMapper转换业务对象) 查询单个结果Map /Map列表(类似ResultSet) 使用Map形式传入的命名参数 使用Bean形式传入的命名参数

特别演示了IN语句的命名参数使用, where id in (:ids), 输入一个List参数即可。 批处理更新。

使用SQL Builder，在XML文件里定义Freemarker SQL模板。

TransactionTemplate

有时会嫌方法级别的@Transactional太粗旷，还是想自己精确控制事务，就用TransactionTemplate了, 在Showcase的UserJdbcDao演示了有/无返回值的事务以及需要catch异常自行处理不想再抛出的情形。

另外一个典型的场景是应用更改数据库后发送JMS消息，为了使消息接收者能查询到最新的数据，最好用TrasactionTemplate来精确控制事务 提交。

SQL Builder

SQLBuilder支持Velocity来渲染定义在XML中的SQL. 为什么要用模板好处有二：

1.相比只能用+号换行而且老被Eclipse自动格式化的Java 字符串，XML中可以自由的缩进与换行。 2.可以用Velocity来自由动态的拼装SQL, 这个好处更无需多言了。 为什么不选用Freemarker做模板引擎，原因同样有二：

1. 因为SQL定义在spring的applicationContext-*.xml中，freemarker的变量定义与Spring的 placeholder一样，会引起冲突. 2. Velocity最近居然比Freemarker活跃. 详见Showcase的UserJdbcDao及其测试用例。

1. H2

1.1 选型

H2嵌入式模式是功能测试的首选。测试要求数据库运行要非常快速，而且为免测试间数据的耦合，要能在每个测试间很快速的重建数据，H2刚好满足这个需求。

H2的主要对手是Derby，对比显示H2比Derby更快，而且有着非常好用的Web管理界面(在Web界面里写SQL时居然有表名列名的动态提 示....)

1.2 in Springside 3

在/tools/h2目录里带了启动H2的命令(借助于maven管理的Jar包)。

另外，H2完全兼容hsqldb的语法，一般依赖数据库的开源项目都附带有hsqldb语法的初始化脚本。 SpringSide3中在使用嵌入式H2提供快速功能测试。url为jdbc:h2:mem:mini- service;DB_CLOSE_DELAY=-1 同时运行期的数据库也使用了H2的Server模式，url为jdbc:h2:tcp://localhost/~/mini-service。

2. MySQL 与 Oracle

开发实际项目时，需要将H2更换为实际数据库，Hibernate支持大部分的数据库，其中 Java程序员选用MySQL和Oracle的最多。 更换MySQL与Oracle 主要修改几个地方，SpringSide已在两个mini-example中带了示范配置，取消相应的注释符号即可。

1.pom.xml

一节jar包的groupid与artifactId，version用于下载依赖包。

注意因为版权问题，Oracle的Driver不在maven官网的仓库上，需要自行发布到团队的私服或拷贝到本机的maven仓库目录。

2.src/main/resource/applicationt.properties

用于连接池与hibernate的配置。

3. bin/build.xml

用于导出导入数据到数据库。

4. bin/hibernate/hibernate.cfg.xml

如果需要用hibernate-tools生成代码则修改此文件，否则可忽略。

5.修改entity的ID生成策略。

注意Oracle中一般会为每个主要的表创建一个Sequence，所以继承于IdEntity的子类需要重载getId()方法指定Sequence 名。 当然也可以只修改IdEntity基类，所有entity共用一个sequence。

Overview

数据库连接池可以使用应用服务器自带的实现，也可以使用开源的连接词如DBCP，可怜Tomcat/JBoss/Jetty貌似用的都是它。 使用ApplicationServer级别的连接池， 在ApplicationServer内的几个webapp间共享连接池以节约总的连接数，也可以为每个webapp独立分配以保证关键应用的供应。

DBCP好还是 Hibernate CP30 好，个人没有太深的感觉。因为Tomcat 还有 Spring的示例都是用DBCP的，那就DBCP吧。

配置参数

DBCP的性能配置主要是4个参数 #连接池启动时的初始值. dbcp.initialSize=10 #连接池的最大值. dbcp.maxActive=50

#最大空闲值.当经过一个高峰时间后，连接池可以慢慢将已经用不到的连接慢慢释放一部分，一直减少到maxIdle为止。 dbcp.maxIdle=20

#最小空闲值.当空闲的连接数少于阀值时，连接池就会预申请去一些连接，以免洪峰来时来不及申请。 dbcp.minIdle=5

一般这几个参数应该放在applicationContext.properties里方便部署时快速修改。

?

Web: MVC - Struts2, View - JSP2、Taglib、UrlRewrite, Javascript - JQuery、Dojo Base, CSS - YUI CSS Framework

1. 资料

江南白衣博物馆--Struts2笔记 ? 京山游侠--SpringSide 3 中的 Struts 2 ? 2.选型

Struts的招牌与用户群 + Webwork的较优雅架构 + Convention Plugin实现零配置文件，Struts2已经成为传统MVC里的最安全选择。 当然，GWT，Flex等是另一个潮流了。

3. in SpringSide 3.0

3.1 Convention Plugin实现零配置文件

Convention Plugin是2.1.6最新坐正的零配置Plugin,取代了原来的CodeBehind等插件，详细见详见Struts2笔记。 及其官方文档，Alfa.Shi翻译了中文版。

SpringSide 在struts.xml中重新定义扫描了根package名为web, 即会扫描xxx.xxx.web下所有的子Package。

3.2 CRUDAction的Prepareable与ModelDrivenen接口(涉及CRUD时的可选接口)

CRUD的Action全部使用Prepareable与ModelDriven接口，两个接口都是CRUD界面必备，详见Struts2笔记。 而非CRUD的action是否使用这两个接口就看具体情况了。

因为只有input() 和 save()两个函数需要二次绑定，而list()等函数并不需要，所以根据命名约定实现了

prepareInput(),prepareSave()两 个函数，Struts2会自动在执行input()与save()前执行它们，详见CRUDAction基类.

4.2. CRUDAction基类(涉及CRUD时的可选基类):

规范了CRUD函数的名称，规定使用ModelDriven和Preparedable接口，并规范了prepare二次绑定接口只在input和 save函数中的使用

流程如下：

1. 用户打开用户列表页，访问/user.action

2. a.执行默认的execute() 函数，实际执行list() 函数。

3. b.list() 函数查询列表放入某list变量，返回SUCCESS，默认跳转到user.jsp 4. c.user.jsp取出action中的list变量进行渲染。 5. 用户新增对象，访问/user!input.action

6. a.首先将id放入id变量，执行prepareInput()函数创建一个新的user变量 7. b.input() 函数，返回INPUT，默认跳转到user-input.jsp

8. c.user-input.jsp 执行getModel()获得user变量渲染input框 9. 用户提交Form，访问/user!save.action

10.a.执行preparedSave()函数创建新的user变量，将input框的内容绑定到getModel()获得的user变量

11.b.执行save()函数保存user，返回RELOAD，跳转到@Result中定义RELOAD页面，以redirect方式重新打开 /user.action 12.用户修改对象，访问/user!input.action?id=1

13.a.绑定id=1到id变量，执行prepareInput()从数据库查询出user。 14.b.下同2.

15.用户提交Form,访问/user!save.action

16.a.绑定id=1到id变量，执行prepareSave()从数据库查询出user。 17.b.下同3.

3.3 View相关

View /Taglib 相关规则详见View/Taglib，

? JSP放在WEB-INF/content 中保证文件不可读，使SpringSecurity专心的只过滤*.action。

? 基于Convention的神奇映射能力，WEB-INF/content/login.jsp的访问地址为/login.action，而且 无需编写真正的

LoginAction.java。

?

3.4 输入校验与国际化

Struts2的validate框架优点是可以在客户端和服务端同时进行校验。

? 但是因为JQuery的validate plugin客户端检测更加好用，而且客户千方百计绕开客户端，直接发送一个邮箱格式不正确的请求意

义不是很大，真的很紧要校验，还可以在服务层进行(参 考hibernate validator)。 ? 所以用了JQuery的validate plugin，见Javascript。

? 国际化，因为国际化式的开发是有成本的，挺麻烦的，因为不是每个项目都需要国际化的能力，所以在默认的mini-web示例里就不

演示了。

?

3.5 信息与异常显示

1.页面在跳转时会丢失addActionMessage()的信息, 在struts.xml中配置使用store interceptor，可以在redirect页面时，将信息存储在session中.

2.尽量使用addActionMessage来添加信息, 如果用addActionError会自动跳到input页。

4. SpringSide Core的封装

4.1. Struts2Utils:

绕过jsp/freemarker直接输出字符串/JSON/XML的便捷函数，用于ajax请求等简单输出结果，支持 encoding,no-cache等参数。 ? 获取http request/response/session的简化方法.

?

1.资料

JSP2.0 笔记(江南白衣博物馆) ? Struts2 Tag Reference ? 2. in SpringSide 3

2.1 JSP 2.0

因为开发人员，编辑器等原因，使用JSP2.0 而不是Freemaker作为模板，JSP2.0的EL已经非常简洁(见JSP2.0 笔记)。

同时因为目前的IDE智能程度颇高，因此不使用SiteMesh/Tiles式的光猪页面，方便IDE根据完整页面内容进行提示与校验，在有页面重用时使 用jsp中的解决。

2.2 关于Taglib

1. 页面内容显示使用原版的html语法，少用taglib，使用JSP2.0 EL 输出动态变量。 2. 尽量不使用Struts2的UI taglib，尤其是封装Dojo的ajax theme。

3. 控制语句统一使用Struts2的taglib 、 、、，因为JSTL的taglib不支持if-else，而

且Struts2的 OGNL语法强大(但需要学习)。 4. 不建议使用的tag

4.1. 、不使用：该tag作用为自动在绝对路径中加入context-path保持灵活度。但层层的节点 使得阅读性很差。使用taglib.jsp中放入context-path变量，然后在页面上直接

4.2. 用普通html代替，如果Form中有多个button，要提交到不同的method甚至不同action，实际的 html效果为：

2.3SpringSide改造的taglib

springside改进了一些taglib的输出模板，详见在mini-web的src/resources/theme/custom目录，在使用时 要将theme设为custom，见Struts2资料

，之类的select,check,radio taglib都挺好用的。

下例中Action里有一个List roleIds代表要选中的角色,一个List roleList代表完整的角色列表，Role有两个属性：id 和 name。

但 在选项较多的时候无法做到很好的换行与对, 因此Spring使用了table来实现，设定每行3个选项。 与也是不错的标签，SpringSide也作了美化，比如可 以点击关闭消息。

2.4 html格式

页面尽量符合Xhtml 1.0，在页首加入，Eclipse会自动检查：

2.4 URL Rewrite

Struts2的action url对google与用户都不那么友好，所以对外的网站可以使用url rewrite filter来改善。

见showcase的示例，首先在web.xml中加入url rewrite filter,注意需放到struts2 filter的前面，然后在WEB-INF/下放一个urlrewrite.xml进行定义，使得

/common/users.htm 等于 /common/user.action

/common/user/1.htm 等于 /common/user!input.action?id=1 ^/common/users.htm$

^/common/user/([0-9]+)\\.htm$

1. 资料

JQuery资料(江南白衣博物馆) ? Dojo Base ? 2. 选型

因为widgets框架如Ext 和 Dojo Dijit始终不够好用，决定还是忍一忍，等一等到RIA时代。

? Prototype.js，JQuery, Dojo Base这类Javascript库，有助于跨浏览器的 Javascript，并简化对象选择、DOM操作、Ajax操作。 ? JQuery比Prototype.js的发展似乎好一点，起码Plugin是在官方网站管理的，同时JQuery UI也在向着好的方向发展。

? 如果自己写的JavaScript很多，则推荐用Dojo，因为它的javascript文件Package管理和Javascript最弱的 面向对象继承机制

是做的最好的。

?

3. JQuery in SpringSide3

在Showcase的Ajax示例中演示了jquery的ajax标准功能和基于JSONP的跨域访问。

3.1 基本功能

JQuery的最基本功能包括是选择DOM对象，设置其内容、属性、CSS及一些常用操作，如： $(\

其中#loginName 是CSS语法，获得页面id为loginName的元素。一般按ID获取对象已足够，想使用更高级的CSS+XPath的获取方法，参考JQuery的Selector文档。

注意JQuery1.3后，按属性查询对象的语法已取消@，下面语句为name为\的radio，checked值为\的 box。 $('input:radio[name=gender]').val(['male']);

3.2 Ajax

在showcase使用了ajax的几种常用法，包括： 1. 将Form中的内容序列化成字符串动态提交。 2. 动态获取文本内容，更新本页内容。 3. 动态获取JSON内容，更新本页内容。

4. 基于JSONP，跨域获取html内容，更新本页内容。

注意要避免缓存，要不服务端返回时输出no-cache参数，要不使用JQuery中最麻烦的用法$.ajax()方法来设定非缓存参数，详见JQuery官方文档。 因为Ajax时，会在URL中传输中文字符，需要设置URI-Encoding=\如Tomcat在server.xml中设置)，否则会 出现乱码。 跨域访问的细节可见IBM DW的文章《Cross-domain communications with JSONP》

3.3 Valiation plugin

Validation 是著名的客户端输入校验plugin，可进行非空、数字等常规校验，也可以远程ajax判断用户名是否唯一，详见 JQuery Plugin资料。

min-web中用它代替了Struts2的validate框架，详见的user-input.jsp(正式风格)、login.jsp(轻量风格)。

4. DOJO Base in SpringSide3

在showcase的Ajax示例中演示了DOJO Base的面向对象和Package管理。

Dojo Base的基本功能没什么出彩的地方，不过不失，但它的面向对象继承与JavaScript Package管理就做得很不错，如果项目需要写大量的Javascript，可采用Dojo Base来加强管理。

4.1 面向对象定义

下面这段容易理解的面向对象父类子类定义，在JavaScript世界是很难得的。 //父对象, 拥有_color属性与getColor()函数 dojo.declare(\ _color : \ constructor : function(color) { this._color = color; }, getColor : function() { return this._color;

} });

//子对象, 拥有半径属性与计算范围的函数, 同时继承父对象属性与函数. dojo.declare(\ _radius : 0, constructor : function(color, radius) { this._radius = radius; }, getArea : function() { return Math.PI * this._radius * this._radius; }, generateContent : function() { return \ } });

4.2 Package管理

在dojo js文件的父目录，放入需要管理的目录与原文件，如dojo.js路径为js/dojo/dojo.js, 放入新的js/showcase/shape.js，并在shape.js中声明dojo.provide(\ 则可在任意地方以以下语句载入该文件。 dojo.require(\

1. 参考资料

? 使用YUI CSS 2. 选型

互联网发展飞快，转眼间CSS也需要Framework来保证页面在各种浏览器上表现一致，支持缩放了, 连px像数点都不是定义布局时的最佳单位了。

在YUI CSS 与Buleprint之间，貌似Blueprint的宽度总是比较固定，如950px，所以基本CSS框架选了YUI CSS.

3. In SpringSide3

SpringSide3将YUI CSS2.8 r4的四个文件全压在了yui.css中，分别是：

reset.css:消除各种浏览器之间对HTML元素样式表现的差异，从而提供一致的样式

? base.css:使用Reset消除了浏览器默认样式，使用Base就可以使HTML元素在A级浏览器中获得一致的表现 ? font.css:提供跨浏览器的字体样式和控制。默认大小是13px，其他px的百分比见图表 ? grid.css:提供布局。

?

SpringSide3中的布局很简单, id=\声明了一个100%的页面， class=\声明了bd div左边栏180宽。id=\声明了这是主栏。id=\的意义也很明显，其他剩下的就是有时多得有点让人烦的 yui-b了。

各式主流的、实用的、好玩的开源项目大派对。

在showcase的jmx-client.jsp中，更近一步demo了使用yui-g/yui-u进行内容排版，将两种JMX操作的Form等 宽并列。

4. CSS进阶长

为了更好的支持缩放，现在不流行用px作为长度单位了，改用em. 常用的换算关系如下，其他可以查 http://pxtoem.com/ px em 5 0.313 8 0.5 10 0.625 13 0.813 16 1

另外，可能是为了批量的修改字体，也会只定义一个标准body字体的大小，然后其他h1,h2等全部用百分比来表示大小。 YUI里默认大小是13px，常用换算关系如下，其他px的百分比见图表 px % 10 77

13 100% 20 153.9%

?

基础类库: 日 志-Slf4j, Log4j, Utils工具类

1.资料

? 日志的资料(江南白衣博物馆) 2.选型

log4j作者的新作slf4j是commons-logging的替代品，因为可以参数化的语句\，不用再为了丁点性能写什么 if( logger.isDebugenable()) ....Hibernate、Jetty, Spring3.0等项目已经迁移到了slf4j。 至于log4j的后续项目logback，因为国内主流还是log4j，暂时不做演示。

3.in SpringSide 3

3.1 日志库间关系

新写的代码，使用slf4j，然后会通过slf4j-log4j12调度log4j。

原有代码或第三方代码，使用commons logging的依然会去调用log4j，使用log4j的也无需改动。

3.2 日志文件生成策略

日志文件一般按日滚动，对于要被每小时处理一次的话也可以按小时来滚动，见showcase中的log4j.properties。 对于调试信息等不大重要的信息，可以使用按大小滚动，且设置最多保留的文件数量。

如果需要按日/小时滚动，每日的文件又要按大小滚动，还想限制目录中文件的总数量，建议使用一个叫TimeAndSizeRollingAppender的开源项目

3.3 调试日志

系统上线后，难免会出现问题，这时候，好的调试日志就是TO team或开发人员的救命稻草。 调试日志一般有如下设计：

发生在多个服务器的日志可以汇总到一个日志文件里.

? 可以通过JMS, SocketServer等Appender实现, SS中暂无演示。

? 发生在前后台多个业务子系统的日志, 每条日志有一个TransactionId清晰的显示某次业务的完整过程，可以方便的grep.|

? 利用log4j的MDC实现，见TraceUtils, showcase的TraceLogAspect通过AOP在每个WebService方法调用前，都自动生成了一个

TraceId.

?

要把traceId自动打印到日志中, 需要在log4j.properties中在appdender的ConversionPattern添加%X{traceId},如:

log4j.appender.stdout.layout.ConversionPattern=%d [%t] %p %c %X{traceId}-%m%n

调试日志在发送到中央JMS/SocketServer的同时要在本地保留备份，但与平时的系统日志又不要放在同一文件，且调试日志不会保留太 长。

? 可将调试日志的级别限定在Debug，同时在系统日志的appender上设置Threshold为Info，设定RollingFile的文件大小与数 量，

见log4j.properties.

? 利用AOP自动记录一些信息，减少debug语句的数量，showcase中的TraceLogAspect作了简单演示。

?

3.4 业务日志

使用QueueAppender/JdbcLogTask, 再配合TraceUtils中演示的Log4j MDC技术, 能方便的实现业务日志功能.

3.5 JMX动态配置日志级别

Springside3简单封装了一个Log4jMBean，可以通过JMX Console无需重启的动态读取或设置每个Logger的日志级别，并读取每个Logger设定的appender。

在showcase示例中，路径为service:jmx:rmi:///jndi/rmi://localhost:1099/showcase, MBean名称为SpringSide:type=Log4jManagement

另外平时在代码中也可以随意某个设置日志级别，如- Logger logger= Logger.getLogger(\ logger.setLevel(Level.toLevel(\);

3.6 Log4jMockAppender

MockAppender用于验证日志输出的正确性，在JmsQueueTest，ExecutorJobTest等测试用例中均有演示。

在测试开始前, 使用addToLogger()方法将MockAppender添加到需要侦听的logger. 即可在测试后通过getAllLogs()方法, getFirst/LastLog()等方法取出log事件。

3.6 加强版的异步数据库日志

log4j的异步Appender不是很稳定，Jdbc Appender也不完全符合需求(不是由Spring注入DataSource，没有好的批处理机制) ， 因此在extension项目中重新进行了封装，并在showcase的log4j.properties, applicationContext-log.xml,LogAction.java中演示。 轻量的异步QueueAppender将消息放入由QueueHolder持有的队列。

? 由Spring管理DataSource的JdbcLogWriter从队列中读出消息，批量写入数据库。支持阻塞的读取消息并缓存到一定数量 时写入

与定时批量读取消息两种策略。

? JdbcLogWriter的sql可由Spring注入，更可在子类重载getActualSql()函数进行处理。

? Queue管理器在系统正常关闭/重启时会通知JdbcLogWriter停止工作，JdbcLogWriter的基类 QueueConsumer会将负责队列中未完

成信息持久化到临时文件，在下次启动时重新载入。

?

1.SpringSide3 Core Utils

? ? ? ? ? ? ? ?

ReflectionUtils，在Sping/Apache Commons的反射类的基础上，提供更进一步的反射操作，如: 1.强制直接访问private/protected属性 或 调用Getter/Setter 2.获取范型定义类型信息

3.获取集合中元素的属性组成一个List或字符串 4.转换字符串到相应的对象类型.

5.转换Checked Exception到UnChecked Exception.

EncodeUtils，集成了大部分的编码解码需求，包括Base64/Base64URLSave, Hex, Url Encode, Html/Xml Escape. WebUtils, Servlet编程常用的工具类辅助函数,特别是对缓存控制，Etag判断的支持。

本文来源：https://www.bwwdw.com/article/2aia.html