张治峰的博客

JAVA开发规范-阿里规约

2020-10-20

原文地址: zhangzhifeng的主页

编程规约

命名规约

1.所有编程相关命名均不能以下划线或美元符号开始，也不能以下划线或美元符号结束。

// 反例： _name 
         __name 
         $Object
         name_ 
         name$
         Object$

2.所有编程相关的命名严禁使用拼音与英文混合的方式，更不允许直接使用中文的方式。说明：正确的英文拼写和语法可以让阅读者易于理解，避免歧义。注意，即使纯拼音命名方式也要避免采用

反例 
    DaZhePromotion [打折] getPingfenByName() [评分] int 变量 = 3;
正例
    ali/alibaba/taobao/cainiao/aliyun/youku/hangzhou等国际通用的名称，可视为英文。

3.类名使用UpperCamelCase风格，必须遵从驼峰形式，但以下情形例外：（领域模型的相关命名）DO / DTO / VO / DAO等。

反例：
    macroPolo / UserDo/XMLService / TCPUDPDeal / TAPromotion
正例：
    MarcoPolo / UserDO / XmlService /TcpUdpDeal / TaPromotion

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

正例：
    localValue / getHttpMessage() /inputUserId

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

正例： MAX_STOCK_COUNT 
反例： MAX_COUNT

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

反例：定义为基本数据类型boolean isSuccess；的属性，它的方法也是isSuccess()，
RPC框架在反向解析的时候，“以为”对应的属性名称是success，导致属性获取不到，进而抛出异常。

9.包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式，但是类名如果有复数含义，类名可以使用复数形式。
正例： 应用工具类包名为com.oceandatum.mpp.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 ="oceandatum";
反例：接口方法定义：public abstract void f();

说明：JDK8中接口允许有默认实现，那么这个default方法，是对所有实现类都有价值的默认实现。
13.接口和实现类的命名有两套规则：

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

/**
 * 正例: CacheServiceImpl实现CacheService
 */
public class CacheServiceImpl implements CacheService{
}

2）如果是形容能力的接口名称，取对应的形容词做接口名（通常是–able的形式）。
正例：AbstractTranslator实现 Translatable。

14.枚举类名建议带上Enum后缀，枚举成员名称需要全大写，单词间用下划线隔开。(枚举其实就是特殊的常量类，且构造方法被默认强制是私有。)
正例：枚举名字：DealStatusEnum；成员名称：SUCCESS / UNKOWN_REASON。

15.各层命名规约：

  • Service/DAO/Mapper层方法命名规约
    1） 获取单个对象的方法用get做前缀。
    2） 获取多个对象的方法用list做前缀。
    3） 获取统计值的方法用count做前缀。
    4） 插入的方法用save做前缀。
    5） 删除的方法用remove做前缀。
    6） 修改的方法用update做前缀。
  • 领域模型命名规约
    1） 数据对象：xxxDO，xxx即为数据表名。
    2） 数据传输对象：xxxDTO，xxx为业务领域相关的名称。
    3） 展示对象：xxxVO，xxx一般为网页名称。
    4） POJO是DO/DTO/BO/VO的统称，禁止命名成xxxPOJO。

常量定义

1.不允许出现任何魔法值（即未经定义的常量）直接出现在代码中。

//反例
String key="Id#taobao_"+tradeId；

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

//反例
Long a = 2l;// 写的是数字的21，还是Long型的2?

3.【推荐】不要使用一个常量类维护所有常量，应该按常量功能进行归类，分开维护。如：缓存相关的常量放在类：CacheConsts下；系统配置相关的常量放在类：ConfigConsts下。

  • 大而全的常量类，非得ctrl+f才定位到修改的常量，不利于理解，也不利于维护。

4.【推荐】常量的复用层次有五层：跨应用共享常量、应用内共享常量、子工程内共享常量、包内共享常量、类内共享常量。

  • 跨应用共享常量：放置在二方库中，通常是client.jar中的const目录下。
  • 应用内共享常量：放置在一方库的modules中的const目录下。
/**
*反例：易懂变量也要统一定义成应用内共享常量，两位攻城师在两个类中分别定义了表示“是”的变量
*/
 类A中：public static final String YES ="yes"; 
 类B中：public static final String YES ="y";
       A.YES.equals(B.YES);//预期是true，但实际返回为false，导致产生线上问题。
  • 子工程内部共享常量：即在当前子工程的const目录下。
  • 包内共享常量：即在当前包下单独的const目录下。
  • 类内共享常量：直接在类内部private static final定义。

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

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

