背景：公司開發(fā)新項目，小組幾個人共同開發(fā)，平時也沒特意規(guī)定，簡單寫個約規(guī)；

說明：本文簡單羅列一些常見的Java編碼規(guī)范，目的是使大家編碼風(fēng)格保持一致。
便于項目維護，所有約規(guī)不強制，但要有這個意識；

一、注釋
1、類注釋，包括Controller層、Service層等；
2、方法注釋，所有接口及公私有方法；
3、代碼邏輯塊中盡量有點注釋；

二、提交規(guī)范
1、冗余的類、方法、代碼塊盡量都刪除；
2、無效的import，idea設(shè)置勿用import xxx.xxx.*；
3、提交注釋參考公司規(guī)范要求；

三、編碼風(fēng)格
1、接口之間盡量解耦，不共用請求、響應(yīng)類，每個接口都應(yīng)該有請求響應(yīng)體；
2、常量盡量定義在常量類中；
3、多張表的更新根據(jù)情況考慮使用事務(wù)，但@Transactional事務(wù)不要濫用，事務(wù)會影響數(shù)據(jù)庫的 QPS；
4、非必要的業(yè)務(wù)邏輯單獨提取出來，考慮用異步注解@Async修飾；
5、判空統(tǒng)一使用工具類方法；
6、相同之處的代碼優(yōu)先考慮提取公共方法；

四、命名規(guī)范
1、獲取單個對象的方法用 get 做前綴，例："getXXX"；
2、獲取多個對象的方法用 list 做前綴，例："getXXXList"；
3、獲取統(tǒng)計值的方法用 count 做前綴，例："getXXXCount"；
4、插入的方法用 insert 或 save 做前綴，例："insertXXX"；
5、刪除的方法用 delete 或 remove 做前綴，例："deleteXXX"；
6、修改的方法用 update 或 modify 做前綴，例："updateXXX"；

五、日志規(guī)范
1、某些關(guān)鍵或經(jīng)常報錯或邏輯復(fù)雜的方法的入口出口，或者某些業(yè)務(wù)代碼塊可適當加些日志，避免因加日志而產(chǎn)生的報錯。
例：入口、出口加info級別日志()，代碼塊中debug級別；
2、catch中異常日志要打印出來，加error級別日志；

?

總結(jié)

以上是生活随笔為你收集整理的Java编码规范总结的全部內(nèi)容，希望文章能夠幫你解決所遇到的問題。

如果覺得生活随笔網(wǎng)站內(nèi)容還不錯，歡迎將生活随笔推薦給好友。