loongly / purescript Goto Github PK

View Code? Open in Web Editor NEW

271.0 14.0 49.0 39.93 MB

A C# hot reload framework for Unity3D, based on Mono's MONO_AOT_MODE_INTERP mode.

License: MIT License

C# 23.41% C 75.58% C++ 0.61% Ruby 0.15% Objective-C 0.25%

unity3d hot-reload interpreter mono

purescript's Introduction

PureScript

一个支持Unity3D的C#热更框架，基于Mono的MONO_AOT_MODE_INTERP模式。

支持在iOS平台Assembly.Load
构建时自动绑定Unity的Il2cpp代码。
支持大部分Unity特性，包括MonoBehaviour、Coroutine。
支持配置程序集运行环境（Il2cpp/aot/interp）
支持Cocoapods自动集成
支持对"magic code"的自定义绑定实现

iOS真机演示视频
 项目介绍

iOS平台

使用“Mixed Mode Execution” 兼顾性能(aot)和灵活性(interpreter)

Windows平台

使用Jit模式运行，可以导出Il2cpp工程，添加ScriptEngine项目断点调试。

Android平台

请使用Unity的Mono运行时，可以直接调用Assembly.Load，同使用PureScript是等效的，工程结构无需修改。

使用

Clone本工程，拷贝DemoProject/Assets/Plugins/PureScript目录。
修改 PureScriptBuilder.cs及ScriptEngine/Tools/config.json中的路径配置。

config.json中配置运行在interpreter模式的dll(否则以aot运行),以及运行在Il2cpp运行时内的dll(一般用作Adapter)。
config.json（默认配置为Demo工程配置）：

 ScriptEngineDir： 指向PureScript\ScriptEngine目录
 AdapterSet：      配置即要在Il2cpp又要在Mono中使用的dll,一般为一些通用插件
 InterpSet：       配置需要热更的dll,否则运行在aot中   
 Entry:            配置Mono中入口dll,通过引用关系收集需要在Mono中运行的dll,动态load的dll也需要配置在此处

ScriptEngine启动接口请参考 DemoProject\Assets\Scripts\Lancher.cs, (注意修改'reloadDir'变量)。

iOS平台

iOS平台需要安装Cocoapods和Ninja 。并在项目的podfile内添加PureScript引用。例： */iOS/Podfile-example
导出xcode工程，然后

    pod install

Windows平台

Windows平台仅用来调试，目前未添加自动集成，在构建项目后，需编译 ScriptEngine/ScriptEngine.vcxproj,替换原来Plugins目录下的的ScriptEngine.dll。
ScriptEngine.vcxproj 属性/VC++目录/包含目录中使用了宏：$(UnityEditorPath) 指向Unity/Editor目录。

调试步骤：

修改Lancher.cs中的reloadDir，替换其中的{path_to_ScriptEngine}指向PureScript\ScriptEngine\Managed目录
Unity导出VS工程。
需要删除Unity导出目录下的Managed目录例如($(ExportPath)/DemoProject/Managed),否则Mono会默认从此处加载dll,Il2cpp并不会使用此目录，但是每次构建都会导出。
在导出的解决方案中添加ScriptEngine.vcxproj,并在主项目中添加ScriptEngine项目的依赖（方便调试）。
修改ScriptEngine.vcxproj中的输出目录为 $(ExportPath)/build/bin/DemoProject_Data/Plugins/,即替换原本的ScriptEngine.dll。
运行项目

例子

以下两段代码是等效的，详细参考DemoProject/*/MonoEntry.cs。

  ScriptEngine.Setup(reloadDir, "TestEntry.dll");

  // equal to:

  Assembly assembly = Assembly.Load("TestEntry.dll");
  Type type = assembly.GetType("MonoEntry");
  MethodInfo mi = type.GetMethod("Main");
  var res = mi.Invoke(null, null)

`注意`

需要热更新的程序集可以使用UnityEditor上的菜单PureScript/Build构建。
目前iOS平台带的mono库为arm64指令集没有开启bitcode，如有其它需求请自己构建一个替换。
如果是windows平台记得根据上面说明生成ScriptEngine.dll 替换导出目录中的dll
Unity2020编辑器默认release模式导出失败，需要在编辑器右下角'Switch to debug mode'即可正常导出。
建议所有网络或文件IO操作统一在il2cpp内执行，配置为Adapter提供给Mono使用。

实现

PureScript 封装了Mono运行时，c/csharp代码生成器，pod项目自动集成，实现了两种绑定方式。两种方式均在构建时自动生成绑定代码，调用方几乎无感知，具体参考DemoProject。两种绑定均支持调用和回调。

Internal call 绑定：由c/cpp实现，直接使用Unity的dll，同时把Unity的Internal call绑定到UnityEngine实现，几乎没有性能损失，调用方无需修改。
例：ScriptEngine/generated/icall_binding_gen.c。
如果碰到“Unity magic”代码自动绑定有问题，可以实现自己的绑定。
例：ScriptEngine/custom/icall_binding.c。
或者在CSharp层用Adapter绑定。
Adapter绑定：由纯CSharp实现，分别在Mono端和Il2cpp端生成绑定代码，具有更好的兼容和灵活性。Mono运行时内的dll调用Il2cpp内的dll时用到，在config.json中配置需要运行在Il2cpp内又需要在Mono内调用的dll，构建时自动生成绑定代码，在aot执行，调用时自动替换到绑定代码，调用方无需修改。例：DemoProject/*/AdapterTest