格式规约

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

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

2.左括号和后一个字符之间不出现空格；同样，右括号和前一个字符之间也不出现空格。详见第5条下方正例提示。
3.if/for/while/switch/do等保留字与左右括号之间都必须加空格。
4.任何运算符左右必须加一个空格。
说明：运算符包括赋值运算符=、逻辑运算符&&、加减乘除符号、三目运行符等。
5.代码块缩进4个空格，如果使用tab缩进，请设置成1个tab为4个空格。

/**
 * 正例：（涉及1-5点）
 */
public static void main(Stringargs[]){     
    // 缩进4个空格     
    String say="hello";     
    // 运算符的左右必须有一个空格     
    int flag = 0;    
    // 关键词if与括号之间必须有一个空格，括号内f与左括号，1与右括号不需要空格     
    if(flag== 0) {         
        System.out.println(say);     
    }              
    // 左大括号前加空格且不换行；左大括号后换行     
    if (flag ==1){         
        System.out.println("world");     
    // 右大括号前换行，右大括号后有else，不用换行     
    }else{           
        System.out.println("ok");     
    // 右大括号做为结束，必须换行      
    } 
}

6.单行字符数限制不超过120个，超出需要换行，换行时，遵循如下原则：

1) 换行时相对上一行缩进4个空格。
2）运算符与下文一起换行。
3）方法调用的点符号与下文一起换行。
4）在多个参数超长，逗号后进行换行。
5）在括号前不要换行，见反例。正例：

//正例子
StringBuffer sb = new StringBuffer(); 
//超过120个字符的情况下，换行缩进4个空格，并且方法前的点符号一起换行  
sb.append("zi").append("xin")…    
.append("huang"); 
反例：
StringBuffer sb = new StringBuffer(); 
//超过120个字符的情况下，不要在括号前换行 
sb.append("zi").append("xin")…append
("huang");  
//参数很多的方法调用也超过120个字符，逗号后才是换行处 
method(args1,args2,args3, ...  
,argsX);

7.方法参数在定义和传入时，多个参数逗号后边必须加空格。

//正例 下例中实参的"a",后边必须要有一个空格。
method("a", "b", "c");

8.没有必要增加若干空格来使某一行的字符与上一行的相应字符对齐。

// 正例
int a = 3; 
long b = 4L; 
float c = 5F; 
StringBuffer sb = new StringBuffer();

说明：增加sb这个变量，如果需要对齐，则给a、b、c都要增加几个空格，在变量比较多的情况下，是一种累赘的事情。
9.方法体内的执行语句组、变量的定义语句组、不同的业务逻辑之间或者不同的语义之间插入一个空行。相同业务逻辑和语义之间不需要插入空行(没有必要插入多行空格进行隔开)

OOP规约

1.避免通过一个类的对象引用访问此类的静态变量或静态方法，无谓增加编译器解析成本，直接用类名来访问即可。
2.所有的覆写方法，必须加@Override注解。

反例：
getObject()与get0bject()的问题。
一个是字母的O，一个是数字的0，加@Override可以准确判断是否覆盖成功。
另外，如果在抽象类中对方法签名进行修改，其实现类会马上编译报错。

3.相同参数类型，相同业务含义，才可以使用Java的可变参数，避免使用Object。
说明：可变参数必须放置在参数列表的最后。（提倡同学们尽量不用可变参数编程）

// 正例
public User getUsers(Stringtype,Integer... ids);

4.对外暴露的接口签名，原则上不允许修改方法签名，避免对接口调用方产生影响。接口过时必须加@Deprecated注解，并清晰地说明采用的新接口或者新服务是什么。
5.不能使用过时的类或方法。

java.net.URLDecoder 中的方法decode(StringencodeStr) 这个方法已经过时，
应该使用双参数decode(String source, Stringencode)。接口提供方既然明确是过时接口，
那么有义务同时提供新的接口；作为调用方来说，有义务去考证过时方法的新实现是什么。

6.Object的equals方法容易抛空指针异常，应使用常量或确定有值的对象来调用equals。

// 正例 
"test".equals(object);
// 反例
object.equals("test");

推荐使用java.util.Objects#equals （JDK7引入的工具类）
7.所有的相同类型的包装类对象之间值的比较，全部使用equals方法比较。
对于Integer var=?在-128至127之间的赋值，Integer对象是在IntegerCache.cache 产生，会复用已有对象，这个区间内的Integer值可以直接使用==进行判断，但是这个区间之外的所有数据，都会在堆上产生，并不会复用已有对象，这是一个大坑，推荐使用equals方法进行判断。

