一、程式設計規約

(一) 命名規約

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等。

正例：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; 反例：請勿使用Stringargs[]的方式來定義

8.【強制】POJO類中的任何布林型別的變數，都不要加is，否則部分框架解析會引起序列化錯誤。

反例：定義為基本資料型別boolean isSuccess；的屬性，它的方法也是isSuccess()，RPC

框架在反向解析的時候，“以為”對應的屬性名稱是success，導致屬性獲取不到，進而丟擲異常。

9.【強制】包名統一使用小寫，點分隔符之間有且僅有一個自然語義的英語單詞。包名統一使用單數形式，但是類名如果有複數含義，類名可以使用複數形式。

正例： 應用工具類包名為com.alibaba.mpp.util、類名為MessageUtils（此規則參考spring 的框架結構）

10.【強制】杜絕完全不規範的縮寫，避免望文不知義。

反例：<某業務程式碼>AbstractClass“縮寫”命名成AbsClass；condition“縮寫”命名成 condi，此類隨意縮寫嚴重降低了程式碼的可閱讀性。

11.【推薦】如果使用到了設計模式，建議在類名中體現出具體模式。

說明：將設計模式體現在名字中，有利於閱讀者快速理解架構設計思想。

正例：public classOrderFactory;   public class LoginProxy;

   public classResourceObserver;

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。

 

(二) 常量定義

 

1.【強制】不允許出現任何魔法值（即未經定義的常量）直接出現在程式碼中。

反例： Stringkey="Id#taobao_"+tradeId；    cache.put(key,value);

2.【強制】long或者Long初始賦值時，必須使用大寫的L，不能是小寫的l，小寫容易跟數字1 混淆，造成誤解。

說明：Longa = 2l; 寫的是數字的21，還是Long型的2?

3.【推薦】不要使用一個常量類維護所有常量，應該按常量功能進行歸類，分開維護。如：快取相關的常量放在類：CacheConsts下；系統配置相關的常量放在類：ConfigConsts下。

說明：大而全的常量類，非得ctrl+f才定位到修改的常量，不利於理解，也不利於維護。

4.【推薦】常量的複用層次有五層：跨應用共享常量、應用內共享常量、子工程內共享常量、包內共享常量、類內共享常量。

1） 跨應用共享常量：放置在二方庫中，通常是client.jar中的const目錄下。

2） 應用內共享常量：放置在一方庫的modules中的const目錄下。

  反例：易懂變數也要統一定義成應用內共享常量，兩位攻城師在兩個類中分別定義了表示

“是”的變數：

    類A中：publicstatic final String YES ="yes";     類B中：public static final String YES ="y";

   A.YES.equals(B.YES)，預期是true，但實際返回為false，導致產生線上問題。

3） 子工程內部共享常量：即在當前子工程的const目錄下。

4） 包內共享常量：即在當前包下單獨的const目錄下。

5）  類內共享常量：直接在類內部private staticfinal定義。

5.【推薦】如果變數值僅在一個範圍內變化用Enum類。如果還帶有名稱之外的延伸屬性，必須使用Enum類，下面正例中的數字就是延伸資訊，表示星期幾。

正例：public Enum{ MONDAY(1), TUESDAY(2),WEDNESDAY(3), THURSDAY(4),FRIDAY(5),

SATURDAY(6), SUNDAY(7);}

(三) 格式規約

 

1.【強制】大括號的使用約定。如果是大括號內為空，則簡潔地寫成{}即可，不需要換行；如果是非空程式碼塊則：

1） 左大括號前不換行。

2） 左大括號後換行。

3） 右大括號前換行。

4） 右大括號後還有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. 【強制】IDE的text file encoding設定為UTF-8; IDE中檔案的換行符使用Unix格式，不要使用windows格式。

10.【推薦】方法體內的執行語句組、變數的定義語句組、不同的業務邏輯之間或者不同的語義之間插入一個空行。相同業務邏輯和語義之間不需要插入空行。

說明：沒有必要插入多行空格進行隔開。

(四) 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方法中，儘量不要增加業務邏輯，增加排查問題難度。

反例：

