作者： @是嘟嘟呀(shiduduya)

前言

一、编程规约

（一）命名风格

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

反例： name / name / Sname / name / name$ / name

  1. 【强制】所有编程相关的命名严禁使用拼音与英文混合的方式 ，更不允许直接使用中文的方式。

说明：正确的英文拼写和语法可以让问读者易于理解，避免歧义。注意，纯拼音命名方式更要避免来用。
正例：ali / alibaba / taobao / cainiao/ aliyun/ youku / hangzhou 等国际通用的名称，可视同英文。
反例：DaZhePromotion （打折1/ getPingfenBy Name0 [评分]/ int 某变量 = 3

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

正例：ForceCode / UserDo / HtmIDTO/ XmIService/ TcpUdpDeal / TaPromotion
反例：forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion

  1. 【强制】方法名、参数名、成员变量、局部变量都统一使用 lowerCamelCase 风格。

正例：localValue / getHttpMessage0 / inputUserld

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

正例：MAX STOCK COUNT / CACHE EXPIRED_ TIME
反例：MAX COUNT / EXPIRED TIME

  1. 【强制】抽象类命名使用 Abstract 或 Base 开头；异常类命名使用 Exception 结尾；测试类命名以它要测试的类的名称开始，以 Test 结尾。
  2. 【强制】类型与中括号紧挨相连来表示数组。

正例：定义整形数组 int array Demo;
反例：在main 参数中，使用 String args0来定义。

  1. 【强制】POJO 类中的任何布尔类型的变量，都不要加is 前缀，杏则部分框架解析会引起序列化错误。

说明：在本文 MySQL 规约中的建表约定第一条，表达是与否的值采用 is xxx 的命名方式，所以，需要在 设置从 is xxx 到xxx 的映射关系。
反例：定义为基本数据类型 Boolean isDeleted 的属性，它的方法也是 isDeleted()，框架在反向解析的时侯，^误以为”对应的厲性名称是 deleted ，导致属性获取不到，进而拋出异常。

  1. 【强制】包名统一使用小写，点分隔符之间有且仅有一个自然语义的英语单词。包名统一使用单数形式， 但是类名如果有复数含义，类名可以使用复数形式。

正例：应用工具类包名为 com.alibaba.eikunlun.aap.util、类名为 MessageUtils（此规则参考 spring 的框架结构）

  1. 【强制】避免在子父类的成员变量之间或者不同代码块的局部变量之间采用完全相同的命名，使可读性隆低

说明：子类、父类成员变量名相同，即使是 public 类型的变量也是能够通过编译，而局部变量在同一方法 内的不同代码块中同名也是合法的，但是要避免使用。对于非 setter/getter 的参数名称也要避免与成员变量名称相同 。
反例：

  1. public class ConfusingName {
  2.     public int stock;
  4.   //非setter/getter的参数名称，不允许与本类成员交量向名 
  5.     public void get (String alibaba) {
  6.       if (condition){
  7.         final int money = 666;
  8.       //...
  9.     } 
  12.     for (int i = 0; i < 10 ;i+ +) {
  13.       //在同一方法体中，不允许其他代码块中的money命名相同
  14.       final int menony = 15978;
  15.       //...
  17.       }
  18.   }
  19. }
  22. }
  24. class Son extends ConfusingName {
  25.     //不允许与父亲的成员变量名称相同
  26.   public int stock
  28. }
  1. 【强制】杜绝完全不规范的缩写，避免望文不知义。

反例：AbstractClass“缩写”命名成 AbsClass;condition“缩写”命名成 condi，此类随意缩写严重降低了代码的可阅读性。

  1. 【推荐】为了达到代码自解释的目标，任何自定义编程元素在命名时，使用尽量完整的单词组合来表达
  2. 正例 ：在JDK 中对某个对象子用的 volatile 字段进行原子更新的类名为 AtomicReference FieldUpdater.
  3. 反例：常见的方法内变量为 int a;的定义方式。

（二）常量定义

（三）代码格式

（四）OOP规约

（五）日期时间

（六）集合处理

（七）并发处理

（八）语句控制

（九）注释规约

（十）其他

二、异常日志

（一）错误码

（二）异常处理

（三）日志规约

三、单元测试

四、安全规约

五、 MySQL数据库

（一）建表规约

（二）索引规约

（三）SQL语句

（四）ORM映射

六、工程结构

（一）应用分层

（二）二方库依赖

（三）服务器

七、设计规约

附录：