类型参数的约束(C# 编程指南)
约束告知编译器类型参数必须具备的功能。 在没有任何约束的情况下,类型参数可以是任何类型。 编译器只能假定 Object
的成员,它是任何 .NET
类型的最终基类。 有关详细信息,请参阅使用约束的原因。 如果客户端代码尝试使用约束所不允许的类型来实例化类,则会产生编译时错误。 通过使用 where
上下文关键字指定约束。 下表列出了七种类型的约束:
约束 | 说明 |
---|---|
where T : struct | 类型参数必须是值类型。 可以指定除 Nullable<T> 以外的任何值类型。 有关可以为 null 的类型的详细信息,请参阅可以为 null 的类型。 |
where T : class | 类型参数必须是引用类型。 此约束还应用于任何类、接口、委托或数组类型。 |
where T : unmanaged | 类型参数不能是引用类型,并且任何嵌套级别均不能包含任何引用类型成员。 |
where T : new() | 类型参数必须具有公共无参数构造函数。 与其他约束一起使用时,new() 约束必须最后指定。 |
where T : <基类名> | 类型参数必须是指定的基类或派生自指定的基类。 |
where T : <接口名称> | 类型参数必须是指定的接口或实现指定的接口。 可指定多个接口约束。 约束接口也可以是泛型。 |
where T : U | 为 T 提供的类型参数必须是为 U 提供的参数或派生自为 U 提供的参数。 |
某些约束是互斥的。 所有值类型必须具有可访问的无参数构造函数。 struct
约束包含 new()
约束,且 new()
约束不能与 struct
约束结合使用。 unmanaged
约束包含 struct
约束。 unmanaged
约束不能与 struct
或 new()
约束结合使用。
使用约束的原因
通过约束类型参数,可以增加约束类型及其继承层次结构中的所有类型所支持的允许操作和方法调用的数量。 设计泛型类或方法时,如果要对泛型成员执行除简单赋值之外的任何操作或调用 System.Object
不支持的任何方法,则必须对该类型参数应用约束。 例如,基类约束告诉编译器,仅此类型的对象或派生自此类型的对象可用作类型参数。 编译器有了此保证后,就能够允许在泛型类中调用该类型的方法。 以下代码示例演示可通过应用基类约束添加到(泛型介绍中的)GenericList<T>
类的功能。
public class Employee
{
public Employee(string s, int i) => (Name, ID) = (s, i);
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)
{
//约束允许访问Name属性
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 : Employee, IEmployee, System.IComparable<T>, new()
{
// ...
}
在应用 where T : class
约束时,请避免对类型参数使用 ==
和 !=
运算符,因为这些运算符仅测试引用标识而不测试值相等性。 即使在用作参数的类型中重载这些运算符也会发生此行为。 下面的代码说明了这一点;即使 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>
约束,并在用于构造泛型类的任何类中实现该接口。
约束多个参数
可以对多个参数应用多个约束,对一个参数应用多个约束,如下例所示:
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
类的上下文中是一个未绑定的类型参数。
类型参数还可在泛型类定义中用作约束。 必须在尖括号中声明该类型参数以及任何其他类型参数:
//类型参数V用作类型约束
public class SampleClass<T, U, V> where T : V { }
类型参数作为泛型类的约束的作用非常有限,因为编译器除了假设类型参数派生自 System.Object
以外,不会做其他任何假设。 如果要在两个类型参数之间强制继承关系,可以将类型参数用作泛型类的约束。
非托管约束
从 C# 7.3
开始,可使用 unmanaged
约束来指定类型参数必须为“非托管类型”。 “非托管类型”不是引用类型,且任何嵌套级别都不包含引用类型字段。 通过 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;
}
以上方法必须在 unsafe
上下文中编译,因为它并不是在已知的内置类型上使用 sizeof
运算符。 如果没有 unmanaged
约束,则 sizeof
运算符不可用。
委托约束
同样从 C# 7.3
开始,可将 System.Delegate
或 System.MulticastDelegate
用作基类约束。 CLR
始终允许此约束,但 C#
语言不允许。 使用 System.Delegate
约束,用户能够以类型安全的方式编写使用委托的代码。 以下代码定义了合并两个同类型委托的扩展方法:
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;
//组合签名确保组合委托必须具有相同的类型。
//var badCombined = first.TypeSafeCombine(test);
如果取消最后一行,它将不会编译。 first
和 test
均为委托类型,但它们是不同的委托类型。
枚举约束
从 C# 7.3
开始,还可指定 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 Rainbow
{
Red,
Orange,
Yellow,
Green,
Blue,
Indigo,
Violet
}
var map = EnumNamedValues<Rainbow>();
foreach (var pair in map)
Console.WriteLine($"{pair.Key}:\t{pair.Value}");