CodeGym /課程 /C# SELF /Extension Members: 方法

Extension Members: 方法

C# SELF
等級 18, 課堂 2
開放

1. 前言

在物件導向程式設計的世界裡,我們常常會遇到想要幫現有 class 加新功能的需求。有時候我們根本拿不到那些 class 的原始碼(像是標準 .NET 類型、第三方 library 的 class 或自動產生的程式碼)。

這時候 Extension Methods 就超級好用啦——C# 語言裡一個強大又優雅的功能,讓你可以「假裝」幫現有類型加新方法,完全不用動到它本身。

Extension methods 其實就是 C# 的 syntactic sugar,讓你可以把 static 方法當成 instance 方法來呼叫。它們看起來、用起來就像本來就是那個類型的一部分,但其實不是啦。

假設你想要一個方法,把字串的第一個字母變大寫:


public static class StringUtil
{
    public static string CapitalizeFirstLetter(string str)
    {
        if (string.IsNullOrEmpty(str)) return str;
        return char.ToUpper(str[0]) + str.Substring(1);
    }
}

// 使用方式
string hello = StringUtil.CapitalizeFirstLetter("привет"); // "Привет"
Console.WriteLine(hello); 

這段 code 沒什麼,但 C# 其實可以寫得更精簡。

這一行

string hello = StringUtil.CapitalizeFirstLetter("привет"); // "Привет"

可以這樣寫:

string hello = "привет".CapitalizeFirstLetter(); // "Привет"

現在我來解釋這到底怎麼運作。

2. Extension Methods 的原理

Extension Methods 看起來很神奇,其實底層很簡單。Extension method 就是普通的 static 方法,寫在 static class 裡,但有個重點:它的第一個參數前面要加 this。這個參數就是指定這個方法要「擴充」哪個類型。

來看一個擴充 string 類型的例子:

namespace MyProject.Extensions
{
    // 1. Extension Methods 一定要寫在 static class 裡。
    public static class StringExtensions
    {
        // 2. 方法要是 static。
        // 3. 第一個參數要加 'this'。
        public static string CapitalizeFirstLetter(this string str)
        {
            if (string.IsNullOrEmpty(str)) 
                return str; 

            // 用 String.ToUpper 跟 String.Substring 產生新字串
            return char.ToUpper(str[0]) + str.Substring(1);
        }

        // 再加一個例子:
        public static int WordCount(this string text)
        {
            if (string.IsNullOrEmpty(text))
                return 0;

            // 最簡單的字數統計,用空白分割
            return text.Split(new char[] { ' ' }, StringSplitOptions.RemoveEmptyEntries).Length;
        }
    }
}    

要用這些方法,只要在你的檔案裡加上 MyProject.Extensions 命名空間就好:

using MyProject.Extensions; // 重點:要 import 有 Extension Methods 的命名空間

string hello = "привет, мир!";
Console.WriteLine(hello.CapitalizeFirstLetter()); // 會印出:"Привет, мир!"

string sentence = "Это тестовая строка для подсчета слов.";
Console.WriteLine($"Количество слов: {sentence.WordCount()}"); // 會印出:"Количество слов: 6"

string emptyString = "";
Console.WriteLine(emptyString.CapitalizeFirstLetter()); // 會印出:""

重點:如果你沒在第一個參數 string str 前面加 this,CapitalizeFirstLetter 就只是 StringExtensions 的普通 static 方法,你只能這樣叫:StringExtensions.CapitalizeFirstLetter("привет")。就是 this 讓它變成 Extension Method,才能用物件導向的寫法呼叫。

3. Extension Methods 的語法

要寫 Extension Methods,照這幾步走就對了:

  1. 寫一個 static class: 所有 Extension Methods 都要寫在 static class 裡。名字隨便你,但通常會叫 [TypeName]Extensions(像 StringExtensions、ListExtensions、DateTimeExtensions)。
  2. 寫 static 方法: 在你的 static class 裡寫普通 static 方法。
  3. 第一個參數加 this: 最重要的就是第一個參數要加 this,後面接你想擴充的類型。這個參數就是你呼叫 Extension Method 時的物件。
  4. 加上命名空間: 在你要用 Extension Method 的檔案裡,記得加上(using)有你 static class 的命名空間。不然 compiler 找不到你的擴充方法。
  5. 直接當普通方法用: 你現在可以直接把 Extension Method 當成該類型的 instance 方法來呼叫了。

4. 「魔法」其實怎麼運作

Extension Methods 的「魔法」其實都是 C# 編譯器 在搞鬼。程式跑的時候,Extension Methods 並不是真的加進 class 裡。C# 編譯器會把你呼叫 Extension Method 的寫法轉成普通的 static 方法呼叫。

當你寫 obj.Method(args),而 Method 是 Extension Method,編譯器其實會把它變成 ContainingClass.Method(obj, args)。這一切都在背後自動完成,所以你才會覺得這個方法好像本來就在 class 裡。

命名衝突怎麼辦:Extension Methods vs 原生方法

如果 class 本來就有一個跟你的 Extension Method 同名同參數的方法,會發生什麼事?

public class MyClass
{
    public void DoSomething(int value)
    {
        Console.WriteLine($"Родной метод MyClass.DoSomething: {value}");
    }
}

public static class MyClassExtensions
{
    public static void DoSomething(this MyClass instance, int value)
    {
        Console.WriteLine($"Extension Method MyClassExtensions.DoSomething: {value}");
    }
}

