代碼壞味道 (Code Smells) 完整識別與重構指南：軟體品質改善最佳實踐

Thu, 17 Mar 2022 22:50:11 +0800

代碼壞味道 (Code Smells) 完整識別與重構指南

概述

代碼壞味道是指代碼中存在的設計缺陷和結構問題，雖然不會導致程序功能錯誤，但會影響代碼的可讀性、可維護性和可擴展性。本文將深入探討各種代碼壞味道的識別方法、重構技巧和預防策略。

經典四大軟體設計問題

1. Rigidity (僵化性) - 難以變更

問題描述： 系統中存在過多的相依性，導致任何小的變更都需要修改大量相關代碼。

症狀：

修改一個小功能需要改動多個模組
開發人員害怕進行代碼變更
估算工作量困難，因為變更範圍難以預測

壞味道示例：

// 僵化的訂單處理系統
public class OrderService {
    private DatabaseConnection dbConnection;
    private EmailService emailService;
    private InventoryService inventoryService;
    private PaymentService paymentService;
    private LoggingService loggingService;
    
    public void processOrder(Order order) {
        // 直接依賴具體實現，難以變更
        dbConnection.connect("jdbc:mysql://localhost:3306/orders");
        
        // 硬編碼的業務邏輯
        if (order.getType().equals("PREMIUM")) {
            order.setDiscount(0.1);
        } else if (order.getType().equals("STANDARD")) {
            order.setDiscount(0.05);
        }
        
        // 緊密耦合的操作順序
        inventoryService.reserveItems(order.getItems());
        paymentService.processPayment(order.getPayment());
        dbConnection.saveOrder(order);
        emailService.sendConfirmationEmail(order.getCustomer());
        loggingService.log("Order processed: " + order.getId());
    }
}

重構解決方案：

UML 統一建模語言完整指南：軟體設計與架構建模最佳實踐

Mon, 12 Jul 2021 23:33:14 +0800

UML 統一建模語言完整指南

概述

UML（Unified Modeling Language，統一建模語言）是一種標準化的建模語言，用於軟體系統的視覺化、規範、建構和文檔化。UML 提供了多種圖形表示法，幫助開發人員理解系統結構、行為和互動關係。

UML 圖形分類

結構圖（Structure Diagrams）

類別圖（Class Diagram）：展示類別及其關係
物件圖（Object Diagram）：展示特定時刻的物件實例
封裝圖（Package Diagram）：展示套件及其依賴關係
部署圖（Deployment Diagram）：展示系統部署結構

行為圖（Behavior Diagrams）

使用案例圖（Use Case Diagram）：展示系統功能和用戶互動
活動圖（Activity Diagram）：展示工作流程和業務邏輯
狀態圖（State Diagram）：展示物件狀態變化

互動圖（Interaction Diagrams）

序列圖（Sequence Diagram）：展示物件間的時間順序互動
協作圖（Collaboration Diagram）：展示物件間的協作關係
時序圖（Timing Diagram）：展示物件在時間軸上的狀態變化

類別圖關係詳解

1. 依賴關係（Dependency）

符號： 虛線箭頭 A -----> B

意義： A 類別使用 B 類別，通常是臨時性的使用關係，如方法參數、局部變數或靜態方法調用。

Java 實現範例：

// 依賴關係示例
public class OrderService {
    
    // 方法參數依賴
    public void processOrder(Order order, PaymentProcessor processor) {
        // OrderService 依賴 PaymentProcessor
        processor.processPayment(order.getAmount());
    }
    
    // 靜態方法依賴
    public void validateOrder(Order order) {
        // OrderService 依賴 OrderValidator
        if (!OrderValidator.validate(order)) {
            throw new ValidationException("無效的訂單");
        }
    }
    
    // 局部變數依賴
    public void sendNotification(Order order) {
        // OrderService 依賴 EmailService
        EmailService emailService = new EmailService();
        emailService.sendOrderConfirmation(order);
    }
}

// 被依賴的類
public class PaymentProcessor {
    public void processPayment(BigDecimal amount) {
        // 處理付款邏輯
    }
}

public class OrderValidator {
    public static boolean validate(Order order) {
        return order != null && order.getAmount() != null;
    }
}

public class EmailService {
    public void sendOrderConfirmation(Order order) {
        // 發送確認郵件
    }
}

2. 關聯關係（Association）

符號： 實線箭頭 A -----> B

Design Patterns on Bill.Lin's Notes