接口和實(shí)現(xiàn)類的命名有兩套規(guī)則:
1)【強(qiáng)制】對(duì)于?Service?和?DAO?類,基于?SOA?的理念,暴露出來(lái)的服務(wù)一定是接口,內(nèi)部
的實(shí)現(xiàn)類用?Impl?的后綴與接口區(qū)別。正例:CacheServiceImpl?實(shí)現(xiàn)?CacheService?接口。
2)【推薦】 如果是形容能力的接口名稱,取對(duì)應(yīng)的形容詞做接口名(通常是–able?的形式)。正例:AbstractTranslator?實(shí)現(xiàn)Translatable。
【參考】枚舉類名建議帶上?Enum?后綴,枚舉成員名稱需要全大寫(xiě),單詞間用下劃線隔開(kāi)。說(shuō)明:枚舉其實(shí)就是特殊的常量類,且構(gòu)造方法被默認(rèn)強(qiáng)制是私有。正例:枚舉名字:DealStatusEnum,成員名稱:SUCCESS?/?UNKOWN_REASON。
?【參考】各層命名規(guī)約:
A) Service/DAO層方法命名規(guī)約
1)?獲取單個(gè)對(duì)象的方法用get做前綴。
2)?獲取多個(gè)對(duì)象的方法用list做前綴。
3)?獲取統(tǒng)計(jì)值的方法用count做前綴。
4)?插入的方法用save(推薦)或insert做前綴。
5)?刪除的方法用remove(推薦)或delete做前綴。6)?修改的方法用update做前綴。
B)?領(lǐng)域模型命名規(guī)約
1)?數(shù)據(jù)對(duì)象:xxxDO,xxx即為數(shù)據(jù)表名。
2)?數(shù)據(jù)傳輸對(duì)象:xxxDTO,xxx為業(yè)務(wù)領(lǐng)域相關(guān)的名稱。3)?展示對(duì)象:xxxVO,xxx一般為網(wǎng)頁(yè)名稱。
4)?POJO是DO/DTO/BO/VO的統(tǒng)稱,禁止命名成xxxPOJO。