Skip to content

Commit

Permalink
更新文档
Browse files Browse the repository at this point in the history
  • Loading branch information
pirunxi committed Jul 25, 2024
1 parent 957d223 commit 6b12c05
Show file tree
Hide file tree
Showing 3 changed files with 63 additions and 40 deletions.
14 changes: 11 additions & 3 deletions docs/basic/runhotupdatecodes.md
Original file line number Diff line number Diff line change
Expand Up @@ -2,14 +2,22 @@

## 加载更新assembly

根据你们项目资源管理的方式,获得热更新dll的bytes数据。然后再直接调用Assembly.Load(byte[] assemblyData)即可。代码类似
如下:
根据你们项目资源管理的方式,获得热更新dll的bytes数据。然后再直接调用`Assembly.Load(byte[] assemblyData)`即可。**自v6.4.0版本起,支持加载pdb符号文件**,即可以通过
调用`Assembly.Load(byte[] assemblyData, byte[] pdbSybmbolData)`同时加载程序集和调试符号。

代码如下:

```csharp
// 从你的资源管理系统中获得热更新dll的数据
byte[] assemblyData = xxxx;
// Assembly.Load内部会自动复制assemblyData,调用完此函数可以释放assemblyData,没必要保存起来。

// Assembly.Load内部会自动复制assemblyData,调用完此函数可以释放assemblyData,不需要保存起来。
Assembly ass = Assembly.Load(assemblyData);

// 同时加载dll和pdb文件
byte[] assData2 = yyy;
byte[] pdbData2 = zzz;
Assembly ass2 = Assembly.Load(assData2, pdbData2);
```

如果有多个热更新dll,请一定要**按照依赖顺序加载**,先加载被依赖的assembly。加载完热更新dll后,有多种方式运行热更新代码,这些技巧跟不考虑热更新时完全相同。
Expand Down
71 changes: 38 additions & 33 deletions docs/intro.md
Original file line number Diff line number Diff line change
@@ -1,7 +1,3 @@
---
id: intro
title: 介绍
---
# HybridCLR

