15.值类型CLR绑定

热更新 > Unity热更新 > ILRuntime > ILRuntime基础知识热更新 Unity热更新 ILRuntime ILRuntime基础知识更多跨域调用

发布时间 : 2024-04-25 23:08

字数:3.6k 阅读 :

115.更多跨域调用-值类型绑定

115.更多跨域调用-值类型绑定

15.1 知识点

复制之前的主入口调用

ILRuntimeManager.Instance.StartILRuntime(() =>
{
    //执行ILRuntime当中的一个静态函数
    //静态函数中 就是热更工程自己处理的逻辑了
    ILRuntimeManager.Instance.appDomain.Invoke("HotFix_Project.ILRuntimeMain", "Start", null, null);
});

值类型绑定是什么

通过上节课我们知道CLR绑定其实就是把ILRuntime中用到的Unity相关方法进行CLR重定向，让本来要使用反射去执行的一些逻辑变成直接执行。这样可以大大提升我们的性能。那么值类型绑定，其实就是把Unity当中的一些常用值类型方法进行CLR绑定，比如Vector2、Vector3、Quaternion等。值类型绑定后，性能将得到大幅提升。

如何进行值类型绑定

如何进行值类型绑定概述

手写值类型绑定类（示例工程中提供了Vector2、Vector3、Quaternion的，可以直接使用）。
注册值类型绑定：
- appDomain.RegisterValueTypeBinder(typeof(值类型), new 绑定类())。
- 在CLR绑定脚本中注册，在加载dll和pdb后注册。

注意：手写必须了解ILRuntime原理，之后会讲解。

找到示例工程的值类型绑定类，里面其实也是做了一些重定向操作。

CLR绑定脚本其实自动帮我们进行了值类型绑定注册。但是这只是编辑器下点击生成CLR绑定按钮才调用的。我们等一下要自己加到ILruntime管理器。

把值类型绑定注册拷贝到ILruntime管理器的InitILRuntime方法中

/// <summary>
/// 初始化ILRuntime相关的内容
/// </summary>
unsafe private void InitILRuntime()
{
    //其他初始化
    
    //委托注册相关  略
    
    //注册跨域继承的父类适配器 略

   
    // 值类型绑定注册
    appDomain.RegisterValueTypeBinder(typeof(Vector3), new Vector3Binder());
    appDomain.RegisterValueTypeBinder(typeof(Vector2), new Vector2Binder());
    appDomain.RegisterValueTypeBinder(typeof(Quaternion), new QuaternionBinder());
    
    
    
    
    //CLR重定向内容 要写到CLR绑定之前
    //得到想要重定向类的Type
    System.Type debugType = typeof(Debug);
    //得到想要重定向方法的方法信息
    MethodInfo methodInfo = debugType.GetMethod("Log", new System.Type[] { typeof(object) });
    //进行CLR重定向
    appDomain.RegisterCLRMethodRedirection(methodInfo, MyLog);
    
    
    
    //注册CLR绑定信息
    ILRuntime.Runtime.Generated.CLRBindings.Initialize(appDomain);
    
    
    
    //初始化ILRuntime相关信息（目前只需要告诉ILRuntime主线程的线程ID，主要目的是能够在Unity的Profiler剖析器窗口中分析问题）
    appDomain.UnityMainThreadID = Thread.CurrentThread.ManagedThreadId;
}

注册完点击CLR绑定

性能优化体现

主要体现

在ILRuntime热更工程中使用Unity中值类型进行计算。不进行值类型绑定的效率较低，进行值类型绑定后性能将大幅提升。

ILRuntimeMain添加值类型十万次运算的逻辑，重新生成

System.DateTime currentTime = System.DateTime.Now;
Vector3 v1 = new Vector3(123, 54, 567);
Vector3 v2 = new Vector3(342, 678, 123);
float dot = 0;
for (int i = 0; i < 100000; i++)
{
    dot += Vector3.Dot(v1, v2);
}

Vector2 v3 = new Vector2(12, 56);
Vector2 v4 = new Vector2(123123, 45345);
for (int i = 0; i < 100000; i++)
{
    dot += Vector3.Dot(v3, v4);
}

