JAVA软件开发规范.doc

Java软件开发规范 JAVA软件开发规范 一、绪论 1.1 概述 随着公司上ERP项目，为统一开发技术规范，缩短开发周期，进一步提高项目质量，降低后期维护难度，迫切需要一个更完善、专业、有效的开发规范。 本规范的目的是使本科室JAVA开发能以统一、标准的、规范的方式设计和编码。通过建立开发规范，使每个开发人员养成良好的开发风格和习惯；提高程序的可靠性、可读性、可维护性和一致性等，提高程序员的开发水平，增进团队间的交流，并保证软件产品的质量。 1.2 适用范围 本规范适用于本公司所有JAVA软件项目、产品等的设计、开发以及维护等。所有JAVA软件开发人员在整个软件开发过程中必须遵循此规范。 二、总体框架 2.1 框架概述 本公司JAVA开发的软件产品多为B/S结构，涉及多个层面的开发，为便于逻辑分离及项目分工，开发的软件产品应当符合MVC设计模式，基础框架使用SSH（spring+hibernate+struts2）MVC基础框架。 2.2 框架规范 旧框架中Servlet层应当仅负责宏观层面的业务逻辑，不进行具体的数据访问，新框架中Action组件负责事务同旧框架中的Servlet层组件。Model由开发人员自己实现。hibernate是将原来的 DAO部分，就是数据库部分，进行数据持久化，可以理解为数据库的接口和对数据库的操作之一。spring是管理容器的角色，降低耦合度，方便管理。 2.2.1 Hibernate DAO规范 DAO为数据访问组件，用于访问持久性数据，例如为关系型数据库。本规范要求DAO对象必须直接或间接继承数据访问组件的基础类 com.yonggang.framework.hibernate.HibernateDAOSupport ,该基类已经实现了hibernate通用的查询，更新，插入，删除，分页查询等操作，业务类继承该类后即可使用HibernateDAOSupport提供的hibernate数据库操作方法。 DAO处理完正常逻辑后设置本次处理后用于界面提示的消息。禁止DAO类依赖于request等Web对象，便于DAO类可以脱离于Web应用。 2.2.2业务处理类BO规范 在BaseBO当中，提供了业务开发常用方法，比如采用Hibernate方式的普通查询、分页查询、对象的保存与更新，还提供了Jdbc方式的普通查询、分页查询、数据更新等。开发当中可以创建一类业务处理的“BaseBO”，比如 “WorkflowBO”，该BO扩展自“com.yonggang.framework.base.BaseBO”，项目当中工作流业务模块皆要扩展这个新创建出来的WorkflowBO。具体的业务模块当中就可以扩展这个WorkflowBO，编写相关的业务方法。 其中的业务方法如果需要事务包裹，要以update、delete、save、process、execute开头，并且配置将该BO配置到Spring当中时，Bean的命名要以BO结尾。 编写好业务类之后，我们需要将其配置到spring的配置文件当中，通常情况下，我们建议您在您的模块的src目录下创建一个configs目录，在其下放置您的spring配置文件，这样，因为是分模块配置对应的spring配置文件，所以即使在多人开发的场景下也不会产生配置文件编辑的冲突问题。下面表格当中向我们展示了TestBO在Spring配置文件中的配置情形。 TestBO配置示例 从上面的配置当中可以看到，我们建议您在Spring当中配置您的BO的时候，bean的ID命名方式采用模块名+“.”+类名（首字母小写）的方式，如上面的bean的名字为“modulea.testBO”，这里的modulea是模块名称，testBO是类名（首字母小写）。通过这种命名方式，我们从Bean名称上就可以看出Bean的作用，同时这种命名方式还可以防止重名。 2.2.3 Action规范 新框架以Action层组件代替Servlet层组件。此处，Action组件将主要负责业务逻辑开发、消息设置、页面导航设置，不再需要管理资源释放(如数据库连接的释放)。 Action类都必须直接或间接继承类com.opensymphony.xwork2.ActionSupprot与DAO的理由一致，每一套应用也应当定义自己的Action入口，此处假定其名称为AppAction。 2.2.4 角色权限用户验证规范 使用spring security3作为本框架的安全验证，使用SpringSecurity可以与spring无缝集成，扩展性很强。下面简单说明下spring security 的业务流程： 1）容器启动(MySecurityMetadataSource：loadResourceDefine加载系统资