8.关于基本数据类型与包装数据类型的使用标准如下：

1) 所有的POJO类属性必须使用包装数据类型。
2) RPC方法的返回值和参数必须使用包装数据类型。
3） 所有的局部变量推荐使用基本数据类型。

POJO类属性没有初值是提醒使用者在需要使用时，必须自己显式地进行赋值，任何NPE问题，或者入库检查，都由使用者来保证。

正例：数据库的查询结果可能是null，因为自动拆箱，用基本数据类型接收有NPE风险。
反例：某业务的交易报表上显示成交总额涨跌情况，即正负x%，x为基本数据类型，
     调用的RPC服务，调用不成功时，返回的是默认值，页面显示：0%，这是不合理的，应该显示成中划线-。
     所以包装数据类型的null值，能够表示额外的信息，如：远程调用失败，异常退出。

9.定义DO/DTO/VO等POJO类时，不要设定任何属性默认值。

反例：
某业务的DO的gmtCreate默认值为newDate();但是这个属性在数据提取时并没有置入具体值，
在更新其它字段时又附带更新了此字段，导致创建时间被修改成当前时间。

10.序列化类新增属性时，请不要修改serialVersionUID字段，避免反序列失败；如果完全不兼容升级，避免反序列化混乱，那么请修改serialVersionUID值。
注意serialVersionUID不一致会抛出序列化运行时异常。
11.构造方法里面禁止加入任何业务逻辑，如果有初始化逻辑，请放在init方法中。
12.POJO类必须写toString方法。使用工具类source> generate toString时，如果继承了另一个POJO类，注意在前面加一下super.toString。
在方法执行抛出异常时，可以直接调用POJO的toString()方法打印其属性值，便于排查问题。
13.使用索引访问用String的split方法得到的数组时，需做最后一个分隔符后有无内容的检查，否则会有抛IndexOutOfBoundsException的风险。

String str = "a,b,c,,";
String[]ary =str.split(","); 
//预期大于3，结果是3
System.out.println(ary.length);

14.当一个类有多个构造方法，或者多个同名方法，这些方法应该按顺序放置在一起，便于阅读。
15.类内方法定义顺序依次是：公有方法或保护方法 > 私有方法 > getter/setter方法。
公有方法是类的调用者和维护者最关心的方法，首屏展示最好；保护方法虽然只是子类关心，也可能是“模板设计模式”下的核心方法；而私有方法外部一般不需要特别关心，是一个黑盒实现；因为方法信息价值较低，所有Service和DAO的getter/setter方法放在类体最后。
16.setter方法中，参数名称与类成员变量名称一致，this.成员名=参数名。在 getter/setter方法中，尽量不要增加业务逻辑，增加排查问题难度。

反例：
public Integer getData(){
  if(true) {
      return data +100; 
  } else  {
         return data- 100;
          }  
  }

17.循环体内，字符串的联接方式，使用StringBuilder的append方法进行扩展。

String str="start";
for(int i=0;i<100;i++){
   str = str+"hello";     
}

反编译出的字节码文件显示每次循环都会new出一个StringBuilder对象，然后进行 append操作，最后通过toString方法返回String对象，造成内存资源浪费。
18.final可提高程序响应效率，声明成final的情况：
1）不需要重新赋值的变量，包括类属性、局部变量。
2）对象参数前加final，表示不允许修改引用的指向。
3）类方法确定不允许被重写。

19.慎用Object的clone方法来拷贝对象。
对象的clone方法默认是浅拷贝，若想实现深拷贝需要重写clone方法实现属性对象的拷贝

20.类成员与方法访问控制从严
1） 如果不允许外部直接通过new来创建对象，那么构造方法必须是private。
2） 工具类不允许有public或default构造方法。
3） 类非static成员变量并且与子类共享，必须是protected。
4） 类非static成员变量并且仅在本类使用，必须是private。
5） 类static成员变量如果仅在本类使用，必须是private。
6） 若是static成员变量，必须考虑是否为final。
7） 类成员方法只供类内部调用，必须是private。
8） 类成员方法只对继承类公开，那么限制为protected。

