虚幻4（Unreal Engine4）中的代理委托Delegate的使用方法 ...

jquave

前言

最近做的游戏经常使用到delegate，如果你使用过C#，可能对delegate有一定的了解。不过如果你和我一样在C#中没有用过代理，甚至根本就没接触过C#，那可能就需要花一点时间来理解delegate到底是一个什么东西了。
我们先来看看微软官方文档关于C#中的委托delegate的定义：
委托是一种引用类型，表示对具有特定参数列表和返回类型的方法的引用。 在实例化委托时，你可以将其实例与任何具有兼容签名和返回类型的方法相关联。 你可以通过委托实例调用方法。
委托用于将方法作为参数传递给其他方法。 事件处理程序就是通过委托调用的方法。 你可以创建一个自定义方法，当发生特定事件时，某个类（如 Windows 控件）就可以调用你的方法。
简单来说，delegate实现了将一个方法传递给其他类，使得其他的类在编译时期内不需要了解具体是什么方法被调用，而只是知道这个被调用方法的函数签名。有点类似于C++中函数指针的存在。
Unreal中的代理基本也是相同的一个东西，我们看看官方文档上面是怎么解释的：
Delegates allow you to call member functions on C++ objects in a generic, yet type-safe way. Using delegates, you can dynamically bind to a member function of an arbitrary object, then call functions on the object, even if the caller does not know the object's type.
同样的也是可以从其他的对象中调用一个动态绑定的成员函数。事件系统基本上也可以看过一个代理。能够使一个类对象在完成了某个任务之后发送一个事件给另一个类使其调用自己的方法来处理后续的任务。
那么unreal之中的delegate具体应该怎么使用呢？由于unreal采用的是自己特别封装的C++，其中有很多自己的规则，这些方法可能官方文档和一些教程中所写的比较晦涩难懂，本人虽然也是刚刚接触到这部分的内容，不过还是将自己的心得分享出来。

Delegate宏

要在Unreal中使用delegate，首先的一步是用Unreal自带的宏来声明delegate。Unreal自己提供了很多的宏（Macro），我们可以根据需要绑定的方法的参数和返回值（函数签名）来选择对应的宏。

其中delegate又分为single-cast delegate， multi-cast delegate以及dynamic delegates. 最常用的是single-cast delegate，也就是我们之前解释的delegate。multi-cast delegates比起single-cast，能够远程的保存和加载，但是不支持返回值。dynamic delegates据说能够支持序列化，这些暂时我没有使用过，不做过多讨论。顺便提一句，event和multi-cast delegates非常的类似，有兴趣的可以往这个方面研究一下。

声明delegate需要使用到Unreal的宏。Unreal主要提供了以下的几个宏。

/*Single-cast delegate declaration. No parameters*/
DECLARE_DELEGATE(MyDelegate)

/*Single-cast delegate declaration. One parameter*/
DECLARE_DELEGATE_OneParam(MyDelegate, paramtype1)

/*Single-cast delegate declartion. Two parameters*/
DECLARE_DELEGATE_TwoParams(MyDelegate, paramtype1, paramtype2)

/*Single-cast delegate declartion. Three parameters*/
DECLARE_DELEGATE_ThreeParams(MyDelegate, paramtype1, paramtype2, paramtype3)

/*Single-cast delegate declartion. Four parameters*/
DECLARE_DELEGATE_FourParams(MyDelegate, paramtype1, paramtype2, paramtype3, paramtype4)

/*Single-cast delegate declaration. One parameter with return value */
DECLARE_DELEGATE_RetVal_OneParam(RetType, MyDelegate, paramtype1)
...

好像目前只支持绑定的方法最多有4个参数。可以带有返回值，返回值写在delegate的前面。我们在头文件中声明了代理。 然后当然还需要在类中以这个delegate声明一个delegate的成员变量。

MyDelegate MyDelegateMemVar;这个成员变量就是未来我们可以用来动态绑定其他和之前在宏声明的一样的函数签名的方法。

绑定Bind方法

