包名全部小寫

類名的命名要遵循首字母大寫原則

的名字必須由大寫字母開頭而單詞中的其他字母均為小寫；

如果一個類名稱是由多個單詞組成，則每個單詞的首字母均應為大寫例如ModelWhAction；

如果類名稱中包含單詞縮寫，則這個所寫詞的每個字母均應大寫，如：XMLExample,還有一點命名技巧就是由于類是設計用來代表對象的，所以在命名類時應盡量選擇名詞

類名、接口名使用UpperCamelCase風格，必須遵從駝峰形式，但以下情形例外：DO/BO/DTO/VO/AO/PO/UID等。

方法名、參數名、成員變量、局部變量都統一使用lowerCamelCase風格，必須遵從駝峰形式。

常量命名全部大寫，單詞間用下劃線隔開，力求語義表達完整清楚，不要嫌名字長

定義數組時，類型與中括號緊挨相連

int[] array = new int[10];

int array[] = new int[10]; // 不建議這樣寫

抽象類命名使用 Abstract 或 Base 開頭；異常類命名使用 Exception 結尾；測試類命名以它要測試的類的名稱開始，以 Test 結尾

AbstractService/CommonException/DemoTest

如果模塊、 接口、類、方法使用了設計模式，在命名時需體現出具體模式

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

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

對于 Service 和 DAO 類，基于 SOA的理念，暴露出來的服務一定是接口，內部的實現類用Impl 的后綴與接口區別。

正例：CacheServiceImpl實現CacheService接口

如果是形容能力的接口名稱，取對應的形容詞為接口名（通常是–able 的形容詞）。

正例：JDK中的Comparable接口

在long或者Long賦值時，數值后使用大寫的 L，不能是小寫的 l，小寫容易跟數字 1 混淆，造成誤解。

明：Long a = 2l；寫的是數字的 21，還是 Long 型的 2 ？？

不允許任何魔法值（即未經預先定義的常量）直接出現在代碼中

正例：

public static final ORDER_REDIS_KEY_PREFIX = "orderId_";
String orderRedisKey = ORDER_REDIS_KEY_PREFIX + orderId;
反例：

String redisKey = "orderId_" + orderId;

枚舉類名帶上Enum后綴，枚舉成員名稱需要全大寫，單詞間用下劃線隔開。

正例：枚舉名字為ProcessStatusEnum的成員名稱：SUCCESS / UNKNOWN_REASON

總結

以上是生活随笔為你收集整理的命名规范的全部內容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網站內容還不錯，歡迎將生活随笔推薦給好友。