SSH编码规范SSH编码规范.doc

SSH编码规范 一、项目设计 本项目分为3Struts2）、业务层（Spring2.0）、持久层（Hibernate3.0）。由Struts来管理视图层并对异常进行捕获，由Spring来管理业务逻辑及事务的管理，Hibernate封装了所有数据以及数据库的操作与分页等。 如图： 二、包的命名规范 包的命名规范总体来说主要是按照模块的名称来命名。并且每个包的名称都必须是小写的字母。一个系统中有用户模块、日志模块等，每个模块都是一个包，然后在包的下面包含此模块下所有的类。 譬如应用中有一个testtest包 例如：在test ???2.1、action包 该包放置各种strutsaction，此包的命名规范是必须以Action结尾，例如我们要写个登陆的Action那么这个类得名称是LoginAction。 例如：???2.2、service包 该包放置业务操作类，譬如用户管理类，一般情况将该用户操作类提取一个接口，此接口以Serviceservice包下面，然后在service包下新建一个imp包，在imp包中才放置用户操作接口的实现类，实现类以ServiceImpl来结尾。该接口实现类中调用DAO接口对数据库进行操作，而调用该实现类的方法在struts的action中通过此类的父接口调用。 下面以testUserService；实现类：UserServiceImpl。 例如： ???2.3、dao包 dao层有一个接口是BaseDaodao包下面所有的接口都要继承BaseDao，在dao.impl包下所有的类都要实现对应的dao包下面的接口，继承BaseDaoImpl类，具体见示例。 例如：dao?? cn.bdqn.hnoa.test.dao.impl 以上是一个模块的规范 以下是 cn.bdqn.hnoa 包下的目录 ???2.4、entity包 该包中放置hibernatebean和该bean对应的.hbm.xml文件。 例如：??2.5、util包（工具包） util包个人理解是:在我们需要添加的功能不在以上所有包中，那么就可以写在util包。 如： MD5加密。 登录图片验证。 Constant.class（常量类） 通用非空判断… … 例如：三、配置文件的命名规范 StrutsSpring都是通过模块名称来命名的，每个模块对应的一个Struts配置文件和一个Spring配置文件。Struts和Hibernate都是通过Spring（IOC）来注入对象的。 ???3.1、web.xml配置文件 开发人员不允许私自动web.xmlservlet，过滤器等，需要在web.xml配置时，需要向项目组长说明，方可添加。 ???3.2、Struts配置文件 Struts所有的配置文件放在WEB-INF/struts-config目录下。开发人员不要新建Struts配置文件，所有配置Struts配置文件都是由项目组长来添加。Struts的配置文件是根据模块来划分的，每个人都会对自己所开发的模块来维护一个Struts的配置文件。Struts配置文件根据模块名称来命名。 例如：???3.3、Spring配置文件 spring所有的配置文件放在WEB-INF/spring-config目录下。开发人员也不要新建Spring配置文件，所有Spring配置文件都是由项目组长来添加。Spring的配置文件是根据模块来划分的，每个人都会对自己所开发的模块来维护一个Spring的配置文件。Spring配置文件根据模块名称来命名。 例如：spring_test.xml ???3.4Spring和Struts配置文件命名规范 1、Strutspath的命名规范 Struts配置文件path的命名规范是由下划线“_”右面的部分加上本类所对应功能来命名。例如struts_test.xml,所有的配置文件应该由test和类得功能来命名。并且每个action都要写清楚注释。 例如： !—?-- action? name=”register” class=”userAction” method=”register” result name=”success” type=”redirect”index.jsp/result /action ???? 2、spring配置文件id的命名规范 注意一提的是springid的命名规范，在spring_dao.xml中daoid的命名规范是此dao类得全称，并且第一个字母小写。例如UserDao在spring_dao.xml中的iduserDao。Service层中在spring中配置文件第一个字母小写，例如UserService应该是userService。 并且在spring_dao.xml中谁加的一定要