任何类、方法、参数、变量，严控访问范围。过宽泛的访问范围，不利于模块解耦。
思考：如果是一个private的方法，想删除就删除，可是一个public的Service方法，
或者一个public的成员变量，删除一下，不得手心冒点汗吗？变量像自己的小孩，尽量在自己的视线内，
变量作用域太大，如果无限制的到处跑，那么你会担心的。

集合处理

1.Map/Set的key为自定义对象时，必须重写hashCode和equals。
String重写了hashCode和equals方法，所以我们可以非常愉快地使用String对象作为key来使用。
2.ArrayList的subList结果不可强转成ArrayList，否则会抛出ClassCastException 异常：java.util.RandomAccessSubList cannot be cast tojava.util.ArrayList; 说明：subList 返回的是 ArrayList 的内部类 SubList，并不是 ArrayList ，而是 ArrayList 的一个视图，对于SubList子列表的所有操作最终会反映到原列表上。
3.在subList场景中，高度注意对原集合元素个数的修改，会导致子列表的遍历、增加、删除均产生ConcurrentModificationException 异常。
4.使用集合转数组的方法，必须使用集合的toArray(T[] array)，传入的是类型完全一样的数组，大小就是list.size()。

// 反例：直接使用toArray无参方法存在问题，此方法返回值只能是Object[]类，若强转其它类型数组将出现ClassCastException错误。
//正例
List<String> list =newArrayList<String>(2);     
list.add("guan");     
list.add("bao");      
String[] array =newString[list.size()];     
array=list.toArray(array);

使用toArray带参方法，入参分配的数组空间不够大时，toArray方法内部将重新分配内存空间，并返回新数组地址；如果数组元素大于实际所需，下标为[ list.size() ]的数组元素将被置为null，其它数组元素保持原值，因此最好将方法入参数组大小定义与集合元素个数一致。
5.使用工具类Arrays.asList()把数组转换成集合时，不能使用其修改集合相关的方法，它的add/remove/clear方法会抛出UnsupportedOperationException异常。

// asList的返回对象是一个Arrays内部类，并没有实现集合的修改方法。
// Arrays.asList 体现的是适配器模式，只是转换接口，后台的数据仍是数组。
String[] str = newString[] {"a", "b" };
List list =Arrays.asList(str);
// 第一种情况：list.add("c");运行时异常。
// 第二种情况：str[0]= "gujin"; 那么list.get(0)也会随之修改。

6.泛型通配符<? extends T>来接收返回的数据，此写法的泛型集合不能使用add方法。说明：苹果装箱后返回一个<? extends Fruits>对象，此对象就不能往里加任何水果，包括苹果。
7.不要在foreach循环里进行元素的remove/add操作。remove元素请使用Iterator 方式，如果并发操作，需要对Iterator对象加锁。

//反例
List<String> a =newArrayList<String>();     
a.add("1");     
a.add("2");
for(String temp : a){
   if("1".equals(temp)){             
      a.remove(temp);         
   }      
}

这个例子的执行结果会出乎大家的意料，那么试一下把“1”换成“2”，会是同样的结果吗?

//正例
Iterator<String> it =a.iterator(); while(it.hasNext()){             
    String temp =  it.next();                       
    if(删除元素的条件){                            
        it.remove();                
    }     
}

8.在JDK7版本以上，Comparator要满足自反性，传递性，对称性，不然Arrays.sort,Collections.sort会报IllegalArgumentException异常。
1） 自反性：x，y的比较结果和y，x的比较结果相反。
2） 传递性：x>y,y>z,则x>z。
3） 对称性：x=y,则x,z比较结果和y，z比较结果相同。

//反例：下例中没有处理相等的情况，实际使用中可能会出现异常：
newComparator<Student>(){          
    @Override         
    public int compare(Student o1, Studento2){
         returno1.getId() > o2.getId() ? 1 :-1;         
    }     
}

9.集合初始化时，尽量指定集合初始值大小。说明：ArrayList尽量使用ArrayList(int initialCapacity) 初始化。

10.使用entrySet遍历Map类集合KV，而不是keySet方式进行遍历。
keySet其实是遍历了2次，一次是转为Iterator对象，另一次是从hashMap中取出key 所对应的value。而entrySet只是遍历了一次就把key和value都放到了entry中，效率更高。如果是JDK8，使用Map.foreach方法。

正例：values()返回的是V值集合，是一个list集合对象；
     keySet()返回的是K值集合，是一个Set集合对象；
     entrySet()返回的是K-V值组合集合。

