Java 编程规范

1 编程规约

1.1 命名风格

1、【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。反例：_name/_name/$Object/name/name$/Object$

2、【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。
正例：
alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。
反例：
DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

3、【强制】类名使用 UpperCamelCase 风格，必须遵从驼峰形式

4、【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。
正例： localValue / getHttpMessage() / inputUserId

5、【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。
正例：MAX_STOCK_COUNT 反例：MAX_COUNT

6、【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。

7、【强制】中括号是数组类型的一部分，数组定义如下：String[] args; 反例：使用 String args[]的方式来定义。

8、【强制】POJO 类中布尔类型的变量，都不要加 is，否则部分框架解析会引起序列化错误。
反例：定义为基本数据类型 Boolean isDeleted；的属性，它的方法也是 isDeleted()，RPC 框架在反向解析的时候，“以为”对应的属性名称是 deleted，导致属性获取不到，进而抛出异常。

9、【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。正例：应用工具类包名为 com.alibaba.open.util、类名为 MessageUtils（此规则参考 spring 的框架结构）

10、【强制】杜绝完全不规范的缩写，避免望文不知义。反例：AbstractClass“缩写”命名成 AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。

11、【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达其意。正例：从远程仓库拉取代码的类命名为 PullCodeFromRemoteRepository。
反例：变量 int a; 的随意命名

12、【推荐】如果模块、接口、类、方法使用了设计模式，在命名时体现出具体模式。说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计理念。
正例：

public class OrderFactory;
public class LoginProxy;
public class ResourceObserver;

13、【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的 Javadoc 注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。正例：接口方法签名：void f(); 接口基础常量表示：String COMPANY ="alibaba"; 反例：接口方法定义：public abstract void f(); 说明：JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默认实现。

14、接口和实现类的命名有两套规则：

【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服
务一定是接口，内部的实现类用 Impl 的后缀与接口区别。正例：
CacheServiceImpl 实现 CacheService 接口。
【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通
常是–able 的形式）。
正例：AbstractTranslator 实现 Translatable。

15、【参考】枚举类名建议带上 Enum 后缀，枚举成员名称需要全大写，单词间用下划线隔开。
说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。
正例：枚举名字为 ProcessStatusEnum 的成员名称：SUCCESS / UNKOWN_REASON。

16、【参考】各层命名规约：

DAO 层方法命名规约
1. 获取单个对象的方法用 get 做前缀。
2. 获取多个对象的方法用 list 做前缀。
3. 获取统计值的方法用 count 做前缀。
4. 插入的方法用 save/insert 做前缀。
5. 删除的方法用 remove/delete 做前缀。
6. 修改的方法用 update 做前缀。
7. 每个 DAO 文件的命名格式 Dao 做后缀
Service 层命名规约
每个 Service 文件均以 Service 做后缀
Controller 层命名规约
每个 Controller 文件均以 Controller 做后缀
Entity 层命名规约
每个 Entity 文件均以 Entity 做后缀
其他层以此类推

1.2 常量定义

1、【强制】不允许任何魔法值（即未经定义的常量）直接出现在代码中。
反例：

String key = "Id#taobao_" + tradeId;
cache.put(key, value);

2、【强制】long 或者 Long 初始赋值时，使用大写的 L，不能是小写的 l，小写容易跟数字 1 混淆，造成误解。说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2?

3、【推荐】不要使用一个常量类维护所有常量，按常量功能进行归类，分开维护。
说明：大而全的常量类，非得使用查找功能才能定位到修改的常量，不利于理解和维护。
正例：
缓存相关常量放在类 CacheConsts 下；系统配置相关常量放在类 ConfigConsts 下。

4、【推荐】如果变量值仅在一个范围内变化，且带有名称之外的延伸属性，定义为枚举类。下面正例中的数字就是延伸信息，表示星期几。
正例：

