資訊專欄INFORMATION COLUMN
摘要：一命名規(guī)則類名和接口使用意義完整的英文描述，每個(gè)英文單詞的首字母使用大寫其余字母使用小寫的大小寫混合法。在內(nèi)部規(guī)劃好包名的范圍，防止產(chǎn)生沖突。示例常量名使用全大寫的英文描述，英文單詞之間用下劃線分隔開，并且使用修飾。
一 命名規(guī)則
類名和接口使用意義完整的英文描述，每個(gè)英文單詞的首字母使用大寫、其余字母使用小寫的大小寫混合法。
示例：
OrderInformation, CustomerList, LogManager, LogConfig, SmpTransaction
方法名使用意義完整的英文描述：第一個(gè)單詞的字母使用小寫、剩余單詞首字母大寫其余字母小寫的大小寫混合法。
示例：
private void calculateRate(); public void addNewOrder();
包名采用域名倒置加上自定義的包名，采用小寫字母。在內(nèi)部規(guī)劃好包名的范圍，防止產(chǎn)生沖突。部門內(nèi)部產(chǎn)品使用部門名加上模塊名稱。產(chǎn)品線的產(chǎn)品使用產(chǎn)品的名稱加行模塊的名稱
格式：
com.dmall.產(chǎn)品名.模塊名 com.dmall.部門名稱.項(xiàng)目名稱
示例：
商品系統(tǒng)lighthouse：com.dmall.ware.lighthouse 通用消息：com.dmall.dafka
方法中，存取屬性的方法采用setter 和 getter方法，動(dòng)作方法采用動(dòng)詞和動(dòng)賓結(jié)構(gòu)。
格式：
get + 非布爾屬性名() is + 布爾屬性名() set + 屬性名() 動(dòng)詞() 動(dòng)詞 + 賓語()
示例：
public String getType(); public boolean isFinished(); public void setVisible(boolean); public void show(); public void addKeyListener(Listener);
屬性名使用意義完整的英文描述，第一個(gè)單詞的字母使用小寫，剩余單詞首字母大寫其余字母小寫的大小寫混合法。屬性名不能與方法名相同。
示例：
private customerName; private orderNumber;
常量名使用全大寫的英文描述，英文單詞之間用下劃線分隔開，并且使用 static final修飾。
示例：
private static final int PAGE_COUNT = 1000; private static final Logger LOGGER = LoggerFactory.getLogger(CacheControlServiceImpl.class); public static final String DEFAULT_START_DATE = "2001-12-08";
屬性名可以和公有方法參數(shù)相同，不能和局部變量相同，引用非靜態(tài)變量。
抽象類命名使用 Abstract 或 Base 開頭;異常類命名使用 Exception 結(jié)尾;測(cè)試類 命名以它要測(cè)試的類的名稱開始，以 Test 結(jié)尾;枚舉用Enum結(jié)尾。
如果使用到了設(shè)計(jì)模式，建議在類名中體現(xiàn)出具體模式。
示例:
public class OrderFactory; public class LoginProxy; public class ResourceObserver;
通過對(duì)函數(shù)或過程、變量、結(jié)構(gòu)等正確的命名以及合理地組織代碼的結(jié)構(gòu)，使代碼成為自注釋的。增加代碼的可讀性，減少不必要的注釋。
常用組件類的命名以組件名加上組件類型名結(jié)尾。
示例：
Application 類型的，命名以App 結(jié)尾——MainApp Frame 類型的，命名以Frame 結(jié)尾——TopoFrame Panel 類型的，建議命名以Panel 結(jié)尾——CreateCircuitPanel Bean 類型的，建議命名以Bean 結(jié)尾——DataAccessBean EJB 類型的，建議命名以EJB 結(jié)尾——DBProxyEJB Applet 類型的，建議命名以Applet 結(jié)尾——PictureShowApplet
如果函數(shù)名超過15 個(gè)字母，可采用以去掉元音字母的方法或者以行業(yè)內(nèi)約定俗成的縮寫方式縮寫函數(shù)名。
示例:
getCustomerInformation() 改為 getCustomerInfo()
接口和實(shí)現(xiàn)類的命名規(guī)則
對(duì)于 Service 和 DAO 類，基于 SOA 的理念，暴露出來的服務(wù)一定是接口，內(nèi)部
的實(shí)現(xiàn)類用 Impl 的后綴與接口區(qū)別。
示例:
CacheServiceImpl 實(shí)現(xiàn) CacheService 接口。
如果是形容能力的接口名稱，取對(duì)應(yīng)的形容詞做接口名(通常是–able 的形式)。 示例:
AbstractTranslator 實(shí)現(xiàn) Translatable。
long 或者 Long 初始賦值時(shí)，必須使用大寫的 L，不能是小寫的 l，小寫容易跟數(shù)字 1 混淆，造成誤解。
示例:
Long a = 2l; 寫的是數(shù)字的21，還是Long型的2?
15.不要使用一個(gè)常量類維護(hù)所有常量，應(yīng)該按常量功能進(jìn)行歸類，分開維護(hù)。如:緩存 相關(guān)的常量放在類:CacheConsts 下;系統(tǒng)配置相關(guān)的常量放在類:ConfigConsts 下
各層命名規(guī)范
1)Service/DAO層方法命名規(guī)約
獲取單個(gè)對(duì)象的方法用get做前綴。
獲取多個(gè)對(duì)象的方法用list做前綴。
獲取統(tǒng)計(jì)值的方法用count做前綴。
插入的方法用save(推薦)或insert做前綴。
刪除的方法用remove(推薦)或delete做前綴。
修改的方法用update做前綴。
2)領(lǐng)域模型命名規(guī)約
數(shù)據(jù)對(duì)象:xxxDO，xxx即為數(shù)據(jù)表名。
數(shù)據(jù)傳輸對(duì)象:xxxDTO，xxx為業(yè)務(wù)領(lǐng)域相關(guān)的名稱。
展示對(duì)象:xxxVO，xxx一般為網(wǎng)頁名稱。
POJO是DO/DTO/BO/VO的統(tǒng)稱，禁止命名成xxxPOJO。
文章版權(quán)歸作者所有，未經(jīng)允許請(qǐng)勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。
轉(zhuǎn)載請(qǐng)注明本文地址：http://specialneedsforspecialkids.com/yun/70159.html
摘要：此處指定的虛擬機(jī)與平臺(tái)兼容，并支持語言規(guī)范中指定的編程語言。第章說明了虛擬機(jī)的指令集，按字母順序顯示操作碼助記符。 介紹 一點(diǎn)歷史 Java?編程語言是一種通用的、并發(fā)的、面向?qū)ο蟮恼Z言，它的語法類似于C和C++，但它省略了許多使C和C++復(fù)雜、混亂和不安全的特性。最初開發(fā)Java平臺(tái)是為了解決為聯(lián)網(wǎng)的消費(fèi)者設(shè)備構(gòu)建軟件的問題，它旨在支持多種主機(jī)架構(gòu)，并允許安全交付軟件組件，為了滿足這...
摘要：最近在看一本有關(guān)編程規(guī)范的書，書中精煉闡述了使用語言時(shí)應(yīng)該遵循的一些原則。所以擁有良好一致的編程規(guī)范對(duì)于一個(gè)團(tuán)隊(duì)至關(guān)重要。二堅(jiān)持最小驚奇原則在編碼過程中盡量避免可能讓軟件用戶感到意外的做法。 最近在看一本有關(guān)Java編程規(guī)范的書，書中精煉闡述了使用java語言時(shí)應(yīng)該遵循的一些原則。接下來的一段時(shí)間我將在這里總結(jié)我的學(xué)習(xí)內(nèi)容，也希望這一系列文章能夠?qū)τ行枰娜擞兴鶐椭?不考慮任何編碼規(guī)...
摘要：大家好，我是樂字節(jié)的小樂，這次要給大家?guī)淼氖亲兞颗c數(shù)據(jù)類型。本文是第一集編程規(guī)范，關(guān)鍵字與標(biāo)識(shí)符。后面我們要寫一個(gè)程序的過程。需求分析實(shí)現(xiàn)代碼體現(xiàn)注釋的作用解釋說明程序，提高了代碼的閱讀性。可以幫助我們調(diào)試程序。 大家好，我是樂字節(jié)的小樂，這次要給大家?guī)淼氖荍ava變量與數(shù)據(jù)類型。本文是第一集：Java編程規(guī)范，關(guān)鍵字與標(biāo)識(shí)符。showImg(https://segmentfaul...
摘要：二格式規(guī)范在上一篇的編程規(guī)范一中我們講述了在編碼中的一般原則，雖然這些原則并不涉及具體的代碼規(guī)范，但是這些原則卻是我們?cè)陂_發(fā)過程中所應(yīng)該遵循的規(guī)范與思想。不要把多個(gè)語句放在同一行里以免超過最大可接受寬度。 二、格式規(guī)范 在上一篇的java編程規(guī)范(一)中我們講述了在Java編碼中的一般原則，雖然這些原則并不涉及具體的代碼規(guī)范，但是這些原則卻是我們?cè)贘ava開發(fā)過程中所應(yīng)該遵循的規(guī)范與思...
摘要：在上一篇的編程風(fēng)格學(xué)習(xí)二中我們學(xué)習(xí)了一些在編碼過程中的格式規(guī)范，遵循這些規(guī)范毋庸置疑是我們的書寫高質(zhì)量代碼的前提與基礎(chǔ)。二語言編程規(guī)范常量命名常量的每個(gè)單詞均大寫，單詞之間使用下劃線連接。方法表示動(dòng)作，采用動(dòng)詞命名。 在上一篇的java編程風(fēng)格學(xué)習(xí)（二）中我們學(xué)習(xí)了一些在Java編碼過程中的格式規(guī)范，遵循這些規(guī)范毋庸置疑是我們的書寫高質(zhì)量代碼的前提與基礎(chǔ)。今天我們更進(jìn)一步，一起來學(xué)習(xí)J...
摘要：對(duì)變量對(duì)象或者函數(shù)等進(jìn)行命名時(shí)，選擇能清晰表達(dá)其用途的名字。其實(shí)，測(cè)試方法名應(yīng)該明確指出測(cè)試的內(nèi)容與條件。和這種命名方式是時(shí)代的前朝遺物。使用自己的異常類型筆者又一次錯(cuò)誤地認(rèn)為這一開發(fā)習(xí)慣是業(yè)內(nèi)的共識(shí)。 作為 Java 開發(fā)人員，我們會(huì)遵循一系列的編碼風(fēng)格和開發(fā)習(xí)慣。習(xí)慣使然是一方面，另一方面，我們也從不停下腳步質(zhì)疑這些習(xí)慣。一段時(shí)間以后，筆者養(yǎng)成了一些不同于常人的編碼風(fēng)格和開發(fā)習(xí)慣。...
閱讀 1876·2021-09-24 09:48
閱讀 3220·2021-08-26 14:14
閱讀 1674·2021-08-20 09:36
閱讀 1461·2019-08-30 15:55
閱讀 3628·2019-08-26 17:15
閱讀 1426·2019-08-26 12:09
閱讀 607·2019-08-26 11:59
閱讀 3324·2019-08-26 11:57
