Java编码规范-CSDN博客

1.Java源文件
开首注释:此中列出类名、版本信息、日期和版权声明;
包和引入语句；
类和接口声明：类/接口文档注释，类或接口的声明，类的（静态）变量，
实例变量，办法

2.缩进排版（Indentation）
4个空格常被作为缩进排版的一个单位。缩进的确切申明并未具体指定（空格 vs. 制表符）。一个制表符便是8个空格（而非4个）。

3.行长度（Line Length）
用于文档中的例子应当应用更短的行长，长度一般不跨越70个字符

4.换行（Wrapping Lines）
当一个表达式无法容纳在一行内时，可以根据如下一般规矩断开之：
在一个逗号后面断开
在一个操纵符前面断开
宁可选择较高等别（higher-level）的断开，而非较初级别（lower-level）的断开
新的一行应当与上一行同一级别表达式的开首处对齐
若是以上规矩导致你的代码杂沓或者使你的代码都堆挤在右边，那就代之以缩进8个空格。

5.注释（Comments）
Java程序有两类注释：实现注释（implementation comments）和文档注释（document comments）。实现注释是那些在C++中见过的，应用/…/和//界定的注释。文档注释（被称为"doc comments"）是Java独有的，并由/**…*/界定。文档注释可以经由过程javadoc对象转换成HTML文件。
程序可以有4种实现注释的风格：块（block）、单行（single-line）、尾端（trailing）和行末（end-of-line）

6.定名规范（Naming Conventions）
包：一个独一包名的前缀老是全部小写的ASCII字母并且是一个域名，凡是是com，edu，gov，mil，net，org，或1981年 ISO 3166标准所指定的标识国度的英文双字符代码。包名的后续项目组按照不合机构各自内部的定名规范而不尽雷同。这类定名规范可能以特定目次名的构成来区分部门（department），项目（project），机械（machine），或注册名（login names）。

类：类名是个一名词，采取大小写混淆的体式格式，每个单词的首字母大写。尽量使你的类名简洁而富于描述。应用完全单词，避免缩写词（除非该缩写词被更广泛应用，像URL，HTML）

接口：大小写规矩与类名类似

方法：采取大小写混淆的体式格式，第一个单词的首字母小写，厥后单词的首字母大写

变量：除了变量名外，所有实例，包含类，类常量，均采取大小写混淆的体式格式，第一个单词的首字母小写，厥后单词的首字母大写。变量名不该以下划线或美元符号开首，尽管这在语法上是容许的。
变量名应简短且富于描述。变量名的选用应当易于记忆，即，可以或许指出其用处。尽量避免单个字符的变量名，除非是一次性的姑且变量。姑且变量凡是被取名为i，j，k，m和n，它们一般用于整型；c，d，e，它们一般用于字符型。

实例变量：大小写规矩和变量名类似

常量：应当全部大写，单词间用下划线隔开

(一) 命名规约

【强制】代码中的命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

反例： _nam / __name / $Object / name_ / name$ / Object$
2. 【强制】代码中的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。

说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用。

反例： DaZhePromotion [打折] / getPingfenByName() [评分] / int 某变量 = 3

正例： alibaba / taobao / youku / hangzhou 等国际通用的名称，可视同英文。
3. 【强制】类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / BO / DTO / VO等。

正例：MarcoPolo / UserDO / XmlService / TcpUdpDeal / TaPromotion

反例：macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion
4. 【强制】方法名、参数名、成员变量、局部变量都统一使用lowerCamelCase风格，必须遵从驼峰形式。

正例： localValue / getHttpMessage() / inputUserId
5. 【强制】常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

正例： MAX_STOCK_COUNT

反例： MAX_COUNT
6. 【强制】抽象类命名使用Abstract或Base开头；异常类命名使用Exception结尾；测试类命名以它要测试的类的名称开始，以Test结尾。
7. 【强制】中括号是数组类型的一部分，数组定义如下：String[] args;
8. 【强制】POJO类中布尔类型的变量，都不要加is，否则部分框架解析会引起序列化错误。

反例：定义为基本数据类型boolean isSuccess；的属性，它的方法也是isSuccess()，RPC框架在反向解析的时候，“以为”对应的属性名称是success，导致属性获取不到，进而抛出异常。
9. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。

