目錄
文件命名
控制器:Controller目錄,xxxController
業務邏輯層:Service目錄,xxxService,ServiceImpl目錄,xxxServiceImpl
數據持久化對象:Dao或Mapper目錄,xxxDao,xxxMapper, xxx數據表名
數據傳輸對象:DTO目錄,爲了更簡潔高效的傳輸整合出的對象
展示對象:VO目錄
表對應的實體類:DO或PO或entity目錄,表名命名
業務對象:BO目錄,抽象業務中的事物
其他的:common 公共目錄,util或tool 工具目錄,config 配置類目錄,component Spring的組件目錄,enums 枚舉類目錄,request包裝入參類目錄,response包裝響應類目錄,constant定義常量
resources資源路徑中,config放配置文件,mapper放mybatis映射文件,static放靜態資源,templates放html頁面,名字基本上是固定的,換個名字Springboot找不到了。
方法命名駝峯命名法,表意完整的單詞,類似get、find、load、insert、delete、update、select、save等,不同類中功能近似的方法可以用一樣的名字,同一業務的儘量用同樣的前綴或後綴。
註釋
方法註釋 /**+回車,自動生成入參和返回值,類註釋也一樣
註釋裏@xxx是標籤,格式化了解釋說明文字,不是註解。
常用的標籤:
@author:作者
@param:參數
@return 返回
@see 引用,其他文件或類的路徑
@version 類的版本號
代碼規約
IDEA環境開發,基本的代碼縮進依照編譯器推薦的 Ctrl+Alt+L,如果沒有代碼語法錯誤,這個格式足夠美觀清晰。
不能有任何常量直接出現在代碼中,反例:"86"+phone,不利於維護,有專門放常量的類或枚舉類。
單行字符不要超過120個,第二行縮進4空格,後面的跟第二行對齊,運算符等連接符號跟下文,逗號跟上文,括號前不換行,IDEA較新的版本有一根豎輔助線。