11.【参考】合理利用好集合的有序性(sort)和稳定性(order)，避免集合的无序性(unsort)和不稳定性(unorder)带来的负面影响。
稳定性指集合每次遍历的元素次序是一定的。有序性是指遍历的结果是按某种比较规则依次排列的。如：ArrayList是order/unsort；HashMap是unorder/unsort；TreeSet是 order/sort。

12.【参考】利用Set元素唯一的特性，可以快速对另一个集合进行去重操作，避免使用List的 contains方法进行遍历去重操作。

并发处理

1.获取单例对象要线程安全。在单例对象里面做操作也要保证线程安全。
资源驱动类、工具类、单例工厂类都需要注意。
2.线程资源必须通过线程池提供，不允许在应用中自行显式创建线程。
使用线程池的好处是减少在创建和销毁线程上所花的时间以及系统资源的开销，解决资源不足的问题。如果不使用线程池，有可能造成系统创建大量同类线程而导致消耗完内存或者“过度切换”的问题。
3.SimpleDateFormat 是线程不安全的类，一般不要定义为static变量，如果定义为 static，必须加锁，或者使用DateUtils工具类。

// 正例：注意线程安全，使用DateUtils。亦推荐如下处理：
private static finalThreadLocal<DateFormat> df =new ThreadLocal<DateFormat>(){      
    @Override       
    protected DateFormatinitialValue(){           
        return new SimpleDateFormat("yyyy-MM-dd");       
    }   
};

如果是JDK8的应用，可以使用instant代替Date，Localdatetime代替Calendar，Datetimeformatter代替Simpledateformatter，官方给出的解释：simple beautifulstrong immutable thread-safe。
4.高并发时，同步调用应该去考量锁的性能损耗。能用无锁数据结构，就不要用锁；能锁区块，就不要锁整个方法体；能用对象锁，就不要用类锁。
5.对多个资源、数据库表、对象同时加锁时，需要保持一致的加锁顺序，否则可能会造成死锁。
线程一需要对表A、B、C依次全部加锁后才可以进行更新操作，那么线程二的加锁顺序也必须是A、B、C，否则可能出现死锁。
6.并发修改同一记录时，避免更新丢失，要么在应用层加锁，要么在缓存加锁，要么在数据库层使用乐观锁，使用version作为更新依据。说明：如果每次访问冲突概率小于20%，推荐使用乐观锁，否则使用悲观锁。乐观锁的重试次数不得小于3次。

7.多线程并行处理定时任务时，Timer运行多个TimeTask时，只要其中之一没有捕获抛出的异常，其它任务便会自动终止运行，使用ScheduledExecutorService则没有这个问题。

8.线程池不允许使用Executors去创建，而是通过ThreadPoolExecutor的方式，这样的处理方式让写的同学更加明确线程池的运行规则，规避资源耗尽的风险。Executors各个方法的弊端：
1）new FixedThreadPool和newSingleThreadExecutor:主要问题是堆积的请求处理队列可能会耗费非常大的内存，甚至OOM。
2）new CachedThreadPool和newScheduledThreadPool:主要问题是线程数最大数是Integer.MAX_VALUE，可能会创建数量非常多的线程，甚至OOM。
9.创建线程或线程池时请指定有意义的线程名称，方便出错时回溯。

// 正例
public class TimerTaskThread extendsThread{     
    public TimerTaskThread(){         
        super.setName("TimerTaskThread");… 
    }
}

10.使用CountDownLatch进行异步转同步操作，每个线程退出前必须调用countDown方法，线程执行代码注意catch异常，确保countDown方法可以执行，避免主线程无法执行至 countDown方法，直到超时才返回结果。说明：注意，子线程抛出异常堆栈，不能在主线程try-catch到。
11.避免Random实例被多线程使用，虽然共享该实例是线程安全的，但会因竞争同一seed 导致的性能下降。说明：Random实例包括java.util.Random 的实例或者 Math.random()实例。
在JDK7之后，可以直接使用API ThreadLocalRandom，在 JDK7之前，可以做到每个线程一个实例。
12.通过双重检查锁（double-checked locking）（在并发场景）实现延迟初始化的优化问题隐患(可参考 The “Double-Checked Locking is Broken” Declaration),推荐问题解决方案中较为简单一种（适用于jdk5及以上版本），将目标属性声明为 volatile型（比如反例中修改helper的属性声明为privatevolatile Helper helper= null;）；

// 反例
class Foo {
    private Helper helper= null;
    public Helper getHelper() {
        if (helper ==null)
            synchronized(this) {
                if (helper==null)
                    helper =newHelper();

            }      returnhelper; }

