Skip to content

Latest commit

 

History

History
156 lines (106 loc) · 9.97 KB

faq.md

File metadata and controls

156 lines (106 loc) · 9.97 KB

FAQ

错误码相关

[Puer001]DllNotFoundException: puerts

意思是Unity无法加载PuerTS的Native Plugin,比如windows下的.dll,macOS下的.dylib.bundle,其它平台下的.a.so等。

出现该问题的可能性如下:

  1. 你确实没有把PuerTS的Native Plugin放到Assets目录下
  2. Native Plugin的Import Setting,即平台设置,没有设置对。请在Unity里点击对应的文件设置好平台。或者你可以将官方demo项目里对应的meta文件拷过来用。
  3. Native Plugin所依赖的系统库不存在。Mac下可以使用otool、Linux下可以使用objdump,Windows下可以使用Dependencies查看NativePlugin文件的依赖。查出来后自行补充安装即可。

相关issue:#941

[Puer002]module not found | [Puer003]module not found

Puer002代表PuerTS在加载js文件时没有能够找到对应的js文件,具体来说,是调用ILoader的FileExists返回了false,或是调用IResolvableLoader的Resolve时返回了空字符串或null。

如果遇到这个问题,先确认你使用的loader是DefaultLoader(即创建JsEnv时没有传任何参数)还是你自己编写的自定义Loader。然后检查这个Loader的FileExists函数或是Resolve函数,看看为什么会返回不正确的值。

Puer003Puer002是类似的,只不过Puer003是Loader的ReadFile接口返回了空。你同时要检查一下为什么FileExistsResolve返回了存在,但ReadFile时却读到了空

安装相关

版本中的 Stable/Latest,RC/Preview 分别意味着什么?

  1. Stable:stable代表这个版本已经被长久的验证过,可以稳定地使用,基本不会有明显问题。
  2. Latest: 版本会搭载着最新的功能,比如兼容近期的一些上下游变更(比如mac m系列CPU推出等)或是包含更高性能的调用、更平滑的入门曲线等。

版本号中的pre和RC:

  1. Preview或pre:preview代表这个版本带有一些实验性功能,且这些功能在未来还有可能修改/删除
  2. RC:意味着release candidate。一个版本从preview进入rc意味着这个版本号不会再激进地添加/修改/删除功能,且bug量会逐渐收敛。当一段时间无bug反馈后就会进入release阶段。

PuerTS三种后端V8/QuickJS/NodeJS 是什么意思?

  1. PuerTS本身并不负责编译或是解释执行Javascript,而是通过引入第三方 JS 引擎来做这件事。默认情况下,使用的是 NodeJS 引擎。但根据不同的使用场景,同时也允许你改用QuickJS和V8后端。
  2. V8。最经典的选择,性能好,可调试,大小适中。
  3. QuickJS。不支持调试和JIT,但是它 很小。某些时候你可能有需要压缩安装包大小的需求。那么你就可以quickjs版本的plugins。
  4. NodeJS。是OpenUPM版本所使用的后端。的详细介绍可以参见官网。它在v8的基础上提供了文件网络等等API。它撑起了 Javascript 强大生态的大半壁江山。有了它你可以更顺畅地使用 npm 带来的各种包。如果你对使用npm包有后续问题,可参见puerts-ts-loader

OpenUPM/Git Clone/拷贝安装怎么选择?

  1. 【步骤最简单-OpenUPM】你只需要运行openupm add xxx即可(国内如果网络不通注意使用openupm-cn)。但它受Unity自身的upm设计限制,当你魔改package内部代码时,Unity会自动帮你重置。如果有魔改需求,需要自行把Library/PackageCache里的包内容复制出来,然后在PackageManager里改成按本地路径使用
  2. 【最灵活自由】Git Clone再在PackageManager里按本地路径使用的方式可以直接解决魔改困难的问题,但你最好自己checkout到合适的tag使用(master上的代码不是永远都经过全量测试)
  3. 【最无脑】从github release下载安装不需要任何前置知识,上手最简单。但2.0版本后PuerTS会逐渐增加一些仅UPM体系可用的辅助型功能,这个方式就用不了了。

其它FAQ

invalid arguments to XXX

如果你用js,可能是输错参数了。

如果你用typescript,可能是子类同名,但不同参数的函数覆盖了父类。以System.Text.Encoding.UTF8.GetBytes为例,你直接调用会报错。

System.Text.Encoding.UTF8.GetBytes("你好");

System.Text.Encoding.UTF8指向的对象System.Text.UTF8Encoding,有GetBytes的其它重载,按目前的实现找到当前类有同名函数就不再找基类导致的。这时候你可以手动指定下用其基类接口访问该对象。

