http://fls.jetbrains-agent.com
- 編碼常規項
- 代碼是否內存泄漏,是否UI成紅色,是否性能低下,是否會形成crash
- 各種異常邏輯是否處理
- 代碼能夠工作麼?它有沒有實現預期的功能,邏輯是否正確等。
- 所有的代碼是否簡單易懂?
- 代碼符合你所遵循的編程規範麼?這通常包括大括號的位置,變量名和函數名,行的長度,縮進,格式和註釋。
- 是否存在多餘的或是重複的代碼?
- 代碼是否儘可能的模塊化了?
- 是否有可以被替換的全局變量?
- 是否有被註釋掉的代碼?
- 循環是否設置了長度和正確的終止條件?
- 是否有可以被庫函數替代的代碼?
- 是否有可以刪除的日誌或調試代碼?
安裝Alibaba Java Code Guidelines插件
可以通過直接通過Jetbrians官方倉庫安裝,由於網絡關係,這裏選擇手工安裝方式
1)、下載最新版本「Alibaba Java Coding Guidelines插件」
http://plugins.jetbrains.com/plugin/10046-alibaba-java-coding-guidelines/versions
2)、IntelliJ IDEA → Preference→Plugins,選擇「install Plugin from Disk...」完成後,選擇重啓IntelliJ IDEA。
2.代碼規範
- Service/DAO層方法命名規約
1)獲取單個對象的方法用get做前綴。
2)獲取多個對象的方法用list做前綴。
3)獲取統計值的方法用count做前綴。
4)插入的方法用save/insert做前綴。
5)刪除的方法用remove/delete做前綴。
6)修改的方法用update做前綴。
- 領域模型命名規約
1)數據對象:xxxDO,xxx即爲數據表名。
2)數據傳輸對象:xxxDTO,xxx爲業務領域相關的名稱。
3)展示對象:xxxVO,xxx一般爲網頁名稱。
4)POJO是DO/DTO/BO/VO的統稱,禁止命名成xxxPOJO
- 枚舉類名建議帶上Enum後綴,枚舉成員名稱需要全大寫,單詞間用下劃線隔開。
說明:枚舉其實就是特殊的常量類,且構造方法被默認強制是私有。正例:枚舉名字爲ProcessStatusEnum的成員名稱:SUCCESS/ UNKOWN_REASON。
- 採用4個空格縮進,禁止使用tab字符。
說明:如果使用tab縮進,必須設置1個tab爲4個空格。IDEA設置tab爲4個空格時,請勿勾選Use tab character;而在eclipse中,必須勾選insert spaces for tabs。
- 建表規約
1.【強制】表達是與否概念的字段,必須使用is_xxx的方式命名,數據類型是unsignedtinyint(1表示是,0表示否)。
說明:任何字段如果爲非負數,必須是unsigned。正例:表達邏輯刪除的字段名is_deleted,1表示刪除,0表示未刪除。
2.【強制】表名、字段名必須使用小寫字母或數字,禁止出現數字開頭,禁止兩個下劃線中間只出現數字。數據庫字段名的修改代價很大,因爲無法進行預發佈,所以字段名稱需要慎重考慮。
說明:MySQL在Windows下不區分大小寫,但在Linux下默認是區分大小寫。因此,數據庫名、表名、字段名,都不允許出現任何大寫字母,避免節外生枝。正例:aliyun_admin,rdc_config,level3_name反例:AliyunAdmin,rdcConfig,level_3_name
3.【強制】表名不使用複數名詞。
說明:表名應該僅僅表示表裏面的實體內容,不應該表示實體數量,對應於DO類名也是單數形式,符合表達習慣。
4.【強制】禁用保留字,如desc、range、match、delayed等,請參考MySQL官方保留字。
5.【強制】主鍵索引名爲pk_字段名;唯一索引名爲uk_字段名;普通索引名則爲idx_字段名。說明:pk_ 即primary key;uk_ 即uniquekey;idx_ 即index的簡稱。
6.【強制】小數類型爲decimal,禁止使用float和double。說明:float和double在存儲的時候,存在精度損失的問題,很可能在值的比較時,得到不正確的結果。如果存儲的數據範圍超過decimal的範圍,建議將數據拆成整數和小數分開存儲。
7.【強制】如果存儲的字符串長度幾乎相等,使用char定長字符串類型。
8.【強制】varchar是可變長字符串,不預先分配存儲空間,長度不要超過5000,如果存儲長度大於此值,定義字段類型爲text,獨立出來一張表,用主鍵來對應,避免影響其它字段索引效率。
9.【強制】表必備三字段:id, gmt_create, gmt_modified。說明:其中id必爲主鍵,類型爲unsigned bigint、單表時自增、步長爲1。gmt_create, gmt_modified的類型均爲date_time類型,前者現在時表示主動創建,後者過去分詞表示被動更新。
10.【推薦】表的命名最好是加上“業務名稱_表的作用”。正例:alipay_task/ force_project/ trade_config
12.【推薦】如果修改字段含義或對字段表示的狀態追加時,需要及時更新字段註釋。
13.【推薦】字段允許適當冗餘,以提高查詢性能,但必須考慮數據一致。冗餘字段應遵循:1)不是頻繁修改的字段。2)不是varchar超長字段,更不能是text字段。正例:商品類目名稱使用頻率高,字段長度短,名稱基本一成不變,可在相關聯的表中冗餘存儲類目名稱,避免關聯查詢。
15.【參考】合適的字符存儲長度,不但節約數據庫表空間、節約索引存儲,更重要的是提升檢索速度