命名规范
本规范主要针对java开发制定的规范
项目命名
项目创建,名称所有字母均小写,组合方式为:com.leadal.$projectName.$component.$hiberarchy。
$projectName:项目名称
$component:模块名称
$hiberarchy:开发层次名称
例如:
com.leadal.tims.exchange.dao
类文件夹命名¶
source代码模块
config配置文件模块
test 测试模块
包命名¶
规则
全部小写。
标识符用点号分隔开来。为了使包的名字更易读。如com.leadal.shanty
常用几个包名
dao:数据层
service:逻辑层
model:持久类定义包
实现Serializable接口,创建serialVersionUID
主键统一用id标识,Long类型
web:表示层及控制层
enums:枚举类型
config:配置文件类包
resource:资源文件包
类文件命名¶
尽量以英文进行类定义
所有类都以大写字母开头
组合词每个词以大写字母开头,不用下划线或其他符号
避免使用单词的缩写,除非它的缩写已经广为人知,如HTTP
变量命名¶
第一个字母小写,中间单词的第一个字母大写
不用_或&作为第一个字母。
尽量使用短而且具有意义的单词
单字符的变量名一般只用于生命期非常短暂的变量。i,j,k,m,n一般用于integers;c,d,e一般用于characters
如果变量是集合,则变量名应用复数。
String myName;
int[] students;
int i;
int n;
char c;
btNew;
(bt是Button的缩写)
常量命名¶
所有常量名均全部大写,单词间以‘_’隔开
int MAX_NUM;
方法命名规则¶
规则
第一个单词一般是动词。
第一个字母是小些,但是中间单词的第一个字母是大写。
如果方法返回一个成员变量的值,方法名一般为get+成员变量名,如若返回的值是bool变量,一般以is作为前缀。
如果方法修改一个成员变量的值,方法名一般为:set + 成员变量名。
常用动词
获取单个对象
load
获取列表
find
list
获取分页
page
搜索
search
保存
save
添加
add
insert
删除
delete
remove
修改
update
DAO命名规则¶
接口类命名以DAO结尾
实现类类命名以DAOImpl结尾
结构参考如下:
· dao
· ├─dom4j
· │ └─UserDAOImpl
· ├─hibernate
· │ └─UserDAOImpl
· └UserDAO
Service命名规范¶
接口类命名以Service结尾
实现类类命名以ServiceImpl结尾
结构参考如下:
· service
· ├─impl
· │ └─UserServiceImpl
· │
· └UserService
Struts Action 命名规范¶
类命名与Action结尾
结构参考如下:
· web
· └struts
· ├─UserAction
· └─GroupAction
·