hibernate命名规范.docx
《hibernate命名规范.docx》由会员分享，可在线阅读，更多相关《hibernate命名规范.docx（11页珍藏版）》请在冰豆网上搜索。
hibernate命名规范
竭诚为您提供优质文档/双击可除
hibernate,命名规范
篇一：
java代码命名规范
代码命名规范
1工程总述
本项目的整体命名规范，在java语言的命名规范的基础上，做出更符合这次项目开发的规定，下面的表格是java命名规范的一些规定，之后的分述中，我们还有更详尽的约束。
java程序组成包名类名接口
命名规范
英文单词全部小写
每一个单词的第一个字母都大写每一个单词的第一个字母都大写
第一个英文单词的第一个字母小写其他单词
属性
的第一个字母大写
第一个英文单词的第一个字母小写其他单词
方法
的第一个字母大写
英文单词全部大写，并且每个单词之间用下划
常量
线隔开
工程全部存放在wap文件夹下。
wap文件夹下结构如下文件夹srcwap
资源命名规则资源业务分类cp单位信息cp管理员信息上传图片信息信息机型消费过滤字普通用户
作用
存放java源文件存放jsp页面及资源文件
命名cpbusinesscpcategorycpinfocpmanagerinfodownpicgroupinfomanagemobileuapaymentmanageruncommonwordusermanager
备注
2命名空间（namespace）
项目文件的命名空间采用com.xdtech.wap+包名的命
名方式
例如，用户
com.xdtech.wap.po.user
3src源文件
所有的源文件都在src文件夹下，所属com.xdtech.wap包。
该包下的文件和文件夹命名我们按照本系统的功能来描述。
文件夹名（包名）作用dao
项目dao层代码
文件命名见规则3.1
表名.java例如，
po
项目po层代码
user.java
hibernate的映射、配置文表名.hbm.xml例如，
modelservicewebutil
件
项目service层代码项目web层代码项目的通用类
单元测试代码，是对
test
service层的测试
见规则3.5user.hbm.xml见规则3.2见规则3.3见规则3.4
3.1dao
3.1.1
文件夹命名
在dao中只有1个文件夹——hibernate，里面存放的是dao文件，所有的dao类都继承自basedao.java并实现generatebasedao接口。
dao文件的命名规则：
资源名+dao.java
3.1.2
文件命名
文件
作用
继承自hibernatedaosupport，是所有dao
basedao.javainterfacedao.java
类的父类
项目中dao接口的父接口（标识接口）继承自interfacedao，所有dao类都要实
generatebasedao.java现它
3.1.3
方法的命名
命名
方法
增加记录删除记录修改记录
savedatabean（）
removedata+byid（参数为id时）updatedatabean（）
loaddatabean（）查询单条记录
Finddatalist（）查询记录查询多条记录
querycount（）查询记录条数
3.2service
3.2.1
文件夹
文件夹命名（包名）作用
后台系统管理员的
admin
service层代码
资源名+serviceimpl文件命名
后台cp管理员的所有的service类都继承自
manageservice层代码
baseservice类，
前台普通用户的并实现generateservice接口
face
service层代码
篇二：
项目命名规范
包命名规范：
servlet类所在包命名规范：
开发组名称.项目名称.web.servlet
例如：
sc.gpm.web.servlet
自定义标签类所在包命名规范：
开发组名称.项目名称.web.tags
例如：
sc.gpm.web.tags
过滤器类所在包命名规范：
开发组名称.项目名称.web.filter
例如：
sc.gpm.web.filter
action类所在包命名规范：
开发组名称.项目名称.web.struts.action
例如：
sc.gpm.web.struts.action
actionForm类所在包命名规范：
开发组名称.项目名称.web.struts.form
例如：
sc.gpm.web.struts.form
javabean所在包命名规范：
开发组名称.项目名称.web.struts.service.impl
例如：
sc.gpm.web.service.impl
javabean实现接口命名规范：
开发组名称.项目名称.web.service
例如：
sc.gpm.web.service
dao类所在包命名规范：
开发组名称.项目名称.dao.impl
例如：
sc.gpm.dao.impl
dao类所实现的接口在包中命名规范：
开发组名称.项目名称.dao
例如：
sc.gpm.dao
pojo类与hbm文件所在包命名规范：
开发组名称.项目名称.dao.hbm
例如：
sc.gpm.dao.hbm
全局公共类、接口类所在包命名规范：
开发组名称.项目名称.global
例如：
sc.gpm.global
全局工具类所在包命名规范：
开发组名称.项目名称.util
例如：
sc.gpm.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中的类：
与数据库中的表名一致，一一对应，如：
information.java；
3、Form中的类：
[model]+Form，与model一一对应，如：
informationForm.java；
4、bean中的类：
[model]+bean，与model一一对应，如：
informationbean.java；
5、action中的类：
[model]+[操作或目标对象]+action，如：
informationdeleteaction.java、informationdetailaction.java；
6、页面中的链接：
[model]+[操作或目标对象]，与action一一对应，如：
informationdelete.do、informationdetail.do；
7、action中的定向名称：
to+[model]+[操作（需要显示结果集的）或操作+结果（需要显示成功或失败的）或目标对象]，如：
toinformationedit、toinformationdeletesuccess、toinformationdetail；
8、action中的结果集名称：
show+[model]+[操作（需要显示结果集的）或目标对象]，如：
showinformationedit、showinformationdetail；
9、页面：
[model]+[操作（需要显示结果集的）或操作+结果（需要显示成功或失败的）或目标对象]+.html或.jsp等，与action中的定向名称基本一一对应，如：
informationedit.jsp、informationdeletesuccess.html、informationdetail.jsp。
jsp页面命名：
名称要体现出该页面的意义，实体名_功能类型后缀。
其中实体名采用：
业务对应术语,每个业务术语可由1个或多个单词构成。
实体名过长时，可以考虑缩写，但缩写必须规范化，统一化，保证一致。
如：
部门管理,
全称为：
departmentmanagement
规范缩写应该如下：
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方法。
例如：
privateintstudentage;
publicintgetstudentage（）{
returnstudentage;
}
publicvoidsetstudentage（intstudentage）{
this.studentage=studentage;
}
常量命名：
命名规范：
所有字母大写，如果有多个单词组成，单词与单词之间以”_“隔开。
而且该变量必须是公共、静态、final类型
例如：
publicstaticfinalstringuseR_name=”username“;
方法命名
命名规范：
首字母必须小写，如果该变量名有多个单词组成，后面的单词首字母大写，单词与单词之间不要使用"_"做连接。
单词不要使用名词。
例如：
publicintchecklogin（stringname,stringpwd）{}
注释规范：
类的注释：
作用：
注释整个类，简单概述该类作用。
书写规范：
类的注释必须写在该类的声明语法之前。
在注释中要描述该类的基本作用，作者，日期，版本，公司名称。
格式：
/**
*类功能描述：
（大致描述类的功能）
*@author：
编写者名称
*
*@version：
类文件的版本号从1.0开始（自己确定版本号的增改
*情况），修改情况（修改时间、作者、改动情况）
*
*@see包名.参考类名（列出父类，引入类，每个类占一行），如果有
*可省略
*相关数据如：
（便于理解本类的一些常量数据及某些数据的格式
*或认为比较重要的数据，如果没有可省略）
*/
类的声明语法
例如：
/**
* title:
管理员模块数据处理类
* description:
两个数相加
* copyright:
copyright（c）20xx
* company:
华腾软件公司
*
*@author童金虎
*
*@version$Revision:
1.7$$date:
20xx/07/08$
*/
publicclassadmindao
变量、常量注释：
作用：
简单描述该变量的意义。
书写规范：
变量注释必须写在变量定义之前，简单描述其代表的意义。
格式：
/**
*变量功能描述：
（大致描述变量的功能）
*/
篇三：
java代码命名规范
代码命名规范
1工程总述
本项目的整体命名规范，在java语言的命名规范的基础上，做出更符合这次项目开发的规定，下面的表格是java命名规范的一些规定，之后的分述中，我们还有更详尽的约束。
java程序组成包名类名接口属性方法常量
工程全部存放在wap文件夹下。
wap文件夹下结构如下文件夹src
wap
资源命名规则资源业务分类cp单位信息cp管理员信息上传图片信息信息机型消费过滤字普通用户
命名规范英文单词全部小写
每一个单词的第一个字母都大写每一个单词的第一个字母都大写
第一个英文单词的第一个字母小写其他单词的第一个字母大写第一个英文单词的第一个字母小写其他单词的第一个字母大写英文单词全部大写，并且每个单词之间用下划线隔开
作用
存放java源文件存放jsp页面及资源文件
命名cpbusinesscpcategorycpinfocpmanagerinfodownpicgroupinfomanagemobileuapaymentmanageruncommonwordusermanager
备注
2命名空间（namespace）
项目文件的命名空间采用com.xdtech.wap+包名的命名方式例如，用户
com.xdtech.wap.po.user
3src源文件
所有的源文件都在src文件夹下，所属com.xdtech.wap包。
该包下的文件和文件夹命名我们按照本系统的功能来描述。
文件夹名（包名）作用daopomodelservicewebutiltest
项目dao层代码项目po层代码
hibernate的映射、配置文件项目service层代码项目web层代码项目的通用类
文件命名见规则3.1
表名.java例如，user.java表名.hbm.xml例如，user.hbm.xml见规则3.2见规则3.3见规则3.4
单元测试代码，是对service层的测试见规则3.5
3.1dao
3.1.1文件夹命名
在dao中只有1个文件夹——hibernate，里面存放的是dao文件，所有的dao类都继承自basedao.java并实现generatebasedao接口。
dao文件的命名规则：
资源名+dao.java
3.1.2文件命名
文件basedao.javainterfacedao.javageneratebasedao.java
作用
继承自hibernatedaosupport，是所有dao类的父类项目中dao接口的父接口（标识接口）继承自interfacedao，所有dao类都要实现它
3.1.3方法的命名方法增加记录删除记录修改记录
查询单条记录
查询记录
3.2
查询多条记录查询记录条数
命名
savedatabean（）
removedata+byid（参数为id时）updatedatabean（）loaddatabe
an（）Finddatalist（）querycount（）
service
3.2.1文件夹
文件夹命名（包名）作用adminmanageface
文件命名
后台系统管理员的service层代资源名+serviceimpl码所有的service类都继承自baseservice后台cp管理员的service层代码类，
前台普通用户的service层代码并实现generateservice接口
3.2.2文件
baseservice.java是所有service类的父类。
所有的service类都要实现generateservice接口。
3.2.3方法的命名
方法增加记录删除记录修改记录
命名savepobject（）
removepobject+by+操作对象，例如，按条件删除removepobjectbyFilter（）updatepobject+[by+Filter]（当操作对象为hqlFilter类型时）
updatepobject+[by+list]（批量修改一组对象,对象为list类型）
查询单条记录loadpobject+by+操作对象，例如，按id查询loadpobjectbyid（）查询多条记录findpobject+by+操作对象，例如，按条件查询loadpobjectbyFilter（）
升级会员 