java编程规约

Posted 2020-10-01 hy7873

一、命名风格

1、代码中的命名不能以下划线和美元符号开始和结束。

2、代码中严禁使用拼音和英文混合的方式，更加不能使用中文。

3、类名必须使用驼峰形式（UpperCamelCase），一下例外：BO、DO、DTO。

4、方法名、参数名、成员变量名、局部变量名都统一使用lowerCamelCase。

5、常量名全部大写，各个单词之间用 _ 分开，比如：MAX_STOCK_COUNT。

6、抽象类命名必须以Abstract或者Base开头，异常类命名以Exception结尾，测试类以Test结尾。

7、中括号是数组类型的一部分，String[] args。

8、POJO中布尔类型的变量都不要加is，否则会引起序列化错误。

9、包名一律使用小写，点分符之间使用有自然语义的单词，不允许使用复数形式，类名可以使用复数形式。

10、杜绝完全不规范的简写，避免望文不知义。

11、如果使用了设计模式，要在类名中体现具体的设计模式，比如：OrderFactory/LoginProxy

12、枚举类名要以Enum结尾，枚举统一使用大写各个单词以下划线分开。

13、各层的命名规约：

A）Service、DAO层方法命名：

1）获取单个对象以get作为前缀；

2）获取多个对象以list作为前缀；

3）删除用remove所为前缀；

4）保存用save作为前缀；

5）更新用update作为前缀；

B）领域模型命名：

1）数据对象：xxxDO，xxx即为数据表名；

2）数据传输对象：xxxDTO，xxx为业务领域相关名称；

3）展示对象;xxxVO，xxx为网页的名称；

 

二、常量定义

1、不允许任何魔法值，直接出现在代码中，比如：“JRXJ”+xxx。

2、long赋初始值时必须用L结尾。

3、不要使用一个常量类维护所有常量，根据功能进行区分，比如缓存相关的用CacheConstant，系统相关的用ConfigConstant。

4、常量的复用层次：跨应用常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量，

跨应用共享常量：保存在二方库中，通常是client jar；

应用内共享常量：保存在一方库中，通常在modules的constant目录下面；

子工程内共享常量：在子工程的constant目录下面；

包内共享常量：当前包单独的constant目录下面；

类内共享常量：直接在类内部 private static final ...

5、如果一个变量在一定的范围内变化，而且带有一定的延生属性，那么使用枚举。