1 package com.zjk.core;
  2 
  3 import java.util.Date;
  4 import java.util.List;
  5 
  6 public class a1_NameStyle {
  7     public static void main(String[] args) {
  8         System.out.println(ConstantThis.MAX_STOCK_COUNT);
  9     }
 10 
 11     /**
 12      * 1. 【強制】程式碼中的命名均不能以下劃線或美元符號開始，也不能以下劃線或美元符號結束。
 
 13      * 反例：_name / __name / $name / name_ / name$ / name__
 14      */
 15     private void name(){
 16         String name;
 17     }
 18 
 19     /**
 20      * 2. 【強制】所有程式設計相關的命名嚴禁使用拼音與英文混合的方式，更不允許直接使用中文的方式。
 21      * 說明：正確的英文拼寫和語法可以讓閱讀者易於理解，避免歧義。注意，純拼音命名方式更要避免採用。
 22      * 正例：ali / alibaba / taobao / cainiao/ aliyun/ youku / hangzhou 等國際通用的名稱，可視同英文。
 
 23      * 反例：DaZhePromotion [打折] / getPingfenByName() [評分] / int 某變數 = 3
 24      */
 25     private void nameEnCn(){
 26         String alibaba;
 27         String taobao;
 28     }
 29 }
 30 
 31 /**
 32  * 3. 【強制】類名使用UpperCamelCase風格，但以下情形例外：DO / BO / DTO / VO / AO / PO / UID等。
 33  * 正例：ForceCode / UserDO / HtmlDTO / XmlService / TcpUdpDeal / TaPromotion
 
 34  * 反例：forcecode / UserDo / HTMLDto / XMLService / TCPUDPDeal / TAPromotion
 35  */
 36 class UserDO {
 37     private Integer id;
 38     private String name;
 39 
 40     /**
 41      * 4. 【強制】方法名、引數名、成員變數、區域性變數都統一使用lowerCamelCase風格。
 42      * 正例： localValue / getHttpMessage() / inputUserId
 43      */
 44     public Integer getId() {
 45         return id;
 46     }
 47 
 48     public void setId(Integer id) {
 49         this.id = id;
 50     }
 51 
 52     public String getName() {
 53         return name;
 54     }
 55 
 56     public void setName(String name) {
 57         this.name = name;
 58     }
 59 
 60 }
 61 
 62 /**
 63  *5. 【強制】常量命名全部大寫，單詞間用下劃線隔開，力求語義表達完整清楚，不要嫌名字長。
 64  * 正例：MAX_STOCK_COUNT / CACHE_EXPIRED_TIME
 65  * 反例：MAX_COUNT / EXPIRED_TIME
 66  */
 67 interface ConstantThis{
 68     final Integer MAX_STOCK_COUNT=1000;
 69 }
 70 
 71 /**
 72  *6. 【強制】抽象類命名使用Abstract或Base開頭；
 73  * 異常類命名使用Exception結尾；
 74  * 測試類命名以它要測試的類的名稱開始，以Test結尾。
 75  */
 76 abstract class AbstractClassThis{}
 77 class MessageException{}
 78 class MessageTest{}
 79 
 80 /**
 81  *7. 【強制】型別與中括號緊挨相連來表示陣列。
 82  * 正例：定義整形陣列int[] arrayDemo;
 83  * 反例：在main引數中，使用String args[]來定義。
 84  */
 85 class User1{
 86     int[] arrayDemo;
 87     String[] args;
 88 
 89     /**
 90      *8. 【強制】POJO類中的任何布林型別的變數，都不要加is字首，否則部分框架解析會引起序列化錯誤。
 91      * 說明：在本文MySQL規約中的建表約定第一條，表達是與否的值採用is_xxx的命名方式，所以，需要在<resultMap>設定從is_xxx到xxx的對映關係。
 92      * 反例：定義為基本資料型別Boolean isDeleted的屬性，它的方法也是isDeleted()，框架在反向解析的時候，“誤以為”對應的屬性名稱是deleted，
 93      * 導致屬性獲取不到，進而丟擲異常
 94      */
 95     /// MySQL中使用
 96 //    boolean is_female;
 97     boolean female;
 98 }
 99 
