java代码命名规范

代码命名规范

1 工程总述

本项目的整体命名规范，在Java语言的命名规范的基础上，做出更符合这次项目开发的规定，下面的表格是Java命名规范的一些规定，之后的分述中，我们还有更详尽的约束。

Java程序组成 包名 类名 接口 属性 方法 常量

工程全部存放在Wap文件夹下。Wap文件夹下结构如下 文件夹 src

Wap

资源命名规则 资源 业务 分类 CP单位信息 CP管理员信息 上传图片信息 信息 机型 消费 过滤字 普通用户

命名规范 英文单词全部小写

每一个单词的第一个字母都大写 每一个单词的第一个字母都大写

第一个英文单词的第一个字母小写 其他单词的第一个字母大写 第一个英文单词的第一个字母小写 其他单词的第一个字母大写 英文单词全部大写，并且每个单词之间用下划线隔开

作用

存放Java源文件 存放JSP页面及资源文件

命名 CPBusiness CPCategory CPInfo CPManagerInfo DownPicGroup Infomanage MobileUA PaymentManager Uncommonword UserManager

备注

2 命名空间(namespace)

项目文件的命名空间采用 com.xdtech.wap + 包名的命名方式 例如，用户

com.xdtech.wap.po.User

3 src 源文件

所有的源文件都在src文件夹下，所属com. xdtech.wap包。该包下的文件和文件夹命名我们按照本系统的功能来描述。

文件夹名（包名） 作用 dao po model service web util test

项目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.1 dao

3.1.1 文件夹命名

在dao中只有1个文件夹——hibernate，里面存放的是Dao文件，所有的Dao类都继承自BaseDAO.java并实现GenerateBaseDAO接口。

Dao文件的命名规则：资源名 + Dao.java

3.1.2 文件命名

文件 BaseDAO.java InterfaceDAO.java GenerateBaseDAO.java

作用

继承自HibernateDaoSupport，是所有DAO类的父类 项目中DAO接口的父接口（标识接口） 继承自InterfaceDAO，所有DAO类都要实现它

3.1.3 方法的命名 方法 增加记录 删除记录 修改记录

查询单条记录

查询记录

3.2

查询多条记录 查询记录条数

命名

saveDataBean( )

removeData + ById（参数为id时） updateDataBean( ) loadDataBean( ) FindDataList( ) queryCount( )

service

3.2.1 文件夹

文件夹命名（包名） 作用 admin manage face

文件命名

后台系统管理员的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( )

本文来源：https://www.bwwdw.com/article/xorf.html