Debug.Log("值类型计算花费的时间：" + (System.DateTime.Now - currentTime).TotalMilliseconds + "ms");

先暂时注释掉ILruntime管理器的值类型绑定代码，运行查看时间

// // 值类型绑定注册
// appDomain.RegisterValueTypeBinder(typeof(Vector3), new Vector3Binder());
// appDomain.RegisterValueTypeBinder(typeof(Vector2), new Vector2Binder());
// appDomain.RegisterValueTypeBinder(typeof(Quaternion), new QuaternionBinder());

解开注释再运行，可以看到性能有一定提升

// 值类型绑定注册
appDomain.RegisterValueTypeBinder(typeof(Vector3), new Vector3Binder());
appDomain.RegisterValueTypeBinder(typeof(Vector2), new Vector2Binder());
appDomain.RegisterValueTypeBinder(typeof(Quaternion), new QuaternionBinder());

总结

值类型绑定，就是把Unity当中的一些常用值类型方法进行CLR绑定。他可以大幅提高在热更新工程中使用Unity中值类型对象的效率。

15.2 知识点代码

Lesson15_更多跨域调用_值类型绑定

using System.Collections;
using System.Collections.Generic;
using BaseFramework;
using UnityEngine;

public class Lesson15_更多跨域调用_值类型绑定 : MonoBehaviour
{
    void Start()
    {
        #region 复制之前的主入口调用

        ILRuntimeManager.Instance.StartILRuntime(() =>
        {
            //执行ILRuntime当中的一个静态函数
            //静态函数中 就是热更工程自己处理的逻辑了
            ILRuntimeManager.Instance.appDomain.Invoke("HotFix_Project.ILRuntimeMain", "Start", null, null);
        });

        #endregion

        #region 知识点一 值类型绑定是什么

        //通过上节课我们知道
        //CLR绑定其实就是把ILRuntime中用到的Unity相关方法
        //进行CLR重定向，让本来要使用反射去执行的一些逻辑变成直接执行
        //这样可以大大提升我们的性能
        //那么值类型绑定，其实就是把Unity当中的一些常用值类型方法进行CLR绑定
        //比如Vector2、Vector3、Quaternion等
        //值类型绑定后
        //性能将得到大幅提升

        #endregion

        #region 知识点二 如何进行值类型绑定

        //1.手写值类型绑定类（示例工程中提供了Vector2、Vector3、Quaternion的，可以直接使用）
        //2.注册值类型绑定
        //  appDomain.RegisterValueTypeBinder(typeof(值类型), new 绑定类());
        //  在CLR绑定脚本中注册，在加载dll和pdb后注册

        //注意：
        //手写必须了解ILRuntime原理，之后会讲解

        #endregion

        #region 知识点三 性能优化体现

        //在ILRuntime热更工程中使用Unity中值类型进行计算
        //不进行值类型绑定的效率较低
        //进行值类型绑定后性能将大幅提升

        #endregion

        #region 总结

        //值类型绑定，就是把Unity当中的一些常用值类型方法进行CLR绑定
        //他可以大幅提高在热更新工程中使用Unity中值类型对象的效率

        #endregion
    }
}

ILRuntimeManager

using ILRuntime.Mono.Cecil.Pdb;
using ILRuntime.Runtime.Enviorment;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Reflection;
using System.Threading;
using ILRuntime.CLR.Method;
using ILRuntime.CLR.Utils;
using ILRuntime.Runtime.Intepreter;
using ILRuntime.Runtime.Stack;
using Lesson12_FatherNameSpace;
using Lesson13_FatherNameSpace;
using Lesson13_InheritAllNameSpace;
using Lesson13_InterfaceNameSpace;
using UnityEngine;
using UnityEngine.Events;
using UnityEngine.Networking;

namespace BaseFramework
{
    public class ILRuntimeManager : BaseSingletonInMonoBehaviour<ILRuntimeManager>
    {
        public AppDomain appDomain;