public Enum { 
    MONDAY(1), 
    TUESDAY(2), 
    WEDNESDAY(3), 
    THURSDAY(4),
	FRIDAY(5), 
    SATURDAY(6), 
    SUNDAY(7);
}

1.3 代码规格

1、【强制】大括号的使用约定。如果是大括号内为空，则简洁地写成 {} 即可，不需要换行；如果是非空代码块则：

左大括号前不换行。
左大括号后换行。
右大括号前换行。
右大括号后还有 else 等代码则不换行；表示终止的右大括号后必须换行。
正例：

if (a > b) {
	System.out.println("a>b");
} else {  
	System.out.println("a<=b");
}

2、【强制】左小括号和字符之间不出现空格；同样，右小括号和字符之间也不出现空格,括号内是函数的此条规则同样适用；详见第 5 条下方正例提示。
反例：

if (空格 a == b 空格)

3、【强制】if/for/while/switch/do 等保留字与括号之间都必须加空格。

4、【强制】任何二目、三目运算符的左右两边都需要加一个空格。说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

5、【强制】采用 4 个空格缩进，禁止使用 tab 字符。说明：如果使用 tab 缩进，必须设置 1 个 tab 为 4 个空格。IDEA 设置 tab 为 4 个空格时，请勿勾选 Use tab character；而在 eclipse 中，必须勾选 insert spaces for tabs。
正例：（涉及 1-5 点）

public static void main(String[] args) {
	String say = "hello";//缩进 4 个空格
	int flag = 0;//运算符的左右必须有一个空格
    /*
    关键词 if 与括号之间必须有一个空格;
    括号内的 f 与左括号，0 与右括号不需要空格
    */
    if (flag == 0) {
    	System.out.println(say);
    }  
    /*
    左大括号前加空格且不换行；左大括号后换行;右大括号前换行，
    右大括号后有 else，不用换行;在右大括号后直接结束，则必须换行
    */
    if (flag == 1) {
    	System.out.println("world");
    } else {
    	System.out.println("ok");
    }
}

6、【强制】注释的双斜线与注释内容之间有且仅有一个空格。正例：// 注释内容，注意在 // 和注释内容之间有一个空格。

7、【强制】单行字符数限制不超过 120 个，超出需要换行，换行时遵循如下原则：

第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。
运算符与下文一起换行。
方法调用的点符号与下文一起换行。
方法调用时，多个参数，需要换行时，在逗号后进行。
在括号前不要换行，见反例。
正例：

StringBuffer sb = new StringBuffer();
// 超过 120 个字符的情况下，换行缩进 4 个空格，点号和方法名称一起换行 
sb.append("zi").append("xin")...
.append("huang")...
.append("huang")...

反例：

StringBuffer sb = new StringBuffer();
// 超过 120 个字符的情况下，不要在括号前换行
sb.append("zi").append("xin")...append
("huang");
// 参数很多的方法调用可能超过 120 个字符，不要在逗号前换行
method(args1, args2, args3, ...
, argsX);

8、【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
正例：下例中实参的"a",后边必须要有一个空格。 method("a", "b", "c");

9、【强制】IDE 的 text file encoding 设置为 UTF-8;

10、【推荐】没有必要增加若干空格来使某一行的字符与上一行对应位置的字符对齐。
正例： int a = 3; long b = 4L; float c = 5F; StringBuffer sb = new StringBuffer();
说明：增加 sb 这个变量，如果需要对齐，则给 a、b、c 都要增加几个空格，在变量比较多的情况下，是一种累赘的事情。

11、【推荐】方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行。说明：没有必要插入多个空行进行隔开。

[持续更新中。。。]

posted @ 2021-10-03 21:20 南石阅读(406) 评论(0) 编辑收藏举报

刷新页面返回顶部

南石的小园子

每一天遇见更好的自己

Java 编程规范

1 编程规约

1.1 命名风格

1.2 常量定义

1.3 代码规格

公告