譯者 | 劉汪洋
審校 | 重樓
什么是 Java 代碼重構(gòu)？
Java 代碼重構(gòu)是一種在不影響代碼外部行為的前提下進(jìn)行的代碼優(yōu)化，它通過漸進(jìn)和小規(guī)模的優(yōu)化來改善現(xiàn)有代碼的結(jié)構(gòu)和質(zhì)量。重構(gòu)的目標(biāo)是提高代碼的可讀性、性能、可維護(hù)性和效率等。
Martin Fowler 是這個(gè)領(lǐng)域的權(quán)威的大牛和非常高產(chǎn)的作家，他在多篇文章和書籍中探討了代碼設(shè)計(jì)和重構(gòu)的主題。在他的作品《重構(gòu)：改善既有代碼的設(shè)計(jì)》中，他精辟地解釋了重構(gòu)的本質(zhì)：
_“重構(gòu)是在不改變代碼外在行為的前提下，對(duì)代碼做出修改，以改進(jìn)程序內(nèi)在結(jié)構(gòu)的過程。重構(gòu)是一種經(jīng)過千錘百煉形成的有條不紊的程序整理方法，可以最大限度地減少整理過程中引入的錯(cuò)誤幾率。其核心是不斷進(jìn)行一些小的優(yōu)化，每個(gè)優(yōu)化看似不起眼，但積少成多，效果顯著?！?
——Martin Fowler
在進(jìn)行 Java 代碼重構(gòu)時(shí)，可以考慮以下常見的優(yōu)化措施：
- 為變量、類、函數(shù)和其他元素重命名，使其具有更好的可讀性和自描述性。
- 通過內(nèi)聯(lián)減少方法或函數(shù)調(diào)用，使用更簡(jiǎn)潔的內(nèi)容。
- 抽取函數(shù)中的代碼塊，并將它們移到新的獨(dú)立函數(shù)中，以增強(qiáng)模塊性和可讀性。
- 消除冗余，通過刪除相同功能的多個(gè)代碼片段，并將它們合并為一個(gè)。
- 拆分處理過多職責(zé)的類或模塊，將其分解為更小、更有內(nèi)聚的組件。
- 合并具有相似功能的類或模塊，簡(jiǎn)化結(jié)構(gòu)。
- 進(jìn)行代碼性能方面的優(yōu)化。
Java 代碼重構(gòu)技巧
變量和方法的重新命名
為變量和方法選擇具有代表性的名稱是增強(qiáng)代碼可讀性的重要方法。
代碼的可讀性是構(gòu)建高質(zhì)量代碼庫的關(guān)鍵要素之一。易讀的代碼能夠清晰地表達(dá)其目的，而難以理解的代碼則會(huì)增加重構(gòu)過程中出現(xiàn)錯(cuò)誤的風(fēng)險(xiǎn)。采用有意義的變量和方法名稱可以減少注釋的需求，并降低溝通成本。
// 重構(gòu)前
int d = 30; // 天數(shù)
int h = 24; // 一天的小時(shí)數(shù)
// 重構(gòu)后
int daysInMonth = 30;
int hoursInDay = 24;方法的提取
在 Java 代碼重構(gòu)技術(shù)中，方法的提取是一種常見而實(shí)用的策略。當(dāng)一個(gè)方法變得過長(zhǎng)和過于復(fù)雜時(shí)，通過提取部分功能到一個(gè)新的方法中能夠使原方法更簡(jiǎn)潔和易讀。這不僅使代碼更具可維護(hù)性，還提高了其可重用性。
假設(shè)你有一個(gè)簡(jiǎn)單的類，用于處理訂單并計(jì)算小計(jì)、稅費(fèi)和總費(fèi)用。
public class OrderProcessor {
private List<Item> items;
private double taxRate;
public double processOrder() {
double subtotal = 0;
for (Item item : items) {
subtotal += item.getPrice();
}
double totalTax = subtotal * taxRate;
double totalCost = subtotal + totalTax;
return totalCost;
}
}你可以將該代碼重構(gòu)，把計(jì)算小計(jì)、稅費(fèi)和總費(fèi)用的代碼分別提取到 calculateSubtotal、calculateTax 和 calculateTotalCost 三個(gè)獨(dú)立的方法中，從而使類更加易讀、模塊化和可重用。
public class OrderProcessor {
private List<Item> items;
private double taxRate;
public double processOrder() {
double subtotal = calculateSubtotal();
double totalTax = calculateTax(subtotal);
return calculateTotalCost(subtotal, totalTax);
}
private double calculateSubtotal() {
double subtotal = 0;
for (Item item : items) {
subtotal += item.getPrice();
}
return subtotal;
}
private double calculateTax(double subtotal) {
return subtotal * taxRate;
}
private double calculateTotalCost(double subtotal, double totalTax) {
return subtotal + totalTax;
}
}消除“魔法”數(shù)字和字符串
“魔法”數(shù)字和字符串是指直接硬編碼在代碼中的值。這種做法不僅會(huì)降低代碼的可維護(hù)性，還可能因輸入錯(cuò)誤而導(dǎo)致結(jié)果不一致和錯(cuò)誤的增多。為了避免這樣的問題，你應(yīng)當(dāng)避免使用硬編碼的值，而是通過使用具有清晰描述性的常量來重構(gòu)你的代碼。
// 重構(gòu)前
if (status == 1) {
// ... 活躍狀態(tài)的代碼 ...
}
// 重構(gòu)后
public static final int ACTIVE_STATUS = 1;
if (status == ACTIVE_STATUS) {
// ... 活躍狀態(tài)的代碼 ...
}代碼復(fù)用
代碼復(fù)用是指刪除代碼庫中多處出現(xiàn)的重復(fù)或相似的代碼段。這樣的代碼不僅降低了代碼質(zhì)量和效率，還可能導(dǎo)致 bug 更加頻繁的出現(xiàn)和代碼庫變得更加復(fù)雜。因此，開發(fā)人員通常會(huì)對(duì)這類代碼感到反感。為了優(yōu)化代碼，我們可以考慮提取重復(fù)部分來創(chuàng)建可復(fù)用的方法或函數(shù)，同時(shí)確保重構(gòu)過程中保持原有代碼的功能和邏輯。
重構(gòu)前
public class NumberProcessor {
// 計(jì)算總和
public int calculateTotal(int[] numbers) {
int total = 0;
for (int i = 0; i < numbers.length; i++) {
total += numbers[i];
}
return total;
}
// 計(jì)算平均值
public double calculateAverage(int[] numbers) {
int total = 0;
for (int i = 0; i < numbers.length; i++) {
total += numbers[i];
}
double average = (double) total / numbers.length;
return average;
}
}重構(gòu)后
public class NumberProcessor {
// 計(jì)算總和
public int calculateSum(int[] numbers) {
int total = 0;
for (int i = 0; i < numbers.length; i++) {
total += numbers[i];
}
return total;
}
// 計(jì)算總和
public int calculateTotal(int[] numbers) {
return calculateSum(numbers);
}
// 計(jì)算平均值
public double calculateAverage(int[] numbers) {
int total = calculateSum(numbers);
double average = (double) total / numbers.length;
return average;
}
}在優(yōu)化后的代碼中，我們將用于計(jì)算數(shù)組總和的邏輯提取到了一個(gè)名為 calculateSum 的獨(dú)立方法中?，F(xiàn)在，calculateTotal 和 calculateAverage 方法可以直接調(diào)用 calculateSum 來獲取數(shù)組的總和，從而避免了代碼重復(fù)。
簡(jiǎn)化方法
隨著時(shí)間的推移，隨著維護(hù)代碼的人越來越多，代碼庫容易變得陳舊和混亂。為保證代碼的清晰度和易維護(hù)性，就非常有必要對(duì)代碼進(jìn)行重構(gòu)，使其更易理解、維護(hù)和擴(kuò)展。
在簡(jiǎn)化方法的過程中，首先要識(shí)別出那些包含復(fù)雜嵌套邏輯和承擔(dān)過多職責(zé)的方法。接著，可以通過以下幾步來簡(jiǎn)化它們：
- 遵循單一責(zé)任原則（SRP）來調(diào)整方法的功能劃分。
- 將部分功能提取出來，創(chuàng)建新的子方法。
- 刪除無用和冗余的代碼。
- 減少方法內(nèi)部的嵌套層次，使其結(jié)構(gòu)更清晰。
接下來，我們將通過一個(gè) Java 代碼重構(gòu)示例來具體展示如何簡(jiǎn)化方法。
簡(jiǎn)化前
public class ShoppingCart {
private List<Item> items;
// 計(jì)算總價(jià)
public double calculateTotalCost() {
double total = 0;
for (Item item : items) {
if (item.isDiscounted()) {
total += item.getPrice() * 0.8;
} else {
total += item.getPrice();
}
}
if (total > 100) {
total -= 10;
}
return total;
}
}我們可以通過提取 calculateItemPrice 邏輯到 calculateItemPrice 和 applyDiscount 方法中，并使用三元運(yùn)算符來簡(jiǎn)化條件判斷，使上述示例更為簡(jiǎn)潔。
簡(jiǎn)化后
public class ShoppingCart {
private List<Item> items;
// 計(jì)算總價(jià)
public double calculateTotalCost() {
double total = 0;
for (Item item : items) {
total += calculateItemPrice(item);
}
total -= applyDiscount(total);
return total;
}
// 計(jì)算價(jià)格
private double calculateItemPrice(Item item) {
return item.isDiscounted() ? item.getPrice() * 0.8 : item.getPrice();
}
// 獲取滿減
private double applyDiscount(double total) {
return total > 100 ? 10 : 0;
}
}紅綠重構(gòu)流程
圖片來源: Codecademy
紅綠重構(gòu)，又稱測(cè)試驅(qū)動(dòng)開發(fā)（TDD），是一種強(qiáng)調(diào)先編寫測(cè)試再編寫能通過這些測(cè)試的代碼的代碼重構(gòu)技術(shù)。該技術(shù)是一個(gè)循環(huán)迭代的過程，每一輪迭代都包括編寫新的測(cè)試和足夠的代碼來通過這些測(cè)試，最后對(duì)代碼進(jìn)行重構(gòu)。
這一技術(shù)包括以下三個(gè)階段：
- 紅色階段： 在這一階段，你還未編寫實(shí)際的代碼。首先需要編寫一組預(yù)期會(huì)失敗的測(cè)試（標(biāo)記為紅色），因?yàn)檫€沒有相應(yīng)的實(shí)現(xiàn)來滿足這些測(cè)試條件。
- 綠色階段： 此階段的目的是編寫足夠的代碼來通過之前編寫的未通過的測(cè)試，即讓測(cè)試變綠。注意，此時(shí)的目標(biāo)不是編寫完美或高度優(yōu)化的代碼，而是簡(jiǎn)單地確保測(cè)試的通過。
- 重構(gòu)階段： 在確認(rèn)代碼已成功通過所有測(cè)試后，此時(shí)應(yīng)著重于代碼重構(gòu)，以提升其性能和結(jié)構(gòu)，而不改變其基本功能，確保測(cè)試仍然能夠順利通過。
每完成一個(gè)測(cè)試用例后，你將進(jìn)入下一個(gè)循環(huán)，繼續(xù)編寫新的測(cè)試用例和對(duì)應(yīng)的代碼，然后再進(jìn)行代碼重構(gòu)以實(shí)現(xiàn)更好的優(yōu)化。
優(yōu)化違反單一責(zé)任原則的代碼
可能你已對(duì)面向?qū)ο缶幊讨械?SOLID 原則有所了解。SOLID 是五個(gè)設(shè)計(jì)原則的首字母縮寫。
- S：?jiǎn)我回?zé)任原則（Single Responsibility Principle），這個(gè)原則強(qiáng)調(diào)一個(gè)類應(yīng)該僅有一個(gè)變化的原因，簡(jiǎn)言之，一個(gè)類應(yīng)只負(fù)責(zé)一個(gè)功能點(diǎn)。
- O：開放封閉原則（Open Closed Principle），軟件實(shí)體應(yīng)該是可擴(kuò)展的而不是可修改的。
- L：里氏替換原則（Liskov Substitution Principle），對(duì)象應(yīng)該能夠被其子類型所替換，而不影響程序的正確性。
- I：接口隔離原則（Interface Segregation Principle），客戶端不應(yīng)被強(qiáng)迫依賴于它們不用的接口。
- D：依賴倒置原則（Dependency Inversion Principle），高層模塊不應(yīng)該依賴于低層模塊，二者都應(yīng)該依賴于抽象。
單一責(zé)任原則是首要原則，該原則強(qiáng)調(diào)每個(gè)類應(yīng)僅有一個(gè)變化的原因，即一個(gè)類只負(fù)責(zé)一個(gè)功能點(diǎn)遵守單一責(zé)任原則是確保代碼可維護(hù)、可讀、靈活和模塊化的基本方式之一。下面我們將展示一個(gè) OrderProcessor 類的示例，這個(gè)類違反了單一責(zé)任原則，因?yàn)樗瑫r(shí)承擔(dān)了訂單處理和記錄信息日志兩項(xiàng)職責(zé)。
重構(gòu)前
public class OrderProcessor {
// 處理訂單
public void processOrder(Order order) {
// 訂單驗(yàn)證
// 處理邏輯
// 日志記錄
Logger logger = new Logger();
logger.log("Order processed: " + order.getId());
}
}為了遵循單一責(zé)任原則，我們可以將該類重構(gòu)為三個(gè)類：一個(gè)是 OrderProcessor 類，只負(fù)責(zé)訂單處理；OrderValidator負(fù)責(zé)訂單校驗(yàn)，另外一個(gè)是 OrderLogger 類，專門負(fù)責(zé)日志記錄。
重構(gòu)后
public class OrderProcessor {
private final OrderValidator orderValidator;
public OrderProcessor(OrderValidator orderValidator) {
this.orderValidator = orderValidator;
}
// 處理訂單
public void processOrder(Order order) {
// 訂單驗(yàn)證
if(!orderValidator.validate(order)) {
throw new IllegalArgumentException("Order is not valid");
}
// 處理邏輯
// ...
// 日志記錄
OrderLogger logger = new OrderLogger();
logger.logOrderProcessed(order);
}
}
public class OrderValidator {
// 訂單驗(yàn)證
public boolean validate(Order order) {
// 驗(yàn)證邏輯
// ...
return true;
}
}
public class OrderLogger {
public void logOrderProcessed(Order order) {
Logger logger = new Logger();
logger.log("Order processed: " + order.getId());
}
}Java 代碼重構(gòu)的 14 條最佳實(shí)踐
代碼重構(gòu)是一個(gè)能夠顯著提升代碼質(zhì)量的重要步驟，它帶來了我們之前強(qiáng)調(diào)的諸多好處。但在進(jìn)行重構(gòu)時(shí)也需謹(jǐn)慎，特別是在處理龐大的代碼庫或不熟悉的代碼庫時(shí)，以避免無意中改變軟件的功能或產(chǎn)生未預(yù)見的問題。
為了避免任何潛在問題，您可以參考以下重構(gòu) Java 代碼的技巧和最佳實(shí)踐：
- 保持功能不變： Java 代碼重構(gòu)的首要目標(biāo)是提高代碼質(zhì)量。然而，程序的外部行為，如它如何響應(yīng)輸入和輸出以及其他用戶交互應(yīng)該保持不變。
- 充分理解代碼： 在開始重構(gòu)某個(gè)代碼片段之前，請(qǐng)確保你充分理解你即將重構(gòu)的代碼。這包括其功能、交互和依賴關(guān)系。這種理解將指導(dǎo)你的決策，并幫助你避免做出可能影響代碼功能的更改。
- 將 Java 重構(gòu)過程分解為小步驟： 重構(gòu)大型軟件，尤其是當(dāng)你對(duì)它還不夠了解時(shí)，可能會(huì)令人感到不知所措。然而，通過將重構(gòu)過程分解為更小、易于管理的步驟，你可以使工作負(fù)擔(dān)更輕，減少錯(cuò)誤的風(fēng)險(xiǎn)，并容易持續(xù)驗(yàn)證你的更改。
- 使用版本控制創(chuàng)建備份： 由于重構(gòu)涉及對(duì)代碼庫進(jìn)行更改，有可能事情不會(huì)按計(jì)劃進(jìn)行。在一個(gè)單獨(dú)的分支上備份你的工作軟件是一個(gè)好主意，以避免在找不出是哪些更改破壞了你的軟件時(shí)浪費(fèi)大量時(shí)間和資源。像 Git 這樣的版本控制系統(tǒng)允許你同時(shí)管理不同的軟件版本。
- 頻繁測(cè)試你的更改： 在重構(gòu)代碼時(shí)你最不想做的就是不小心破壞程序的功能或引入影響軟件的錯(cuò)誤。在進(jìn)行任何重大的代碼更改之前，尤其是重構(gòu)，建立一套測(cè)試集是提供安全網(wǎng)的好方法。這些測(cè)試驗(yàn)證你的代碼行為是否符合預(yù)期，以及現(xiàn)有的功能是否保持完整。
- 利用重構(gòu)工具： 有了像 Eclipse 和 IntelliJ 這樣的現(xiàn)代 IDE，Java 代碼重構(gòu)不必是一個(gè)緊張的過程。例如，IntelliJ IDEA 包括一套強(qiáng)大的重構(gòu)功能。一些功能包括安全刪除，提取方法/參數(shù)/字段/變量，內(nèi)聯(lián)重構(gòu)，復(fù)制/移動(dòng)等。這些功能使你的工作更輕松，減少了你在重構(gòu)過程中引入錯(cuò)誤的機(jī)會(huì)。
- 深入理解代碼變更：在重構(gòu)過程中，深入了解你所做的代碼變更是非常重要的，它可以幫助你快速識(shí)別和解決可能出現(xiàn)的問題。
- 充分利用單元測(cè)試：作為開發(fā)者，我們需要確保在重構(gòu)代碼時(shí)不會(huì)破壞現(xiàn)有的應(yīng)用程序或引入新的 bug。一個(gè)完善的單元測(cè)試套件可以幫助你檢測(cè)回歸問題，確保功能的完整性，同時(shí)也有利于團(tuán)隊(duì)合作和長(zhǎng)期的代碼維護(hù)。
- 持續(xù)跟蹤性能變化并反饋：Java 代碼重構(gòu)不僅僅是為了改善代碼結(jié)構(gòu)，它還涉及到性能優(yōu)化。通過持續(xù)監(jiān)控性能指標(biāo)，你可以確保你的重構(gòu)工作正在取得實(shí)質(zhì)性的進(jìn)展。
- 進(jìn)行同行代碼審查：重構(gòu)完成后，建議邀請(qǐng)另一名開發(fā)者來審查你的更改，他們可以從一個(gè)新的角度來發(fā)現(xiàn)可能被你忽視的問題，并提供有價(jià)值的反饋。
- 記錄重構(gòu)變更：當(dāng)你與其他開發(fā)者一起工作時(shí)，記錄你的重構(gòu)變更非常重要，因?yàn)檫@樣可以提高透明度和協(xié)作效率，同時(shí)也有助于新員工更快地了解項(xiàng)目。
- 進(jìn)行回歸測(cè)試：完成重構(gòu)后，需要通過回歸測(cè)試來確保所有現(xiàn)有的功能都得到了保留，并且新引入的邏輯沒有與現(xiàn)有代碼產(chǎn)生沖突。
- 保持團(tuán)隊(duì)同步：在多人開發(fā)團(tuán)隊(duì)中工作時(shí)，及時(shí)通報(bào)你的重構(gòu)變更非常必要，這可以避免沖突并幫助團(tuán)隊(duì)更好地適應(yīng)新的變更。
- 在必要時(shí)執(zhí)行回滾：如果重構(gòu)過程中遇到無法解決的問題，不要猶豫，立即回滾到一個(gè)穩(wěn)定的狀態(tài)，以避免浪費(fèi)更多的時(shí)間和資源。
結(jié)論
重構(gòu)是一項(xiàng)至關(guān)重要的技術(shù)實(shí)踐，它是確保軟件項(xiàng)目長(zhǎng)期成功的關(guān)鍵。 通過融入我們之前討論的技術(shù)到你的開發(fā)周期并嚴(yán)格遵循最佳實(shí)踐，你可以把任何復(fù)雜且混亂的代碼庫改造為一個(gè)可讀、可維護(hù)和可擴(kuò)展的軟件解決方案。但請(qǐng)注意，Java 代碼重構(gòu)不是一次性的任務(wù)，而是一個(gè)可以持續(xù)整合到你的開發(fā)周期中的過程。
常見問題解答
應(yīng)該何時(shí)重構(gòu)我的 Java 代碼？
在軟件開發(fā)的任何階段都可以進(jìn)行代碼重構(gòu)。無論是在添加新功能、修復(fù) bug 還是優(yōu)化難以理解的代碼片段時(shí)，都是進(jìn)行重構(gòu)的好時(shí)機(jī)。定期預(yù)留時(shí)間來進(jìn)行重構(gòu)可以避免技術(shù)債務(wù)的累積，從而維持代碼庫的高質(zhì)量。
如何決定哪些代碼需要重構(gòu)？
你可以從識(shí)別代碼庫中難以理解、存在重復(fù)邏輯或容易產(chǎn)生 bug 的區(qū)域開始。尋找具有冗長(zhǎng)的方法、復(fù)雜條件語句的代碼，并嘗試遵循“單一職責(zé)原則”來提高代碼的組織性。
如何確保重構(gòu)不會(huì)引入 bug？
擁有一套完善的自動(dòng)化測(cè)試套件是減少重構(gòu)過程中引入 bug 的風(fēng)險(xiǎn)的關(guān)鍵。在開始重構(gòu)之前，確保你的代碼具有良好的測(cè)試覆蓋率，這將幫助你捕捉任何可能的回歸問題，確保代碼功能的穩(wěn)定性。
如何在 Java 中重構(gòu)類？
首先，你需要確定目標(biāo)類并深入理解其行為和依賴關(guān)系。然后可以考慮拆分龐大的方法和將方法移動(dòng)到更適合的類中，同時(shí)利用繼承和接口來實(shí)現(xiàn)更清晰的結(jié)構(gòu)。此外，重命名變量和方法、重新組織代碼結(jié)構(gòu)和簡(jiǎn)化條件語句都可以提高代碼的可讀性。最后，確保對(duì)所有更改進(jìn)行徹底測(cè)試，以保證功能的完整性。
譯者介紹
劉汪洋，51CTO社區(qū)編輯，昵稱：明明如月，一個(gè)擁有 5 年開發(fā)經(jīng)驗(yàn)的某大廠高級(jí) Java 工程師，擁有多個(gè)主流技術(shù)博客平臺(tái)博客專家稱號(hào)。
標(biāo)題：CODE REFACTORING IN JAVA: TIPS, BEST PRACTICES, TECHNIQUES，作者：Digma