正例：应用工具类包名为com.alibaba.open.util、类名为MessageUtils（此规则参考spring的框架结构）
10. 【强制】杜绝完全不规范的缩写，避免望文不知义。

反例： AbstractClass“缩写”命名成AbsClass；condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。
11. 【推荐】如果使用到了设计模式，建议在类名中体现出具体模式。

说明：将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。

正例：public class OrderFactory;

public class LoginProxy;

public class ResourceObserver;
12. 【推荐】接口类中的方法和属性不要加任何修饰符号（public 也不要加），保持代码的简洁性，并加上有效的Javadoc注释。尽量不要在接口里定义变量，如果一定要定义变量，肯定是与接口方法相关，并且是整个应用的基础常量。

正例：接口方法签名：void f(); 接口基础常量表示：String COMPANY = “alibaba”;

反例：接口方法定义：public abstract void f(); 说明：JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。
13. 接口和实现类的命名有两套规则：

1）【强制】对于Service和DAO类，基于SOA的理念，暴露出来的服务一定是接口，内部的实现类用Impl的后缀与接口区别。

正例：CacheServiceImpl实现CacheService接口。

2）【推荐】如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able的形式）。

正例：AbstractTranslator实现 Translatable。
14. 【参考】枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。

说明：枚举其实就是特殊的常量类，且构造方法被默认强制是私有。

正例：枚举名字：DealStatusEnum，成员名称：SUCCESS / UNKOWN_REASON。
15. 【参考】各层命名规约：

A) Service/DAO层方法命名规约

1）获取单个对象的方法用get做前缀。

2）获取多个对象的方法用list做前缀。

3）获取统计值的方法用count做前缀。

4）插入的方法用save（推荐）或insert做前缀。

5）删除的方法用remove（推荐）或delete做前缀。

6）修改的方法用update做前缀。

B) 领域模型命名规约

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

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

3）展示对象：xxxVO，xxx一般为网页名称。

4） POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。

(二) 常量定义

【强制】不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。
　　反例： String key=“Id#taobao_”+tradeId；
　　　　　cache.put(key, value);
【强制】long或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。
【推荐】不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存相关的常量放在类：CacheConsts下；系统配置相关的常量放在类：ConfigConsts下。
【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。

1）跨应用共享常量：放置在二方库中，通常是client.jar中的constant目录下。

2）应用内共享常量：放置在一方库的modules中的constant目录下。

反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示“是”的变量：

类A中：public static final String YES = “yes”;

类B中：public static final String YES = “y”; A.YES.equals(B.YES)，预期是true，但实际返回为false，导致产生线上问题。
　　3）子工程内部共享常量：即在当前子工程的constant目录下。

4）包内共享常量：即在当前包下单独的constant目录下。

5）类内共享常量：直接在类内部private static final定义。
5. 【推荐】如果变量值仅在一个范围内变化用Enum类。如果还带有名称之外的延伸属性，必须使用Enum类，下面正例中的数字就是延伸信息，表示星期几。

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

(三) 格式规约

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

1）左大括号前不换行。

2）左大括号后换行。

3）右大括号前换行。

4）右大括号后还有else等代码则不换行；表示终止右大括号后必须换行。
2. 【强制】左括号和后一个字符之间不出现空格；同样，右括号和前一个字符之间也不出现空格。详见第5条下方正例提示。
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点）

【强制】方法参数在定义和传入时，多个参数逗号后边必须加空格。
【强制】IDE的text file encoding设置为UTF-8; IDE中文件的换行符使用Unix格式，不要使用windows格式。

OOP规约
8. 【强制】避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。
9. 【强制】不能使用过时的类或方法
10. Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals
11. 关于基本数据类型与包装数据类型的使用标准如下：

1）所有的POJO类属性必须使用包装数据类型。

2） RPC方法的返回值和参数必须使用包装数据类型。

3）所有的局部变量【推荐】使用基本数据类型。

说明：POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。正例：数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收有NPE风险

12.POJO类必须写toString方法。使用IDE的中工具：source> generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。

谨慎地记录日志。生产环境禁止输出debug日志；有选择地输出info日志；如果使用warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。