阿里Java开发规范记录(一)
近日,從網上下載了阿里云棲社區發布的《阿里巴巴Java開發手冊(正式版)》v1.1.0版。從編程以來,一直苦于沒有相關的、全面的、靠譜的規范可以參考,有了這手冊,日后編程也算是找到了依據。瞧,人家阿里都是按照這規則來操作的!
云棲社區此舉對于普通Java開發者來說,算是功德無量,在一定程度上規范了Java開發者的編程習慣。為后來者謀福利了。
這本手冊一共分為五個部分,包括了編程規約、異常日志、MySQL規約、工程規約、安全規約。基本上從編碼的各個方面都細細的理了一遍,感覺完全可以當做是公司招人的面試題,用來考較對方的編碼習慣,甚至也能在一定程度上能推斷出對方的編碼水平,畢竟高的編碼水平,其編碼習慣肯定不會差到哪去。
手冊的內容約束分為三種級別,分別為強制、推薦、參考。強制,即必須遵從的編碼規范;推薦,則表示最好遵從該規范,有利于提高代碼水平;參考,則表示需要了解即可。
花了一個上午,仔細地將這篇手冊閱讀了一番,結果只看了編程規約這部分,從中摘錄了一些規約,我覺得日后在編碼過程中需要注意及提升的地方。
命名規約
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。
點評:因為公司人來人往的緣故,對方法的命名從來都是自己按照自己的那套玩。就我個人習慣而言,只要是獲取對象全部都是get做前綴,阿里的這種做法的確可以用來參考參考。
OOP規約
說明: 在方法執行拋出異常時,可以直接調用 POJO 的 toString()方法打印其屬性值,便于排查問題。
說明: 擴展說一下 PECS(Producer Extends Consumer Super)原則: 1) 頻繁往外讀取內容的,適合用上界 Extends。 2) 經常往里插入的,適合用下界 Super。
總結
以上是生活随笔為你收集整理的阿里Java开发规范记录(一)的全部內容,希望文章能夠幫你解決所遇到的問題。
- 上一篇: python基本知识点if、while、
- 下一篇: 2014年百度之星资格赛第一题Energ