委托是C#中的一个引用类型。它允许捕捉对方法的引用,并像传递其他对象那样传递该引用,也可以像调用其他方法一样调用被捕捉的方法。
声明委托需要使用delegate关键字:
// 声明委托
delegate string TestDelegate(int a, int b);
public static void DelegatePracticeMain()
{
TestDelegate testDelegate = null;
// 绑定方法
testDelegate = Test;
// 执行方法
Console.WriteLine(testDelegate(10,20));
}
public static string Test(int a, int b)
{
return $"a + b = {a + b}";
}
我们同样可以使用C#为我们声明好的委托System.Func
和System.Action
。其中,System.Func
代表有返回值的方法,System.Action
代表无返回值的方法。它们的使用方法如下:
public static string Test(int a, int b)
{
return $"a + b = {a + b}";
}
public static void VoidTest(int a)
{
Console.WriteLine($"a is {a}");
}
public static void DelegatePracticeMain()
{
// 最后一个参数为返回值类型
Func<int, int, string> testFunc = Test;
Console.WriteLine(testFunc(20,30));
Action<int> testAct = VoidTest;
testAct(50);
}
通过实例化委托的方式向方法中传递委托的一个实例:
/**
* Person比较方法
*/
public static bool PersonCompare(Person person1, Person person2)
{
return person1.Age > person2.Age;
}
/**
* 输出较大的对象
*/
public static void PrintGreater<T>(T item1,T item2,Func<T,T,bool> compare)
{
Console.WriteLine(compare(item1, item2) ? item1:item2);
}
public class Person
{
public string Name { get; set; }
public int Age { get; set; }
public override string ToString()
{
return $"姓名:{Name},年龄:{Age}";
}
}
public static void DelegatePracticeMain()
{
Person person1 = new Person() {Age = 10, Name = "张三"};
Person person2 = new Person() {Age = 20, Name = "李四"};
// 向方法传递要委托的方法名
PrintGreater(person1,person2,PersonCompare);
}
.Net的委托类型不具备结构相等性。即无法将一个委托类型的对象引用转换成另一个不相关的委托类型。但可以通过创建新委托,并让它引用旧委托的Invoke方法实现。
delegate string Test1Delegate(int a, int b);
delegate string Test2Delegate(int a, int b);
public static void DelegatePracticeMain()
{
Test1Delegate test1Delegate = Test;
// 编译不通过
// Test2Delegate test2Delegate = test1Delegate;
// 编译通过
Test2Delegate test2Delegate = test1Delegate.Invoke;
}
通过C#4.0添加的对可变性的支持,也可以实现某些委托类型之间的转换。C#提供的System.Func
委托类型,参数类型使用了in修饰,结果类型使用了out修饰;System.Action
的参数类型同样也使用了in修饰。这就意味着这两种委托类型是可以进行协变与逆变转换的:
// 逆变
Action<object> objAction = o => Console.WriteLine(o);
Action<string> strAction = objAction;
// 协变
Func<string> strFunc = () => "strFunc";
Func<object> objFunc = strFunc;
// 协变与逆变同时发生
Func<object, string> objStrFunc = o => o.ToString();
Func<string, object> strObjFunc = objStrFunc;
我们来设想一个场景:假设有一个恒温器,它连接了一台加热器和一台冷却器。当温度发生变化时,恒温器需要将温度变化发送给加热器和冷却器。该如何设计这几个类呢?其实这是一个典型的观察者模式的应用。而通过多播委托,我们可以很容易地实现这种设计模式。
我们首先要定义出消息的订阅者,也就是加热器和冷却器:
/**
* 冷却器
*/
public class Cooler
{
// 设定温度
public float Temperature { get; set; }
public Cooler(float ratedTemp)
{
Temperature = ratedTemp;
}
// 温度改变事件
public void OnTemperatureChanged(float newTemp)
{
Console.WriteLine("冷却器:"+(newTemp > Temperature? "开":"关"));
}
}
/**
* 加热器
*/
public class Heater
{
// 设定温度
public float Temperature { get; set; }
public Heater(float ratedTemp)
{
Temperature = ratedTemp;
}
// 温度改变事件
public void OnTemperatureChanged(float newTemp)
{
Console.WriteLine("加热器:"+(newTemp < Temperature? "开":"关"));
}
}
接下来就可以定义消息的发布者,也就是恒温器:
/**
* 恒温器
*/
public class Thermostat
{
// 当前温度
private float _CurrentTemp;
public float CurrentTemp
{
get => _CurrentTemp;
set
{
if (value != _CurrentTemp)
{
_CurrentTemp = value;
// OnTemperatureChanged(value);
// 防止为空
OnTemperatureChanged?.Invoke(value);
}
}
}
// 委托
public Action<float>? OnTemperatureChanged { get; set; }
}
在恒温器中定义了一个无返回值的,带一个float类型参数的委托。通过这个委托,就可以连接发布者和订阅者。在CurrentTemp属性的赋值方法中调用委托,即可向所有订阅者发送消息。
public static void MultiDelegateMain()
{
Thermostat thermostat = new Thermostat();
Heater heater = new Heater(20);
Cooler cooler = new Cooler(30);
// 注册事件
thermostat.OnTemperatureChanged += heater.OnTemperatureChanged;
thermostat.OnTemperatureChanged += cooler.OnTemperatureChanged;
thermostat.CurrentTemp = 40;
thermostat.CurrentTemp = 10;
}
当我们使用“+=”操作符时,它会获取第一个委托并将第二个委托添加到委托链。第一个委托方法返回后就会调用第二个委托。同理使用“-=”会从委托链中删除该委托。无论是“+”“-”还是它们的复合赋值版本“+=”“-=”,内部都是使用了静态方法System.Delegate.Combine()
和System.Delegate.Remove()
实现,它们会返回一个全新的多播委托——即原始的多播委托并不会受到影响。
.Net的委托总是派生自System.MulticastDelegate
类型,而System.MulticastDelegate
又派生自System.Delegate
。在System.MulticastDelegate
中有一个非常重要的字段_invocationList
,在System.Delegate
中也有两个重要的字段_target
和_methodPtr
。当我们将方法的引用传递给一个委托的实例,它的_methodPtr
字段会指向这个方法,_target
字段会指向调用方法的类型实例,而_invocationList
则被置空。当我们通过+=
实现多播委托时,内部会调用CombineImpl
方法,该方法会返回一个新的委托,这个新的委托_invocationList
字段是一个数组,数组中的每个元素就是一个委托的实例。当调用多播委托时,数组中的实例会被顺序调用。下面引用另一个博客(原地址)的一张示意图:
到目前为止,委托存在着两个重要的问题。
(1)错误使用赋值操作符导致原本的委托链被覆盖
thermostat.OnTemperatureChanged += heater.OnTemperatureChanged;
// 错误使用了=,导致之前的委托链被覆盖
thermostat.OnTemperatureChanged = cooler.OnTemperatureChanged;
(2)在外部也可以调用委托
thermostat.OnTemperatureChanged += heater.OnTemperatureChanged;
thermostat.OnTemperatureChanged += cooler.OnTemperatureChanged;
// thermostat.CurrentTemp = 40;
// 原本当前温度改变时才会调用委托,但现在可以直接在外部调用委托
thermostat.OnTemperatureChanged(40);
以上两个问题都是因为委托的封装不充分。而事件则解决了这些问题。要使用事件,我们只需要对原有的Thermostat类进行如下修改:
/**
* 恒温器
*/
public class Thermostat
{
// 当前温度
private float _CurrentTemp;
public float CurrentTemp
{
get => _CurrentTemp;
set
{
if (value != _CurrentTemp)
{
_CurrentTemp = value;
// OnTemperatureChanged(value);
// 防止为空
OnTemperatureChanged?.Invoke(value);
}
}
}
// 委托
// public Action? OnTemperatureChanged { get; set; }
// 事件
public event Action<float> OnTemperatureChanged = delegate { };
}
在上面的修改中,我们只是将原本的OnTemperatureChanged
属性移除,并更换为event关键字修饰的字段,并将这个字段赋值为空白委托,用来防止委托为null时产生异常。修改完成后,在外部就无法直接调用OnTemperatureChanged
委托,同时也无法使用=
符进行直接赋值。
// 编译不通过
thermostat.OnTemperatureChanged(40);
thermostat.OnTemperatureChanged = cooler.OnTemperatureChanged;
在实际的事件编程中,我们一般使用EventHandler<>
来代替Action<>
,目的是遵循标准的C#编程规范。EventHandler<>
提供了两个参数(object? sender, TEventArgs e)
,前者代表事件的发布者,后者代表事件参数。当一个订阅者方法注册了多个事件时,将发布者作为参数传入就可以判断出具体是哪个实例触发了事件。第二个事件参数是System.EventArgs
类型或从System.EventArgs
派生的类型,但包含事件附加数据。System.EventArgs
唯一重要的属性是Empty,用于指出“没有事件数据”。
// 事件数据
public class TemperatureArgs : EventArgs
{
public float NewTemp { get; set; }
public TemperatureArgs(float temperature)
{
NewTemp = temperature;
}
}
// 事件
public event EventHandler<TemperatureArgs> OnTemperatureChanged = delegate { };
// 调用时将sender指定为容器类
OnTemperatureChanged?.Invoke(this,new TemperatureArgs(value));
C#编译器获取带有event关键字修饰的public委托变量后,会在内部将委托声明为private,并添加两个方法和两个特殊事件块。下面是与CIL等价的C#代码:
两个方法add_OnTemperatureChange()
和remove_OnTemperatureChange()
分别实现了“+=”和“-=”操作符。下面的两个特殊事件块语法与C#实现属性时创建的代码语法类似,负责调用add和remove方法。
基于此我们可以实现自定义的事件,可以将内部的委托设置为protected而不是private,也可以添加自定义的add和remove块:
public event EventHandler<TemperatureArgs> OnTemperatureChanged
{
add
{
_OnTemperatureChanged = (EventHandler<TemperatureArgs>)Delegate.Combine(value, _OnTemperatureChanged);
}
remove
{
_OnTemperatureChanged = (EventHandler<TemperatureArgs>)Delegate.Remove(_OnTemperatureChanged, value);
}
}
protected EventHandler<TemperatureArgs>? _OnTemperatureChanged;