publicIntegergetData(){      if(true)  {  returndata +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         publicintcompare(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.【推薦】高度注意Map類集合K/V能不能儲存null值的情況，如下表格：

 

12.【參考】合理利用好集合的有序性(sort)和穩定性(order)，避免集合的無序性(unsort)和不穩定性(unorder)帶來的負面影響。

 

說明：穩定性指集合每次遍歷的元素次序是一定的。有序性是指遍歷的結果是按某種比較規則依次排列的。如：ArrayList是order/unsort；HashMap是unorder/unsort；TreeSet是 order/sort。

13.【參考】利用Set元素唯一的特性，可以快速對另一個集合進行去重操作，避免使用List的 contains方法進行遍歷去重操作。

(六) 併發處理

 

1.【強制】獲取單例物件要執行緒安全。在單例物件裡面做操作也要保證執行緒安全。

說明：資源驅動類、工具類、單例工廠類都需要注意。

2.【強制】執行緒資源必須通過執行緒池提供，不允許在應用中自行顯式建立執行緒。

說明：使用執行緒池的好處是減少在建立和銷燬執行緒上所花的時間以及系統資源的開銷，解決資源不足的問題。如果不使用執行緒池，有可能造成系統建立大量同類執行緒而導致消耗完記憶體或者

“過度切換”的問題。

3.【強制】SimpleDateFormat 是執行緒不安全的類，一般不要定義為static變數，如果定義為 static，必須加鎖，或者使用DateUtils工具類。

正例：注意執行緒安全，使用DateUtils。亦推薦如下處理：

private static finalThreadLocal<DateFormat> df =new ThreadLocal<DateFormat>(){      

 @Override       

protected DateFormatinitialValue(){           

returnnewSimpleDateFormat("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）    newFixedThreadPool和newSingleThreadExecutor:  主要問題是堆積的請求處理佇列可能會耗費非常大的記憶體，甚至OOM。

2）    newCachedThreadPool和newScheduledThreadPool:  主要問題是執行緒數最大數是Integer.MAX_VALUE，可能會建立數量非常多的執行緒，甚至OOM。

9. 【強制】建立執行緒或執行緒池時請指定有意義的執行緒名稱，方便出錯時回溯。

正例：

public class TimerTaskThread extendsThread{     publicTimerTaskThread(){         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){             …            returnobj;    }  

// 接著寫else的業務邏輯程式碼; 

說明：如果使用要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.【強制】類、類屬性、類方法的註釋必須使用javadoc規範，使用/**內容*/格式，不得使用

//xxx方式。

說明：在IDE編輯視窗中，javadoc方式會提示相關注釋，生成javadoc可以正確輸出相應註釋；在IDE中，工程呼叫方法時，不進入方法即可懸浮提示方法、引數、返回值的意義，提高閱讀效率。

2.【強制】所有的抽象方法（包括介面中的方法）必須要用javadoc註釋、除了返回值、引數、異常說明外，還必須指出該方法做什麼事情，實現什麼功能。

說明：如有實現和呼叫注意事項，請一併說明。

3. 【強制】所有的類都必須新增建立者資訊。

4.【強制】方法內部單行註釋，在被註釋語句上方另起一行，使用//註釋。方法內部多行註釋使用/* */註釋，注意與程式碼對齊。

5. 【強制】所有的列舉型別欄位必須要有註釋，說明每個資料項的用途。

6.【推薦】與其“半吊子”英文來註釋，不如用中文註釋把問題說清楚。專有名詞、關鍵字，保持英文原文即可。

反例：“TCP連線超時”解釋成“傳輸控制協議連線超時”，理解反而費腦筋。

7.【推薦】程式碼修改的同時，註釋也要進行相應的修改，尤其是引數、返回值、異常、核心邏輯等的修改。

說明：程式碼與註釋更新不同步，就像路網與導航軟體更新不同步一樣，如果導航軟體嚴重滯後，就失去了導航的意義。

8.【參考】註釋掉的程式碼儘量要配合說明，而不是簡單的註釋掉。

說明：程式碼被註釋掉有兩種可能性：1）後續會恢復此段程式碼邏輯。2）永久不用。前者如果沒有備註資訊，難以知曉註釋動機。後者建議直接刪掉（程式碼倉庫儲存了歷史程式碼）。

9.【參考】對於註釋的要求：第一、能夠準確反應設計思想和程式碼邏輯；第二、能夠描述業務含義，使別的程式設計師能夠迅速瞭解到程式碼背後的資訊。完全沒有註釋的大段程式碼對於閱讀者形同天書，註釋是給自己看的，即使隔很長時間，也能清晰理解當時的思路；註釋也是給繼任者看的，使其能夠快速接替自己的工作。

10.【參考】好的命名、程式碼結構是自解釋的，註釋力求精簡準確、表達到位。避免出現註釋的一個極端：過多過濫的註釋，程式碼的邏輯一旦修改，修改註釋是相當大的負擔。

反例：

// put elephant intofridge  put(elephant,fridge);   

  方法名put，加上兩個有意義的變數名elephant和fridge，已經說明了這是在幹什麼，語義清晰的程式碼不需要額外的註釋。

11.【參考】特殊註釋標記，請註明標記人與標記時間。注意及時處理這些標記，通過標記掃描，經常清理此類標記。線上故障有時候就是來源於這些標記處的程式碼。  1） 待辦事宜（TODO）:（標記人，標記時間，[預計處理時間]）

   表示需要實現，但目前還未實現的功能。這實際上是一個javadoc的標籤，目前的

javadoc還沒有實現，但已經被廣泛使用。只能應用於類，介面和方法（因為它是一個javadoc標籤）。

 2）錯誤，不能工作（FIXME）:（標記人，標記時間，[預計處理時間]）

   在註釋中用FIXME標記某程式碼是錯誤的，而且不能工作，需要及時糾正的情況。

 

(九) 其它

 

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值時注意判空。

   反例：public int f(){return Integer物件}，如果為null，自動解箱拋NPE。

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，並且直接使用中文來進行檢索。

三、MYSQL規約

(一) 建表規約

 

1.【強制】表達是與否概念的欄位，必須使用is_xxx的方式命名，資料型別是unsigned tinyint

（ 1表示是，0表示否），此規則同樣適用於odps建表。

說明：任何欄位如果為非負數，必須是unsigned。

2.【強制】表名、欄位名必須使用小寫字母或數字；禁止出現數字開頭，禁止兩個下劃線中間只出現數字。資料庫欄位名的修改代價很大，因為無法進行預釋出，所以欄位名稱需要慎重考慮。

正例：getter_admin，task_config，level3_name 反例：GetterAdmin，taskConfig，level_3_name

3.【強制】表名不使用複數名詞。

說明：表名應該僅僅表示表裡面的實體內容，不應該表示實體數量，對應於DO類名也是單數形式，符合表達習慣。

4. 【強制】禁用保留字，如desc、range、match、delayed等，參考官方保留字。

5.【強制】唯一索引名為uk_欄位名；普通索引名則為idx_欄位名。

說明：uk_即 uniquekey；idx_ 即index的簡稱。

6.【強制】小數型別為decimal，禁止使用float和double。

說明：float和double在儲存的時候，存在精度損失的問題，很可能在值的比較時，得到不

正確的結果。如果儲存的資料範圍超過decimal的範圍，建議將資料拆成整數和小數分開儲存。

7. 【強制】如果儲存的字串長度幾乎相等，使用CHAR定長字串型別。

8.【強制】varchar是可變長字串，不預先分配儲存空間，長度不要超過5000，如果儲存長度大於此值，定義欄位型別為TEXT，獨立出來一張表，用主鍵來對應，避免影響其它欄位索引效率。

9.【強制】表必備三欄位：id, gmt_create, gmt_modified。

說明：其中id必為主鍵，型別為unsignedbigint、單表時自增、步長為1；分表時改為從

TDDL Sequence取值，確保分表之間的全域性唯一。gmt_create,gmt_modified的型別均為 date_time型別。

10.【推薦】表的命名最好是加上“業務名稱_表的作用”，避免上雲梯後，再與其它業務表關聯時有混淆。

正例：tiger_task/ tiger_reader / mpp_config

11.【推薦】庫名與應用名稱儘量一致。

12.【推薦】如果修改欄位含義或對欄位表示的狀態追加時，需要及時更新欄位註釋。

13.【推薦】欄位允許適當冗餘，以提高效能，但是必須考慮資料同步的情況。冗餘欄位應遵循：

1）   不是頻繁修改的欄位。

2）   不是varchar超長欄位，更不能是text欄位。

正例：各業務線經常冗餘儲存商品名稱，避免查詢時需要呼叫IC服務獲取。

14.【推薦】單錶行數超過500萬行或者單表容量超過2GB，才推薦進行分庫分表。

說明：如果預計三年後的資料量根本達不到這個級別，請不要在建立表時就分庫分表。

反例：某業務三年總資料量才2萬行，卻分成1024張表，問：你為什麼這麼設計？答：分1024 張表，不是標配嗎？

15.【參考】合適的字元儲存長度，不但節約資料庫表空間、節約索引儲存，更重要的是提升檢索速度。

正例：人的年齡用unsigned tinyint（表示範圍0-255，人的壽命不會超過255歲）；海龜就必須是smallint，但如果是太陽的年齡，就必須是int；如果是所有恆星的年齡都加起來，那麼就必須使用bigint。

(二) 索引規約

 

1.【強制】業務上具有唯一特性的欄位，即使是組合欄位，也必須建成唯一索引。

說明：不要以為唯一索引影響了insert速度，這個速度損耗可以忽略，但提高查詢速度是明顯的；另外，即使在應用層做了非常完善的校驗和控制，只要沒有唯一索引，根據墨菲定律，必然有髒資料產生。

2.【強制】超過三個表禁止join。需要join的欄位，資料型別保持絕對一致；多表關聯查詢時，保證被關聯的欄位需要有索引。

說明：即使雙表join也要注意表索引、SQL效能。

3.【強制】在varchar欄位上建立索引時，必須指定索引長度，沒必要對全欄位建立索引，根據實際文字區分度決定索引長度。

說明：索引的長度與區分度是一對矛盾體，一般對字串型別資料，長度為20的索引，區分度會高達90%以上，可以使用count(distinct left(列名, 索引長度))/count(*)的區分度來確定。

4.【強制】頁面搜尋嚴禁左模糊或者全模糊，如果需要請走搜尋引擎來解決。

說明：索引檔案具有B-Tree的最左字首匹配特性，如果左邊的值未確定，那麼無法使用此索引。

5.【推薦】如果有order by的場景，請注意利用索引的有序性。order by 最後的欄位是組合索引的一部分，並且放在索引組合順序的最後，避免出現file_sort的情況，影響查詢效能。

正例：where a=? and b=? order by c; 索引：a_b_c

反例：索引中有範圍查詢，那麼索引有序性無法利用，如：WHERE a>10ORDER BY b; 索引a_b 無法排序。

6.【推薦】利用覆蓋索引來進行查詢操作，來避免回表操作。

說明：如果一本書需要知道第11章是什麼標題，會翻開第11章對應的那一頁嗎？目錄瀏覽一下就好，這個目錄就是起到覆蓋索引的作用。

正例：IDB能夠建立索引的種類：主鍵索引、唯一索引、普通索引，而覆蓋索引是一種查詢的一種效果，用explain的結果，extra列會出現：using index.

7.【推薦】利用延遲關聯或者子查詢優化超多分頁場景。

說明：MySQL並不是跳過offset行，而是取offset+N行，然後返回放棄前offset行，返回N 行，那當offset特別大的時候，效率就非常的低下，要麼控制返回的總頁數，要麼對超過特定閾值的頁數進行SQL改寫。

正例：先快速定位需要獲取的id段，然後再關聯：

      SELECT a.*FROM 表1 a, (select id from表1 where 條件 LIMIT 100000,20 )bwhere a.id=b.id

8.【推薦】 SQL效能優化的目標：至少要達到range 級別，要求是ref級別，如果可以是consts 最好。說明：

1）   consts 單表中最多隻有一個匹配行（主鍵或者唯一索引），在優化階段即可讀取到資料。

2）   ref 指的是使用普通的索引。（normalindex）

3）   range 對索引進範圍檢索。

反例：explain表的結果，type=index，索引物理檔案全掃描，速度非常慢，這個index級別比較range還低，與全表掃描是小巫見大巫。

9.【推薦】建組合索引的時候，區分度最高的在最左邊。

正例：如果where a=? and b=? ，a列的幾乎接近於唯一值，那麼只需要單建idx_a索引即可。說明：存在非等號和等號混合判斷條件時，在建索引時，請把等號條件的列前置。如：where a>?

and b=? 那麼即使a的區分度更高，也必須把b放在索引的最前列。

10.【參考】建立索引時避免有如下極端誤解：

1）   誤認為一個查詢就需要建一個索引。

2）   誤認為索引會消耗空間、嚴重拖慢更新和新增速度。

3）    誤認為唯一索引一律需要在應用層通過“先查後插”方式解決。

(三) SQL規約

 

1.【強制】不要使用count(列名)或count(常量)來替代count(*)，count(*)就是SQL92定義的標準統計行數的語法，跟資料庫無關，跟NULL和非NULL無關。

說明：count(*)會統計值為NULL的行，而count(列名)不會統計此列為NULL值的行。

2.【強制】count(distinct col) 計算該列除NULL之外的不重複數量。注意 count(distinct col1, col2) 如果其中一列全為NULL，那麼即使另一列有不同的值，也返回為0。

3.【強制】當某一列的值全是NULL時，count(col)的返回結果為0，但sum(col)的返回結果為

NULL，因此使用sum()時需注意NPE問題。

正例：可以使用如下方式來避免sum的NPE問題：SELECTIF(ISNULL(SUM(g)),0,SUM(g)) FROMtable;

4.【強制】使用ISNULL()來判斷是否為NULL值。注意：NULL與任何值的直接比較都為NULL。

說明：

1）    NULL<>NULL的返回結果是NULL，不是false。

2）    NULL=NULL的返回結果是NULL，不是true。

3）    NULL<>1的返回結果是NULL，而不是true。

5. 【強制】在程式碼中寫分頁查詢邏輯時，若count為0應直接返回，避免執行後面的分頁語句。

6.【強制】不得使用外來鍵與級聯，一切外來鍵概念必須在應用層解決。

說明：（概念解釋）學生表中的student_id是主鍵，那麼成績表中的student_id則為外來鍵。

如果更新學生表中的student_id，同時觸發成績表中的student_id更新，則為級聯更新。外來鍵與級聯更新適用於單機低併發，不適合分散式、高併發叢集；級聯更新是強阻塞，存在資料庫更新風暴的風險；外來鍵影響資料庫的插入速度。

7.【強制】禁止使用儲存過程，儲存過程難以除錯和擴充套件，更沒有移植性。

8.【強制】IDB資料訂正時，刪除和修改記錄時，要先select，避免出現誤刪除，確認無誤才能提交執行。

9.【推薦】in操作能避免則避免，若實在避免不了，需要仔細評估in後邊的集合元素數量，控制在1000個之內。

10.【參考】因阿里巴巴全球化需要，所有的字元儲存與表示，均以utf-8編碼，那麼字元計數方法注意：

說明：

   SELECT LENGTH("阿里巴巴")； 返回為12

   SELECTCHARACTER_LENGTH("阿里巴巴")；返回為4

    如果要使用表情，那麼使用utfmb4來進行儲存，注意它與utf-8編碼。

11.【參考】TRUNCATE TABLE 比 DELETE 速度快，且使用的系統和事務日誌資源少，但TRUNCATE 無事務且不觸發trigger，有可能造成事故，故不建議在開發程式碼中使用此語句。

說明：TRUNCATETABLE 在功能上與不帶 WHERE 子句的 DELETE 語句相同。

(四) ORM規約

 

1.【強制】在表查詢中，一律不要使用 * 作為查詢的欄位列表，需要哪些欄位必須明確寫明。

說明：1）增加查詢分析器解析成本。2）增減欄位容易與resultMap配置不一致。

2.【強制】POJO類的boolean屬性不能加is，而資料庫欄位必須加is_，要求在resultMap中進行欄位與屬性之間的對映。

說明：參見定義POJO類以及資料庫欄位定義規定，在sql.xml增加對映，是必須的。

3.【強制】不要用resultClass當返回引數，即使所有類屬性名與資料庫欄位一一對應，也需要定義；反過來，每一個表也必然有一個與之對應。

說明：配置對映關係，使欄位與DO類解耦，方便維護。

4. 【強制】xml配置中引數注意使用：#{}，#param#不要使用${} 此種方式容易出現SQL注入。

5.【強制】iBATIS自帶的queryForList(StringstatementName,intstart,int size)不推薦使用。

說明：其實現方式是在資料庫取到statementName對應的SQL語句的所有記錄，再通過subList 取start,size的子集合，線上因為這個原因曾經出現過OOM。

 

 

 

正例：在sqlmap.xml中引入 #start#, #size#

Map<String, Object> map = newHashMap<String,Object>();   map.put("start",start);    map.put("size",size);   

6.【強制】不允許直接拿HashMap與HashTable作為查詢結果集的輸出。

反例：某同學為避免寫一個<resultMap>，直接使用HashTable來接收資料庫返回結果，結果出現日常是把bigint轉成Long值，而線上由於資料庫版本不一樣，解