C#の拡張メソッド：構文、IEnumerable、LINQ、ルール

拡張メソッドは、既存の型を変更したり、継承したり、ラップしたりせずに、その型にメソッドを追加します。通常の静的メソッドを書いて最初の引数に this を付けると、呼び出し側は、その型が最初からそのメソッドを持っていたかのようにドット構文で使えます。

using System;

static class StringExtensions
{
    public static string Truncate(this string text, int maxLength)
    {
        if (text.Length <= maxLength) return text;
        return text.Substring(0, maxLength) + "...";
    }

    public static int WordCount(this string text) =>
        text.Split(new[] { ' ' }, StringSplitOptions.RemoveEmptyEntries).Length;
}

class Program
{
    static void Main()
    {
        string title = "Extension methods let you add behavior to types you do not own";

        Console.WriteLine(title.Truncate(24));
        Console.WriteLine(title.WordCount());
        Console.WriteLine("short".Truncate(24));

        Console.WriteLine(StringExtensions.Truncate(title, 9));   // the same method, called directly
    }
}

出力：

Extension methods let yo...
12
short
Extension...

title.Truncate(24) は、まさに StringExtensions.Truncate(title, 24) にコンパイルされます。ドット構文は便宜上のものにすぎません。メソッドは静的なままで、StringExtensions の中にあり、string の公開メンバーしか使えません。

宣言のルール

• メソッドは static で、static で非ジェネリックで他のクラスに入れ子になっていないクラスの中になければなりません。非静的またはジェネリックなクラスではCS1106 Extension method must be defined in a non-generic static class、入れ子のクラスではCS1109 Extension methods must be defined in a top level static class になります。
• this は最初の引数にだけ付け、その引数の型が拡張される型です。それ以降の引数は通常どおりです。
• クラスはジェネリックにできませんが、メソッド自体はジェネリックにできます（this IEnumerable<T> source）。
• 見えるのは外部のコードから見えるものだけで、public（同じアセンブリ内ならinternal）のメンバーです。privateなフィールドはprivateのままです。

慣例として、クラスには拡張する対象にちなんだ名前を付け（StringExtensions、EnumerableExtensions）、MyApp.Extensions のような名前空間にまとめます。

インターフェースとIEnumerable<T>の拡張

インターフェースを拡張すると、それを実装するすべての型にメソッドが追加されます。したがって IEnumerable<T> を拡張すると、配列、リスト、セット、辞書のキーのコレクション、LINQクエリの結果に一度にメソッドが加わります。

using System;
using System.Collections.Generic;
using System.Linq;

static class EnumerableExtensions
{
    public static decimal Median(this IEnumerable<decimal> source)
    {
        var sorted = source.OrderBy(x => x).ToList();
        if (sorted.Count == 0) throw new InvalidOperationException("sequence is empty");
        int mid = sorted.Count / 2;
        return sorted.Count % 2 == 1 ? sorted[mid] : (sorted[mid - 1] + sorted[mid]) / 2;
    }

    public static IEnumerable<T> EveryNth<T>(this IEnumerable<T> source, int n)
    {
        int i = 0;
        foreach (T item in source)
        {
            if (i % n == 0) yield return item;
            i++;
        }
    }
}

class Program
{
    static void Main()
    {
        decimal[] prices = { 12m, 3m, 45m, 7m };
        var orderTotals = new List<decimal> { 20m, 80m, 50m };

        Console.WriteLine(prices.Median());
        Console.WriteLine(orderTotals.Median());
        Console.WriteLine(orderTotals.Where(t => t > 25m).Median());

        string[] frames = { "f0", "f1", "f2", "f3", "f4", "f5", "f6" };
        Console.WriteLine(string.Join(" ", frames.EveryNth(3)));
    }
}

出力：

9.5
50
65
f0 f3 f6

EveryNth はジェネリックです。T はレシーバーから推論されるので、ここでは文字列に対して動き、他の任意の要素型にも使えます。yield return を使っているので、組み込みのLINQ演算子と同じく遅延評価され、それらと連結できます。

LINQは拡張メソッドで作られている

Where、Select、OrderBy、Sum、First などのLINQは、静的クラス System.Linq.Enumerable に定義された IEnumerable<T> の拡張メソッドです。だから list.Where(...) をコンパイルするにはファイルの先頭に using System.Linq; が必要で、どのコレクション型も Where メソッドを実装していないのにLINQが使えるのです。

using System;
using System.Linq;

class Program
{
    static void Main()
    {
        int[] scores = { 72, 95, 58, 88 };

        var passed1 = scores.Where(s => s >= 60).OrderBy(s => s);
        var passed2 = Enumerable.OrderBy(Enumerable.Where(scores, s => s >= 60), s => s);

        Console.WriteLine(string.Join(", ", passed1));
        Console.WriteLine(string.Join(", ", passed2));
    }
}

出力：

72, 88, 95
72, 88, 95

2行は同じコードです。拡張の構文は、内側から外側へ読む入れ子の呼び出しを、処理が起きる順に読める連鎖に変えます。これが拡張メソッドが存在する主な理由で、C# 3でLINQとともに追加されました。演算子についてはLINQのページで扱います。

名前空間のインポートが必要

