Java 中常見的程式碼味道以及如何修復它們

程式碼異味表示 Java 程式碼中存在潛在問題，影響可維護性、可讀性和效能。 雖然錯誤並不總是存在，但解決它們可以使您的程式碼庫保持乾淨和高效。本文研究了五種常見的 Java 程式碼異味，提供了範例、解釋和改進的解決方案。

---

1. 過長的方法

問題：過長的方法會妨礙可讀性、測試和維護。即使使用輔助方法，組合多個抽象層級也會違反單一職責原則 (SRP)。

範例：

public void processOrder(Order order) {
    validateOrder(order);
    calculateDiscount(order);
    updateInventory(order);
    generateInvoice(order);
    sendNotification(order);
}

processOrder 混合了不相關的任務（驗證、折扣計算、庫存更新、發票和通知），因此很難在不產生意外後果的情況下進行修改。

解：重建為較小、較集中的方法。命令模式或管道模式等設計模式增強了模組化性。

重構程式碼（指令模式）：

interface OrderCommand { void execute(Order order); }

class ValidateOrderCommand implements OrderCommand {
    public void execute(Order order) { /* Validation logic */ }
}

// ... other commands (ApplyDiscountCommand, etc.)

class OrderProcessor {
    List<OrderCommand> commands;

    public OrderProcessor(List<OrderCommand> commands) { this.commands = commands; }

    public void processOrder(Order order) {
        for (OrderCommand command : commands) { command.execute(order); }
    }
}

// Usage
List<OrderCommand> commands = List.of(new ValidateOrderCommand(), new ApplyDiscountCommand(), ...);
OrderProcessor processor = new OrderProcessor(commands);
processor.processOrder(new Order());

優點：改進的模組化、獨立測試和指令重複使用、輕鬆新增步驟。

---

2. 神課

問題：一個「神類」承擔太多職責，導致耦合度高，可維護性差。

範例：

public class OrderManager {
    public void createOrder() { /* Implementation */ }
    public void updateOrder() { /* Implementation */ }
    public void deleteOrder() { /* Implementation */ }
    public void validatePayment() { /* Implementation */ }
    public void sendInvoice() { /* Implementation */ }
}

解決方案：將職責分解為較小的、較集中的類別。

重構程式碼：

public class OrderService {
    public void createOrder() { /* Implementation */ }
    // ... other order-related methods
}

public class PaymentService {
    public void validatePayment() { /* Implementation */ }
}

public class NotificationService {
    public void sendInvoice() { /* Implementation */ }
}

好處：減少耦合，提高模組化，更容易維護、測試和獨立擴展。

---

3. 神奇數字

問題：直接使用文字數字會降低程式碼清晰度並增加修改風險。

範例：

public double calculateDiscount(double totalAmount) {
    return totalAmount > 1000 ? totalAmount * 0.1 : totalAmount;
}

解：用命名常數取代文字數字。

重構程式碼：

private static final double DISCOUNT_THRESHOLD = 1000;
private static final double DISCOUNT_RATE = 0.1;

public double calculateDiscount(double totalAmount) {
    return totalAmount > DISCOUNT_THRESHOLD ? totalAmount * DISCOUNT_RATE : totalAmount;
}

好處：增強可讀性，降低更新過程中的錯誤風險，更清晰的業務邏輯。

---

4. 重複程式碼

問題：跨方法或類別的重複程式碼會導致不一致和維護麻煩。

範例：

public double calculateTax(double amount) { return amount * 0.18; }
public double calculateDiscount(double amount) { return amount * 0.1; }

解：將通用邏輯抽象化為可重複使用的方法。

重構程式碼：

private double applyRate(double amount, double rate) { return amount * rate; }

public double calculateTax(double amount) { return applyRate(amount, 0.18); }
public double calculateDiscount(double amount) { return applyRate(amount, 0.1); }

好處：消除冗餘，確保一致性，簡化修改和擴展。

---

5. 參數列表過多

問題：具有許多參數的方法難以閱讀、理解，並且在呼叫過程中容易出錯。

範例：

public void processOrder(Order order) {
    validateOrder(order);
    calculateDiscount(order);
    updateInventory(order);
    generateInvoice(order);
    sendNotification(order);
}

解決方案：將參數封裝在物件內或使用建構器模式。

重構程式碼：

interface OrderCommand { void execute(Order order); }

class ValidateOrderCommand implements OrderCommand {
    public void execute(Order order) { /* Validation logic */ }
}

// ... other commands (ApplyDiscountCommand, etc.)

class OrderProcessor {
    List<OrderCommand> commands;

    public OrderProcessor(List<OrderCommand> commands) { this.commands = commands; }

    public void processOrder(Order order) {
        for (OrderCommand command : commands) { command.execute(order); }
    }
}

// Usage
List<OrderCommand> commands = List.of(new ValidateOrderCommand(), new ApplyDiscountCommand(), ...);
OrderProcessor processor = new OrderProcessor(commands);
processor.processOrder(new Order());

好處：提高可讀性和可擴充性；新增參數不需要更改方法簽章。

---

主動解決程式碼異味可以防止更大的設計問題並減少技術債務，從而產生更健壯且可維護的 Java 應用程式。 記住 DRY（不要重複自己）和 SRP（單一職責原則）的原則，以獲得更乾淨、更有效率的程式碼。

以上是Java 中常見的程式碼味道以及如何修復它們的詳細內容。更多資訊請關注PHP中文網其他相關文章！