绑定分两部分，构建时会自动生成Adapter.gen.dll(Il2cpp内执行)和Adapter.wrapper.dll(Mono内执行)，生成代码参考：ScriptEngine/Adapter/glue/*.cs。
运行时ScriptEngine.Setup会将需要绑定的接口生成代理对象，然后序列化到非托管内存中，同时将内存指针报错到ScriptEngine中,参考：ScriptEngine.c。
Mono运行时启动后，执行Main函数时会首先从ScriptEngine读取内存指针，然后反序列化为代理，供Wrapper调用。
Mono运行时内，调用被Adapter绑定过的程序集时会自动指向Adapter.wrapper.dll内的Wrapper实现。
注：代理的序列化与反序列化参考：

Marshal.GetFunctionPointerForDelegate
Marshal.GetDelegateForFunctionPointer

自动绑定过程

构建Unity项目时PureScriptBuilder.cs内注册了回调，并通过hook的方式分别在StripAssemblies前/后添加了绑定调用,此处是要再Il2cpp前将已经Strip的Assemblies拷贝出一份，并且进行Adapter绑定的代码生成。
第一次绑定调用是做Adapter绑定的代码生成，生产物是Adapter.gen.dll和Adapter.wrapper.dll，这步需要在Strip前，否则会触发Il2cpp构建错误。
第二次绑定调用是在Strip后，此次绑定会将已经Strip的Assemblies拷贝出一份。
然后进行icall绑定，生产物是ScriptEngine/generated/.c
如果是iOS平台，会进行aot构建,首先生成build.ninja,然后通过ninja生成ScriptEngine/aot/.a

正式项目请将Mono库(mono*.dll/mono*.a) 替换为自己编译的。

如果大家对这个方案有兴趣再补充详细文档，同时欢迎提交PR或者Star。

有问题欢迎提交issue 或 [email protected]

purescript's People

Contributors

Stargazers

Watchers

purescript's Issues

windows平台跑Demo的时候会出问题

今天一直在尝试，打了个windows下的il2cpp来测试，遇到了很多dll相关的主要是路径的问题，最后到了这里返回的res是-1，然后就不能继续下去了

按照我的理解，从ScriptEngine.Setup调用SetupMono启动TestEntry.dll这里应该是对应了intepreter模式的入口调用，应该是比较关键的地方。
接下来我只能用调试mono的方式来看为什么调用出错了。如果仓库主能完善一下文档追加一些原理和问题的faq，再来一个可复现的demo就好了。

请问支持Unity的版本有哪些呢？

如题，顺便请教下有没有Q群号技术交流群，提供下加下好友

有没有什么交流群

用安卓il2cpp 模式下启动mono 虚拟机之后会crash ，现在还更新了吗

class内定义的delegate如果作为此class的构造函数的参数传入，会导致生成的UnityBind有语法错误，并且wrapper class的处理也有误

例如这个class：

public class TestDelegateAsCtorArg
{
    public delegate void Callback();

    public TestDelegateAsCtorArg(Callback callback)
    {
        SetCallBack(callback);
    }
    public void SetCallBack(Callback callback)
    {
        if(callback != null)
        {
            callback();
        }
    }
}

生成的wrapper class的代码：

......
public  global::TestDelegateAsCtorArg.Callback _TestDelegateAsCtorArg__ctor_callback;
public GCHandle _TestDelegateAsCtorArg__ctor_callback_ref;
static Delegate5605cacf TestDelegateAsCtorArg__ctor_callbackAction = OnTestDelegateAsCtorArg__ctor_callback;
static void OnTestDelegateAsCtorArg__ctor_callback(IntPtr arg0_h)
{
  Exception __e = null;
  try
  {
    var arg0Obj = ObjectStore.Get<global::TestDelegateAsCtorArg>(arg0_h);
    arg0Obj._TestDelegateAsCtorArg__ctor_callback();
  }
  catch(Exception e)
  {
    __e = e;
  }
  if(__e != null)
  ScriptEngine.OnException(__e.ToString());
}
public  global::TestDelegateAsCtorArg.Callback _TestDelegateAsCtorArg_SetCallBack_callback;
public GCHandle _TestDelegateAsCtorArg_SetCallBack_callback_ref;
static Delegate5605cacf TestDelegateAsCtorArg_SetCallBack_callbackAction = OnTestDelegateAsCtorArg_SetCallBack_callback;
static void OnTestDelegateAsCtorArg_SetCallBack_callback(IntPtr arg0_h)
{
	Exception __e = null;
	try
	{
		var arg0Obj = ObjectStore.Get<global::TestDelegateAsCtorArg>(arg0_h);
		arg0Obj._TestDelegateAsCtorArg_SetCallBack_callback();
	}
	catch(Exception e)
	{
		__e = e;
	}
	if(__e != null)
	ScriptEngine.OnException(__e.ToString());
}
......

public TestDelegateAsCtorArg(Callback callback)
{
  if(typeof(TestDelegateAsCtorArg) == GetWType())
  {
    var TestDelegateAsCtorArg__ctor_callback_p = Marshal.GetFunctionPointerForDelegate(TestDelegateAsCtorArg__ctor_callbackAction);
    var h = MonoBind.TestDelegateAsCtorArg__ctor_6(TestDelegateAsCtorArg__ctor_callback_p);
    ScriptEngine.CheckException();
    SetHandle(h);
    ObjectStore.Store(this, h);
  }
}
public void SetCallBack(Callback callback)
{
  _TestDelegateAsCtorArg_SetCallBack_callback = callback;
  ObjectStore.RefMember(this,ref _TestDelegateAsCtorArg_SetCallBack_callback_ref,_TestDelegateAsCtorArg_SetCallBack_callback);
  var TestDelegateAsCtorArg_SetCallBack_callback_p = Marshal.GetFunctionPointerForDelegate(TestDelegateAsCtorArg_SetCallBack_callbackAction);
  MonoBind.TestDelegateAsCtorArg_SetCallBack(this.Handle, TestDelegateAsCtorArg_SetCallBack_callback_p);
  ScriptEngine.CheckException();
  return ;
}

生成的UnityBind的代码：

static Delegatef55bb3df _EventDelegate__ctor_call;
static void OnEventDelegate__ctor_call(this global::EventDelegate arg0)
{
var arg0_h = ObjectStore.Store(arg0);
_EventDelegate__ctor_call(arg0_h);
ScriptEngine.CheckException();
}

[MonoPInvokeCallback(typeof(EventDelegate__ctor_12_Type))]
static IntPtr EventDelegate__ctor_12 (IntPtr call_p)
{
Exception __e = null;
try
{
	_EventDelegate__ctor_call = call_p == IntPtr.Zero ? null: Marshal.GetDelegateForFunctionPointer<Delegatef55bb3df>(call_p);
	var _value = new global::EventDelegate(thizObj.OnEventDelegate__ctor_call); //语法错误
	var _valueHandle = ObjectStore.Store(_value);
	return _valueHandle;
}
catch(Exception _e_)
{
	__e = _e_;
}
if(__e != null)
ScriptEngine.OnException(__e.ToString());
return default(IntPtr);
}

项目目前对于delegate的处理应该是将mono层传入的delegate作为function pointer，赋值给wrapper class的static成员。mono内的wrapper class传入的delegate没有正确赋值，UnityBInd内被封装之后的delegate的实例则依赖于class的实例来获得，而此时还在构造constructor的参数，无法获取到实例，导致最后生成的代码产生语法错误。

MonoPInvokeCallbackAttribute会被strip

如果项目内没有引用到MonoPInvokeCallbackAttribute，会在导出工程时被裁剪掉，导致Adapter.gen.dll的编译错误。

在生成UnityBind时对generic delegate parameter进行UnBox没有展开非泛型的参数类型

例如：

public class TestArgs
{
  public string name;
}

public class TestClassA
{
public delegate System.EventHandler<TestArgs> testDelegate; 
}

testDelegate展开之后类型是 EventHandler(object sender, TestArgs e)，此delegate含有两个参数，但是目前会错误的只包含了一个TestArgs类型的参数。

loongly / purescript Goto Github PK

purescript's Introduction

PureScript

iOS平台

Windows平台

Android平台

使用

iOS平台

Windows平台

例子

注意

实现

自动绑定过程

purescript's People

Contributors

Stargazers

Watchers

Forkers

purescript's Issues

Recommend Projects

Recommend Topics

Recommend Org

`注意`