型パラメーターの制約 (C# プログラミングガイド)

[アーティクル]
07/26/2024

制約では、型引数に必要な機能をコンパイラに通知します。制約のない型引数は、任意の型にすることができます。コンパイラは、.NET 型の最終的な基底クラスになる、System.Object のメンバーを見なすことができるだけです。詳細については、「制約を使用する理由」を参照してください。クライアントコードが制約を満たさない型を使用している場合、コンパイラではエラーが発行されます。制約を指定するには、where コンテキストキーワードを使用します。次の表は、さまざまな制約の種類の一覧です。

制約	説明
`where T : struct`	型引数は、`record struct` 型を含む null 非許容値型である必要があります。 null 許容値型の詳細については、「null 許容値型」を参照してください。すべての値の型には、宣言されているかまたは暗黙的なアクセス可能なパラメーターなしのコンストラクターがあるため、 `struct` 制約は `new()` 制約を意味し、`new()` 制約と組み合わせることはできません。 `struct` 制約を `unmanaged` 制約と組み合わせることはできません。
`where T : class`	この型引数は参照型である必要があります。この制約は、任意のクラス、インターフェイス、デリゲート、または配列型にも適用されます。 null 許容コンテキストでは、`T` は null 非許容の参照型である必要があります。
`where T : class?`	型の引数は、null 許容または null 非許容の参照型である必要があります。この制約は、レコードを含むすべてのクラス、インターフェイス、デリゲート、または配列型にも適用されます。
`where T : notnull`	この型引数は null 非許容型である必要があります。引数は null 非許容参照型または null 非許容値型にできます。
`where T : unmanaged`	この型引数は null 非許容でアンマネージド型である必要があります。 `unmanaged` 制約は `struct` 制約を意味し、`struct` 制約とも `new()` 制約とも組み合わせることはできません。
`where T : new()`	この型引数には、パラメーターなしのパブリックコンストラクターが必要です。 `new()` 制約を別の制約と併用する場合、この制約を最後に指定する必要があります。 `new()` 制約は、`struct` や `unmanaged` 制約と組み合わせることはできません。
`where T :` <基底クラス名>	この型引数は、指定された基底クラスであるか、そのクラスから派生している必要があります。 null 許容コンテキストでは、`T` は指定の基底クラスから派生した null 非許容の参照型である必要があります。
`where T :` <基底クラス名>?	この型引数は、指定された基底クラスであるか、そのクラスから派生している必要があります。 Null 許容コンテキストでは、`T` は指定の基底クラスから派生した Null 許容または非許容のいずれかの参照型である場合があります。
`where T :` <インターフェイス名>	この型引数は、指定されたインターフェイスであるか、そのインターフェイスを実装している必要があります。複数のインターフェイス制約を指定することができます。制約のインターフェイスを汎用的にすることもできます。 null 許容コンテキストでは、`T` は指定したインターフェイスを実装する null 非許容型である必要があります。
`where T :` <インターフェイス名>?	この型引数は、指定されたインターフェイスであるか、そのインターフェイスを実装している必要があります。複数のインターフェイス制約を指定することができます。制約のインターフェイスを汎用的にすることもできます。 Null 許容コンテキストでは、`T` は Null 許容参照型、null 非許容参照型、または値型である場合があります。 `T` は Null 許容値型にすることはできません。
`where T : U`	`T` に指定する型引数は、`U` に指定された引数であるか、その引数から派生している必要があります。 Null 許容コンテキストでは、`U` が null 非許容参照型である場合、`T` は null 非許容参照型である必要があります。 `U` が Null 許容参照型である場合、`T` は Null 許容または null 非許容のいずれかになります。
`where T : default`	この制約により、メソッドをオーバーライドするとき、または明示的なインターフェイスの実装を提供するときに、制約のない型パラメーターを指定する必要がある場合の、曖昧さが解決されます。 `default` 制約は、`class` または `struct` 制約のない基本メソッドを意味します。詳細については、`default` 制約の仕様の提案を参照してください。
`where T : allows ref struct`	この反制約では、`T` の型引数を `ref struct` 型にできることを宣言します。ジェネリック型またはメソッドは、`ref struct` である可能性があるため、`T` のインスタンスに関する安全性参照規則に従う必要があります。

一部の制約は相互に排他的であり、一部の制約は指定された順序である必要があります。

struct、 class、 class?、 notnull、unmanaged の制約のうち、最大で 1 つを適用できます。これらの制約のいずれかを指定する場合は、その型パラメーターに指定される最初の制約である必要があります。
基底クラスの制約 (where T : Base または where T : Base?) は、struct、class、class?、notnull、unmanaged のどの制約とも組み合わせることはできません。
どちらの形式でも、最大で 1 つの基底クラス制約を適用できます。 Null 許容基本データ型をサポートする場合は、Base? を使用してください。
インターフェイスの null 非許容形式と Null 許容形式の両方を制約として指定することはできません。
new() 制約は、struct や unmanaged 制約と組み合わせることはできません。 new() 制約を指定する場合は、その型パラメーターの最後の制約である必要があります。適用可能な場合、反制約は new() 制約の後に続けることができます。
default 制約は、オーバーライドまたは明示的なインターフェイス実装にのみ適用できます。 struct または class 制約と組み合わせることはできません。
allows ref struct 反制約は、class や class? 制約と組み合わせることはできません。
allows ref struct 反制約は、その型パラメーターのすべての制約に従う必要があります。

制約を使用する理由

制約では、型パラメーターの能力と期待を指定します。これらの制約を宣言することで、制約型の操作とメソッドの呼び出しを使用できるようになります。ジェネリッククラスまたはメソッドが単純な代入以上のジェネリックメンバーに対して任意の操作を使用する場合は、型パラメーターに制約を適用します。これには、System.Object でサポートされていないメソッドの呼び出しが含まれます。たとえば、この基底クラスの制約は、この型のオブジェクトか、この型から派生したオブジェクトだけが、その型引数を置き換えられることをコンパイラに指示します。コンパイラがこの保証を獲得したら、その型のメソッドをジェネリッククラスで呼び出すことができるようになります。基底クラスの制約を適用して GenericList<T> クラス (「ジェネリックの概要」を参照) に追加できる機能を説明するコード例を次に示します。

public class Employee
{
    public Employee(string name, int id) => (Name, ID) = (name, id);
    public string Name { get; set; }
    public int ID { get; set; }
}

public class GenericList<T> where T : Employee
{
    private class Node
    {
        public Node(T t) => (Next, Data) = (null, t);

        public Node? Next { get; set; }
        public T Data { get; set; }
    }

    private Node? head;

    public void AddHead(T t)
    {
        Node n = new Node(t) { Next = head };
        head = n;
    }

    public IEnumerator<T> GetEnumerator()
    {
        Node? current = head;

        while (current != null)
        {
            yield return current.Data;
            current = current.Next;
        }
    }

    public T? FindFirstOccurrence(string s)
    {
        Node? current = head;
        T? t = null;

        while (current != null)
        {
            //The constraint enables access to the Name property.
            if (current.Data.Name == s)
            {
                t = current.Data;
                break;
            }
            else
            {
                current = current.Next;
            }
        }
        return t;
    }
}

この制約ではジェネリッククラスで Employee.Name プロパティを使用できるようにします。制約では、型 T のすべての項目が、Employee オブジェクトまたは Employee から継承するオブジェクトのいずれかになることが保証されることを指定します。

同じ型パラメーターに複数の制約を適用できます。また、制約自体をジェネリック型にすることもできます。次に例を示します。

class EmployeeList<T> where T : notnull, Employee, IComparable<T>, new()
{
    // ...
    public void AddDefault()
    {
        T t = new T();
        // ...
    }
}

where T : class 制約を適用する場合は、型パラメーターに == および != 演算子を使用しないでください。これらの演算子でテストされるのは、値の等価性ではなく、参照 ID についてのみです。これらの演算子が、引数として使用されている型内でオーバーロードされている場合でも、この動作が発生します。この点を説明するコードを次に示します。String クラスが == 演算子をオーバーロードしている場合でも、出力は false です。

public static void OpEqualsTest<T>(T s, T t) where T : class
{
    System.Console.WriteLine(s == t);
}

private static void TestStringEquality()
{
    string s1 = "target";
    System.Text.StringBuilder sb = new System.Text.StringBuilder("target");
    string s2 = sb.ToString();
    OpEqualsTest<string>(s1, s2);
}

コンパイラは T がコンパイル時に参照型であることしか認識しておらず、すべての参照型で有効な既定の演算子を使用する必要があります。値の等価性をテストする必要がある場合は、where T : IEquatable<T> または where T : IComparable<T> 制約も適用し、ジェネリッククラスの制約に使用されるすべてのクラスでそのインターフェイスを実装してください。

複数のパラメーターを制約する

複数のパラメーターに制約を適用できます。また、複数の制約を 1 つのパラメーターに適用することができます。次に例を示します。

class Base { }
class Test<T, U>
    where U : struct
    where T : Base, new()
{ }

非バインド型パラメーター

パブリッククラス SampleClass<T>{} の T など、制約がない型パラメーターは、非バインド型パラメーターと呼ばれます。非バインド型パラメーターには次の規則があります。

!= および == 演算子は使用できません。これは、具象型引数によってこれらの演算子がサポートされるという保証がないためです。
これらの演算子は System.Object との間で相互に変換できます。また、任意のインターフェイス型に明示的に変換できます。
これらは null と比較することができます。非バインド型パラメーターと null を比較し、その型引数が値の型の場合、比較結果として常に false が返されます。

制約としての型パラメーター

制約としてジェネリック型パラメーターを使用する方法は、独自の型パラメーターがあるメンバー関数が、含まれる型の型パラメーターにそのパラメーターを制約する必要がある場合に便利です。次に例を示します。

public class List<T>
{
    public void Add<U>(List<U> items) where U : T {/*...*/}
}

前の例の T は、Add メソッドのコンテキストでは型の制約ですが、List クラスのコンテキストでは非バインド型パラメーターです。

型パラメーターは、ジェネリッククラス定義の制約としても使用できます。型パラメーターは、他の型パラメーターと共に山かっこ内で宣言する必要があります。

//Type parameter V is used as a type constraint.
public class SampleClass<T, U, V> where T : V { }

ジェネリッククラスで制約として型パラメーターを使用する方法が便利なのは、限られた場合のみです。コンパイラでは、System.Object から派生したことを除き、型パラメーターに関して何も仮定できないためです。 2 つの型パラメーター間に継承関係を適用するシナリオには、ジェネリッククラスの制約として型パラメーターを使用してください。

`notnull` 制約

notnull 制約を使用して、型引数が null 非許容値型または null 非許容参照型である必要があることを指定できます。他のほとんどの制約とは異なり、型引数が notnull 制約に違反すると、コンパイラによりエラーではなく警告が生成されます。

notnull 制約は、null 許容コンテキストで使用した場合にのみ有効です。 null 許容が未指定のコンテキストで notnull 制約を追加した場合、コンパイラによって制約違反に関する警告やエラーが生成されません。

`class` 制約

null 許容コンテキスト内の class 制約は、型引数が null 非許容型である必要があることを指定します。 null 許容コンテキストでは、型引数が null 許容参照型である場合、コンパイラによって警告が生成されます。

`default` 制約

null 許容参照型を追加すると、ジェネリック型またはメソッドでの T? の使用が複雑になります。 T? は、struct または class のいずれかの制約と共に使用できますが、そのうちの 1 つが存在する必要があります。 class 制約が使用されていると、T? は T の null 許容参照型を参照しました。 T? は、どちらの制約も適用されていないときに使用できます。その場合、T? は、値型と参照型について、T? として解釈されます。ただし、T が Nullable<T> のインスタンスである場合は、T? は T と同じになります。つまり、T?? にはなりません。

T? は、class または struct の制約なしで使用できるようになったため、オーバーライドまたは明示的なインターフェイスの実装で曖昧さが発生する可能性があります。どちらの場合も、オーバーライドには制約は含まれませんが、基底クラスから継承されます。基底クラスで class または struct のいずれの制約も適用されていない場合は、派生クラスで、どちらの制約もない基本メソッドに適用されるオーバーライドを指定する必要があります。派生メソッドは、default 制約を適用します。 default 制約では、class または struct のどちらの制約も明確に "なりません"。

アンマネージド制約

unmanaged 制約を指定して、型パラメーターが null 非許容でアンマネージド型である必要があることを指定できます。 unmanaged 制約では、次の例のように、メモリのブロックとして操作できる型を処理する再利用可能なルーチンを記述できます。

unsafe public static byte[] ToByteArray<T>(this T argument) where T : unmanaged
{
    var size = sizeof(T);
    var result = new Byte[size];
    Byte* p = (byte*)&argument;
    for (var i = 0; i < size; i++)
        result[i] = *p++;
    return result;
}

ビルトイン型ではない型で sizeof 演算子を使用するため、先行するメソッドは unsafe コンテキストでコンパイルされる必要があります。 unmanaged 制約なしで、sizeof 演算子を使用することはできません。

unmanaged 制約は struct 制約を意味するため、これと組み合わせることはできません。 struct 制約は new() 制約を意味するため、unmanaged 制約を new() 制約と組み合わせることもできません。

制約をデリゲートする

基底クラスの制約として System.Delegate または System.MulticastDelegate を使用できます。 CLR では常にこの制約を許可していますが、C# 言語では許可されていません。 System.Delegate 制約では、タイプセーフな方法でデリゲートを処理するコードを記述できます。次のコードでは、2 つのデリゲートが同じ型である場合にそれらを組み合わせる拡張メソッドを定義します。

public static TDelegate? TypeSafeCombine<TDelegate>(this TDelegate source, TDelegate target)
    where TDelegate : System.Delegate
    => Delegate.Combine(source, target) as TDelegate;

上述のメソッドを使用して、同じ型のデリゲートを組み合わせることができます。

Action first = () => Console.WriteLine("this");
Action second = () => Console.WriteLine("that");

var combined = first.TypeSafeCombine(second);
combined!();

Func<bool> test = () => true;
// Combine signature ensures combined delegates must
// have the same type.
//var badCombined = first.TypeSafeCombine(test);

最後の行のコメントを解除した場合、コンパイルされません。 first と test は両方ともデリゲート型ですが、これらは異なるデリゲート型です。

列挙の制約

基底クラスの制約として System.Enum 型を指定することもできます。 CLR では常にこの制約を許可していますが、C# 言語では許可されていません。 System.Enum を使用するジェネリックは、System.Enum の静的メソッドの使用から結果をキャッシュするために、タイプセーフのプログラミングを提供します。次の例では、列挙型の有効な値をすべて見つけて、それらの値をその文字列表記にマップするディクショナリをビルドします。

public static Dictionary<int, string> EnumNamedValues<T>() where T : System.Enum
{
    var result = new Dictionary<int, string>();
    var values = Enum.GetValues(typeof(T));

    foreach (int item in values)
        result.Add(item, Enum.GetName(typeof(T), item)!);
    return result;
}

Enum.GetValues と Enum.GetName ではリフレクションが使用されます。これは、パフォーマンスに影響を与えます。リフレクションを必要とする呼び出しを繰り返すのではなく、EnumNamedValues を呼び出してキャッシュおよび再利用されるコレクションを作成できます。

次の例で示すように、このメソッドを使用して、列挙を作成し、その値と名前のディクショナリをビルドできます。

enum Rainbow
{
    Red,
    Orange,
    Yellow,
    Green,
    Blue,
    Indigo,
    Violet
}

var map = EnumNamedValues<Rainbow>();

foreach (var pair in map)
    Console.WriteLine($"{pair.Key}:\t{pair.Value}");

型引数で宣言されたインターフェイスを実装する

一部のシナリオでは、型パラメーターに指定された引数がそのインターフェイスを実装する必要があります。次に例を示します。

public interface IAdditionSubtraction<T> where T : IAdditionSubtraction<T>
{
    static abstract T operator +(T left, T right);
    static abstract T operator -(T left, T right);
}

このパターンにより、C# コンパイラでは、オーバーロードされた演算子、または任意の static virtual または static abstract メソッドの含んでいる型を決定できるようになります。含んでいる型で加算演算子と減算演算子を定義できるように、構文が提供されています。この制約がないと、パラメーターと引数をインターフェイスとして宣言する必要があります (型パラメーターではなく)。

public interface IAdditionSubtraction<T> where T : IAdditionSubtraction<T>
{
    static abstract IAdditionSubtraction<T> operator +(
        IAdditionSubtraction<T> left,
        IAdditionSubtraction<T> right);

    static abstract IAdditionSubtraction<T> operator -(
        IAdditionSubtraction<T> left,
        IAdditionSubtraction<T> right);
}

上記の構文では、実装者がこれらのメソッドに対して明示的なインターフェイスの実装を使用することが必要になります。追加の制約を指定すると、インターフェイスでは型パラメーターの観点から演算子を定義できます。インターフェイスを実装する型では、そのインターフェイスメソッドを暗黙的に実装できます。

ref struct を許可する

allows ref struct 反制約は、対応する型引数を ref struct 型にできることを宣言します。その型パラメーターのインスタンスは、次の規則に従う必要があります。

ボックス化することはできません。
ref 安全性規則に参加しています。
static フィールドなど、ref struct 型が許可されていない場所ではインスタンスを使用できません。
インスタンスは、scoped 修飾子でマークできます。

allows ref struct 句は継承されません。次のコードの内容は以下のとおりです。

class SomeClass<T, S>
    where T : allows ref struct
    where S : T
{
    // etc
}

S には allows ref struct 句がないため、S の引数を ref struct にすることはできません。

allows ref struct 句を持つ型パラメーターは、対応する型パラメーターに allows ref struct 句がない限り、型引数として使用できません。この規則を次の例で示します。

public class Allow<T> where T : allows ref struct
{

}

public class Disallow<T>
{
}

public class Example<T> where T : allows ref struct
{
    private Allow<T> fieldOne; // Allowed. T is allowed to be a ref struct

    private Disallow<T> fieldTwo; // Error. T is not allowed to be a ref struct
}

上記のサンプルは、ref struct 型である可能性のある型引数を、ref struct 型である可能性がない型パラメーターに置き換えることができないことを示しています。

次の方法で共有

型パラメーターの制約 (C# プログラミングガイド)

制約を使用する理由

複数のパラメーターを制約する

非バインド型パラメーター

制約としての型パラメーター

`notnull` 制約

`class` 制約

`default` 制約

アンマネージド制約

制約をデリゲートする

列挙の制約

型引数で宣言されたインターフェイスを実装する

ref struct を許可する

関連項目

その他のリソース

次の方法で共有

型パラメーターの制約 (C# プログラミング ガイド)

制約を使用する理由

複数のパラメーターを制約する

非バインド型パラメーター

制約としての型パラメーター

notnull 制約

class 制約

default 制約

アンマネージド制約

制約をデリゲートする

列挙の制約

型引数で宣言されたインターフェイスを実装する

ref struct を許可する

関連項目

その他のリソース

型パラメーターの制約 (C# プログラミングガイド)

`notnull` 制約

`class` 制約

`default` 制約