        //用于存储加载出来的 两个文件的内存流对象
        private MemoryStream dllStream;
        private MemoryStream pdbStream;

        private bool isStart = false;


        /// <summary>
        /// 用于启动ILRuntime初始化方法
        /// </summary>
        public void StartILRuntime(UnityAction callBack = null)
        {
            if (!isStart)
            {
                isStart = true;
                appDomain = new AppDomain();
                StartCoroutine(LoadHotUpdateInfo(callBack));
            }
        }

        public void StopILRuntime()
        {
            //1.释放流
            if (dllStream != null)
                dllStream.Close();
            if (pdbStream != null)
                pdbStream.Close();
            dllStream = null;
            pdbStream = null;
            //2.清空appDomain
            appDomain = null;

            isStart = false;
        }

        /// <summary>
        /// 初始化ILRuntime相关的内容
        /// </summary>
        unsafe private void InitILRuntime()
        {
            //其他初始化
            
            //无参无返回值不需要委托注册
            //MyUnityDel1因为转成的是无参无返回值的Action，Action在热更新里可以直接使用，所以不需要进行委托的注册
            //委托转换器注册（要把自定义委托无参无返回值MyUnityDel1委托转换为Action，其他自定义委托可以看语法也转成Action或Func）
            appDomain.DelegateManager.RegisterDelegateConvertor<MyUnityDel1>((act) =>
            {
                return new MyUnityDel1(() =>
                {
                    ((System.Action)act)();
                });
            });

            //有参有返回值委托注册 因为是自己定的规则要自己手动进行委托注册
            appDomain.DelegateManager.RegisterFunctionDelegate<System.Int32, System.Int32, System.Int32>();
            
            //委托转换器注册（要把自定义委托有参有返回值MyUnityDel2委托转换为Func，其他自定义委托可以看语法也转成Action或Func）
            appDomain.DelegateManager.RegisterDelegateConvertor<MyUnityDel2>((act) =>
            {
                return new MyUnityDel2((i, j) =>
                {
                    return ((System.Func<System.Int32, System.Int32, System.Int32>)act)(i, j);
                });
            });

            
            //注册跨域继承的父类适配器
            appDomain.RegisterCrossBindingAdaptor((new Lesson12_FatherAdapter()));
            appDomain.RegisterCrossBindingAdaptor((new Lesson13_FatherAdapter()));
            appDomain.RegisterCrossBindingAdaptor((new Lesson13_InterfaceAdapter()));
            appDomain.RegisterCrossBindingAdaptor((new Lesson13_InheritAllAdapter()));
            
            
            // 值类型绑定注册
            appDomain.RegisterValueTypeBinder(typeof(Vector3), new Vector3Binder());
            appDomain.RegisterValueTypeBinder(typeof(Vector2), new Vector2Binder());
            appDomain.RegisterValueTypeBinder(typeof(Quaternion), new QuaternionBinder());
            
            
            
            
            //CLR重定向内容 要写到CLR绑定之前
            //得到想要重定向类的Type
            System.Type debugType = typeof(Debug);
            //得到想要重定向方法的方法信息
            MethodInfo methodInfo = debugType.GetMethod("Log", new System.Type[] { typeof(object) });
            //进行CLR重定向
            appDomain.RegisterCLRMethodRedirection(methodInfo, MyLog);
            
            
            
            //注册CLR绑定信息
            ILRuntime.Runtime.Generated.CLRBindings.Initialize(appDomain);
            
            
            
            //初始化ILRuntime相关信息（目前只需要告诉ILRuntime主线程的线程ID，主要目的是能够在Unity的Profiler剖析器窗口中分析问题）
            appDomain.UnityMainThreadID = Thread.CurrentThread.ManagedThreadId;
        }

        
        
        
        // MyLog函数用于记录日志，并输出调用栈信息
        // 参数：
        //   __intp: ILRuntime解释器实例
        //   __esp: 栈指针
        //   __mStack: 托管堆栈
        //   __method: 当前方法
        //   isNewObj: 是否为新对象
        unsafe StackObject* MyLog(ILIntepreter __intp, StackObject* __esp, List<object> __mStack, CLRMethod __method, bool isNewObj)
        {
            // 获取当前应用程序域
            ILRuntime.Runtime.Enviorment.AppDomain __domain = __intp.AppDomain;
            // 指针的声明
            StackObject* ptr_of_this_method;
            // 为了方便减法运算，计算栈顶指针位置
            StackObject* __ret = ILIntepreter.Minus(__esp, 1);

            // 获取栈顶参数的指针
            ptr_of_this_method = ILIntepreter.Minus(__esp, 1);
            // 将栈顶参数转换为System.Object类型
            System.Object @message = (System.Object)typeof(System.Object).CheckCLRTypes(StackObject.ToObject(ptr_of_this_method, __domain, __mStack), (ILRuntime.CLR.Utils.Extensions.TypeFlags)0);
            // 释放栈顶参数的指针
            __intp.Free(ptr_of_this_method);

            // 获取调用栈信息 是我们自己添加的
            var stackTrace = __domain.DebugService.GetStackTrace(__intp);

            // 输出日志信息和调用栈信息
            UnityEngine.Debug.Log(@message + "\n" + stackTrace);

            return __ret;
        }

        
        
        
        
        
        
        
        