绑定具体的方法这一部存在这不少坑，本人第一次尝试的时候就碰到了很多问题。其中绑定主要有几种方法：

/* Binds to an existing delegate object. */
Bind()

/* Binds a raw C++ pointer global function delegate. */
BindStatic()

/* Binds a raw C++ pointer delegate. Raw pointer does not use any sort of reference,
* so may be unsafe to call if the object was deleted out from underneath your delegate.
* Be careful when calling Execute()!
*/
BindRaw()

/* Binds a shared pointer-based member function delegate.
* Shared pointer delegates keep a weak reference to your object.
* You can use ExecuteIfBound() to call them.
*/
BindSP()

/* Binds a UObject-based member function delegate.
* UObject delegates keep a weak reference to your object.
* You can use  ExecuteIfBound() to call them.
*/
BindUObject()

/* Binds a UFunction member function delegate. */
BindUFuntion()

/* Unbinds this delegate. */
UnBind()根据绑定的方法的类型，我们需要调用不同的Bind函数。本人之前使用的时候没有注意到这一点，所以一直编译的时候报错。

Bind(）比较简单，直接Bind一个已经存在的Delegate。第二个BindRaw需要注意，它只能绑定到C++原生的指针指向的方法上，在Unreal中有Raw pointer和smart pointer之分，Raw Pointer是需要自己管理其内存的分配和释放。 而智能指针（Smart Pointer）则会由Unreal自行来管理其生命周期和垃圾回收，这样就不会造成因为忘记释放内存造成的内存泄漏问题。而对于类来说， 一般只要在类中继承了Unreal的UObject或者其子类（比如Actor等），这个类就会是Unreal的类，那么它的方法就不是C++的原生类的方法， Unreal会自动管理其生命周期。那么这些类的方法就不能使用BindRaw来绑定。

简单地来说，如果这个类是继承与UObject（基本所有的Unreal类），那么可以用BindUObject来绑定这个成员方法。如果这个成员方法是UFUNCTION，则可以用BindUFucntion来绑定。如果是TSharedPtr（智能指针），则可以使用BindSp来绑定。如果是static的成员方法，则使用BindStatic。非Unreal类方法，就是用BindRaw。BindStatic只有一个参数，就是
BIndStatic(&MyClass::StaticMethod);BindUObject和BindRaw基本都是
BindRaw(MyClassInstance* pClassInst， &MyClass::Method);
BindUObject(MyClassInstance* pClassInst， &MyClass::Method); 而BindUFunction则是
BindUFunction(MyClassInstance* pClassInst， FName MethodName);具体的参数内容可以查阅文档。
调用代理方法

调用代理的方法就相对的简单，我们只需要使用
MyDelegateMemVar.Execute(）即可。当然如果这个delegate是含参数的，可以在其中添加参数。
MyDelegateMemVar.Execute(Param1, Param2 ...)这样所绑定的方法就会被调用，很类似于通过函数指针来调用。

当然为了确保这个delegate的成员变量确实绑定了一个方法。最好在执行Execute之前先确认一下是否绑定了
MyDelegateMemVar.IsBound()如果绑定过了就会返回true，否则是false。
文档中还有一个叫做
ExecuteIfBound()的方法，本人暂时没有成功使用过。所以我都是先检查是否绑定，在执行delegate方法

if (MyDelegateMemVar.IsBound()
{
    MyDelegateMemVar.Execute(Param1 ... Paramn);
}
总结


Delegate使得在Unreal不同类之间相互调用其方法变得更加方便和通用，可以部分模仿事件的调用。了解其使用方法肯定对编写游戏有很多帮助，毕竟游戏中经常要使用到类似的功能。本人也是刚开始学习相关的知识，写一点自己的心得以供参考，其中有不对的地方欢迎指出，大家一同学习进步。

DungDaj

很有帮助！

mastertravels77

可以绑定多个对象上的不同方法吗

Baste

委托时候挺诡异的。。。多线程调用broadcast过一会回失效，还是直接用函数指针了。