拡張メソッドがスコープに入るのは、その静的クラスの名前空間が using でインポートされているときだけです。インポートがないと、メソッドが存在しないかのように呼び出しが失敗します。

error CS1061: 'string' does not contain a definition for 'Truncate' and no accessible extension method 'Truncate' accepting a first argument of type 'string' could be found (are you missing a using directive or an assembly reference?)

拡張の名前空間の using を追加します（C# 10以降なら、プロジェクトに1回だけ global using を書く方法もあります）。

using System;
using Shop.Extensions;

namespace Shop.Extensions
{
    public static class PriceExtensions
    {
        public static string ToPriceTag(this decimal amount) => $"EUR {amount:F2}";
    }
}

class Program
{
    static void Main()
    {
        decimal total = 49.9m;
        Console.WriteLine(total.ToPriceTag());
    }
}

出力：

EUR 49.90

裏を返すと便利なこともあります。どこでも使えるようにはしたくない拡張メソッドを、一部のファイルだけがインポートする名前空間に置けます。

インスタンスメソッドが優先される

型がすでに適用可能なインスタンスメソッドを持っていると、コンパイラはそれを使い、拡張は決して検討しません。同じシグネチャの拡張は、ドット構文を使うすべての呼び出し箇所で死んだコードになります。

using System;

class Invoice
{
    public decimal Amount = 120m;
    public string Describe() => $"Invoice (instance method): {Amount}";
}

static class InvoiceExtensions
{
    public static string Describe(this Invoice invoice) => "extension: only reachable as a static call";
    public static string Describe(this Invoice invoice, string currency) =>
        $"Invoice (extension): {invoice.Amount} {currency}";
}

class Program
{
    static void Main()
    {
        var invoice = new Invoice();
        Console.WriteLine(invoice.Describe());
        Console.WriteLine(invoice.Describe("USD"));
        Console.WriteLine(InvoiceExtensions.Describe(invoice));
    }
}

出力：

Invoice (instance method): 120
Invoice (extension): 120 USD
extension: only reachable as a static call

引数1つの拡張はインスタンスメソッドに負けました。引数2つのほうは、文字列を受け取るインスタンスメソッドがないので使われました。つまり、ライブラリの更新で自分の拡張と同じ名前のインスタンスメソッドが追加されると、呼び出しが何も言わずにライブラリ側に切り替わります。衝突しにくい拡張の名前を選びます。

nullに対する呼び出し

呼び出しは実際には静的な呼び出しなので、null のレシーバーでも呼び出し箇所で例外は投げられません。メソッドは最初の引数として null を受け取り、それが何を意味するかを決めます。

using System;

static class TextExtensions
{
    public static bool IsBlank(this string s) => string.IsNullOrWhiteSpace(s);

    public static string Initials(this string fullName)
    {
        if (fullName == null) throw new ArgumentNullException(nameof(fullName));
        string result = "";
        foreach (string part in fullName.Split(' '))
            if (part.Length > 0) result += char.ToUpper(part[0]);
        return result;
    }
}

class Program
{
    static void Main()
    {
        string missing = null;

        Console.WriteLine(missing.IsBlank());
        Console.WriteLine("ada lovelace".Initials());

        try
        {
            missing.Initials();
        }
        catch (ArgumentNullException e)
        {
            Console.WriteLine($"{e.GetType().Name}: {e.ParamName}");
        }
    }
}

出力：

True
AL
ArgumentNullException: fullName

missing.IsBlank() が true を返すのは便利ですが、null に対するメンバー呼び出しは例外になると考えている読み手を驚かせるかもしれません。null を受け入れるのは、名前からそれが明らかなメソッド（IsBlank、OrEmpty）だけにし、それ以外ではLINQと同じく ArgumentNullException を投げます。

enumの拡張

enumは独自のメソッドを持てないので、拡張の自然な対象です。

enum OrderStatus { Pending, Paid, Shipped, Delivered, Cancelled }

static class OrderStatusExtensions
{
    public static bool IsFinal(this OrderStatus s) =>
        s == OrderStatus.Delivered || s == OrderStatus.Cancelled;
}

// usage: if (order.Status.IsFinal()) { ... }

C# 14の拡張メンバー

C# 14までは、拡張にできるのはメソッドだけでした。C# 14では extension ブロックが追加され、1つのレシーバーに対するメンバーをまとめられ、拡張プロパティや静的メンバーも書けるようになりました。

// C# 14 and later
public static class StringExtensions
{
    extension(string s)
    {
        public bool IsBlank => string.IsNullOrWhiteSpace(s);   // extension property
        public string Truncate(int max) => s.Length <= max ? s : s[..max] + "...";
    }
}

従来の this 引数による拡張メソッドは引き続き有効で、既存のコードやライブラリのほとんどすべてがこちらを使っています。

拡張メソッドを書くべきとき

拡張メソッドが向いているのは、型を所有していないとき（string、DateTime、フレームワークのインターフェース）、インターフェースのすべての実装で同じヘルパーを使いたいとき、入れ子の呼び出しより連鎖のほうが読みやすいときです。クラスを所有しているなら、代わりに本物のインスタンスメソッドを追加します。privateな状態を使え、読み手が探す場所に現れるからです。また、object の拡張は避けます。プログラム内のあらゆる値の補完リストに自分のメソッドが出てしまいます。