        /// <summary>
        /// 启动完毕并且初始化完毕后 想要执行的热更新的逻辑
        /// </summary>
        private void ILRuntimeLoadOverDoSomthing()
        {
        }

        /// <summary>
        /// 去异步加载我们的热更相关的dll和pdb文件
        /// </summary>
        /// <returns></returns>
        IEnumerator LoadHotUpdateInfo(UnityAction callBack)
        {
            //这部分知识点在 Unity网络开发基础当中有讲解
            //加载本地的DLL文件
#if UNITY_ANDROID
        UnityWebRequest reqDll = UnityWebRequest.Get(Application.streamingAssetsPath + "/HotFix_Project.dll");
#else
            UnityWebRequest reqDll =
                UnityWebRequest.Get("file:///" + Application.streamingAssetsPath + "/HotFix_Project.dll");
#endif
            yield return reqDll.SendWebRequest();
            //如果失败了
            if (reqDll.result != UnityWebRequest.Result.Success)
                print("加载DLL文件失败" + reqDll.responseCode + reqDll.result);
            //读取加载的DLL数据
            byte[] dll = reqDll.downloadHandler.data;
            reqDll.Dispose();

#if UNITY_ANDROID
        UnityWebRequest reqPdb = UnityWebRequest.Get(Application.streamingAssetsPath + "/HotFix_Project.pdb");
#else
            UnityWebRequest reqPdb =
                UnityWebRequest.Get("file:///" + Application.streamingAssetsPath + "/HotFix_Project.pdb");
#endif
            yield return reqPdb.SendWebRequest();
            //如果失败了
            if (reqPdb.result != UnityWebRequest.Result.Success)
                print("加载Pdb文件失败" + reqPdb.responseCode + reqPdb.result);
            //读取加载的DLL数据
            byte[] pdb = reqPdb.downloadHandler.data;
            reqPdb.Dispose();

            //3.将加载的数据以流的形式(文件流或者内存流对象)传递给AppDomain对象中的LoadAssembly方法
            //注意 这里使用流 不要用完就关 一定要等到热更相关内容不使用了 再关闭
            dllStream = new MemoryStream(dll);
            pdbStream = new MemoryStream(pdb);
            //将我们两个文件的内存流用于初始化 appDomain 我们之后就可以通过该对象来执行我们对应的热更代码了
            appDomain.LoadAssembly(dllStream, pdbStream, new PdbReaderProvider());

            InitILRuntime();

            ILRuntimeLoadOverDoSomthing();

            //当ILRuntime启动完毕 想要在外部执行的内容
            callBack?.Invoke();
        }
    }
}

ILRuntimeCLRBinding

#if UNITY_EDITOR
using UnityEditor;
using UnityEngine;
using System;
using System.Text;
using System.Collections.Generic;
using ILRuntimeDemo;
using Lesson12_FatherNameSpace;
using Lesson13_FatherNameSpace;
using Lesson13_InheritAllNameSpace;
using Lesson13_InterfaceNameSpace;

