JAVA编程规范

JAVA编程规范

阿里巴巴Java开发手册1.4.0

命名风格

1. 【强制】类名使用 UpperCamelCase 风格，但以下情形例外:DO / BO / DTO / VO / AO / PO / UID等。

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

   反例:macroPolo / UserDo / XMLService / TCPUDPDeal / TAPromotion

2. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格，必须遵从驼峰形式。

   正例: localValue / getHttpMessage() / inputUserId

3. 常量命名全部大写，单词间用下划线隔开，力求语义表达完整清楚，不要嫌名字长。

   正例:MAX_STOCK_COUNT
   反例:MAX_COUNT

4. 抽象类命名使用 Abstract 或 Base 开头;异常类命名使用 Exception 结尾;测试类命名以它要测试的类的名称开始，以 Test 结尾。

5. 类型与中括号紧挨相连来表示数组。

   正例:定义整形数组 int[] arrayDemo;

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

7. 接口和实现类的命名有两套规则:
   1)【强制】对于 Service 和 DAO 类，基于 SOA 的理念，暴露出来的服务一定是接口，内部的实现类用 Impl 的后缀与接口区别。

   正例:CacheServiceImpl 实现 CacheService 接口。

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

   正例:AbstractTranslator 实现 Translatable 接口。

8. Service/DAO层方法命名规约

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

   2. 获取多个对象的方法用list做前缀，复数形式结尾如:listObjects。

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

   4. 插入的方法用save/insert做前缀。

   5. 删除的方法用remove/delete做前缀。

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

代码格式

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

   1. 左大括号前不换行。
   2. 左大括号后换行。
   3. 右大括号前换行。
   4. 右大括号后还有else等代码则不换行;表示终止的右大括号后必须换行。

2. 【强制】左小括号和字符之间不出现空格;同样，右小括号和字符之间也不出现空格;而左大 括号前需要空格。详见第 5 条下方正例提示。
   反例 : if (空格a == b空格)

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

4. 【强制】任何二目、三目运算符的左右两边都需要加一个空格。

   说明:运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号等。

5. 【强制】采用 4 个空格缩进，禁止使用 tab 字符。

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

6. 【强制】注释的双斜线与注释内容之间有且仅有一个空格

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

   1. 第二行相对第一行缩进 4 个空格，从第三行开始，不再继续缩进，参考示例。

   2. 运算符与下文一起换行。

   3. 方法调用的点符号与下文一起换行。

   4. 方法调用中的多个参数需要换行时，在逗号后进行。

   5. 在括号前不要换行，见反例。

OOP规约

Todo