第一个稳定的V2实现

Author: labbbirder

.gitignore

@@ -0,0 +1,6 @@
+*.exe
+*.exe.meta
+.vs
+obj
+Tools/net6.0/ProxyLinker.meta
+Tools/net6.0/ProxyLinker

.npmignore

@@ -0,0 +1,5 @@
+VSProj~
+.github
+.exe
+README.md
+Documentation

CliTool~/CliTool.sln

@@ -0,0 +1,25 @@
+
+Microsoft Visual Studio Solution File, Format Version 12.00
+# Visual Studio Version 17
+VisualStudioVersion = 17.6.33829.357
+MinimumVisualStudioVersion = 10.0.40219.1
+Project("{9A19103F-16F7-4668-BE54-9A1E7A4F7556}") = "ProxyLinker", "ProxyLinker.csproj", "{3A40235B-D23C-4A82-86C6-C276031777E2}"
+EndProject
+Global
+	GlobalSection(SolutionConfigurationPlatforms) = preSolution
+		Debug|Any CPU = Debug|Any CPU
+		Release|Any CPU = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(ProjectConfigurationPlatforms) = postSolution
+		{3A40235B-D23C-4A82-86C6-C276031777E2}.Debug|Any CPU.ActiveCfg = Debug|Any CPU
+		{3A40235B-D23C-4A82-86C6-C276031777E2}.Debug|Any CPU.Build.0 = Debug|Any CPU
+		{3A40235B-D23C-4A82-86C6-C276031777E2}.Release|Any CPU.ActiveCfg = Release|Any CPU
+		{3A40235B-D23C-4A82-86C6-C276031777E2}.Release|Any CPU.Build.0 = Release|Any CPU
+	EndGlobalSection
+	GlobalSection(SolutionProperties) = preSolution
+		HideSolutionNode = FALSE
+	EndGlobalSection
+	GlobalSection(ExtensibilityGlobals) = postSolution
+		SolutionGuid = {963788C5-6AE0-4620-89E1-B9EEF87C64AC}
+	EndGlobalSection
+EndGlobal

CliTool~/Common.cs

@@ -0,0 +1,65 @@
+using System.Reflection;
+
+namespace BBBirder.UnityInjection.Tools;
+
+using static ToolsConstants;
+public static class Common
+{
+    static string[]? s_allowedAssemblies;
+
+    public static void Init(string[] allowedAssemblies)
+    {
+        s_allowedAssemblies = allowedAssemblies;
+        AppDomain.CurrentDomain.AssemblyResolve += (s, args) =>
+        {
+            var assemblyName = new AssemblyName(args.Name)?.Name;
+            if (assemblyName == null)
+            {
+                throw new ArgumentException($"cannot resolve assembly {assemblyName}");
+            }
+            return LoadAssembly(assemblyName);
+        };
+    }
+
+    public static void Assert(bool condition, string message)
+    {
+        if (!condition) throw new Exception(message);
+    }
+
+    static Assembly LoadAssembly(string name)
+    {
+        var assembly = AppDomain.CurrentDomain.GetAssemblies()
+            .FirstOrDefault(a => a.GetName().Name == name);
+        if (assembly != null) return assembly;
+        var fileName = name + ".dll";
+
+        // directly reside in allowed assemblies
+        var fullPath = s_allowedAssemblies!.FirstOrDefault(a => Path.GetFileNameWithoutExtension(a) == name);
+
+        // reside in save path of an allowed assembly
+        if (fullPath == null)
+        {
+
+            foreach (var p in s_allowedAssemblies!.Select(Path.GetDirectoryName).Distinct())
+            {
+                var filePath = Path.Combine(p, fileName);
+                if (File.Exists(filePath))
+                {
+                    fullPath = filePath;
+                    break;
+                }
+            }
+        }
+
+        // reside in ScriptAssemblies
+        if (fullPath == null)
+        {
+            fullPath = Path.Combine("Library\\ScriptAssemblies", fileName);
+            if (!File.Exists(fullPath)) fullPath = null;
+        }
+
+        if (fullPath != null) return Assembly.Load(File.ReadAllBytes(fullPath));
+
+        throw new ArgumentException($"cannot resolve assembly {name}");
+    }
+}

CliTool~/ProxyLinker.csproj

@@ -0,0 +1,17 @@
+<Project Sdk="Microsoft.NET.Sdk">
+	<PropertyGroup>
+		<TargetFramework>net6.0</TargetFramework>
+		<ImplicitUsings>enable</ImplicitUsings>
+		<Nullable>enable</Nullable>
+		<StartupObject>BBBirder.UnityInjection.Tools.ProxyLinkerProgram</StartupObject>
+		<OutputType>Exe</OutputType>
+		<OutputPath>../Tools</OutputPath>
+		<EnableDefaultItems>false</EnableDefaultItems>
+	</PropertyGroup>
+	<ItemGroup>
+		<Compile Include="Common.cs" />
+		<Compile Include="ProxyLinker*.cs" />
+		<Compile Include="../Editor/ToolsConstants.cs" />
+		<Compile Include="../Runtime/Logger.cs" />
+	</ItemGroup>
+</Project>

CliTool~/ProxyLinkerProgram.cs