Object.setPrototypeOf(System.Text.Encoding.UTF8, System.Text.Encoding.prototype);//只需要调用过一次即可。后续调用GetBytes都不用再调用。
System.Text.Encoding.UTF8.GetBytes("你好");

setInterval没回调

可能是没调用JsEnv.Tick

如何调试

这是vscode,其它IDE的看各IDE的指引,按nodejs的调试来处理即可。

如果需要调试,ILoader的debugpath参数该如何处理?

ts/js中调用require('./a/b')时,ILoader会被调用并传入字符串".../a/b.js"(相对rootPath的完整路径),你需要理解这字符串并(从文件/内存/网络等)加载好js文件并直接返回。而debugpath需要返回调试器可以理解的路径(比如js文件的绝对路径: D:/.../a/b.js),通过设置out string debuggpath参数返回,调试器后续根据这个文件路径来匹配文件上的断点。

Windows平台不区分文件大小写名称且使用反斜杠"\"代替"/"

can not find delegate bridge for XXX

你将一个js函数映射为一个delegate有时会报这错误,XXX就是要映射的delegate,可能的情况如下:

  • 该delegate带了值类型参数或者返回值,解决办法:如果没有返回值,用JsEnv.UsingAction声明下,有返回值就用JsEnv.UsingFunc声明。关于做这项工作的必要性,可参见这个stackoverflow问题
// 代码示例
Puerts.JsEnv jsEnv = new Puerts.JsEnv();
jsEnv.UsingFunc<int, int>();
System.Func<int, int> add = env.Eval<System.Func<int, int>>(@"
    const add_func = function (num) {
        return num + 1;
    }
    add_func;
");
Console.WriteLine(add(10));
  • 参数数量超过4个,解决办法:官方目前只支持4个,如果有需要,可以依葫芦画瓢写更多的参数支持。

  • 参数含ref,out的修饰,目前尚未支持,解决办法:填写issues来提需求

macOS10.15以上,启动unity的时候提示puerts.bundle损坏,移动到废纸篓

执行

sudo xattr -r -d com.apple.quarantine puerts.bundle

生成代码打包手机版本时报方法(runInEditMode等等)找不到

因为这些方法是编辑器独有的,可以通过filter过滤掉,filter使用参考使用手册

编辑器下运行正常,il2cpp打包后调用函数/访问属性失败

unity默认会进行代码剪裁,简而言之unity发现某引擎api,系统api没有被业务c#使用,就不编译倒cpp。 解决办法:1、对要调用的api生成wrap代码,这样c#里头就有了引用;2、通过link.xml告知unity别剪裁,link.xml的配置请参考unity官方文档。

编辑器下运行正常,打包的时候生成代码报“没有某方法/属性/字段定义”怎么办?

往往是由于该方法/属性/字段是扩在条件编译里头,只在UNITY_EDITOR下有效,这时需要把这方法/属性/字段通过Filter标签过滤,之后重新执行代码生成并打包。(discussions说明)

编辑器下运行正常,打包后调用扩展方法报错(不生成静态代码)

默认打包后不再使用反射获取扩展函数, 可使用PUERTS_REFLECT_ALL_EXTENSION宏来开启反射.(反射速度慢, 建议在任何时候都应该生成静态代码)

GetComponent<XXX>()在CS为null,但在JS调用却不为null,为什么

其实那C#对象并不为null,是UnityEngine.Object重载的==操作符。当一个对象被Destroy,未初始化等情况,obj == null返回true;GetComponent<XXX>()如果组件不存在,Unity重载==的结果也会让其返回null。但这些C#对象并不为null,可以通过System.Object.ReferenceEquals(null, obj)来验证下。

对应这种情况,可以为UnityEngine.Object写一个扩展方法,需要判空的时候统一用它解决:

public static bool IsNull(this UnityEngine.Object o) 
{
    return o == null;
}

source-map-support支持

  1. 正常情况下,你可以直接使用TSLoader,其内置了source-map支持
  2. 如果你的项目不适用TSLoader,可以直接将TSLoader的这个脚本文件放到你的项目,在JsEnv启动后执行下面代码即可。
import sm from 'source-map-support.gen.mjs'
sm.install({
    retrieveFile: (path) => {
        // 如果你用的不是inline的source-map,这里还得处理sourcemap的加载
        return puer.loadFile(path).content
    }
});

概率报Maximum call stack size exceeded

注意是概率报,不是必报,这种情况通常是因为多线程访问了JsEnv,可以尝试打开多线程支持,方法如下:

  • 在C#中加入THREAD_SAFE宏
  • 在plugins中加入THREAD_SAFE宏重新编译并替换各平台的plugins

ps:以上是v8后端的的现象和解决方案,qjs后端如果多线程访问有可能会抛个没有文件信息的异常<unknow>:-1

ps:如果是必报,应该是js代码中有递归死循环了。