    // other functions and members... 
}

13.volatile解决多线程内存不可见问题。对于一写多读，是可以解决变量同步问题，但是如果多写，同样无法解决线程安全问题。如果想取回count++数据，使用如下类实现：

AtomicIntegercount = new AtomicInteger();
count.addAndGet(1); 
count++操作如果是JDK8，推荐使用LongAdder对象，比AtomicLong性能更好（减少乐观锁的重试次数）。

14.注意HashMap的扩容死链，导致CPU飙升的问题。
15.ThreadLocal无法解决共享对象的更新问题，ThreadLocal对象建议使用static修饰。这个变量是针对一个线程内所有操作共有的，所以设置为静态变量，所有此类实例共享此静态变量 ，也就是说在类第一次被使用时装载，只分配一块存储空间，所有此类的对象(只要是这个线程内定义的)都可以操控这个变量。

控制语句

1.在一个switch块内，每个case要么通过break/return来终止，要么注释说明程序将继续执行到哪一个case为止；在一个switch块内，都必须包含一个default语句并且放在最后，即使它什么代码也没有。
2.在if/else/for/while/do语句中必须使用大括号，即使只有一行代码，避免使用下面的形式：if (condition) statements;
3.推荐尽量少用else， if-else的方式可以改写成

if(condition){             
    …            
    return obj;    
}

如果使用要if-else if-else方式表达逻辑，请勿超过3层，超过请使用状态设计模式。
4.除常用方法（如getXxx/isXxx）等外，不要在条件判断中执行复杂的语句，以提高可读性。正例：

// 伪代码如下
InputStream stream =file.open(fileName,"w");
    if (stream != null) {
    …
    }    
    //反例：
    if (file.open(fileName, "w") !=null)){
    …
}

5.循环体中的语句要考量性能，以下操作尽量移至循环体外处理，如定义对象、变量、获取数据库连接，进行不必要的try-catch操作（这个try-catch是否可以移至循环体外）。
6.接口入参保护，这种场景常见的是用于做批量操作的接口。
7.方法中需要进行参数校验的场景：
1）调用频次低的方法。
2）执行时间开销很大的方法，参数校验时间几乎可以忽略不计，但如果因为参数错误导致中间执行回退，或者错误，那得不偿失。
3）需要极高稳定性和可用性的方法。
4）对外提供的开放接口，不管是RPC/API/HTTP接口。
8.方法中不需要参数校验的场景：
1）极有可能被循环调用的方法，不建议对参数进行校验。但在方法说明里必须注明外部参数检查。
2）底层的方法调用频度都比较高，一般不校验。毕竟是像纯净水过滤的最后一道，参数错误不太可能到底层才会暴露问题。一般DAO层与Service层都在同一个应用中，部署在同一台服务器中，所以DAO的参数校验，可以省略。
3）被声明成private只会被自己代码所调用的方法，如果能够确定调用方法的代码传入参数已经做过检查或者肯定不会有问题，此时可以不校验参数。

注释规约

统一发放模版

其它

1.在使用正则表达式时，利用好其预编译功能，可以有效加快正则匹配速度。
不要在方法体内定义：Pattern pattern =Pattern.compile(规则);
2.避免用Apache Beanutils进行属性的copy。
Apache BeanUtils性能较差，可以使用其他方案比如SpringBeanUtils, Cglib BeanCopier。
3.velocity调用POJO类的属性时，建议直接使用属性名取值即可，模板引擎会自动按规范调用POJO的getXxx()，如果是boolean基本数据类型变量（注意，boolean命名不需要加is前缀），会自动调用isXxx()方法。
注意如果是Boolean包装类对象，优先调用getXxx()的方法。
4.后台输送给页面的变量必须加$!{var}——中间的感叹号。
如果var=null或者不存在，那么${var}会直接显示在页面上。
5.注意 Math.random() 这个方法返回是double类型，注意取值范围 0≤x<1（能够取到零值，注意除零异常），如果想获取整数类型的随机数，不要将x放大10的若干倍然后取整，直接使用Random对象的nextInt或者nextLong方法。
6.获取当前毫秒数：System.currentTimeMillis(); 而不是newDate().getTime(); 说明：如果想获取更加精确的纳秒级时间值，用System.nanoTime。在JDK8中，针对统计时间等场景，推荐使用Instant类。
7.尽量不要在vm中加入变量声明、逻辑运算符，更不要在vm模板中加入任何复杂的逻辑。
8.任何数据结构的使用都应限制大小。
这点很难完全做到，但很多次的故障都是因为数据结构自增长，结果造成内存被吃光。
9.对于“明确停止使用的代码和配置”，如方法、变量、类、配置文件、动态配置属性等要坚决从程序中清理出去，避免造成过多垃圾。清理这类垃圾代码是技术气场，不要有这样的观念：“不做不错，多做多错”。