@@ -0,0 +1,90 @@
+using System.IO.Pipes;
+using System.Text;
+using System.Text.RegularExpressions;
+
+namespace BBBirder.UnityInjection.Tools;
+using static ToolsConstants;
+
+public class ProxyLinkerProgram
+{
+    record ArgumentData
+    {
+        public string outdir;
+        public string[] allowedAssemblies;
+    }
+
+    static void ParseArguments(string[] args, out ArgumentData argumentData)
+    {
+        Common.Assert(args.Length >= 1, "no argument provided");
+        string outdir = null;
+        var allowedAssemblies = new List<string>();
+        if (args[0].StartsWith('@'))
+        {
+            var path = args[0].Trim('@');
+            var content = File.ReadAllText(path);
+            var matches = Regex.Matches(content, @"([^ =]+)=?(""[^""]*""|[^ ""]*)");
+            Common.Assert(matches != null, "not a valid arguments file");
+
+            for (int i = 0; i < matches!.Count; i++)
+            {
+                var match = matches[i]!;
+                OnProcessArgument(match);
+            }
+        }
+        else
+        {
+            foreach (var arg in args)
+            {
+                var match = Regex.Match(arg, @"([^ =]+)=?(""[^""]*""|[^ ""]*)");
+                if (!match.Success)
+                {
+                    continue;
+                }
+                OnProcessArgument(match);
+            }
+        }
+        argumentData = new()
+        {
+            outdir = outdir,
+            allowedAssemblies = allowedAssemblies.ToArray()
+        };
+        void OnProcessArgument(Match match)
+        {
+            var key = match.Groups[1].Value;
+            var value = match.Groups[2].Value.Trim('\'', '\"');
+            switch (key)
+            {
+                case "--out":
+                    outdir = value;
+                    break;
+                case "--allowed-assembly":
+                    allowedAssemblies.Add(value);
+                    break;
+                default:
+                    break;
+            }
+        }
+    }
+    public static int Main(string[] args)
+    {
+        ParseArguments(args, out var argumentData);
+        var outDir = argumentData.outdir;
+        Common.Assert(outDir != null, "no out argument");
+
+        using var client = new NamedPipeClientStream(LINKER_PIPE_NAME);
+        client.Connect(8_000);
+        if (!client.IsConnected)
+        {
+            return (int)ProxyLinkerResultCode.ConnectionTimeout;
+        }
+        var bytes = Encoding.UTF8.GetBytes(outDir!);
+        foreach (var b in bytes)
+        {
+            client.WriteByte(b);
+        }
+        client.WriteByte(0);
+        client.Flush();
+
+        return client.ReadByte();
+    }
+}

Documentation.meta

@@ -0,0 +1,125 @@
+# 装饰器
+
+值得一提的是，装饰器的实现有以下优势：
+
+* 调用是0GC，低开销的
+* 实现只需要指定一个`DecoratorAttribute`
+* 支持装饰异步函数
+
+## 例子
+
+下面的例子实现目标方法执行前和后打印信息
+
+定义一个装饰器，需要继承自`DecoratorAttribute`，并实现`Decorate`方法
+
+```csharp
+public class DebugInvocationAttribute:DecoratorAttribute
+{
+    string info;
+
+    public DebugInvocationAttribute(string _info)
+    {
+        info = _info;
+    }
+
+    void OnCompleted()
+    {
+        Debug.Log("end "+info);
+    }
+
+    protected override R Decorate<R>(InvocationInfo<R> invocation)
+    {
+        Debug.Log("begin "+info+string.Join(",",invocation.Arguments));
+        // invoke original method
+        var r = invocation.FastInvoke();
+        if(IsAsyncMethod)
+        {
+            // delay on async method
+            invocation.GetAwaiter(r).OnCompleted(OnCompleted);
+        }
+        else
+        {
+            OnCompleted();
+        }
+        return r;
+    }
+}
+
+```
+
+使用
+
+```csharp
+
+public class Demo:MonoBehaviour{
+    
+    void Start(){
+        FixHelper.InstallAll();
+    }
+
+    async void Update(){
+        if(Input.GetKeyDown(KeyCode.A)){
+            Work(1,"foo");
+        }
+        if(Input.GetKeyDown(KeyCode.S)){
+            await AsyncWork(2,"bar");
+            print("return");
+        }
+    }
+
+    //decorate a standard method
+    [DebugInvocation("w1")]
+    int Work(int i, string s){
+        Debug.Log("do work");
+        return 123+i;
+    }
+
+    //decorate an async method
+    [DebugInvocation("aw2")]
+    async Task<int> AsyncWork(int i, string s){
+        Debug.Log("do a lot work");
+        await Task.Delay(1000);
+        return 123+i;
+    }
+}
+```
+
+## 异步方法补充说明
+
+async方法有一个值得斟酌的问题。如果上例的Task换成UniTask。则不会打印return，这是因为Decrote方法覆盖了原本的continuationAction（这与UniTask的实现有关）。使用如下Decorate方法可以解决所有此类问题：
+
+```csharp
+    protected override R Decorate<R>(InvocationInfo<R> invocation)
+    {
+        Debug.Log("begin "+info+string.Join(",",invocation.Arguments));
+        var r = invocation.FastInvoke();
+        if(IsAsyncMethod)
+        {
+            // delay when its an async method
+            var awaiter = invocation.GetAwaiter(r);
+            UniTask.Create(async()=>
+            {
+                try
+                {
+                    while(!invocation.IsAwaiterCompleted(awaiter))
+                        await UniTask.Yield();
+                }
+                catch {}
+                finally
+                {
+                    OnCompleted();
+                }
+            });
+            // invocation.GetAwaiter(r).OnCompleted(OnCompleted);
+        }
+        else
+        {
+            OnCompleted();
+        }
+        return r;
+    }
+```
+
+上例使用`UniTask.Create`创建了一个Timer，可以使用其他类似的方法，如自定义MonoBehaviour等。一旦`IsAwaiterCompleted`检查结束，立即执行自定义的`OnCompleted`方法。
+
+因为Unity没有官方支持的Timer功能，基于“此库只做自己该做的”原则，这里只是给出提示。