[System.Reflection.Obfuscation(Exclude = true)]
public class ILRuntimeCLRBinding
{
    [MenuItem("ILRuntime/通过自动分析热更DLL生成CLR绑定")]
    static void GenerateCLRBindingByAnalysis()
    {
        //用新的分析热更dll调用引用来生成绑定代码
        ILRuntime.Runtime.Enviorment.AppDomain domain = new ILRuntime.Runtime.Enviorment.AppDomain();
        using (System.IO.FileStream fs = new System.IO.FileStream("Assets/StreamingAssets/HotFix_Project.dll", System.IO.FileMode.Open, System.IO.FileAccess.Read))
        {
            domain.LoadAssembly(fs);

            //Crossbind Adapter is needed to generate the correct binding code
            InitILRuntime(domain);
            ILRuntime.Runtime.CLRBinding.BindingCodeGenerator.GenerateBindingCode(domain, "Assets/Samples/ILRuntime/Generated");
        }

        AssetDatabase.Refresh();
    }

    [MenuItem("ILRuntime/删除所有CLR绑定")]
    static void DeleteCLRBindins()
    {
        System.IO.Directory.Delete("Assets/Samples/ILRuntime/Generated", true);
        AssetDatabase.Refresh();
    }


    static void InitILRuntime(ILRuntime.Runtime.Enviorment.AppDomain domain)
    {
        //这里需要注册所有热更DLL中用到的跨域继承Adapter，否则无法正确抓取引用
        domain.RegisterCrossBindingAdaptor(new MonoBehaviourAdapter());
        domain.RegisterCrossBindingAdaptor(new CoroutineAdapter());
        domain.RegisterCrossBindingAdaptor(new TestClassBaseAdapter());
        
        
        //注册跨域继承的父类适配器 我们自己手动添加进来的 其他注册是其他官方测试示例添加的
        domain.RegisterCrossBindingAdaptor((new Lesson12_FatherAdapter()));
        domain.RegisterCrossBindingAdaptor((new Lesson13_FatherAdapter()));
        domain.RegisterCrossBindingAdaptor((new Lesson13_InterfaceAdapter()));
        domain.RegisterCrossBindingAdaptor((new Lesson13_InheritAllAdapter()));
        
        // 值类型绑定注册
        domain.RegisterValueTypeBinder(typeof(Vector3), new Vector3Binder());
        domain.RegisterValueTypeBinder(typeof(Vector2), new Vector2Binder());
        domain.RegisterValueTypeBinder(typeof(Quaternion), new QuaternionBinder());
    }
}
#endif

ILRuntimeMain

using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.Threading.Tasks;
using UnityEngine;

namespace HotFix_Project
{

    #region 委托调用

    public delegate void MyILRuntimeDel1();
    public delegate int MyILRuntimeDel2(int i, int j);

    #endregion


