利人利己的开发规范（一）

当我们开发中都遵循一套良好的开发习惯，这不仅更容易帮助其他人看懂我们代码，也可以帮助我们之后再看自己代码时不会出现××写字××认不得的窘状

以下列出了十个容易忽视的规范要求，后续还会更新，学中用效果才是最好的。

1.POJO 类中布尔类型的变量，都不要加is，否则部分框架解析会引起序列化错误。

比如定义 booleanisSuccess的属性，它的方法也是isSuccess()，RPC框架在反向解析的时候，“以为”对应的属性名称是success，导致属性获取不到，进而抛出异常。

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

正例： MAX_STOCK_COUNT

反例： MAX_COUNT

3.如果使用到了设计模式，建议在类名中体现出具体模式。将设计模式体现在名字中，有利于阅读者快速理解架构设计思想。

正例：public class OrderFactory;
public class LoginProxy;
public class ResourceObserver

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

反例：接口方法定义：==public abstract== void f();

JDK8 中接口允许有默认实现，那么这个 default 方法，是对所有实现类都有价值的默 认实现。

5.枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开

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

正例：枚举名字：DealStatusEnum

成员名称：SUCCESS/UNKOWN_REASON。

6.long或者Long初始赋值时，必须使用大写的L，不能是小写的l，小写容易跟数字1混淆，造成误解。

说明：Long a = 2l; 写的是数字的 21，还是 Long 型的 2?

7.如果变量值仅在一个范围内变化用Enum类。如果还带有名称之外的延伸属性，必须使用Enum类，下面正例中的数字就是延伸信息，表示星期几。

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

8.任何运算符左右必须加一个空格

运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。

9.大括号的使用约定。如果是大括号内为空，则简洁地写成{}即可，不需要换行

10.if/for/while/switch/do 等保留字与左右括号之间都必须加空格。

关于8,9,10三点的规范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");      
    // 在右大括号后直接结束，则必须换行      
    }  
}

作者：树獭非懒
链接：https://www.jianshu.com/p/1d2ebc081760