Unity Harmony 注入代码排查transform位置变化

原创已于 2025-11-25 15:10:16 修改 · 754 阅读

20 ·

CC 4.0 BY-SA版权

文章标签：

#unity #游戏引擎

于 2025-02-12 15:56:45 首次发布

工具源码：https://github.com/handzlikchris/Unity.TransformChangesDebugger.API

Harmony：https://github.com/pardeike/Harmony

介绍

代码存在直接使用原始Transform.SetPosition等设置坐标，如果出现抖动或者其他位置异常，排查会比较困难，传统做法：
- C#约定所有设置坐标接口都用自己封装的。
- lua的话，因为是都是通过C# Wrap调用，可以在C#Wrap中加打印。
- 极端点：改引擎源码重新编译。
现在提供另一种思路，在所有C#代码改变坐标的地方，注入代码，实现监听所有改变坐标的代码调用情况。
存在的问题：如果是动画或者物理控制等非自己加的代码，就无法检查到，可以提前排查。

使用

对需要检查的GameObject，拖入组件TrackPositionChanges，如果有改动坐标的操作，会在控制台打印改变日志。

#if UNITY_EDITOR
using System;
using System.Collections;
using System.Collections.Generic;
using System.IO;
using System.Reflection;
using UnityEngine;
using TransformChangesDebugger.API;

public class TrackPositionChanges : TrackTransformChanges
{
    // 初次初始化要80多秒
    
    private static bool isInit = false;
    private static void InitializeTracking()
    {
        if (isInit)
            return;
        isInit = true;
        // Unity默认c#程序集 \client\Library\ScriptAssemblies\Assembly-CSharp.dll
        var userCodeAssembly = new FileInfo(Assembly.GetExecutingAssembly().Location);
        var thirdPartyToolAssembly = new FileInfo(userCodeAssembly.Directory.FullName + "/TrueSync.dll");
        
        // 哪些程序集里的SetPosition要监听
        var userChosenAssembliesToPatch = new List<FileInfo>() { userCodeAssembly, thirdPartyToolAssembly }; //you can specify which assemblies are patched (to save time)
        var allAvailableAssembliesToPatch = new List<FileInfo> { userCodeAssembly, thirdPartyToolAssembly }; //and you also specify all available assemblies, this is mainly for performance-statistics that GUI can use
        
        TransformChangesTracker.InitializeTrackingEvenWithoutAnyTrackedObjects = true;
        TransformChangesDebuggerManager.IsTrackingEnabled = true;
        TransformChangesDebuggerManager.Initialize(allAvailableAssembliesToPatch, userChosenAssembliesToPatch);
    }
    public void Start()
    {
        InitializeTracking();
        
        PositionChanged.AddListener(Dump);
    }

    public void Dump(TransformChange c)
    {
        Debug.LogError($"[{Time.frameCount}]坐标在变[{c.ModifiedObject}] 操作者：【[{c.CallingObject}][{c.CallingFromMethodName}]】 变化：【{c.ValueBeforeChange} -> {c.NewValue}】");
    }
}

#endif

原理

找到可能修改坐标的程序集，一般没有自己封装的就是Unity生成的 \client\Library\ScriptAssemblies\Assembly-CSharp.dll，有自己的插件的比如定点数插件TrueSync.dll。在初始化函数TransformChangesDebuggerManager.Initialize中传入参数。
篡改UnityEngine.Component.SendMessage方法，后面会用到，至于为啥改这个方法，猜测可能是Transform自带不需要额外依赖别的代码。
对第一步的所有DLL，修改坐标的代码位置，插入第二步的SendMessage方法。
1. 遍历所有DLL里面函数，找到设置坐标的相关代码函数，比如下面找到了TSTransform.UpdatePlaymode中有.position赋值的操作。
2. 对找到的函数进行篡改
3. 找到对应的il指令
4. 前后插入自己要的SendMessage方法
在自己实现的SendMessage方法内，回调出去自己监听即可。