[![license](http://img.shields.io/badge/license-MIT-blue.svg)](https://github.com/focus-creative-games/hybridclr/blob/main/LICENSE)
Expand All @@ -11,28 +7,44 @@ title: 介绍
<br/>
<br/>

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

HybridCLR扩充了il2cpp的代码,使它由纯[AOT](https://en.wikipedia.org/wiki/Ahead-of-time_compilation) runtime变成`AOT+Interpreter` 混合runtime,进而原生支持动态加载assembly,使得基于il2cpp backend打包的游戏不仅能在Android平台,也能在IOS、Consoles等限制了JIT的平台上高效地以**AOT+interpreter**混合模式执行,从底层彻底支持了热更新
HybridCLR扩充了il2cpp运行时代码,使它由纯[AOT](https://en.wikipedia.org/wiki/Ahead-of-time_compilation) runtime变成AOT+Interpreter 混合runtime,进而原生支持动态加载assembly,从底层彻底支持了热更新。使用HybridCLR技术的游戏不仅能在Android平台,也能在IOS、Consoles、WebGL等所有il2cpp支持的平台上高效运行

HybridCLR不仅支持传统的全解释执行模式,还开创性地实现了 [Differential Hybrid Execution(DHE)](./business/differentialhybridexecution) 差分混合执行技术。即可以对AOT dll任意增删改,会智能地让变化或者新增的类和函数以interpreter模式运行,但未改动的类和函数以AOT方式运行,让热更新的游戏逻辑的运行性能基本达到原生AOT的水平
由于HybridCLR对ECMA-335规范 的良好支持以及对Unity开发工作流的高度兼容,Unity项目在接入HybridCLR后,可以几乎无缝地获得C#代码热更新的能力,开发者不需要改变日常开发习惯和要求。HybridCLR首次实现了将Unity平台的全平台代码热更新方案的工程难度降到几乎为零的水平

欢迎拥抱现代原生C#热更新技术 !!!

## 文档

- [官方文档](./intro)
- [快速上手](./beginner/quickstart)
- [商业项目案例](./other/businesscase)


## 特性

- 特性完整。 近乎完整实现了[ECMA-335规范](https://www.ecma-international.org/publications-and-standards/standards/ecma-335/),只有极少量的[未支持特性](/basic/notsupportedfeatures.md)特性。
- 零学习和使用成本。 HybridCLR将纯AOT runtime增强为完整的runtime,使得热更新代码与AOT代码无缝工作。脚本类与AOT类在同一个运行时内,可以随意写继承、反射、多线程(volatile、ThreadStatic、Task、async)之类的代码。不需要额外写任何特殊代码、没有代码生成,几乎没有限制。
- 执行高效。实现了一个极其高效的寄存器解释器,所有指标都大幅优于其他热更新方案。[性能测试报告](/basic/performance.md)
- 内存高效。 热更新脚本中定义的类跟普通c#类占用一样的内存空间,远优于其他热更新方案。[内存占用报告](/basic/memory.md)
- 由于对泛型的完美支持,使得因为AOT泛型问题跟il2cpp不兼容的库现在能够完美地在il2cpp下运行
- 近乎完整实现了[ECMA-335规范](https://www.ecma-international.org/publications-and-standards/standards/ecma-335/),只有极少量的[不支持的特性](./basic/notsupportedfeatures)
- 零学习和使用成本。对绝大多数开发者来说写代码近乎没有限制。 热更新代码与AOT代码无缝工作,可以随意写继承、**泛型****反射**之类的代码。不需要额外写任何特殊代码、没有代码生成
- 完全支持多线程,包含但不限于 volatile、ThreadStatic、async Task等相关功能和特性。这是其他所有热更新方案都不支持的
- 几乎完全兼容Unity的工作流。包括且不限于支持热更新**MonoBehaviour**、ScriptableObject、**DOTS**技术,资源上挂载的热更新脚本可以正确实例化,这是其他所有热更新方案都不支持的
- 执行高效。实现了一个极其高效的寄存器解释器,所有指标都大幅优于其他热更新方案。[性能测试报告](./basic/performance)
- 内存高效。 热更新脚本中定义的类跟普通c#类占用一样的内存空间,远优于其他热更新方案。[内存占用报告](./basic/memory)
- 支持MonoPInvokeCallback,可以与native代码或者其他语言如lua、javascript、python良好交互
- 支持一些il2cpp不支持的特性,如__makeref、 __reftype、__refvalue指令
- 独创性的`Differential Hybrid Execution(DHE)` 差分混合执行技术,让热更新的运行性能基本达到原生AOT的水平。
- 支持独创的 **Differential Hybrid Execution(DHE)** 差分混合执行技术,即可以对AOT dll任意增删改,会智能地让未改动的函数以AOT方式运行,变化或者新增的函数以interpreter模式运行,让热更新的游戏逻辑的运行性能基本达到原生AOT的水平
- 支持 **热重载** 技术,可以100%卸载程序集
- 支持现代的dll加密技术,有效保障代码安全

## 支持的版本与平台

- 支持2019.4.x、2020.3.x、2021.3.x、2022.3.x、2023.2.x、**6000.x.y**全系列LTS版本
- 支持所有il2cpp支持的平台
- 支持团结引擎和鸿蒙平台

## 工作原理

HybridCLR从mono的 [mixed mode execution](https://www.mono-project.com/news/2017/11/13/mono-interpreter/) 技术中得到启发,为unity的il2cpp runtime额外提供了interpreter模块,将它们由纯AOT运行时改造为`AOT + Interpreter`混合运行方式。
HybridCLR从mono的 [mixed mode execution](https://www.mono-project.com/news/2017/11/13/mono-interpreter/) 技术中得到启发,为unity的il2cpp之类的AOT runtime额外提供了interpreter模块,将它们由纯AOT运行时改造为"AOT + Interpreter"混合运行方式。

![icon](/img/hybridclr/architecture.png)

Expand All @@ -44,30 +56,23 @@ HybridCLR从mono的 [mixed mode execution](https://www.mono-project.com/news/201
- 实现了一个高效的寄存器解释器
- 额外提供大量的instinct函数,提升解释器性能

## 与其他流行的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部分类型,需要写适配器,并且解释器中的类型不能为主工程的类型系统所识别。特性不完整、开发麻烦、运行效率低下。

## 支持的版本与平台

- 支持2019.4.x、2020.3.x、2021.3.x、2022.3.x、2023.2.x、**6000.x.y**全系列LTS版本
- 支持所有il2cpp支持的平台

## 低拒审风险
## 稳定性状况

:::tip
HybridCLR已经被广泛验证是非常高效、稳定的Unity热更新解决方案。

HybridCLR在中国大陆地区非常流行,目前已经至少有数百款使用了HybridCLR的游戏上架了App Store和Google Play。
当前发布了**极其稳定**的1.x-5.x正式版本,足以满足大中型商业项目的稳定性要求。
目前有数千个商业游戏项目完成接入,其中有几百款已经双端上线,上线的项目中包括MMORPG、重度卡牌、重度塔防之类的游戏。**绝大多数头部游戏公司**(如腾讯、网易)都已经在使用HybridCLR。

:::
可查看我们已知的头部公司中使用HybridCLR并且已经上线的[项目列表](./other/businesscase)

HybridCLR的底层原理仍然是解释执行,从这点来说与lua并无本质区别。因此符合App Store及Google Play商店的要求,并无特殊的拒审风险。而且因为HybridCLR与il2cpp的高度集成,
它甚至比lua方案要安全很多,拒审的概率很低。
## 支持与联系

- 官方1群:651188171(满)
- 新手1群:428404198(满)
- 新手2群:**680274677(推荐)**
- discord频道 https://discord.gg/BATfNfJnm2
- 商业合作邮箱: business#code-philosophy.com
- [商业化支持](./business/intro)

## 关于作者

Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -2,12 +2,22 @@

## Load assembly

According to your project resource management method, get the bytes data of the hot update dll. Then call Assembly.Load(byte[] assemblyData) directly. code like
as follows:
According to your project resource management method, get the bytes data of the hot update dll. Then call `Assembly.Load(byte[] assemblyData)` directly.
**Since version v6.4.0, it supports loading pdb symbol files**, that is, you can call `Assembly.Load(byte[] assemblyData, byte[] pdbSybmbolData)` to load the assembly and debug symbols at the same time.

The code is as follows:

```csharp
byte[] assemblyData = xxxx; // Get hot update dll data from your resource management system
Assembly ass = Assembly. Load(assemblyData);
// Get the data of the hot update dll from your resource management system
byte[] assemblyData = xxxx;

// Assembly.Load will automatically copy assemblyData internally. After calling this function, assemblyData can be released and does not need to be saved.
Assembly ass = Assembly.Load(assemblyData);

// Load dll and pdb files at the same time
byte[] assData2 = yyy;
byte[] pdbData2 = zzz;
Assembly ass2 = Assembly.Load(assData2, pdbData2);
```

If there are multiple hot update dlls, please be sure to **load them in the order of dependencies**, and load the dependent assembly first.
Expand Down

0 comments on commit 6b12c05

Please sign in to comment.