内容发布更新时间 : 2024/12/27 2:39:21星期一 下面是文章的全部内容请认真阅读。
Java Web 开发编程规范V1.0
----- By Away @2013.11.13
代码编写规范目的:能够在编码过程中实现规范化,为以后的程序开发中养成良好的行为习惯。
代码编写规范使用范围:J2EE项目开发。
1 包命名规范:
目的:包的命名规范应当体现出项目资源良好的划分
1. servlet类所在包命名规范:公司名称.开发组名称.项目名称.web.servlet 例如:com.whut.web.servlet
2. 自定义标签类所在包命名规范:公司名称.开发组名称.项目名称.web.tags 例如:com.whut.web.tags
3. 过滤器类所在包命名规范:公司名称.开发组名称.项目名称.web.filter 例如:com.whut.web.filter
4. Action类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.action 例如:com.whut.web.struts.action
5. ActionForm类所在包命名规范:公司名称.开发组名称.项目名称.web.struts.form 例如:com.whut.web.struts.form
6. Javabean所在包命名规范:公司名称.开发组名称.项目名称.web.struts.service.impl 例如:com.whut.web.service.impl
7. Javabean实现接口命名规范:公司名称.开发组名称.项目名称.web.service 例如:com.whut.web.service
8. DAO类所在包命名规范:公司名称.开发组名称.项目名称.dao.impl 例如:com.whut.web.dao.impl
9. DAO类所实现的接口在包中命名规范:公司名称.开发组名称.项目名称.dao 例如:com.whut.web.dao
10. POJO类与hbm文件所在包命名规范:公司名称.开发组名称.项目名称.dao.hbm 例如:com.whut.web.dao.hbm
11. 全局公共类、接口类所在包命名规范:公司名称.开发组名称.项目名称.global 例如:com.whut.web.global
12. 全局工具类所在包命名规范:公司名称.开发组名称.项目名称.util 例如:com.whut.web..util
2 类命名规范
基本命名规范:
1. 类、接口命名
命名规范:以大写字母开头,如果有多个单词,每个单词头字母大写 例如:StudentInfo
2. 接口命名
命名规范:以大写字母\开头,如果有多个单词,每个单词头字母大写 例如:IStudentInfo
3. 接口实现类命名:
命名规范:将实现的接口名称的首字母\去掉,以\作为结尾\,如果有多个单词,每个单词头字母大写。 例如:StudentInfoImpl
3 J2EE+SSH框架命名规范
1. servlet类命名:
命名规范:以Servlet单词结尾 例如:LoginServlet
2. POJO命名:
使用hibernate自动生成的类即可
3. DAO类命名:
使用hibernate自动生成的类即可
4. Action类命名:
命名规范:Action的命名以POJO名称来制定,POJO名称Action 例如:
一个POJO名称为Diary,其对应的action为DiaryAction
5. ActionForm类命名:
命名规范:ActionForm的命名以POJO名称来制定,POJO名称Form 例如:
一个POJO名称为Diary,其对应的actioForm为DiaryForm
6. 业务逻辑接口命名:
命名规范:业务逻辑接口的命名以POJO名称来制定,IPOJO名称Service 例如:
一个POJO名称为Diary,其对应的业务逻辑接口为IDiaryService
7. 业务逻辑实现类命名:
命名规范:业务逻辑接口实现类的命名以POJO名称来制定 例如:
一个POJO名称为Diary,对应的业务逻辑接口实现类名为DiaryServiceImpl
4 类变量命名:
命名规范:变量名首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母大写,单词与单词之间不要使用\做连接,变量名访问控制必须为私有, 可以对其增加setter与getter方法。 例如: private int studentAge; public int getStudentAge(){ return studentAge; } public void setStudentAge(int studentAge) { this.studentAge=studentAge; }
5 常量命名:
命名规范:所有字母大写,如果有多个单词组成,单词与单词之间以\隔开。而且该变量必须是公共、静态、final类型
例如:public static final String USER_NAME=\
6方法命名
命名规范:首字母必须小写,如果该变量名有多个单词组成,后面的单词首字母大写,单词与单词之间不要使用\做连接。单词不要使用名词。 例如:public int checkLogin(String name,String pwd){}
7 注释规范
注释规范是整个开发规范中最为重要的组成部分,必须严格执行。
1. 类的注释:
作用:注释整个类,简单概述该类作用。
书写规范:类的注释必须写在该类的声明语法之前。在注释中要描述该类的基 本作用,作者,日期,版本,公司名称,版权声明。