异常日志

异常处理

1.不要捕获Java类库中定义的继承自RuntimeException的运行时异常类，如：IndexOutOfBoundsException/NullPointerException，这类异常由程序员预检查来规避，保证程序健壮性。

正例：if(obj != null) {...}
反例：try { obj.method()}catch(NullPointerException e){…}

2.异常不要用来做流程控制，条件控制，因为异常的处理效率比条件分支低。
3.对大段代码进行try-catch，这是不负责任的表现。catch时请分清稳定代码和非稳定代码，稳定代码指的是无论如何不会出错的代码。对于非稳定代码的catch尽可能进行区分异常类型，再做对应的异常处理。
4.捕获异常是为了处理它，不要捕获了却什么都不处理而抛弃之，如果不想处理它，请将该异常抛给它的调用者。最外层的业务使用者，必须处理异常，将其转化为用户可以理解的内容。
5.有try块放到了事务代码中，catch异常后，如果需要回滚事务，一定要注意手动回滚事务。
6.finally块必须对资源对象、流对象进行关闭，有异常也要做try-catch。
如果JDK7，可以使用try-with-resources方法。
7.不能在finally块中使用return，finally块中的return返回后方法结束执行，不会再执行try块中的return语句。
8.捕获异常与抛异常，必须是完全匹配，或者捕获异常是抛异常的父类。
如果预期抛的是绣球，实际接到的是铅球，就会产生意外情况。
9.方法的返回值可以为null，不强制返回空集合，或者空对象等，必须添加注释充分说明什么情况下会返回null值。调用方需要进行null判断防止NPE问题。
本规约明确防止NPE是调用者的责任。即使被调用方法返回空集合或者空对象，对调用者来说，也并非高枕无忧，必须考虑到远程调用失败，运行时异常等场景返回null的情况。
10.【推荐】防止NPE，是程序员的基本修养，注意NPE产生的场景：
1）返回类型为包装数据类型，有可能是null，返回int值时注意判空。

// 反例：如果为null，自动解箱抛NPE。
public int f(){
    return Integer 对象
}

2）数据库的查询结果可能为null。
3）集合里的元素即使isNotEmpty，取出的数据元素也可能为null。
4）远程调用返回对象，一律要求进行NPE判断。
5）对于Session中获取的数据，建议NPE检查，避免空指针。
6）级联调用obj.getA().getB().getC()；一连串调用，易产生NPE。
11.【推荐】在代码中使用“抛异常”还是“返回错误码”，对于公司外的http/api开放接口必须使用“错误码”；而应用内部推荐异常抛出；跨应用间RPC调用优先考虑使用Result方式，封装isSuccess、“错误码”、“错误简短信息”。
关于RPC方法返回方式使用Result方式的理由：
1）使用抛异常返回方式，调用方如果没有捕获到就会产生运行时错误。
2）如果不加栈信息，只是new自定义异常，加入自己的理解的error message，对于调用端解决问题的帮助不会太多。如果加了栈信息，在频繁调用出错的情况下，数据序列化和传输的性能损耗也是问题。
12.定义时区分unchecked / checked 异常，避免直接使用RuntimeException抛出，更不允许抛出Exception或者Throwable，应使用有业务含义的自定义异常。推荐业界已定义过的自定义异常，如：DaoException / ServiceException等。
13.避免出现重复的代码（Don’tRepeat Yourself），即DRY原则。
[强制]随意复制和粘贴代码，必然会导致代码的重复，在以后需要修改时，需要修改所有的副本，容易遗漏。必要时抽取共性方法，或者抽象公共类，甚至是共用模块。

// 一个类中有多个public方法，都需要进行数行相同的参数校验操作，这个时候请抽取
private boolean checkParam(DTOdto){...}

日志规约

1.应用中不可直接使用日志系统（Log4j、Logback）中的API，而应依赖使用日志框架SLF4J中的API，使用门面模式的日志框架，有利于维护和各个类的日志处理方式统一。