100 /**
101  * 9. 【強制】包名統一使用小寫，點分隔符之間有且僅有一個自然語義的英語單詞。
102  * 包名統一使用單數形式，但是類名如果有複數含義，類名可以使用複數形式。
103  * 正例：應用工具類包名為com.alibaba.ei.kunlun.aap.util、類名為MessageUtils（此規則參考spring的框架結構）
104  */
105 class GetDateUtils{
106     String packageName="com.alibaba.ei.kunlun.aap.util";
107 }
108 
109 /**
110  * 10. 【強制】避免在子父類的成員變數之間、或者不同程式碼塊的區域性變數之間採用完全相同的命名，使可讀性降低。
111  * 說明：子類、父類成員變數名相同，即使是public型別的變數也是能夠通過編譯，而區域性變數在同一方法內的不同程式碼塊中同名也是合法的，但是要避免使用。
112  * 對於非setter/getter的引數名稱也要避免與成員變數名稱相同。
113  */
114 class ConfusingName {
115     public int stock;
116     boolean condition=true;
117     // 非setter/getter的引數名稱，不允許與本類成員變數同名
118     public void get(String alibaba) {
119         if (condition) {
120             final int money = 666;
121             // ...
122         }
123         for (int i = 0; i < 10; i++) {
124             // 在同一方法體中，不允許與其它程式碼塊中的money命名相同
125             final int money = 15978;
126             // ...
127         }
128     }
129 }
130 
131 class Son extends ConfusingName {
132     // 不允許與父類的成員變數名稱相同
133     public int stock;
134 }
135 
136 /**
137  *11. 【強制】杜絕完全不規範的縮寫，避免望文不知義。
138  * 反例：AbstractClass“縮寫”命名成AbsClass；condition“縮寫”命名成 condi，此類隨意縮寫嚴重降低了程式碼的可閱讀性。
139  */
140 abstract class AbstractClass{
141     String condition;
142 }
143 
144 /**
145  * 12. 【推薦】為了達到程式碼自解釋的目標，任何自定義程式設計元素在命名時，使用盡量完整的單詞組合來表達。
146  * 正例：在JDK中，對某個物件引用的volatile欄位進行原子更新的類名為：AtomicReferenceFieldUpdater。
147  * 反例：常見的方法內變數為int a;的定義方式。
148  */
149 class AtomicReferenceFieldUpdater{}
150 
151 /**
152  *13. 【推薦】在常量與變數的命名時，表示型別的名詞放在詞尾，以提升辨識度。
153  * 正例：startTime / workQueue / nameList / TERMINATED_THREAD_COUNT
154  * 反例：startedAt / QueueOfWork / listName / COUNT_TERMINATED_THREAD
155  */
156 interface ConstantThis2{
157     final Date startTime = new Date();
158 }
159 
160 /**
161  *14. 【推薦】如果模組、介面、類、方法使用了設計模式，在命名時需體現出具體模式。
162  * 說明：將設計模式體現在名字中，有利於閱讀者快速理解架構設計理念。
163  * 正例： public class OrderFactory; public class LoginProxy; public class ResourceObserver;
164  */
165 class OrderFactory{}
166 class LoginProxy{}
167 class ResourceObserver{}
168 
169 /**
170  *16. 介面和實現類的命名有兩套規則：
171  * 1）【強制】對於Service和DAO類，基於SOA的理念，暴露出來的服務一定是介面，內部的實現類用Impl的字尾與介面區別。
172  * 正例：CacheServiceImpl實現CacheService介面。
173  * 2）【推薦】如果是形容能力的介面名稱，取對應的形容詞為介面名（通常是–able的形容詞）。
174  * 正例：AbstractTranslator實現 Translatable介面。
175  */
176 interface UserService{}
177 class UserServiceImpl implements UserService{}
178 
179 /**
180  *15. 【推薦】介面類中的方法和屬性不要加任何修飾符號（public 也不要加），保持程式碼的簡潔性，並加上有效的Javadoc註釋。
181  * 儘量不要在接口裡定義變數，如果一定要定義變數，確定與介面方法相關，並且是整個應用的基礎常量。
182  * 正例：介面方法簽名 void commit(); 介面基礎常量 String COMPANY = "alibaba";
183  * 反例：介面方法定義 public abstract void f();
184  * 說明：JDK8中介面允許有預設實現，那麼這個default方法，是對所有實現類都有價值的預設實現。
185  */
186 
187 /**
188  * @author:zjk
189  * @version:1.0v
190  */
191 interface UserDao{
192 
193     /**
194      * 18. 【參考】各層命名規約：
195      * A) Service/DAO層方法命名規約
196      * 1） 獲取單個物件的方法用get做字首。
197      * 2） 獲取多個物件的方法用list做字首，複數結尾，如：listObjects。
198      * 3） 獲取統計值的方法用count做字首。
199      * 4） 插入的方法用save/insert做字首。
200      * 5） 刪除的方法用remove/delete做字首。
201      * 6） 修改的方法用update做字首。
202      */
203 
204     /**
205      * 通過id獲取UserDO資訊
206      * @param id
207      * @return userDO
208      */
209     UserDO getUserById(Integer id);
210     List<UserDO> listAllUsers();
211     Integer countAllUsers();
212     void insertUser(UserDO userDO);
213     void deleteUserById(Integer id);
214     void updateUser(UserDO userDO);
215 }
216 
217 /**
218  * B) 領域模型命名規約
219  * 1） 資料物件：xxxDO，xxx即為資料表名。
220  * 2） 資料傳輸物件：xxxDTO，xxx為業務領域相關的名稱。
221  * 3） 展示物件：xxxVO，xxx一般為網頁名稱。
222  * 4） POJO是DO/DTO/BO/VO的統稱，禁止命名成xxxPOJO。
223  */
224 class DepartmentDO{}
225 class DepartmentDTO{}
226 class RegistVO{}
227 
228 /**
229  * 17. 【參考】列舉類名帶上Enum字尾，列舉成員名稱需要全大寫，單詞間用下劃線隔開。
230  * 說明：列舉其實就是特殊的常量類，且構造方法被預設強制是私有。
231  * 正例：列舉名字為ProcessStatusEnum的成員名稱：SUCCESS / UNKNOWN_REASON。
232  */
233 enum UserTypeEnum{}

原始檔地址：阿里巴巴Java開發手冊（泰山版）.pdf