Springside技术参考手册

Springside3.3.2技术参考手册1.总述架构风格简述1.概述技术框架选型以工业化大规模软件开发为原则---主流的选型、适宜团队分工的架构，同时照顾轻量级快速开发的需求，Java版的约定大于配置的风格。SpringSide3的进步(京山游侠)在SpringSide的官方主页上，写着SpringSide3中包含的主流组件：Spring2.5+Hibernate3+Struts2+JSP2.0+JQuery+JAX-WS2(byApacheCXF2)+SpringSecurity2.0。不过，如果你认为和SpringSide2相比，升级的只是版本号，那么你就大错特错了。像我这样从SpringSide2过来的人，如果能够详细对比SpringSide2和SpringSide3，对于我们理解SpringSide3肯定更加有帮助。下面的内容是我自己的一些体会，不正确的地方欢迎大家指正。从主要的架构来，依然是那么几层，先设计数据库，再写Entity层，再写Dao层，再写Action，然后使用JSP表现出来，其中的Entity和Dao层和Hibernate紧密相关，Action是Struts的主要部分，Spring作为粘合剂，把这些东西连在一起，并提供了一些机制简化编写这些层的工作。SpringSide就是这样一个大的粘合体，省去了我们自己很多的粘合工作。从SpringSide2到SpringSide3，这些工作得到进一步的简化，我们开发起来就更爽了。我认为，我们的开发模式，主要经历了这样的简化过程：第一阶段，代码加一大堆的配置文件第二阶段，代码加少量的配置文件第三阶段，代码加基本上等于零的配置文件这些进步是如何实现的呢？从第一阶段到第二阶段，主要靠的是Annotation，把一些大量的配置工作转移到了Java代码中，那么从第二阶段到第三阶段怎么实现呢？都已经Annotation了，你还有什么办法让配置文件更少？想不到吧！我也想不到，直到我看了SpringSide3生成的项目，我才知道还有一个好东西叫自动扫描。下面使用实际的例子进行说明。作为示例，Hibernate是个不错的选择。第一阶段，如果单独使用Hibernate，我们每写一个Entity类，就得同时写一个.hbm.xml文件，如果有很多Entity，就得写很多.hbm.xml文件，每修改一次Entity，也要同时记得修改.hbm.xml文件，相当的不方便，其目录结构如下图：第二阶段，使用Annotation，SpringSide2中就是这样的方式。具体内容可以看我的另一篇博文《打通持久层的任督二脉》。所以我用SpringSide2进行开发的时候，写Entity也是两个步骤，但是比第一阶段要简单。就是先写一个Entity，Entity里面使用Annotation，如下图：然后修改配置文件，SpringSide2中专门为Hibernate的定义开辟了一个专门的xml文件dataAccessContext-hibernate.xml，里面关于SessionFactory的定义是我们很熟悉的。我只需要将我的Entity类加入到里面就可以了，如下图中红笔圈出来的部分：第二阶段和第一阶段相比，配置文件简单多了，不需要维护那么多的.hbm.xml。但是，每编写一个Entity，依然需要修改一下配置文件。第三阶段就更了不起了，零配置文件，也就是说我们只管写Entity就行了，不需要管配置文件（当然，项目开始的时候还是要配置一次的）。打开SpringSide3生成的项目，果然找不到dataAccessContext-hibernate.xml文件。那么是如何实现零配置的呢？靠的就是自动扫描，如下图中红笔圈出来的部分：上面讲Hibernate只是为了举例说明我的观点，事实上SpringSide3中的零配置可不仅仅只存在这一个地方。Dao层也可以不用配置了。在SpringSide2中，我们每写一个Dao，都需要在serviceContext.xml中加入这个类，如下图：SpringSide3中使用自动扫描了，如下图：以后编写Service后，再也不用修改配置文件了，只要我们在Service中使用如下Annotation：事务也不用配置了，在SpringSide2中，事务是这样配置的：SpringSide3中，事务配置是这样的：Action也不用配置了，不过使得Action零配置的代码却在web.xml中，如下图：还记得SpringSide2中的Struts配置代码吗？编写完Action类的代码后，还需要修改两个配置文件，如下：所以说，SpringSide3的一个优点就是让生活变得更加简单了。在以上的截图中，SpringSide2项目用的是Eclipse3.2，而SpringSide3项目用的是Eclipse3.4ForJavaEEDevelopers。哪一个IDE更爽，那也是一目了然。2.主要库栈JDK：JDK6.0、UTF-8.IOCcontainer：Spring3.ORM：Hibernate3.3.Web：Struts2.1、JSP2.0、JQuery1.4/DojoBase1.4.WebService：基于ApacheCXF2.2的JAX-WS/JAXB2.0规范,基于Jersey的JAX-RS规范.Security:SpringSecurity3.0.3.层次说明3.1entity-领域模型层使用SqlFirst的开发模式，先设计数据库，参考DBA的性能意见而不要太片面追求OO化的表结构。然后纯手工编写entity与极少量的JPAannotation(约定大于配置),也可以用hibernate-tools从数据库逆向生成后再作修改。3.2access-资源访问层资源访问层包括对数据库、JMS、外部的WebService等的访问。每个领域对象对应一个DAO类，继承于通用的HibernateDaoT，所有以该对象为查询主体的HQL语句统一定义于DAO内并提供查询函数.在性能紧要而Hibernate又无法满足要求时，可混合使用JDBCTemplate。3.3service-业务逻辑层Service层有两类对象，一类是领域对象管理类(EntityManager)，按领域对象划分，每个Manager类负责管理多个紧密关联的Entity的增删改查及其业务逻辑。一类是业务服务类(Service)，按业务脚本划分，可能会访问到多种领域对象与Manager类。用Spring的Transcationannotation定义事务。对于HibernateLazyload的关联对象，在性能要求不高时可使用OpenSessionInViewFilter，否则在Service层完成对象的初始化操作。3.4web-WebMVC层MVC框架使用Struts2.1这一老牌传统MVC框架+ConventionPlugin实现零配置文件，每个Action实现一组页面操作。View模板用JSP2.0,尽量使用纯html+JSP2.0EL展示页面。Javascript与Ajax使用JQuery或DojoBase。尽量采用CSS框架规范CSS的布局。3.5ws-WebService接口使用Javafirst的开发模式，通过JSR181annotation标注WebService接口，用JAXB-2.0annotation标注Java-XMLMapping。用DTO类实现Entity与外系统的解耦，用WSResult包裹返回结果与返回码，不使用Exception返回错误。对于Restful服务，同样采用JAX-RSannotation标注。3.6security-安全控制使用SpringSecurity的Filter拦截URL，使用SpirngSecurity的taglib拦截页面内容。采用用户-角色-资源三层控制，角色-资源关系定义于XML的简化模式。3.7测试单元测试尽量采用MockObject的方式屏幕所有依赖对象/数据的访问，对于dao层与特别查询与特别数据库操作，采用集成测试连接实际数据库，基于Spring的集成测试Context。功能测试使用selenium测试主要用户故事的主流程及Javascript的效果，使用Jetty嵌入式Web服务器与H2嵌入式数据库，使用DBUnit预备数据，使得整个测试可以快速运行，对测试环境没有太多的依赖。4.常见问题4.1什么时候使用基于接口编程？基于接口编程、Fascade层等等抽象封装都是有开发和维护的代价的，是否使用归根结底还是看在团队人员的分工情况，在大家不得不依赖这几项技术来解决相互的接口、契约问题时，自然就用了。4.2Package是先分层还是先分模块org.springside.模块A.web还是org.springside.web.模块A？同上，还是看团队人员的分工情况。如果是每人从头到尾负责一个独立模块的可以先分模块。反之，按层进行分工并鼓励层内重用的，可以考虑先分层。目录结构描述1.公共目录结构完全采用maven的默认布局。bin命令脚本目录，详见后。srcmain主源码目录main/javajava源文件main/resources配置文件、属性文件main/webappWeb应用目录test测试目录，结构与主源码目录相同unit单元测试functional功能测试data测试数据生成器targetmaven编译目录2.bin目录结构文件描述db-export/db-init将当前数据库数据通过dbunit导出到export-data.xml。执行src/main/sql中的脚本初始化数据库schema,再通过dbunit执行default-data.xml初始化数据。convert-h2将真正数据库的sql转换为测试用的H2的sql。eclipse生成Eclipse项目文件。jetty/Jetty-debug用jetty快速运行本项目。jetty-debug支持eclipse以debug方式连入，端口为8000hibernate/generatecode从数据库逆向生成entity/dao/pojo2.基础框架Spring:SpringFramework1.参考资料Spring资料(江南白衣博物馆)1.图书Spring2.5参考手册中文版(英文版)(满江红出品)《SpringRecipes-AProblem-SolutionApproach》Apress，20082.文章IntroductiontotheSpringFramework2.5(TSS)Rod老大的Spring介绍Spring2.5版。3.笔记Spring2.5的笔记以前的笔记part1、part2、part3有时间会根据Spring的最新变化重新整理。Spring2.5参考手册中文版(满江红出品)《SpringRecipes-AProblem-SolutionApproach》Apress，2008Spring2中较好的参考书。2.选型有人说guice好，但我们用Spring不仅是为了IOC，也为了Spring对JEE所做的封装，以及整个JavaEE界众多项目(SpringSecurity,CXF、Struts2等)对它的依赖。3.inSpringSide3-Mini示例使用的基本特性属性配置及IOC容器@Transcationalannotation标注的事务管理功能集成测试的基类3.1IOC部分特征使用详见Spring笔记(江南白衣博物馆)3.1.1零配置文件的使用场合Service，Dao层在无特殊配置项时，可使用IOCAnnotation进行配置实现约定俗成大于配置的零配置文件.而其他Database/SessionFactory，SpringSecurity,CXF等需要进行参数配置时，仍然使用XML配置文件。3.1.2零配置文件的annotationSpringSide3中使用@Component注释所有类别，在setter方