项目框架搭建项目规范.doc

项目框架搭建及项目规范本项目使用Struts2+Spring2+Hibernate3+Ajax进行搭建，数据库采用Oracle 10g，服务器采用Tomcat6.0。SSH框架整合：系统架构分Web层、业务层、数据库访问层三层架构模式，客户端不直接与数据库交互，而是通过组件与中间层建立连接，再由中间层与数据库交互，使用了Spring的IoC来实组件之间的依赖关系注入，Spring的作用贯穿了整个中间层，将Web层、业务层、数据库访问层及PO无缝整合，其数据服务层用来存放数据，架构的整合如下：Web层: 使用JSP、Struts2、Ajax技术，通过调用业务委托接口来调用具体的业务组件的实例，而业务组件的实例是通过Spring的IoC容器取得的。业务层: 使用业务委托模式使控制层与业务实现分离，即客户通过调用业务委托接口来调用具体的业务组件的实例，避免控制层与业务层的藕合带来的维护或升级困难。数据库访问层: 将对持久层数据的基本增、删、查、改等操作提取到BaseDAO中，BaseDAO继承Spring的HibernateDaoSupport，各模块DAO继承BaseDAO实现复杂的数据访问访问，由Spring为DAO生成代理对象来为DAO添加事务服务，由IoC容器DAO的代理实例注入到业务组件中,业务组件通过DAO的委托接口调用DAO对象，使得上层组件不直接依赖于DAO的实现类，使得持久层更换或修改不影响上层组件。一、项目的目录结构工程项目名database - 数据库相关文件，各模块数据库表结构相对稳定后提交到此目录document - 项目相关文档及参考 share - 项目中一些较难的技术实现，参考资料，经验共享report - 工作计划，各组员的工作报告提交到此目录plan 项目开发计划requirement - 项目需求文档design 项目设计文档src - 源代码，包名按edu.公司名.项目名.模块名.组件名,如：edu.tshit.erp.base 放整个系统中公共的类、各种组件的基类、常量类 edu.tshit.erp.util 放整个系统要用到的工具类 edu.tshit.erp.*.action 放控制层组件 edu.tshit.erp.*.model 放对应业务实体的类edu.tshit.erp.*.service 放业务处理类，业务接口WebRoot Web应用所在的目录css - 存放样式表文件js 放系统公共的javascript脚本images - 存放系统公共的图片，而各自模块专用的图片在此目录下建子目录存放submodule1 子模块的页面submodule2 子模块的页面WEB-INFclasses 生成的类、配置文件、mapping文件lib - 项目要用到的包全放在此，不能建子目录放二、编码规则1包名一律小写2类名每个单词首字母大写3属性名、变量名前两字母小写，方法名首字母小写4类的命名规则参考: 对象名+组件名，以员工管理为例Action组件命名： edu.tshit.erp.xxx.web.EmployeeAction.javaIService组件命名：edu.tshit.erp.xxx.service.IEmployeeService.javaService组件命名： edu.tshit.erp.xxx.service.EmployeeService.javavo组件命名： edu.tshit.erp.xxx.vo.Employee.java 5页面的命名规则参考: 对象名_操作名，以员工模块为例列表页面：emp_list.jsp详细页面：emp_detail.jsp新建页面：emp_add.jsp修改页面：emp_edit.jsp选择页面：emp_select.jsp查询页面：emp_query.jsp6Result命名规则参考:列表：listemp进入新建：toaddemp新建页面提交: addemp进入修改：toupdateemp修改页面提交：updateemp三、struts子模块Struts.xml四、springapplicationContext.xml五、CVS注意事项1. Eclipse生成的.classpath文件要提交, .project文件一定不要提交2. cvs提交时注意不要提交系统生成的文件，如编译class文件，Tomcat生成的work目录3. 提交文件时只提交你自己模块的文件及公共文件，如果你改了别人的模块的文件，需要与对方沟通之后方可提交，不提交可以使用”overwrite and update”从cvs上取下来覆盖4. 当你本地的修改与服务器上文件有冲突时，应该认真看看哪些地方冲突，谨慎处理5. 从cvs的更新代码使用update与提交代码到cvs用commit，这两者可以随便使用，但Overwrite and update、Overwrite and Commit要谨慎使用6. 每次你要