import org.slf4j.Logger; 
import org.slf4j.LoggerFactory;
private static final Logger logger=LoggerFactory.getLogger(Abc.class);

2.日志文件推荐至少保存15天，因为有些异常具备以“周”为频次发生的特点。
3.应用中的扩展日志（如打点、临时监控、访问日志等）命名方式：appName_logType_logName.log。logType:日志类型，推荐分类有stats/desc/monitor/visit 等；logName:日志描述。这种命名的好处：通过文件名就可知道日志文件属于什么应用，什么类型，什么目的，也有利于归类查找。

正例：mppserver应用中单独监控时区转换异常 
如：mppserver_monitor_timeZoneConvert.log

推荐对日志进行分类，错误日志和业务日志尽量分开存放，便于开发人员查看，也便于通过日志对系统进行及时监控。
4.对trace/debug/info级别的日志输出，必须使用条件输出形式或者使用占位符的方式。
说明：logger.debug(“Processingtrade withid: “ + id + “ symbol: “ + symbol); 如果日志级别是warn，上述日志不会打印，但是会执行字符串拼接操作，如果symbol是对象，会执行toString()方法，浪费了系统资源，执行了上述操作，最终日志却没有打印。

// 正例：（条件）
if (logger.isDebugEnabled()){   
logger.debug("Processing trade with id:" +id + " symbol: " + symbol);  
}      
// 正例：（占位符）
logger.debug("Processing trade with id:{} andsymbol : {} ", id, symbol);

5.避免重复打印日志，浪费磁盘空间，务必在log4j.xml中设置additivity=false。

<loggername="com.taobao.ecrm.member.config"additivity="false">

6.异常信息应该包括两类信息：案发现场信息和异常堆栈信息。如果不处理，那么往上抛。

//正例
logger.error(各类参数或者对象toString +"_" + e.getMessage(), e);

7.输出的POJO类必须重写toString方法，否则只输出此对象的hashCode值（地址值），没啥参考意义。
8.可以使用warn日志级别来记录用户输入参数错误的情况，避免用户投诉时，无所适从。注意日志输出的级别，error级别只记录系统逻辑出错、异常、或者重要的错误信息。如非必要，请不要在此场景打出error级别，避免频繁报警。
9.谨慎地记录日志。生产环境禁止输出debug日志；有选择地输出info日志；如果使用warn来记录刚上线时的业务行为信息，一定要注意日志输出量的问题，避免把服务器磁盘撑爆，并记得及时删除这些观察日志。
大量地输出无效日志，不利于系统性能提升，也不利于快速定位错误点。纪录日志时请思考：这些日志真的有人看吗？看到这条日志你能做什么？能不能给问题排查带来好处？

10.如果日志用英文描述不清楚，推荐使用中文注释。对于中文UTF-8的日志，在secureCRT 中，set encoding=utf-8；如果中文字符还乱码，请设置：全局>默认的会话设置>外观>字体> 选择字符集gb2312；如果还不行，执行命令：set termencoding=gbk，并且直接使用中文来进行检索。

接口定义

说明

modelName: 模块名
obj : 对应模块实体类
query: 查询类对象
Id: 对应模块实体id

接口定义

  • 获取对象详情

    请求类型 get 
    路径名称: /${version}/${modelName}/${id}
    代码
    public R getById(@PathVariable(“id”) id)

  • 新增

    请求类型 put 
    路径名称: /${version}/${modelName}/
    代码
    public R add(@RequestBody Object obj)

  • 修改

    请求类型 post 
     路径名称: /${version}/${modelName}/
     代码
     public R update(@RequestBody obj)

  • 删除

    请求类型 delete 
    路径名称: /${version}/${modelName}/${id}
    代码
    public R delete(@PathVariable(“id”) id)

  • 分页查询:

    请求类型 get 
    路径名称: /${version}/${modelName}/${id}
    代码
    public R delete(Page page,Object query);

    swagger 集成

    接口完成后需要集成到swagger当中

    1. 填写接口说明
    2. 请求参数说明
    3. 返回结果说明
    4. 返回结果示例

MYSQL规约

本模块待完善

命名规约

索引规约

SQL规约

工程规约

应用分层

web->service->mapper

平台项目结构

待完善

Tags: 随笔
← Spring核心概念（源码相关） JDK源码级别理解双亲委派机制 →
赏
使用支付宝打赏
使用微信打赏

若你觉得我的文章对你有帮助，欢迎点击上方按钮对我打赏

扫描二维码，分享此文章