【游戏引擎 - C#脚本系统】4、C++调用C#函数

翻译 from peter1745的《mono-guide》
强烈建议阅读Mono官方文档

---

现在我们已经有了一个C#类的实例，是时候调用一些方法了。需要注意的是，Mono为我们提供了两种调用C#方法的方式：mono_runtime_invoke 和 “Unmanaged Method Thunks”。本节只涵盖 mono_runtime_invoke，但我确实会在稍后介绍 “Unmanaged Method Thunks”。然而，在本节中我将讨论这两种方法之间的区别。

“非托管方法桩”（Unmanaged Method Thunks）是一种技术术语，特指一种用于在托管（managed）和非托管（unmanaged）代码之间建立桥梁的机制

mono_runtime_invoke vs. Unmanaged Method Thunks

---

它们的区别主要在于Mono最终是如何调用目标方法的，以及可以传递哪些参数。使用mono_runtime_invoke相对于非托管方法桩（Unmanaged Method Thunks）来说速度较慢，但更安全且更灵活。mono_runtime_invoke可以调用任何具有任何参数的方法，并且据我了解，它还在传递的对象和参数上执行更多的错误检查和验证。

非托管方法桩是在Mono的第二个版本中添加的一个概念，它允许你以比mono_runtime_invoke更小的开销调用C#方法。这意味着如果你每秒多次调用一个C#方法，比如你在C#中有一个每秒调用60到144次的OnUpdate方法，你可能会想要创建一个非托管到托管的桩。

非托管到托管的桩实际上创建了一个从非托管到托管代码的自定义调用方法（例如自定义的“跳板”），而该调用方法特定于你提供的方法签名，这意味着对于可以传递哪些参数没有歧义。

那么，何时应该使用mono_runtime_invoke，何时应该使用非托管方法桩呢？这取决于情况。如果你在编译时（C++编译时）不知道方法的签名，那么你可能应该使用mono_runtime_invoke，尽管你也可以使用非托管方法桩，但通常你希望参数在编译时已知。

经验法则

• 如果你每秒调用C#方法多次（比如超过10次），并且你在编译时知道该方法的签名，那么你应该使用Unmanaged Method Thunks。
• 如果你在编译时不知道方法签名，或者如果你只是偶尔而非每秒多次调用该方法，你可能会选择使用mono_runtime_invoke。

获取并调用C#方法

---

有很多不同的方法可以获取C#方法的引用，而你将使用的方法完全取决于你是否正在解析C#程序集，事先不知道其中会有哪些方法，以及是否在加载程序集之前就知道方法的名称、签名以及它属于哪个类。

在这种情况下，我们将使用手动获取方法引用的方式，但稍后我们将介绍更动态的方式。

// 这个没啥好说的，前面几章介绍过，获取类指针->分配对象内存->调用无参构造
MonoObject* InstantiateClass(const char* namespaceName, const char* className)
{
    MonoClass* testingClass = GetClassInAssembly(s_AppAssembly, "", "CSharpTesting");
    MonoObject* classInstance = mono_object_new(s_AppDomain, testingClass);

    if (classInstance == nullptr)
    {
        // Log error
    }
    mono_runtime_object_init(classInstance);
}

void CallPrintFloatVarMethod(MonoObject* objectInstance)
{
    MonoClass* instanceClass = mono_object_get_class(objectInstance);
    
    // 获取类中函数的指针
    MonoMethod* method = mono_class_get_method_from_name(instanceClass, "PrintFloatVar", 0);
    if (method == nullptr)
    {
        // 类中没有名字为PrintFloatVar且参数数量为0的方法，log error
        return;
    }
   
    // 调用objectInstance实例的这个方法，并处理可能出现的异常
    MonoObject* exception = nullptr;
    mono_runtime_invoke(method, objectInstance, nullptr, &exception);

    // TODO: 异常处理
}

// ...
MonoObject* testInstance = InstantiateClass("", "CSharpTesting");
CallPrintFloatVarMethod(testInstance);

代码解释

注意CallPrintFloatVarMethod函数，它将调用CSharpTesting类实例上的PrintFloatVar方法。记住，方法存储在类内，但是你在该类的实例上调用它们。实质上，所有C#方法都有一个隐式参数，指向调用该方法的类实例，这有效地让我们使用关键字 this。幸运的是，在Mono中，我们不必将其作为显式参数传递，但了解其在幕后如何工作是很好的。

跟C++里面基本是一个道理，C++的函数也不是存放在实例中的，可以认为它是存放在类中的，在调用该函数的时候，必须通过实例去调，因为这个实例要作为该函数的一个参数传进去，即this指针。为啥静态成员函数不需要通过实例调用，因为它不需要this指针。。

在调用方法之前，我们首先需要从类实例中获取一个MonoClass指针，调用mono_object_get_class并将MonoObject指针作为参数来获取。如果你想，也可以直接把类传递给CallPrintFloatVarMethod函数。