    class ILRuntimeMain
    {
        /// <summary>
        /// 把逻辑处理权交给热更工程
        /// 它是一个启动函数
        /// </summary>
        public static void Start()
        {
            #region ILRuntime调用Unity

            //使用ILRuntime创建的空物体
            GameObject obj = new GameObject("ILRuntime创建的空物体");
            obj.transform.position = new Vector3(10, 10, 10);
            //Debug.Log(obj.transform.position);//(10.00, 10.00, 10.00)

            //添加物理的dll后 可以正常使用Rigidbody了
            Rigidbody rigidBody = obj.AddComponent<Rigidbody>();
            rigidBody.mass = 9999;

            // 可以直接添加Unity自己写的脚本
            obj.AddComponent<Lesson10_Test>();

            #endregion



            #region 委托调用



            ////在ILRuntime中 申明 Unity中自定义委托变量 装载 ILRuntime的函数 正常使用
            //MyUnityDel1 fun = Fun1;
            //fun();//IL_Fun1

            //MyUnityDel2 fun2 = Fun2;
            //int result = fun2(5, 6);//IL_Fun2
            //Debug.Log(result);//11




            ////在Unity中 申明 Unity中自定义委托变量 关联ILRuntime工程中的函数

            ////找到我们在Unity的脚本
            //Lesson11_更多跨域调用_委托调用 lesson11 = GameObject.FindObjectOfType<Lesson11_更多跨域调用_委托调用>();

            ////直接设置Unity中自定义委托变量为ILRuntime工程中的函数会报错
            ////报错信息：KeyNotFoundException: Cannot find convertor for global::MyUnityDel1

            ////使用自定义委托
            ////注册MyUnityDel1和MyUnityDel2的委托和委托转换器后才能正常执行
            //lesson11.fun = Fun1;
            //lesson11.fun();//IL_Fun1
            //lesson11.fun2 = Fun2;
            //result = lesson11.fun2(7, 7);//IL_Fun2
            //Debug.Log(result);//14




            ////使用Action或者Func
            ////因为使用的是Action或者Func 不需要注册委托转换器
            //lesson11.funAction = Fun1;
            //lesson11.funAction();//IL_Fun1
            //lesson11.funFunc = Fun2;
            //result = lesson11.funFunc(8, 8);//IL_Fun2
            //Debug.Log(result);//16



            ////在ILRuntime中自定义委托后使用 直接使用
            //MyILRuntimeDel1 funIL = Fun1;
            //funIL();//IL_Fun1
            //MyILRuntimeDel2 funIL2 = Fun2;
            //result = fun2(1, 1);//IL_Fun2
            //Debug.Log(result);//2

            #endregion


            #region 跨域继承Unity中的类

            //Lesson12_Son lesson12_Son = new Lesson12_Son();
            //lesson12_Son.TestFun("哈哈哈");
            //lesson12_Son.TestAbstract(99);
            //lesson12_Son.valuePublic = 100;

            #endregion

            #region 跨域继承Unity中的类的注意事项


            //Lesson13_Son lesson13_Son = new Lesson13_Son();
            //lesson13_Son.TestAbstract(666);
            //lesson13_Son.TestInterface();

            //Lesson13_InheritAllSon lesson13_InheritAll = new Lesson13_InheritAllSon();
            //lesson13_InheritAll.TestAbstract(666);
            //lesson13_InheritAll.TestInterface();

            #endregion

            #region CLR重定向和CLR绑定

            ////得到当前系统时间
            //System.DateTime currentTime = System.DateTime.Now;
            //for (int i = 0; i < 100000; i++)
            //{
            //    Lesson14_更多跨域调用_CLR重定向和CLR绑定.TestFun(i, i);
            //}
            //Debug.Log("十万次循环花费的时间：" + (System.DateTime.Now - currentTime).TotalMilliseconds + "ms");

            #endregion


            #region 值类型绑定
            System.DateTime currentTime = System.DateTime.Now;
            Vector3 v1 = new Vector3(123, 54, 567);
            Vector3 v2 = new Vector3(342, 678, 123);
            float dot = 0;
            for (int i = 0; i < 1000000; i++)
            {
                dot += Vector3.Dot(v1, v2);
            }

            Vector2 v3 = new Vector2(12, 56);
            Vector2 v4 = new Vector2(123123, 45345);
            for (int i = 0; i < 1000000; i++)
            {
                dot += Vector3.Dot(v3, v4);
            }

            Debug.Log("值类型计算花费的时间：" + (System.DateTime.Now - currentTime).TotalMilliseconds + "ms");
            #endregion

        }


        #region 委托调用

        public static void Fun1()
        {
            Debug.Log("IL_Fun1");
        }

        public static int Fun2(int a, int b)
        {
            Debug.Log("IL_Fun2");
            return a + b;
        }

        #endregion

    }
}

15.3 练习题

进行值类型绑定注册的API是什么？

调用Appdomain对象中的RegisterValueTypeBinder(typeof(值类型), new 绑定类());

转载请注明来源，欢迎对文章中的引用来源进行考证，欢迎指出任何有错误或不够清晰的表达。可以在下面评论区评论，也可以邮件至 785293209@qq.com