JavaWeb_JavaEE_命名规则.doc

代码编写规范目的：能够在编码过程中实现规范化，为以后的程序开发中养成良好的行为习惯。 代码编写规范使用范围：J2EE项目开发。 包命名规范： 目的：包的命名规范应当体现出项目资源良好的划分 servlet类所在包命名规范：公司名称.开发组名称.项目名称.web.servlet 例如：net.linkcn.web.servlet 自定义标签类所在包命名规范：公司名称.开发组名称.项目名称.web.tags 例如：net.linkcn.web.tags 过滤器类所在包命名规范：公司名称.开发组名称.项目名称.web.filter 例如：net.linkcn.web.filter Action类所在包命名规范：公司名称.开发组名称.项目名称.web.struts.action 例如：net.linkcn.web.struts.action ActionForm类所在包命名规范：公司名称.开发组名称.项目名称.web.struts.form 例如：net.linkcn.web.struts.form Javabean所在包命名规范：公司名称.开发组名称.项目名称.web.struts.service.impl 例如：net.linkcn.web.service.impl Javabean实现接口命名规范：公司名称.开发组名称.项目名称.web.service 例如：net.linkcn.web.service DAO类所在包命名规范：公司名称.开发组名称.项目名称.dao.impl 例如：net.linkcn.dao.impl DAO类所实现的接口在包中命名规范：公司名称.开发组名称.项目名称.dao 例如：net.linkcn.dao POJO类与hbm文件所在包命名规范：公司名称.开发组名称.项目名称.dao.hbm 例如：net.linkcn.dao.hbm 全局公共类、接口类所在包命名规范：公司名称.开发组名称.项目名称.global 例如：net.linkcn.global 全局工具类所在包命名规范：公司名称.开发组名称.项目名称.util 例如：net.linkcn.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 类变量命名： 命名规范：变量名首字母必须小写，如果该变量名有多个单词组成，后面的单 词首字母大写，单词与单词之间不要使用_做连接，变量名访问控制必须为私有， 可以对其增加setter与getter方法。 例如： private int studentAge; public int getStudentAge(){ return studentAge; } public void setStudentAge(int studentAge) { this.studentAge=studentAge; } 常量命名： 命名规范：所有字母大写，如果有多个单词组成，单词与单词之间以” _“隔开。而 且该变量必须是公共、静态、final类型 例如：public static final String US