盡管軟件開(kāi)發(fā)一直致力于追求高效、可讀性強(qiáng)、易于維護(hù)的特性，但這些特性卻像是一個(gè)不可能三角，相互交織，此消彼長(zhǎng)。就像底層語(yǔ)言（如匯編和C語(yǔ)言）能夠保持高效的運(yùn)行性能，但在可讀性和維護(hù)性方面卻存在短板和劣勢(shì)；而高級(jí)語(yǔ)言（如Java和Python）在可讀性和可維護(hù)性方面表現(xiàn)出色，但在執(zhí)行效率方面卻存在不足。構(gòu)建語(yǔ)言生態(tài)的優(yōu)勢(shì)，彌補(bǔ)其存在短板，始終是編程語(yǔ)言的一個(gè)演進(jìn)方向。
不同編程語(yǔ)言，擁有不同的特性和規(guī)約，下面就以JAVA語(yǔ)言為例，細(xì)數(shù)那些開(kāi)發(fā)過(guò)程中容易被人忽略，但必須掌握的知識(shí)點(diǎn)和實(shí)踐技能。1999年，美國(guó)太空總署（NASA）的火星任務(wù)失敗：在這次任務(wù)中，火星氣候探測(cè)者號(hào)上的飛行系統(tǒng)軟件使用公制單位牛頓計(jì)算推進(jìn)器動(dòng)力，而地面人員輸入的方向校正量和推進(jìn)器參數(shù)則使用英制單位磅力，導(dǎo)致探測(cè)器進(jìn)入大氣層的高度有誤，最終瓦解碎裂。
這是由于國(guó)際標(biāo)準(zhǔn)（牛）和本土化（磅）的沖突導(dǎo)致的一起事故。由此引出了程序需要關(guān)注可維護(hù)性這個(gè)話題，由于軟件生產(chǎn)往往需要多人協(xié)作，可維護(hù)性正是協(xié)作共識(shí)里的重要一環(huán)。關(guān)于這方面，讓人最容易想到的就是命名和注釋兩個(gè)方面了，下面就展開(kāi)來(lái)探討一下。2.1 關(guān)于命名
按照閱讀習(xí)慣，程序的變量命名法都需要克服單詞間的空格問(wèn)題，從而把不同單詞串連起來(lái)，最終達(dá)到創(chuàng)造出一種易于閱讀的新“單詞”的效果。常見(jiàn)的命名方法有以下幾種：- 蛇形命名法（snake case）：又叫下劃線命名法，使用下劃線，單詞小寫(xiě)，比如：my_system;
- 駝峰命名法（camel case）：按照單詞首字母區(qū)分大小寫(xiě)，又可細(xì)分為大駝峰命名法和小駝峰命名法，比如：MySystem，mySystem;
- 匈牙利命名法（HN case）：屬性+類(lèi)型+描述，比如：nLength，g_cch, hwnd；
- 帕斯卡命名法（Pascal case）：全部首字母大寫(xiě)，等同于大駝峰命名法，比如：MySystem；
- 脊柱命名法（spinal case）：使用中劃線，比如：my-system；
- 自由命名法（studly caps）：大小寫(xiě)混雜，無(wú)簡(jiǎn)明規(guī)則，比如：mySYSTEM，MYSystem；
按照受眾量與知名程度排名，駝峰命名法和蛇形命名法更受到大家的歡迎，畢竟它們?cè)诳勺x性，易寫(xiě)性等方面比較有優(yōu)勢(shì)。2.1.1 命名字典
建議研發(fā)同學(xué)將業(yè)內(nèi)常見(jiàn)業(yè)務(wù)場(chǎng)景的命名熟記，當(dāng)然，已經(jīng)有人幫我們總結(jié)過(guò)了，這里不再做過(guò)多的說(shuō)明。這里摘錄如下，可供參考：管理類(lèi)命名：Bootstrap，Starter，Processor，Manager，Holder，F(xiàn)actory，Provider，Registrar，Engine，Service，Task傳播類(lèi)命名：Context，Propagator回調(diào)類(lèi)命名：Handler，Callback，Trigger，Listener，Aware監(jiān)控類(lèi)命名：Metric，Estimator，Accumulator，Tracker內(nèi)存管理類(lèi)命名：Allocator，Chunk，Arena，Pool過(guò)濾檢測(cè)類(lèi)命名：Pipeline，Chain，F(xiàn)ilter，Interceptor，Evaluator，Detector結(jié)構(gòu)類(lèi)命名：Cache，Buffer，Composite，Wrapper，Option, Param,Attribute，Tuple，Aggregator，Iterator，Batch，Limiter常見(jiàn)設(shè)計(jì)模式命名：Strategy，Adapter，Action，Command，Event，Delegate，Builder，Template，Proxy解析類(lèi)命名：Converter，Resolver，Parser，Customizer，F(xiàn)ormatter網(wǎng)絡(luò)類(lèi)命名：Packet，Encoder、Decoder、Codec，Request，ResponseCRUD命名：Controller，Service，Repository其他類(lèi)命名：Mode，Type，Invoker，Invocation，Initializer，F(xiàn)uture，Promise，selector，Reporter，Constants，Accessor，Generator2.1.2 命名實(shí)踐
工程通用命名規(guī)則都有哪些呢？不同的語(yǔ)言可能會(huì)有不同的習(xí)慣，以Java語(yǔ)言的駝峰命名規(guī)范舉例：- 類(lèi)名首字母大寫(xiě),其余組成詞首字母依次大寫(xiě)；
- 變量名,方法名首字母小寫(xiě),如果名稱(chēng)由多個(gè)單詞組成,除首字母外的每個(gè)單詞首字母都要大寫(xiě)；
規(guī)范比較抽象，先來(lái)看看不好的命名有哪些呢？- 自帶混淆功能的變量名：String zhrmghg = "極致縮寫(xiě)型";
- 沒(méi)有意義的萬(wàn)能變量名：String a,b,c="愛(ài)誰(shuí)誰(shuí)型";
- 長(zhǎng)串拼音變量名：String HuaBuHua = "考古型";
- 各種符號(hào)混用：String $my_first_name_ = "打死記不住型";
- 大小寫(xiě)，數(shù)字，縮寫(xiě)混亂：String waitRPCResponse1 = "極易出錯(cuò)型";
除了標(biāo)準(zhǔn)的規(guī)范之外，在實(shí)際的開(kāi)發(fā)過(guò)程中還會(huì)有一些困擾我們的實(shí)際案例。1. 在定義一個(gè)成員變量的時(shí)候，到底是使用包裝類(lèi)型還是使用基本數(shù)據(jù)類(lèi)型呢？包裝類(lèi)和基本數(shù)據(jù)類(lèi)型的默認(rèn)值是不一樣的，前者是null，后者依據(jù)不同類(lèi)型其默認(rèn)值也不一樣。從數(shù)據(jù)嚴(yán)謹(jǐn)?shù)慕嵌葋?lái)講，包裝類(lèi)的null值能夠表示額外信息，從而更加安全。比如可以規(guī)避基本類(lèi)型的自動(dòng)拆箱，導(dǎo)致的NPE風(fēng)險(xiǎn)以及業(yè)務(wù)邏輯處理異常風(fēng)險(xiǎn)。所以成員變量必須使用包裝數(shù)據(jù)類(lèi)型，基本數(shù)據(jù)類(lèi)型則在局部變量的場(chǎng)景下使用。2. 為什么不建議布爾類(lèi)型的成員變量以is開(kāi)頭？關(guān)于Java Bean中的getter/setter方法的定義其實(shí)是有明確的規(guī)定的，根據(jù)JavaBeans(TM) Specification規(guī)定，如果是普通的參數(shù)，命名為propertyName，需要通過(guò)以下方式定義其setter/getter：
public <PropertyType> get<PropertyName>();
public void set<PropertyName>(<PropertyType> p)
但是，布爾類(lèi)型的變量propertyName則是另外一套命名原則的：
public boolean is<PropertyName>();
public void set<PropertyName>(boolean p)
- 一類(lèi)是同一個(gè)jar包出現(xiàn)了多個(gè)不同的版本。應(yīng)用選擇了錯(cuò)誤的版本導(dǎo)致jvm加載不到需要的類(lèi)或者加載了錯(cuò)誤版本的類(lèi)；（借助maven管理工具相對(duì)容易解決）
- 另一類(lèi)是不同的jar包出現(xiàn)了類(lèi)路徑相同的類(lèi)，同樣的類(lèi)出現(xiàn)在不同的依賴(lài)jar里，由于jar加載的先后順序?qū)е铝薐VM加載了錯(cuò)誤版本的類(lèi)；（比較難以解決）
這里著重介紹第二種情況，這種情況容易出現(xiàn)在系統(tǒng)拆分重構(gòu)時(shí)，將原有的項(xiàng)目進(jìn)行了復(fù)制，然后刪減，導(dǎo)致部分工具或者枚舉類(lèi)和原有的路徑和命名都一樣，當(dāng)?shù)谌秸{(diào)用方同時(shí)依賴(lài)了這兩個(gè)系統(tǒng)時(shí)，就容易為以后的迭代埋下坑。要規(guī)避此類(lèi)問(wèn)題，一定要為系統(tǒng)起一個(gè)獨(dú)一無(wú)二的package路徑。
補(bǔ)充：如果依賴(lài)的都是第三方的庫(kù)，存在著類(lèi)沖突時(shí)，可以通過(guò)引入第三方庫(kù)jarjar.jar，修改其中某個(gè)沖突jar文件的包名，以此來(lái)解決jar包沖突。5. 在變量命名的可讀性和占用資源（內(nèi)存，帶寬）方面，如何去做權(quán)衡？可以通過(guò)對(duì)象序列化工具為突破口，以常見(jiàn)的Json（Jackson）序列化方式來(lái)舉例：
public class SkuKey implements Serializable {
@JsonProperty(value = "sn")
@ApiModelProperty(name = "stationNo", value = " 門(mén)店編號(hào)", required = true)
private Long stationNo;
@JsonProperty(value = "si")
@ApiModelProperty(name = "skuId", value = " 商品編號(hào)", required = true)
private Long skuId;
// 省略get/set方法
}
2.2 關(guān)于注釋
注釋是程序員和閱讀者之間交流的重要手段，是對(duì)代碼的解釋和說(shuō)明，好的注釋可以提高軟件的可讀性，減少維護(hù)軟件的成本。2.2.1 好的注釋
分層次：按照系統(tǒng)，包，類(lèi)，方法，代碼塊，代碼行等不同粒度，各有側(cè)重點(diǎn)的進(jìn)行注釋說(shuō)明。- 系統(tǒng)注釋?zhuān)和ㄟ^(guò)README.md文件體現(xiàn)宏觀的功能和架構(gòu)實(shí)現(xiàn)；
- 包注釋?zhuān)和ㄟ^(guò)package-info文件體現(xiàn)模塊職責(zé)邊界，另外該文件也支持聲明友好類(lèi)，包常量以及為標(biāo)注在包上的注解（Annotation）提供便利；
- 類(lèi)注釋?zhuān)褐饕w現(xiàn)功能職責(zé)，版本支持，作者歸屬，應(yīng)用示例等相關(guān)信息；
- 方法注釋?zhuān)宏P(guān)注入?yún)?，出參，異常處理聲明，使用?chǎng)景舉例等相關(guān)內(nèi)容；
- 代碼塊和代碼行注釋?zhuān)褐饕w現(xiàn)邏輯意圖，閉坑警示，規(guī)劃TODO，放大關(guān)注點(diǎn)等細(xì)節(jié)內(nèi)容；
有規(guī)范：好的代碼優(yōu)于大量注釋?zhuān)@和我們常說(shuō)的“約定大于配置”是相同的道理。借助swagger等三方庫(kù)實(shí)現(xiàn)注解即接口文檔，是一個(gè)不錯(cuò)的規(guī)范方式；2.2.2 壞的注釋
為了能使注釋準(zhǔn)確清晰的表達(dá)出功能邏輯，注釋的維護(hù)是有相當(dāng)?shù)木S護(hù)成本的，所以注釋并不是越多，越詳細(xì)越好。下面就舉一些壞的注釋場(chǎng)景，輔助理解：- 冗余式：如果一個(gè)函數(shù)，讀者能夠很容易的就讀出來(lái)代碼要表達(dá)的意思，注釋就是多余的；
- 錯(cuò)誤式：如果注釋地不清楚，甚至出現(xiàn)歧義，那還不如不寫(xiě)；
- 簽名式：類(lèi)似“add by liuhuiqing 2023-08-05”這種注釋?zhuān)菀走^(guò)期失效而且不太可信（不能保證所有人每次都采用這種方式注釋?zhuān)涔δ芡耆梢杂蒰it代碼管理工具來(lái)實(shí)現(xiàn)；
- 長(zhǎng)篇大論式：代碼塊里，夾雜了大篇幅的注釋?zhuān)粌H影響代碼閱讀，而且維護(hù)困難；
- 非本地注釋?zhuān)鹤⑨寫(xiě)?yīng)該在離代碼實(shí)現(xiàn)最近的地方，比如：被調(diào)用的方法注釋就由方法本身來(lái)維護(hù)，調(diào)用方無(wú)需對(duì)方法做詳細(xì)的說(shuō)明；
- 注釋掉的代碼：無(wú)用的代碼應(yīng)該刪除，而不是注釋。歷史記錄交給git等代碼管理工具來(lái)維護(hù)；
2.3 關(guān)于分層
系統(tǒng)分層設(shè)計(jì)的主要目的是通過(guò)分離關(guān)注點(diǎn)，來(lái)降低系統(tǒng)的復(fù)雜度，同時(shí)提高可復(fù)用性和降低維護(hù)成本。所以懂得分層的概念，很大程度上系統(tǒng)的可維護(hù)性就有了骨架。2.3.1 系統(tǒng)分層
在ISO(（International Standardization Organization）)于1981年制定網(wǎng)絡(luò)通信七層模型(Open System Interconnection Reference Model，OSI/RM)之前，計(jì)算機(jī)網(wǎng)絡(luò)中存在眾多的體系結(jié)構(gòu)，其中以IBM公司的SNA(系統(tǒng)網(wǎng)絡(luò)體系結(jié)構(gòu))和DEC公司的DNA(DigitalNetworkArchitecture)數(shù)字網(wǎng)絡(luò)體系結(jié)構(gòu)最為著名。最早之前，各個(gè)廠家提出的不同標(biāo)準(zhǔn)都是以自家設(shè)備為基礎(chǔ)的，用戶(hù)在選擇產(chǎn)品的時(shí)候就只能用同一家公司的，因?yàn)椴煌鹃g大家的標(biāo)準(zhǔn)不一樣，工作方式也可能不一樣，結(jié)果就是不同廠商的網(wǎng)絡(luò)產(chǎn)品間，可能會(huì)出現(xiàn)不兼容的情況。如果說(shuō)同一家的公司的產(chǎn)品都能滿(mǎn)足用戶(hù)的需求的話，那就看哪家公司實(shí)力強(qiáng)點(diǎn)，實(shí)力強(qiáng)的，用戶(hù)粘性高的，用戶(hù)自然也不會(huì)說(shuō)什么，問(wèn)題是一家公司并不是對(duì)所有的產(chǎn)品都擅長(zhǎng)。這就會(huì)導(dǎo)致廠商和用戶(hù)都面臨著痛苦的煎熬。類(lèi)比一下當(dāng)前手機(jī)充電接口協(xié)議（Micro USB接口、Type- c接口、Lightning接口），手頭總是要備有各種充電線的場(chǎng)景，就能深刻理解標(biāo)準(zhǔn)的意義了。2.3.2 軟件伸縮性
軟件伸縮性指的是軟件系統(tǒng)在面對(duì)負(fù)載壓力時(shí)，能夠保持原有性能并擴(kuò)展以支持更多任務(wù)的能力。
伸縮性可以有兩個(gè)方面，垂直伸縮性和水平伸縮性，垂直伸縮性是通過(guò)在同一個(gè)業(yè)務(wù)單元中增加資源來(lái)提高系統(tǒng)的吞吐量，比如增加服務(wù)器cpu的數(shù)量，增加服務(wù)器的內(nèi)存等。水平伸縮性是通過(guò)增加多個(gè)業(yè)務(wù)單元資源，使得所有的業(yè)務(wù)單元邏輯上就像是一個(gè)單元一樣。比如ejb分布式組件模型，微服務(wù)組件模型等都屬于此種方式。
軟件系統(tǒng)在設(shè)計(jì)時(shí)需要考慮如何進(jìn)行有效的伸縮性設(shè)計(jì)，以確保在面對(duì)負(fù)載壓力時(shí)能夠提供足夠的性能支持。系統(tǒng)分層從伸縮性角度看，更多的屬于水平伸縮性的范疇。在J2EE系統(tǒng)開(kāi)發(fā)當(dāng)中，我們普遍采用了分層構(gòu)架的方式，一般分為表現(xiàn)層，業(yè)務(wù)層和持久層。采用分層以后，因?yàn)閷优c層之間通信會(huì)引來(lái)額外的開(kāi)銷(xiāo)，所以給我們軟件系統(tǒng)帶來(lái)的就是每個(gè)業(yè)務(wù)處理開(kāi)銷(xiāo)會(huì)變大。既然采用分層會(huì)帶來(lái)額外的開(kāi)銷(xiāo)，那么我們?yōu)槭裁催€要進(jìn)行分層呢？這是因?yàn)閱渭円揽慷延布Y源的垂直伸縮方式來(lái)提高軟件性能和吞吐是有上限的，而且隨著系統(tǒng)規(guī)模的擴(kuò)大，垂直伸縮的代價(jià)也將變得非常昂貴。當(dāng)采用了分層以后，雖然層與層之間帶來(lái)了通信開(kāi)銷(xiāo)，但是它有利于各層的水平伸縮性，并且各個(gè)層都可以進(jìn)行獨(dú)立的伸縮而不會(huì)影響到其它的層。也就是說(shuō)當(dāng)系統(tǒng)要應(yīng)對(duì)更大的訪問(wèn)量的時(shí)候，我們可以通過(guò)增加多個(gè)業(yè)務(wù)單元資源來(lái)增加系統(tǒng)吞吐量。2.4 小結(jié)
本章內(nèi)容主要從可讀性和可維護(hù)性方面講述了在開(kāi)發(fā)過(guò)程中，要做好命名和注釋的統(tǒng)一共識(shí)。除了共識(shí)之外，在設(shè)計(jì)層面也需要做好關(guān)注點(diǎn)的隔離，這包含系統(tǒng)職責(zé)的拆分，模塊功能的劃分，類(lèi)能力的收斂，實(shí)體結(jié)構(gòu)的關(guān)系都需要做好規(guī)劃。下面就從程序的擴(kuò)展性，維護(hù)性，安全性以及性能等幾個(gè)重要質(zhì)量指標(biāo)，來(lái)學(xué)習(xí)那些經(jīng)典的實(shí)踐案例。3.1 類(lèi)定義
3.1.1 常量定義
常量是一種固定值，不會(huì)在程序執(zhí)行期間發(fā)生改變。你可以使用枚舉（Enum）或類(lèi)（Class）來(lái)定義常量。如果你需要定義一組相關(guān)的常量，那么使用枚舉更為合適。枚舉從安全性和可操作性（支持遍歷和函數(shù)定義）上面擁有更大的優(yōu)勢(shì)。
public enum Color {
RED, GREEN, BLUE;
}
如果你只需要定義一個(gè)或少數(shù)幾個(gè)只讀的常量，那么使用類(lèi)常量更為簡(jiǎn)潔和方便。
public class MyClass {
public static final int MAX_VALUE = 100;
}
3.1.2 工具類(lèi)
工具類(lèi)通常包含具有通用性的、某一非業(yè)務(wù)領(lǐng)域內(nèi)的公共方法，不需要配套的成員變量，僅僅是作為工具方法被使用。因此，將其做成靜態(tài)方法最合適，不需要實(shí)例化，能夠獲取到方法的定義并調(diào)用就行。工具類(lèi)不實(shí)例化的原因是可以節(jié)省內(nèi)存空間，因?yàn)楣ぞ哳?lèi)提供的是靜態(tài)方法，通過(guò)類(lèi)就能調(diào)用，不需要實(shí)例化工具類(lèi)對(duì)象。
public abstract class ObjectHelper {
public static boolean isEmpty(String str) {
return str == null || str.length() == 0;
}
}
3.1.3 JavaBean
JavaBean的定義有兩種常見(jiàn)實(shí)現(xiàn)方式：手動(dòng)編寫(xiě)和自動(dòng)生成。
public class Person {
private String name;
private int age;
public Person(String name, int age) {
this.name = name;
this.age = age;
}
public String getName() {
return name;
}
public void setName(String name) {
this.name = name;
}
public int getAge() {
return age;
}
public void setAge(int age) {
this.age = age;
}
}
使用lombok插件，通過(guò)注解方式來(lái)增強(qiáng)Java代碼的編寫(xiě)，在編譯期動(dòng)態(tài)生成get和set方法。
import lombok.Data;
@NoArgsConstructor
@Data
@Accessors(chain = true)
public class Person {
private String name;
private int age;
}
3.1.4 不可變類(lèi)
在某些場(chǎng)景下，類(lèi)為了保證其功能和行為的穩(wěn)定性和一致性，會(huì)被設(shè)計(jì)為不能被繼承和重寫(xiě)的。定義方式就是在類(lèi)上面添加final關(guān)鍵字，示例：
public final class String implements Serializable, Comparable<String>, CharSequence {
}
以下是一些不能被繼承和重寫(xiě)的類(lèi)，這在一些底層中間件中會(huì)有應(yīng)用：
java.lang.String
java.lang.Math
java.lang.Boolean
java.lang.Character
java.util.Date
java.sql.Date
java.lang.System
java.lang.ClassLoader
3.1.5 匿名內(nèi)部類(lèi)
匿名內(nèi)部類(lèi)通常用于簡(jiǎn)化代碼，它的定義和使用通常發(fā)生在同一處，它的使用場(chǎng)景如下：直接作為參數(shù)傳遞給方法或構(gòu)造函數(shù)；
用于實(shí)現(xiàn)某個(gè)接口或抽象類(lèi)的匿名實(shí)例；
public class Example {
public static void main(String[] args) {
// 創(chuàng)建一個(gè)匿名內(nèi)部類(lèi)
Runnable runnable = new Runnable() {
@Override
public void run() {
System.out.println("Hello, World!");
}
};
// 調(diào)用匿名內(nèi)部類(lèi)的方法
runnable.run();
}
}
3.1.6 聲明類(lèi)
聲明類(lèi)是Java語(yǔ)言中的基本類(lèi)型或接口，用于定義類(lèi)的行為或特性，有的甚至只是個(gè)聲明，沒(méi)有具體的方法定義。- AutoCloseable：表示實(shí)現(xiàn)了該接口的類(lèi)可以被自動(dòng)關(guān)閉，通常用于資源管理。
- Comparable：表示實(shí)現(xiàn)了該接口的類(lèi)可以與其他實(shí)現(xiàn)了該接口的對(duì)象進(jìn)行比較。
- Callable：表示實(shí)現(xiàn)了該接口的類(lèi)可以作為參數(shù)傳遞給線程池，并返回結(jié)果。
- Cloneable：表示實(shí)現(xiàn)了該接口的類(lèi)可以被克隆。
- Enum：表示實(shí)現(xiàn)了該接口的類(lèi)是一個(gè)枚舉類(lèi)型。
- Iterable：表示實(shí)現(xiàn)了該接口的類(lèi)可以迭代。
- Runnable：表示實(shí)現(xiàn)了該接口的類(lèi)可以作為線程運(yùn)行。
- Serializable：表示實(shí)現(xiàn)了該接口的類(lèi)可以被序列化和反序列化。
- interface：表示實(shí)現(xiàn)了該接口的類(lèi)是一個(gè)接口，可以包含方法聲明。
- Annotation：表示實(shí)現(xiàn)了該接口的類(lèi)是一個(gè)注解，可以用于元數(shù)據(jù)描述。
3.1.7 Record 類(lèi)
Record 類(lèi)在 Java14 中就開(kāi)始預(yù)覽，一直到Java17 才正式發(fā)布。根據(jù) JEP395 的描述，Record 類(lèi)是不可變數(shù)據(jù)的載體，類(lèi)似于當(dāng)下廣泛應(yīng)用的各種 model，dto，vo 等 POJO 類(lèi)，但 record 本身在構(gòu)造之后不再可賦值。所有的 record 類(lèi)都繼承自 java.lang.Record。Record 類(lèi)默認(rèn)提供了全字段的構(gòu)造器，屬性的訪問(wèn)，還有 equals，hashcode，toString 方法，其作用和 lombok 插件非常類(lèi)似。定義方式
/**
* 關(guān)鍵定義的類(lèi)是不可變類(lèi)
* 將所有成員變量通過(guò)參數(shù)的形式定義
* 默認(rèn)會(huì)生成全部參數(shù)的構(gòu)造方法
* @param name
* @param age
*/
public record Person(String name, int age) {
public Person{
if(name == null){
throw new IllegalArgumentException("提供緊湊的方式進(jìn)行參數(shù)校驗(yàn)");
}
}
/**
* 定義的類(lèi)中可以定義靜態(tài)方法
* @param name
* @return
*/
public static Person of(String name) {
return new Person(name, 18);
}
}
使用方式
Person person = new Person("John", 30);
// Person person = Person.of("John");
String name = person.name();
int age = person.age();
通過(guò)Record 構(gòu)建一個(gè)臨時(shí)存儲(chǔ)對(duì)象，將 Person 數(shù)組對(duì)象按照年齡排序。
public List<Person> sortPeopleByAge(List<Person> people) {
record Data(Person person, int age){};
return people.stream()
.map(person -> new Data(person, computAge(person)))
.sorted((d1, d2) -> Integer.compare(d2.age(), d1.age()))
.map(Data::person)
.collect(toList());
}
public int computAge(Person person) {
return person.age() - 1;
}
3.1.8 密封類(lèi)
Java 17推出的新特性密封類(lèi)（Sealed Classes），主要作用就是限制類(lèi)的繼承。我們知道之前對(duì)類(lèi)繼承功能的限制主要有兩種：- final修飾類(lèi)，這樣類(lèi)就無(wú)法被繼承了；
- package-private類(lèi)，可以控制只能被同一個(gè)包下的類(lèi)繼承；
但很顯然，這兩種限制方式的力度都非常粗，而密封類(lèi)正是對(duì)類(lèi)繼承的更細(xì)粒度的控制。
sealed class SealedClass permits SubClass1, SubClass2 {
}
class SubClass1 extends SealedClass {
}
class SubClass2 extends SealedClass {
}
3.2 方法定義
3.2.1 構(gòu)造方法
構(gòu)造方法是一種特殊的方法，用于創(chuàng)建和初始化對(duì)象。構(gòu)造方法的名稱(chēng)必須與類(lèi)名相同，并且沒(méi)有返回類(lèi)型。在創(chuàng)建對(duì)象時(shí)，可以通過(guò)使用 new 關(guān)鍵字來(lái)調(diào)用構(gòu)造方法。
public class MyClass {
private int myInt;
private String myString;
// 構(gòu)造方法
public MyClass(int myInt, String myString) {
this.myInt = myInt;
this.myString = myString;
}
}
3.2.2 方法重寫(xiě)
方法重寫(xiě)是指在子類(lèi)中重新定義與父類(lèi)中同名的方法。方法重寫(xiě)允許子類(lèi)覆蓋父類(lèi)中的方法實(shí)現(xiàn)，以便根據(jù)子類(lèi)的需要實(shí)現(xiàn)其自己的行為。
class Animal {
public void makeSound() {
System.out.println("Animal is making a sound");
}
}
class Cat extends Animal {
@Override
public void makeSound() {
System.out.println("Meow");
}
}
public class Main {
public static void main(String[] args) {
Animal myCat = new Cat();
myCat.makeSound();
// 輸出 "Meow"
}
}
3.2.3 方法重載
類(lèi)中定義多個(gè)方法，它們具有相同的名稱(chēng)但參數(shù)列表不同。方法重載允許我們使用同一個(gè)方法名執(zhí)行不同的操作，根據(jù)傳遞給方法的參數(shù)不同來(lái)執(zhí)行不同的代碼邏輯。
public class Calculator {
public int add(int a, int b) {
return a + b;
}
public double add(double a, double b) {
return a + b;
}
}
public class Main {
public static void main(String[] args) {
Calculator calculator = new Calculator();
int result1 = calculator.add(2, 3);
double result2 = calculator.add(2.5, 3.5);
System.out.println(result1); // 輸出 5
System.out.println(result2); // 輸出 6.0
}
}
3.2.4 匿名方法
Java 8 引入了 Lambda 表達(dá)式，可以用來(lái)實(shí)現(xiàn)類(lèi)似匿名方法的功能。Lambda 表達(dá)式是一種匿名函數(shù)，可以作為參數(shù)傳遞給方法，或者直接作為一個(gè)獨(dú)立表達(dá)式使用。
public static void main(String args[]) {
List<String> names = Arrays.asList("hello", "world");
// 使用 Lambda 表達(dá)式作為參數(shù)傳遞給 forEach 方法
names.forEach((String name) -> System.out.println("Name: " + name));
// 使用 Lambda 表達(dá)式作為獨(dú)立表達(dá)式使用
Predicate<String> nameLengthGreaterThan5 = (String name) -> name.length() > 5;
boolean isLongName = nameLengthGreaterThan5.test("John");
System.out.println("Is long name? " + isLongName);
}
3.3 對(duì)象定義
3.3.1 單例對(duì)象
單例對(duì)象是一種可以重復(fù)使用的對(duì)象，但只有一個(gè)實(shí)例。它有以下幾個(gè)作用：- 控制資源的使用：通過(guò)線程同步來(lái)控制資源的并發(fā)訪問(wèn)。
- 控制實(shí)例產(chǎn)生的數(shù)量：達(dá)到節(jié)約資源的目的。
- 作為通信媒介使用：也就是數(shù)據(jù)共享，它可以在不建立直接關(guān)聯(lián)的條件下，讓多個(gè)不相關(guān)的兩個(gè)線程或者進(jìn)程之間實(shí)現(xiàn)通信。
比如，使用枚舉實(shí)現(xiàn)單例模式：
public enum Singleton {
INSTANCE;
public void someMethod() {
// ...其他代碼...
}
}
3.3.2 不可變對(duì)象
Java中的不可變對(duì)象是指那些一旦被創(chuàng)建，其狀態(tài)就不能被修改的對(duì)象。不可變對(duì)象是一種非常有用的對(duì)象，因?yàn)樗鼈兛梢源_保對(duì)象的狀態(tài)在任何時(shí)候都是一致的，從而避免了因?yàn)樾薷膶?duì)象狀態(tài)而引發(fā)的問(wèn)題。實(shí)現(xiàn)不可變對(duì)象有以下幾種方式：- 將對(duì)象的狀態(tài)存儲(chǔ)在不可變對(duì)象中：String、Integer等就是內(nèi)置的不可變對(duì)象類(lèi)型；
- 將對(duì)象的狀態(tài)存儲(chǔ)在final變量中：final變量一旦被賦值就不能被修改；
- 將對(duì)象的所有屬性都設(shè)為不可變對(duì)象：這樣就可以確保整個(gè)對(duì)象都是不可變的；
一些容器類(lèi)的操作也有對(duì)應(yīng)的包裝類(lèi)實(shí)現(xiàn)容器對(duì)象的不可變，比如定義不可變數(shù)組對(duì)象：
Collections.unmodifiableList(new ArrayList<>());
當(dāng)領(lǐng)域內(nèi)的對(duì)象作為入?yún)⑼鈧鬟f時(shí)，將其定義為不可變對(duì)象，這在保持?jǐn)?shù)據(jù)一致性方面非常重要，否則對(duì)象屬性變更的不可預(yù)測(cè)性，在進(jìn)行問(wèn)題定位時(shí)，將會(huì)非常麻煩。3.3.3 元組對(duì)象
元組（Tuple）是函數(shù)式編程語(yǔ)言中的常見(jiàn)概念，元組是一個(gè)不可變，并且能夠以類(lèi)型安全的形式保存多個(gè)不同類(lèi)型的對(duì)象。它是一種非常有用的數(shù)據(jù)結(jié)構(gòu)，可以讓開(kāi)發(fā)者在處理多個(gè)數(shù)據(jù)元素時(shí)更加方便和高效。但原生的Java標(biāo)準(zhǔn)庫(kù)并沒(méi)有提供元組的支持，需要我們自己或借助第三方類(lèi)庫(kù)來(lái)實(shí)現(xiàn)。二元組實(shí)現(xiàn)
public class Pair<A,B> {
public final A first;
public final B second;
public Pair(A a, B b) {
this.first = a;
this.second = b;
}
public A getFirst() {
return first;
}
public B getSecond() {
return second;
}
}
三元組實(shí)現(xiàn)
public class Triplet<A,B,C> extends Pair<A,B>{
public final C third;
public Triplet(A a, B b, C c) {
super(a, b);
this.third = c;
}
public C getThird() {
return third;
}
public static void main(String[] args) {
// 表示姓名，性別，年齡
Triplet<String,String,Integer> triplet = new Triplet("John","男",18);
// 獲得姓名
String name = triplet.getFirst();
}
}
多元組實(shí)現(xiàn)
public class Tuple<E> {
private final E[] elements;
public Tuple(E... elements) {
this.elements = elements;
}
public E get(int index) {
return elements[index];
}
public int size() {
return elements.length;
}
public static void main(String[] args) {
// 表示姓名，性別，年齡
Tuple<String> tuple = new Tuple<>("John", "男", "18");
// 獲得姓名
String name = tuple.get(0);
}
}
- 存儲(chǔ)多個(gè)數(shù)據(jù)元素：Tuple可以存儲(chǔ)多個(gè)不同類(lèi)型的數(shù)據(jù)元素，這些元素可以是基本類(lèi)型、對(duì)象類(lèi)型、數(shù)組等；
- 簡(jiǎn)化代碼：Tuple可以使代碼更加簡(jiǎn)潔，減少重復(fù)代碼的編寫(xiě)。通過(guò)Tuple，我們可以將多個(gè)變量打包成一個(gè)對(duì)象，從而減少了代碼量；
- 提高代碼可讀性：Tuple可以提高代碼的可讀性。通過(guò)Tuple，我們可以將多個(gè)變量打包成一個(gè)對(duì)象，從而使代碼更加易讀；
- 支持函數(shù)返回多個(gè)值：Tuple可以支持函數(shù)返回多個(gè)值。在Java中，函數(shù)只能返回一個(gè)值，但是通過(guò)Tuple，我們可以將多個(gè)值打包成一個(gè)對(duì)象返回；
除了自定義之外，實(shí)現(xiàn)了元組概念的第三方類(lèi)庫(kù)有：Google Guava，Apache Commons Lang，JCTools，Vavr等。Google Guava庫(kù)的Tuple提供了更多的功能，并且被廣泛使用。比如，為了使元組的含義更加明確，Guava提供了命名元組（NamedTuple）的概念。通過(guò)給元組命名，可以更清晰地表示每個(gè)元素的意義。示例：
NamedTuple namedTuple = Tuples.named("person", "name", "age");
3.3.4 臨時(shí)對(duì)象
臨時(shí)對(duì)象是指在程序執(zhí)行過(guò)程中臨時(shí)需要，但生命周期較短的對(duì)象。這些對(duì)象通常只在使用過(guò)程中短暫存在，不需要長(zhǎng)期存儲(chǔ)或重復(fù)使用。關(guān)于臨時(shí)對(duì)象的優(yōu)化建議如下：- 盡量重用對(duì)象。由于系統(tǒng)不僅要花時(shí)間生成對(duì)象，以后可能還需花時(shí)間對(duì)這些對(duì)象進(jìn)行垃圾回收和處理，因此，生成過(guò)多的對(duì)象將會(huì)給程序的性能帶來(lái)很大的影響，重用對(duì)象的策略有緩存對(duì)象，也可以針對(duì)具體場(chǎng)景進(jìn)行定向優(yōu)化，比如使用StringBuffer代替字符串拼接的方式；
- 盡量使用局部變量。調(diào)用方法時(shí)傳遞的參數(shù)以及在調(diào)用中創(chuàng)建的臨時(shí)變量都保存在棧中，速度較快。其他變量，如靜態(tài)變量、實(shí)例變量等，都在堆中創(chuàng)建，速度較慢；
- 分代收集。分代垃圾回收策略，是基于這樣一個(gè)事實(shí)：不同的對(duì)象的生命周期是不一樣的。因此，不同生命周期的對(duì)象可以采取不同的收集方式，以便提高回收效率；
3.3.5 Valhalla
Java作為高級(jí)語(yǔ)言，和更為底層的C語(yǔ)言，匯編語(yǔ)言在性能方面一直存在著不小的差距。為了彌補(bǔ)這一差距，Valhalla 項(xiàng)目于 2014 年啟動(dòng)，目標(biāo)是為基于 JVM 的語(yǔ)言帶來(lái)更靈活的扁平化數(shù)據(jù)類(lèi)型。我們都知道Java支持原生類(lèi)型和引用類(lèi)型兩種。原生數(shù)據(jù)類(lèi)型按值傳遞，賦值和函數(shù)傳參都會(huì)把值給復(fù)制一份，復(fù)制之后兩份之間就再無(wú)關(guān)聯(lián)；引用類(lèi)型無(wú)論什么情況傳的都是指針，修改指針指向的內(nèi)容會(huì)影響到所有的引用。而Valhalla又引入了值類(lèi)型（value types），一種介于原生類(lèi)型和引用類(lèi)型之間的概念。由于應(yīng)用程序中的大多數(shù)Java數(shù)據(jù)結(jié)構(gòu)都是對(duì)象，因此我們可以將Java視為指針密集型語(yǔ)言。這種基于指針的對(duì)象實(shí)現(xiàn)用于啟用對(duì)象標(biāo)識(shí)，對(duì)象標(biāo)識(shí)本身用于語(yǔ)言特性，如多態(tài)性、可變性和鎖定。默認(rèn)情況下，這些特性適用于每個(gè)對(duì)象，無(wú)論它們是否真的需要。這就是值類(lèi)型（value types）發(fā)揮作用的地方。值類(lèi)型（value types）的概念是表示純數(shù)據(jù)聚合，這會(huì)刪除常規(guī)對(duì)象的功能。因此，我們有純數(shù)據(jù)，沒(méi)有身份。當(dāng)然，這意味著我們也失去了使用對(duì)象標(biāo)識(shí)可以實(shí)現(xiàn)的功能。由于我們不再有對(duì)象標(biāo)識(shí)，我們可以放棄指針，改變值類(lèi)型的一般內(nèi)存布局。讓我們來(lái)比較一下對(duì)象引用和值類(lèi)型內(nèi)存布局。去掉了對(duì)象頭信息，在64位操作系統(tǒng)中值類(lèi)型節(jié)約了對(duì)象頭16個(gè)字節(jié)的空間。同時(shí)，也意味著放棄對(duì)象唯一身份（Identity）和初始化安全性，之前的wait()，notify()，synchronized(obj)，System.identityHashCode(obj)等關(guān)鍵字或方法都將失效，無(wú)法使用。Valhalla 在提高性能和減少泄漏的抽象方面將會(huì)顯著提高：截止到2023年9月，Valhalla 項(xiàng)目仍在進(jìn)行中，還沒(méi)有正式版本的發(fā)布，這一創(chuàng)新項(xiàng)目值得期待的。本文總結(jié)了軟件開(kāi)發(fā)過(guò)程中經(jīng)常用到的基礎(chǔ)常識(shí)，分為基礎(chǔ)篇和實(shí)踐篇兩個(gè)篇章，其中基礎(chǔ)篇中著重講述了類(lèi)，方法，變量的命名規(guī)范以及代碼注釋好壞的評(píng)判標(biāo)準(zhǔn)。實(shí)踐篇中從類(lèi)，方法以及對(duì)象三個(gè)層面分析了常見(jiàn)的技術(shù)概念和落地實(shí)踐，希望這些常識(shí)能夠?yàn)樽x者帶來(lái)一些思考和幫助。
該文章在 2023/12/12 17:37:40 編輯過(guò)
400 186 1886
