萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> ASP.NET 程式設計

C# 方法多載規範與最佳實踐:參數命名、順序、擴展性與 Override 差異

前言

方法多載 是 C# 實現多型的基礎技術之一,但濫用或設計不當會導致 API 混亂、呼叫端模糊不清。本文依據 Microsoft 設計指導方針,詳細說明多載的必要條件、參數命名/順序規範、擴展性設計、預設參數替代方案,並釐清與 Override (覆寫) 的本質差異。

一、構成多載的三個必要條件

  1. 同一個類別/結構 內 (或衍生類別對基類別成員多載)。
  2. 方法名稱相同。
  3. 參數清單不同:型別數量、型別順序、型別種類至少有一項不同。
    注意:回傳型別、修飾詞 (static/virtual)、參數名稱 不影響 多載簽章。

二、參數命名一致性規範

❌ 錯誤範例:參數名稱不一致

public void Write(string message, FileStream stream) { }
public void Write(string line, FileStream file, bool closeStream) { } // message vs line, stream vs file

✅ 正確範例:同義參數同名

public void Write(string message, FileStream stream) { }
public void Write(string message, FileStream stream, bool closeStream) { }

原則:代表相同意義的參數,在所有多載中必須使用相同名稱,方便 IntelliSense 與呼叫端閱讀。

三、參數順序一致性規範

❌ 錯誤範例:順序交換

public void Write(string message, FileStream stream) { }
public void Write(FileStream stream, string message, bool closeStream) { }

✅ 正確範例:相同參數保持相對位置

public void Write(string message, FileStream stream) { }
public void Write(string message, FileStream stream, bool closeStream) { }

四、預設參數 vs 多載 (C# 4.0+)

單純為了「參數可選」時,優先使用預設參數,減少多載數量:

// 推薦:單一方法 + 預設參數
public void Write(string message, FileStream stream, bool closeStream = false, Encoding encoding = null)
{
    encoding ??= Encoding.UTF8;
    // ...
}

// 僅在語意截然不同、或預設參數會造成語意模糊時才用多載
public void Write(string message, TextWriter writer) { ... } // 不同抽象層級

五、擴展性設計:最完整多載為虛擬方法

public class Logger
{
    // 1. 最完整簽章設為 virtual,衍生類可覆寫核心邏輯
    public virtual void Log(string message, LogLevel level, Exception ex, object context) { ... }

    // 2. 較簡單多載「鏈式呼叫」最完整者,避免重複程式碼
    public void Log(string message, LogLevel level, Exception ex) 
        => Log(message, level, ex, null);

    public void Log(string message, LogLevel level) 
        => Log(message, level, null, null);

    public void Log(string message) 
        => Log(message, LogLevel.Info, null, null);
}

優點:維護單一核心邏輯、衍生類僅需覆寫一處、新增參數不破壞現有呼叫端。

六、params 參數與 out/ref 參數限制

  • params 必須是 最後一個 參數,且每個方法僅能有一個。
  • out/ref 參數慣例放在最後,且不參與多載簽章區分 (即無法只靠 ref/out 差異多載)。

七、多載 vs 覆寫 差異總結

特性Overload (多載)Override (覆寫)
關係同一類別內多個同名方法基類與衍生類之間
簽章參數清單必須不同名稱、參數、回傳型別必須完全相同
關鍵字無 (隱含)virtual/abstract + override
多型編譯期靜態綁定 (靜態多型)執行期動態綁定 (動態多型)
目的提供不同參數便利性改變/擴充基類行為

八、實戰反模式與重構建議

反模式 1:布林旗標多載

// ❌ 難以閱讀呼叫意圖
public void Save(bool validate) { ... }
public void Save() { ... }

// ✅ 拆分為語意明確的方法
public void Save() { Save(validate: true); }
public void SaveWithoutValidation() { Save(validate: false); }

反模式 2:多載過多 (超過 5 個)

改用 建造者模式 或 選項物件:

public class ReportOptions
{
    public bool IncludeHeader { get; set; } = true;
    public bool IncludeFooter { get; set; } = false;
    public ExportFormat Format { get; set; } = ExportFormat.Pdf;
    // ...
}

public void GenerateReport(ReportOptions options) { ... }

九、總結清單

  • 同名參數、同樣順序、同樣語意。
  • 預設參數優先,多載補足語意差異。
  • 最完整多載設為 virtual,簡單多載鏈式呼叫。
  • 避免布林旗標、過多多載,改用選項物件。
  • 清楚區分 Overload (靜態) vs Override (動態)。
copyright © 萬盛學電腦網 all rights reserved