ssh包命名规范

ssh包命名规范篇一：SSH 编码规范SSH 编码规范 分类： java web 开发 XX-08-16 15:57 72人阅读 评论(0) 收藏 举报 最近定了下项目的开发规范，贴出来 一、项目设计 本项目分为 3层，表现层（） 、业务层（） 、持久层（） 。由 Struts来管理视图层并对异常进行捕获，由Spring来管理业务逻辑及事务的管理，Hibernate 封装了所有数据以及数据库的操作与分页等。 如图： 二、包的命名规范 包的命名规范总体来说主要是按照模块的名称来命名。并且每个包的名称都必须是小写的字母。一个系统中有用户模块、日志模块等，每个模块都是一个包，然后在包的下面包含此模块下所有的类。 譬如应用中有一个 test模块，则在公共包下建立一个 test包 例如： 在 test包下包括如下子包 、action 包 该包放置各种 struts的 action，此包的命名规范是必须以 Action结尾，例如我们要写个登陆的 Action那么这个类得名称是 LoginAction。 例如： 、service 包 该包放置业务操作类，譬如用户管理类，一般情况将该用户操作类提取一个接口，此接口以 Service来结尾，并放入到 service包下面，然后在 service包下新建一个impl包，在 impl包 中才放置用户操作接口的实现类，实现类以ServiceImpl来结尾。该接口实现类中调用 DAO接口对数据库进行操作，而调用该实现类的方法在 struts的 action中通过此类的父接口调用。 下面以 test下面所有与用户相关的操作来定义一个业务类。接口：IUserService；实现类：UserServiceImpl。并且接口全部以大写字母“I”开头例如： 、vo 包（value object） vo 包个人理解是在 struts中使用的非 POJO对象，而这些对象往往要通过一些复杂的查询操作才能查询出来，如 HQL的多表级联查询，或者在 Hibernate中调用 JDBC查询出来的一些数据，都可以封装到 vo对象里面。在 jsp页面中展现。vo 对象主要应用与表现层，主要含有Setter，Getter 属性和其他辅助方法，例如 hashCode和equals等方法。 例如： 、dao 包 Dao 层有 1个父类是 AbstractBaseDao，一个接口是IBaseDao，这两个类之间的方法是一一对应的。在 dao包下面所有的接口都要继承 IBaseDao，在包下所有的类都要实现对应的 dao包下面的接口，继承 AbstractBaseDao类，具体见示例。 所有多表之间的级联查询都要放到此包下面。如果只需要对其中的一张表进行操作，请具体查看内容。具体的命名可以根据自己的业务逻辑来定。 例如： 以上 4点都必须在 test包下面，test 包下应该具备这最基本的 4个包，一般情况不需要重新添加新的包。特殊情况除外。以下所提到的包都不在 test包的下面。而在主项目下面的包。 、dao（data access object）包 该包放置各类 dao（data access object） ，也就是放置对数据库访问的实现类，原则上是每个表对应一个 dao的处理类，每个处理类对应一个类和一个接口，例如 user表对应的接口是 IUserDao，对应的类是 UserDaoImpl，并且通过Spring的 IOC的方式把此对象注入到业务层中。业务层中用接口来调用。与的区别是此包下面所有的查询操作都是针对一张表进行的，而是针对多表之间的级联查询的。此包下面所有的 dao都是公用的，而只是针对个人的模块来使用的。例如： 、pojo 包 该包中放置 hibernate反向工程生成的 bean和该bean对应的.文件。 例如： 三、配置文件的命名规范 Struts 和 Spring都是通过模块名称来命名的，每个模块对应的一个 Struts配置文件和一个 Spring配置文件。Struts和 Hibernate都是通过 Spring（IOC）来注入对象的。 、配置文件 开发人员不允许自私动，如果需要写 servlet，过滤器等，需要在配置时，需要向项目组长说明，方可添加。 、Struts 配置文件 Struts 所有的配置文件放在 WEB-INF/struts-config目录下。开发人员不要新建 Struts配置文件，所有配置Struts配置文件都是由项目组长来添加。Struts 的配置文件是根据模块来划分的，每个人都会对自己所开发的模块来维护一个 Struts的配置文件。Struts 配置文件根据模块名称来命名。 例如：struts_ 、Spring 配置文件 Struts 所有的配置文件放在 WEB-INF/spring-config目录下。开发人员也不要新建 Spring配置文件，所有Spring配置文件都是由项目组长来添加。Spring 的配置文件是根据模块来划 分的，每个人都会对自己所开发的模块来维护一个Spring的配置文件。Spring 配置文件根据模块名称来命名。例如：spring_ 需要说明的是要把所有写到中的 Dao放入到 spring_配置文件中。也就是在 spring_dao中只是存放只针对一个表所生成的 Dao类，而中的 Dao存放到对应的 spring模块的配置文件中。 、Spring 和 Struts配置文件命名规范 1、Struts 配置文件 path的命名规范 Struts 配置文件 path的命名规范是由下划线“_”右面的部分加上本类所对应功能来命名。例如 struts_,所以的配置文件应该由 test和类得功能来命名。并且每个action都要写清楚注释。 例如： type=“ validate=“false“ 2、spring 配置文件 id的命名规范 注意一提的是 spring中 id的命名规范，在 spring_中 dao对应的 id的命名规范是此 dao类得全称，并且第一个字母小写。例如 UserDao在 spring_中的 id应该是userDao。Service 层中在 spring中配置文件的编写是接口去掉第一个字母“I” ，并且第一个字母小写，例如IUserService应该是 userService。 并且在 spring_中谁加的一定要写清楚注释。例如：spring_中 spring_中 篇二：SSH 编码规范SSH 编码规范 一、项目设计 本项目分为 3层，表现层（Struts2） 、业务层（） 、持久层（） 。由 Struts来管理视图层并对异常进行捕获，由 Spring来管理业务逻辑及事务的管理，Hibernate 封装了所有数据以及数据库的操作与分页等。 如图： 二、包的命名规范 包的命名规范总体来说主要是按照模块的名称来命名。并且每个包的名称都必须是小写的字母。一个系统中有用户模块、日志模块等，每个模块都是一个包，然后在包的下面包含此模块下所有的类。 譬如应用中有一个 test模块，则在公共包下建立一个 test包 例如： 在 test包下包括如下子包 、action 包 该包放置各种 struts的 action，此包的命名规范是必须以 Action结尾，例如我们要写个登陆的 Action那么这个类得名称是 LoginAction。 例如： 、service 包 该包放置业务操作类，譬如用户管理类，一般情况将该用户操作类提取一个接口，此接口以 Service来结尾，并放入到 service包下面，然后在 service包下新建一个imp包，在 imp包中才放置用户操作接口的实现类，实现类以 ServiceImpl来结尾。该接口实现类中调用 DAO接口对数据库进行操作，而调用该实现类的方法在 struts的action中通过此类的父接口调用。 下面以 test下面所有与用户相关的操作来定义一个业务类。接口：UserService；实现类：UserServiceImpl。 例如： 、dao 包 dao 层有一个接口是 BaseDao，里面有个BaseDaoImpl。这两个类之间的方法是一一对应的。在 dao包下面所有的接口都要继承 BaseDao，在包下所有的类都要实现对应的 dao包下面的接口，继承 BaseDaoImpl类，具体见示例。 例如： 以下是 包下的目录 以上是一个模块的规范 、entity 包 该包中放置 hibernate反向工程生成的 bean和该bean对应的.文件。 例如： 、util 包（工具包） util 包个人理解是:在我们需要添加的功能不在以上所有包中，那么就可以写在 util包。 如： MD5 加密。 登录图片验证。 （常量类） 通用非空判断? ? 例如： 三、配置文件的命名规范 Struts 和 Spring都是通过模块名称来命名的，每个模块对应的一个 Struts配置文件和一个 Spring配置文件。Struts和 Hibernate都是通过 Spring（IOC）来注入对象的。 、配置文件 开发人员不允许私自动，如果需要写 servlet，过滤器等，需要在配置时，需要向项目组长说明，方可添加。 、Struts 配置文件 Struts 所有的配置文件放在 WEB-INF/struts-config目录下。开发人员不要新建 Struts配置文件，所有配置Struts配置文件都是由项目组长来添加。Struts 的配置文件是根据模块来划分的，每个人都会对自己所开发的模块来维护一个 Struts的配置文件。Struts 配置文件根据模块名称来命名。 例如：、Spring 配置文件 spring 所有的配置文件放在 WEB-INF/spring-config目录下。开发人员也不要新建 Spring配置文件，所有Spring配置文件都是由项目组长来添加。Spring 的配置文件是根据模块来划分的，每个人都会对自己所开发的模块来维护一个 Spring的配置文件。Spring 配置文件根据模块名称来命名。 例如：spring_ 、Spring 和 Struts配置文件命名规范 1、Struts 配置文件 path的命名规范 Struts 配置文件 path的命名规范是由下划线“_”右面的部分加上本类所对应功能来命名。例如 struts_,所有的配置文件应该由 test和类得功能来命名。并且每个action都要写清楚注释。 例如： 2、spring 配置文件 id的命名规范 注意一提的是 spring中 id的命名规范，在 spring_中 dao对应的 id的命名规范是此 dao类得全称，并且第一个字母小写。例如 UserDao在 spring_中的 id应该是userDao。Service 层中在 spring中配置文件第一个字母小写，例如 UserService应该是 userService。 并且在 spring_中谁加的一定要写清楚注释。例如：spring_中 class=“ userService .UserServiceImpl“ spring_中 篇三：项目命名规范包命名规范： servlet 类所在包命名规范：开发组名称.项目名称. 例如： 自定义标签类所在包命名规范：开发组名称.项目名称. 例如： 过滤器类所在包命名规范：开发组名称.项目名称. 例如： Action 类所在包命名规范：开发组名称.项目名称. 例如： ActionForm 类所在包命名规范：开发组名称.项目名称. 例如： Javabean 所在包命名规范：开发组名称.项目名称. 例如： Javabean 实现接口命名规范：开发组名称.项目名称. 例如： DAO 类所在包命名规范：开发组名称.项目名称. 例如： DAO 类所实现的接口在包中命名规范：开发组名称.项目名称.dao 例如： POJO 类与 hbm文件所在包命名规范：开发组名称.项目名称. 例如： 全局公共类、接口类所在包命名规范：开发组名称.项目名称.global 例如： 全局工具类所在包命名规范：开发组名称.项目名称.util 例如： 类命名规范 基本命名规范： 类、接口命名 命名规范：以大写字母开头，如果有多个单词，每个单词头字母大写 例如：StudentInfo 接口命名 命名规范：以大写字母“I“开头，如果有多个单词，每个单词头字母大写 例如：IStudentInfo 接口实现类命名： 命名规范：将实现的接口名称的首字母“I“去掉，以“Impl作为结尾“，如果有多个单词，每个单词头字母大写。例如：StudentInfoImpl J2EE+SSH 框架命名规范 servlet 类命名： 命名规范：以 Servlet单词结尾 例如：LoginServlet POJO 命名： 使用 hibernate自动生成的类即可 DAO 类命名： 使用 hibernate自动生成的类即可 Action 类命名： 命名规范：Action 的命名以 POJO名称来制定，POJO名称 Action 例如： 一个 POJO名称为 Diary，其对应的 action为DiaryAction ActionForm 类命名： 命名规范：ActionForm 的命名以 POJO名称来制定，POJO名称 Form 例如： 一个 POJO名称为 Diary，其对应的 actioForm为DiaryForm 业务逻辑接口命名: 命名规范：业务逻辑接口的命名以 POJO名称来制定，IPOJO名称 Service 例如： 一个 POJO名称为 Diary，其对应的业务逻辑接口为IDiaryService 业务逻辑实现类命名: 命名规范：业务逻辑接口实现类的命名以 POJO名称来制定 例如： 一个 POJO名称为 Diary，对应的业务逻辑接口实现类名为 DiaryServiceImpl Struts 基本命名规范 1、 数据库中的表：首字母大写，如：Information； 2、 Model中的类：与数据库中的表名一致，一一对应，如：； 3、 Form中的类：Model + Form，与 Model一一对应，如：； 4、 Bean中的类：Model + Bean，与 Model一一对应，如：； 5、 Action中的类：Model + 操作或目标对象 + Action，如：、 ； 6、 页面中的链接：Model + 操作或目标对象，与 Action一一对应，如：、 ； 7、 Action 中的定向名称：To + Model + 操作（需要显示结果集的）或操作+结果（需要显示成功或失败的）或目标对象，如：ToInformationEdit、ToInformationDeleteSuccess、ToInformationDetail； 8、 Action中的结果集名称： Show + Model + 操作（需要显示结果集的）或目标对象，如：ShowInformationEdit、ShowInformationDetail； 9、 页面：Model + 操作（需要显示结果集的）或操作+结果（需要显示成功或失败的）或目标对象 + .html或.jsp 等，与 Action中的定向名称基本一一对应，如：、 、 。 Jsp 页面命名：名称要体现出该页面的意义，实体名_功能类型后缀。其中实体名采用：业务对应术语,每个业务术语可由 1个或多个单词构成。实体名过长时，可以考虑缩写，但缩写必须规范化，统一化，保证一致。 如 ：部门管理 , 全称为：Department Management 规范缩写应该如下： DeptMgmt 对于实体名称的后缀请参考如下： 1. Entity 列表 ： Entity_List 2. Entity 详细信息： Entity_View 3. Entity 新增： Entity_New 4. Entity 修改： Entity_Edit 5. Entity 查找： Entity_Find J2EE 项目工程文件夹组织规范： 文件的组织形式应当体现模块的划分。 根据 eclipse工具的特征，项目的目录结构为： src -存放 java文件 WebRoot |-images -存放 web程序所需的公共图片 |-css -存放 web程序所需的公共样式表 |-js -存放 web程序所需的公共 js文件 |-commons -存放 web程序所需的公共文件 |-功能模块文件夹(存放与某个功能模块相关的资源) |-images -存放与该功能模块相关的图片 |-css -存放与该模块相关的样式表文件 |-js -存放与该模块相关的 js文件 |-jsp、html 页面 |-WEB-INF |-classes |-lib |-tld 文件 类变量命名： 命名规范：变量名首字母必须小写，如果该变量名有多个单词组成，后面的单 词首字母大写，单词与单词之间不要使用“_“做连接，变量名访问控制必须为私有， 可以对其增加 setter与 getter方法。 例如： private int studentAge; public int getStudentAge() return studentAge; public void setStudentAge(int studentAge) =studentAge; 常量