一个近乎完美的Unity全平台原生C#热更方案

前言

给大家推荐一个近乎完美的Unity全平台原生C#热更方案,相对比其他方案,此方案学习成本更低、完全支持C#所有特性、兼容性极高、占用内存低、执行小高。

项目简介

HybridCLR是一个特性完整、零成本、高性能、低内存的近乎完美的Unity全平台原生C#热更方案。.

HybridCLR扩充了il2cpp的代码,使它由纯AOT runtime变成‘AOT+Interpreter’ 混合runtime,进而原生支持动态加载assembly,使得基于il2cpp backend打包的游戏不仅能在Android平台,也能在IOS、Consoles等限制了JIT的平台上高效地以AOT+interpreter混合模式执行。从底层彻底支持了热更新。

项目特点

  • 特性完整。近乎完整实现了ECMA-335规范,除了 下文中"限制和注意事项" 之外的特性都支持。

  • 零学习和使用成本。HybridCLR将纯AOT runtime增强为完整的runtime,使得热更新代码与AOT代码无缝工作。脚本类与AOT类在同一个运行时内,可以随意写继承、反射、多线程(volatile、ThreadStatic、Task、async)之类的代码。不需要额外写任何特殊代码、没有代码生成,也没有什么特殊限制。

  • 执行高效。实现了一个极其高效的寄存器解释器,所有指标都大幅优于其他热更新方案。性能测试报告

  • 内存高效。热更新脚本中定义的类跟普通c#类占用一样的内存空间,远优于其他热更新方案。内存占用报告

  • 原生支持hotfix修复AOT部分代码。几乎不增加任何开发和运行开销。

  • 兼容性:支持所有il2cpp支持的平台。

  • 稳定性:目前已经接入上百个大中小商业游戏项目。

工作原理

HybridCLR从mono的hybrid mode execution技术中得到启发,为unity的il2cpp之类的AOT runtime额外提供了interpreter模块,将它们由纯AOT运行时改造为"AOT + Interpreter"混合运行方式。

一个近乎完美的Unity全平台原生C#热更方案

更具体地说,HybridCLR做了以下几点工作:

  • 实现了一个高效的元数据(dll)解析库

  • 改造了元数据管理模块,实现了元数据的动态注册

  • 实现了一个IL指令集到自定义的寄存器指令集的compiler

  • 实现了一个高效的寄存器解释器

  • 额外提供大量的instinct函数,提升解释器性能

  • 提供hotfix AOT的支持

与其他流行的c#热更新方案的区别

本质比较

HybridCLR是原生的c#热更新方案。通俗地说,il2cpp相当于mono的aot模块,HybridCLR相当于mono的interpreter模块,两者合一成为完整mono。HybridCLR使得il2cpp变成一个全功能的runtime,原生(即通过System.Reflection.Assembly.Load)支持动态加载dll,从而支持ios平台的热更新。

正因为HybridCLR是原生runtime级别实现,热更新部分的类型与主工程AOT部分类型是完全等价并且无缝统一的。可以随意调用、继承、反射、多线程,不需要生成代码或者写适配器。

其他热更新方案则是独立vm,与il2cpp的关系本质上相当于mono中嵌入lua的关系。因此类型系统不统一,为了让热更新类型能够继承AOT部分类型,需要写适配器,并且解释器中的类型不能为主工程的类型系统所识别。特性不完整、开发麻烦、运行效率低下。

实际使用体验或者特性比较

  • 学习和使用成本几乎为零。HybridCLR让il2cpp变成全功能的runtime,学习和使用成本几乎为零,几乎零侵入性。而其他方案则有大量的坑和需要规避的规则,学习和使用成本,需要对原项目作大量改造。

  • 可以使用所有C#的特性。而其他方案往往有大量的限制。

  • 可以直接支持使用和继承主工程中的类型。其他方案要写适配器或者生成代码。

  • 热更新部分元数据与AOT元数据无缝统一。像反射代码能够正常工作的,AOT部分也可以通过标准Reflection接口创建出热更新对象。其他方案做不到。

  • 对多线程支持良好。像多线程、ThreadStatic、async等等特性都是HybridCLR直接支持,其他方案除了async特性外均难以支持。

  • Unity工作流与原生几乎完全相同。HybridCLR中热更新MonoBehaviour可以直接挂载在热更新资源上,并且正确工作。其他方案不行。

  • 兼容性极高。各种第三方库只要在il2cpp下能工作,在HybridCLR下也能正常工作。其他方案往往要大量魔改源码。

  • 内存效率极高。HybridCLR中热更新类型与主工程的AOT类型完全等价,占用一样多的空间。其他方案的同等类型则是假类型,不仅不能被runtime识别,还多占了数倍空间。

  • 执行效率高。HybridCLR中热更新部分与主工程AOT部分交互属于il2cpp内部交互,效率极高。而其他方案则是独立虚拟机与il2cpp之间的效率,不仅交互麻烦还效率低下。

兼容性

  • 支持2019.4.x、2020.3.x、2021.3.x系列LTS版本

  • 支持所有il2cpp支持的平台。目前测试支持 PC(Win32和Win64)、macOS(x86、x64、Arm64)、Android(armv7、armv8)、iOS(64bit)、NS(64bit)、WebGL(有少量bug)平台,剩余平台有待测试。

  • 测试过大量游戏常见库,未发现跟il2cpp原生兼容但使用HybridCLR后不兼容性的库。只要能在il2cpp backend下工作的库都可以在HybridCLR下正常工作。甚至那些与il2cpp因为AOT问题不兼容的库,现在因为HybridCLR对il2cpp的能力扩充,反而可以正常运行了。

稳定性状况

目前PC(x86及x64)、macOS(x86、x64、Arm64)、Android(arm v7及v8)、iOS(64bit) 可稳定使用。已经有几十个大中型游戏项目较完整地接入,其中一些在紧锣密鼓作上线前测试。

项目地址

https://github.com/focus-creative-games/hybridclr