接下来，我们实际上需要获取C#方法或MonoMethod的引用，就像在Mono中的任何事情一样，我们将其作为指针获取。我们用于获取指针的函数是mono_class_get_method_from_name。我们需要传递的第一个参数是方法所属的类，值得注意的是，如果方法实际上不存在于类中，该函数将返回nullptr。第二个参数是我们要获取的方法的名称。第三个参数，我们需要告诉Mono方法有多少个形参。或者我们可以选择传递-1，这时，Mono将返回他找到的该函数的第一个版本。

注意！如果函数有多个形参数量一样的重载版本，mono_class_get_method_from_name就不能用了，因为它不检查方法的实际签名，只是检查它是否具有正确数量的参数。然而，有一些方法可以根据特定签名获取方法，我们稍后也会介绍。

现在我们已经获取了对C#方法的引用，可以通过调用mono_runtime_invoke来实现。

在调用之前，你可以看到我声明了一个指向MonoObject的指针，并将其命名为exception，并将其分配为nullptr。因为如果方法引发异常，mono_runtime_invoke将使用异常实例填充MonoObject，我们随后获取其异常信息。

那么mono_runtime_invoke的所有参数是什么呢？第一个参数是我们要调用的C#方法的指针。第二个参数是我们要在其上调用方法的类实例。第三个参数是形参数组的指针，但由于PrintFloatVar不接受任何形参，所以给个nullptr。第四个参数为获取异常的MonoObject指针，如果不想处理异常可以给nullptr。

值得注意的是，mono_runtime_invoke实际上可以向我们返回MonoObject*。如果你调用的C#方法有返回值，且你希望在C++中检索并对该返回值执行某些操作，这将是有用的。如果返回值为void，那么mono_runtime_invoke将返回nullptr。

我们的方法不返回任何东西，所以我们暂时不需要处理这个，但不用担心，我将确保也覆盖到这一点。

从C++给C#函数传递参数

---

在我们开始之前，我想说传递参数通常涉及在托管和非托管内存之间进行“封送数据（marshalling data）”。我不会详细介绍什么是marshalling ，或者Mono是如何处理它的，但这篇文章以相当好的方式解释了它，所以如果你有兴趣学更多的话，我强烈建议阅读它。我还建议阅读Mono中的这个marshalling示例。

marshalling ：不同编程环境或者数据表示之间进行数据传递的过程，涉及格式的调整和转换。

• 具体而言，在不同的语言或环境之间传递数据时，可能会涉及到数据类型、内存布局、字节序等方面的差异。因此，进行数据驱动是确保数据在传递过程中能够正确映射和转换的关键步骤。
• 在本文语境中，C++ 和 C# 交互时，我们需要考虑到这两种语言之间的数据格式差异，以确保数据能够被正确地传递和理解。

• 值得注意的是，Mono几乎不会为我们处理驱动，这意味着我们将需要在稍后进行一些手动类型检查和转换，但现在我们将只传递一个简单的浮点数，它本身不需要在第一次进行驱动。

不管是传递函数形参还是传递字段、属性，都会涉及到marshalling

值得注意的是，Mono几乎不会为我们处理marshalling，这意味着我们将需要在稍后进行一些手动类型检查和转换，但现在我们只传递一个简单的浮点数，它本身不需要马上marshalling。

void CallIncrementFloatVarMethod(MonoObject* objectInstance, float value)
{
    MonoClass* instanceClass = mono_object_get_class(objectInstance);
    MonoMethod* method = mono_class_get_method_from_name(instanceClass, "IncrementFloatVar", 1);
    if (method == nullptr)
    {
        // error
        return;
    }
	// 示例1
    MonoObject* exception = nullptr;
    void* param = &value;
    mono_runtime_invoke(method, objectInstance, &param, &exception);

    // 示例2：用参数数组
    MonoObject* exception = nullptr;
    void* params[] =
    {
        &value
    };
    mono_runtime_invoke(method, objectInstance, params, &exception);

    // TODO: 异常处理
}

// ...
MonoObject* testInstance = InstantiateClass("", "CSharpTesting");
CallIncrementFloatVarMethod(testInstance, 5.0f);

代码解释

这段代码与我们不传递任何参数时非常相似，所以我不会再次解释所有的代码。

我们声明了一个名为param的void*类型变量，并将其简单赋值为value的内存地址。我们这样做的原因，是因为Mono是一个C库，是没有模板的，mono_runtime_invoke必须能够接受任何参数类型。

在示例1中，Mono很可能会直接将存储在该内存地址的数据复制到托管内存中，因为它是一个简单的浮点数。请注意，某些类型可能需要我们手动marshalling数据，通过构造一个C#类的实例，或者将C风格的字符串转换为MonoString*并传递它。

在示例2中，声明了一个void*数组。如果我们需要向方法传递多个参数，就可以这样做，并确保参数在数组的顺序与方法签名中的顺序一致。

Mono是如何知道我们传递的数据数组的大小的？它只是傻傻的认为该数组的长度等于C#方法中所有参数的大小，如果数组大小与参数数量不匹配，就出错，并且Mono不会告诉你。

结束。后面会更深入地讨论参数类型以及我们如何在C++类型和C#类型之间进行转换。