Transform.set_localPosition NullReferenceException背后的故事

在bugly上看到不少android设备上报一个奇怪的NullReferenceException堆栈：

奇怪的NRE堆栈

[GeneratedByOldBindingsGenerator]
[MethodImpl(MethodImplOptions.InternalCall)]
private extern void INTERNAL_set_localPosition(ref Vector3 value);

......

public Vector3 localPosition
{
    get
    {
        Vector3 result;
        this.INTERNAL_get_localPosition(out result);
        return result;
    }
    set
    {
        this.INTERNAL_set_localPosition(ref value);
    }
}

INTERNAL_set_localPosition方法有MethodImpl(MethodImplOptions.InternalCall)标记，这是mono的一种调用native代码的方法，比传统的P/Invoke高效。看到这里隐约明白了为何set_localPosition内部还会报NullReferenceException。Transform只是Mono托管堆里的一个实例，但它只是一个壳，具体的实现在native层，当GameObject被销毁时，native层的对象已经不存在了，mono堆中的壳由于还存在引用，没有被GC回收。可以写如下代码来验证：

using UnityEngine;
using System.Collections;

public class Test : MonoBehaviour {

    // Use this for initialization
    void Start () {
        var o = new GameObject ("test");
        var tr = o.transform;

        GameObject.DestroyImmediate (o);

        if (tr == null) {
            Debug.Log ("tr is null");

            Debug.Log ("tr type:" + tr.GetType());
        } else {
            Debug.Log ("tr is not null");
        }

        tr.localPosition = Vector3.one;
    }

}

将脚本挂在一个GameObjet上运行，日志输出如下：

Log

输出tr is null,类型又是Transform。怎么会这样呢？原来UnityEngine.Object重载了==操作符。具体可以看UnityEngine.Object的反编译代码：

public override bool Equals(object other)
{
    Object @object = other as Object;
    return (!(@object == null) || other == null || other is Object) && Object.CompareBaseObjects(this, @object);
}

public static implicit operator bool(Object exists)
{
    return !Object.CompareBaseObjects(exists, null);
}

当native对象销毁后，== null就会返true。
接着看log，在设置localPosition时，抛出MissingReferenceException异常，注意这里不是我们预期的NullReferenceException。google了一下MissingReferenceException，原来在Editor环境下，为了出现这种问题时能够给出友好提示，UnityEditor保存了相关的上下文信息，而编译到目标平台后，舍弃了这些信息换来更快的运行速度，就给出了NullReferenceException。见参考2。

回到最早的Bugly异常堆栈，问题出现在lua中调用了transform.localPosition = xxx。搜索一下项目中的相应代码，发现现有的逻辑加了如下判断：

if trans ~= nil then
    trans.localPosition = UnityEngine.Vector3.New(tempX,tempY,0)
end

由于这里lua的trans变量其实是一个UserData类型，指向mono中的对象，~=nil并不能判断native对象是否销毁了。所以这里的保护代码其实是无效的。解决方法有两个：
1）在c#里写一个判断对象是否为null的方法导出给lua使用
2）在设置c#的TransformWrap设置localPosition值的时候，首先判断当前transform对象是否为null。我们使用的uLua，可以通过修改uLua生成Wrap类的脚本来统一实现。

参考：

1. Calling C Code From Mono/.NET
2. Why am I getting MissingReferenceException in the Editor and a NullReferenceException on mobile devices when running the same piece of code?