// 用法:
MyClass obj = new MyClass();
obj.DoSomething(10); // 會呼叫原生方法 MyClass.DoSomething: 10

優先順序規則: 如果 class 已經有 instance 方法跟你的 Extension Method 同名同參數,一定會呼叫原生 instance 方法,Extension Method 只會在找不到原生方法時才會被用到。

Extension Methods 的限制

  • 不能 override(覆寫)現有方法: Extension Methods 不能參與多型。
  • 不能加新欄位、屬性或事件: 只能加方法,不能用來加新狀態。
  • 不能擴充 static class: 第一個 this 參數一定要是 instance。
  • 不能擴充欄位或屬性: 只能擴充類型。
  • 不能存取 private 或 protected 成員: Extension Methods 只能用 public 的成員。

不過,你可以幫這些東西加 Extension Methods:

  • 介面: 這超強!你可以幫所有實作某個 interface 的 class 加方法,完全不用動 interface 或每個 class。像所有實作 IEnumerable<T> 的 class 都能用 LINQ 的 Extension Methods。
  • object 類型: 這樣你寫的 Extension Methods 任何物件都能用。但要小心,這樣很容易把全域命名空間搞亂,還可能撞名。

5. 真實範例跟 Best Practices

Extension Methods 不是紙上談兵,是真的很實用的工具。來看幾個實戰場景:

1. 擴充 DateTime:

加一些常用的日期處理方法,商業邏輯常常會用到。

using System;

namespace MyProject.TimeHelpers
{
    public static class DateTimeExtensions
    {
        public static bool IsWeekend(this DateTime date)
        {
            return date.DayOfWeek == DayOfWeek.Saturday || date.DayOfWeek == DayOfWeek.Sunday;
        }

        public static bool IsWeekday(this DateTime date)
        {
            return !date.IsWeekend(); // 直接用前面寫的 Extension Method!
        }

        public static DateTime NextDay(this DateTime date)
        {
            return date.AddDays(1);
        }

        public static DateTime AddBusinessDays(this DateTime date, int days)
        {
            DateTime newDate = date;
            while (days > 0)
            {
                newDate = newDate.NextDay();
                if (newDate.IsWeekday())
                {
                    days--;
                }
            }
            return newDate;
        }
    }
}

用法:

using MyProject.TimeHelpers;

DateTime today = DateTime.Now;
if (today.IsWeekend())
{
    Console.WriteLine("今天是假日!");
}
else
{
    Console.WriteLine("今天是平日。");
}

DateTime tomorrow = today.NextDay();
Console.WriteLine($"明天:{tomorrow.ToShortDateString()}");

DateTime futureDate = today.AddBusinessDays(5);
Console.WriteLine($"5 個工作天後是:{futureDate.ToShortDateString()}");

2. 擴充自己的類型(例如 Dog):

就算你有 class 的原始碼,Extension Methods 也很適合把輔助邏輯拆出來,或是遵守單一職責原則(Single Responsibility Principle)。

namespace MyProject.Animals
{
    public class Dog
    {
        public string Name { get; set; }
        public int Age { get; set; }
        public string Breed { get; set; }
    }

    public static class DogExtensions
    {
        public static bool IsPuppy(this Dog dog)
        {
            // 判斷是不是小狗
            return dog.Age < 2;
        }

        public static string GetAgeCategory(this Dog dog)
        {
            if (dog.Age < 1) return "小狗";
            if (dog.Age < 7) return "成犬";
            return "老狗";
        }

        public static void Bark(this Dog dog)
        {
            Console.WriteLine($"{dog.Name} 說:汪!汪!");
        }
    }
}

用法:


using MyProject.Animals;

var sharik = new Dog { Name = "Шарик", Age = 1, Breed = "Дворняга" };
if (sharik.IsPuppy())
{
    Console.WriteLine($"{sharik.Name} — 還是小狗!"); // Шарик — 還是小狗!
}

Console.WriteLine($"{sharik.Name} 的年齡分類:{sharik.GetAgeCategory()}"); // Шарик 的年齡分類:小狗
sharik.Bark(); // Шарик 說:汪!汪!

var rex = new Dog { Name = "Рекс", Age = 5, Breed = "Овчарка" };
Console.WriteLine($"{rex.Name} 的年齡分類:{rex.GetAgeCategory()}"); // Рекс 的年齡分類:成犬

Best Practices:

名字要有意義: 擴充 class(StringExtensions、ListExtensions)跟方法本身的名字都要清楚表達功能。

放在合理的命名空間: 把 Extension Methods 分類放在對應的命名空間,避免把全域命名空間塞爆。

用得要剛好: 不要亂用 Extension Methods。如果你能直接改 class,加方法進去可能更乾淨。Extension Methods 最適合加非侵入式功能。

避免命名衝突: 記得原生方法優先。如果你的 Extension Method 跟現有方法撞名,是不會被呼叫的。

方法要單純: Extension Methods 最好只做一件事,不要搞太複雜。

好測試: Extension Methods 就是普通 static 方法,很好寫單元測試。

2
任務
C# SELF, 等級 18, 課堂 2
上鎖
建立一個簡單的字串 Extension Method
建立一個簡單的字串 Extension Method
2
任務
C# SELF, 等級 18, 課堂 2
上鎖
int 類型的擴充方法,用來處理數字
int 類型的擴充方法,用來處理數字
留言
TO VIEW ALL COMMENTS OR TO MAKE A COMMENT,
GO TO FULL VERSION