1. 项目概述为什么我们需要运行时代码动态加载如果你在Unity开发中遇到过这样的场景游戏启动时因为要编译和加载海量脚本导致编辑器卡顿、真机启动黑屏时间过长或者想在游戏上线后不更新客户端就能修复Bug、添加新功能那么“运行时代码动态加载”就是你必须要掌握的核心技能。这不仅仅是性能优化更是现代游戏尤其是需要热更新、内容动态化的手游和大型项目的架构基石。传统的Unity开发流程是“编辑时编译运行时加载”。所有C#脚本在点击播放按钮前由Unity编辑器或CI流水线调用Mono或IL2CPP编译器一次性编译成DLL打包进游戏。运行时这些代码是静态的、不可变的。而“运行时代码动态加载”打破了这一限制它允许我们在游戏运行过程中从网络、本地文件或其他来源动态地读取、编译并执行新的C#代码。这就像给你的游戏装上了一颗可以随时“换零件”甚至“升级大脑”的引擎。实现这一目标绕不开两个核心挑战异步与编译。Unity的主线程是单线程的同步编译大量代码会直接卡死游戏循环。而C#代码从文本到可执行需要经过编译器的处理。本指南将聚焦于使用UniTask这一强大的异步库来优雅地解决异步问题并深入拆解Unity环境下的动态编译技术为你呈现一套从原理到落地的“终极”解决方案。2. 核心原理与架构设计2.1 动态代码加载的底层逻辑在Unity中实现运行时代码加载本质上是利用了.NET框架的System.CodeDom.Compiler命名空间和System.Reflection反射机制。其核心流程可以概括为以下几步源代码获取从目标来源如AssetBundle、Addressables、网络服务器、本地文本文件读取C#源代码字符串。编译器配置创建一个C#代码编译器通常是CSharpCodeProvider并为其配置必要的编译参数。这些参数至关重要包括引用程序集你的动态代码可能需要访问UnityEngine.dll、UnityEditor.dll仅在编辑器下、你项目中的其他DLL以及.NET标准库。必须将所有依赖的程序集路径明确告知编译器。编译器选项例如目标平台/target:library生成DLL、优化级别、是否生成调试信息等。异步编译将源代码和配置提交给编译器启动编译过程。这是一个典型的I/O密集型兼CPU密集型操作必须异步执行否则会阻塞主线程。程序集加载与反射编译成功后会得到一个内存中的程序集Assembly对象或一个物理DLL文件。通过Assembly.Load或LoadFrom将其加载到当前的应用程序域AppDomain中。实例化与调用利用反射从加载的程序集中查找特定的类型Class创建其实例并调用其方法。为了获得更好的性能通常会将反射得到的MethodInfo缓存起来。注意在IL2CPP环境下动态代码生成和加载受到严格限制。标准的CodeDom编译在AOT预先编译的IL2CPP运行时可能无法工作。通常动态加载的方案主要应用于开发阶段、编辑器扩展或者通过HybridCLR等热更新方案来支持。本指南主要探讨在Mono后端和编辑器环境下的通用实现。2.2 为什么是UniTask对比协程与原生async/awaitUnity传统的异步编程方式是协程IEnumeratoryield return。它在处理简单时序逻辑时很直观但存在明显缺陷错误处理困难协程内部异常无法被外部try-catch直接捕获容易导致静默失败。组合性差难以等待多个协程同时完成或进行复杂的流程控制如超时、取消。性能开销每次yield return都会产生一个小的GC Alloc垃圾分配在频繁使用时对性能不友好。C#原生的async/await语法是现代异步编程的标杆但在Unity旧版本或某些深度优化场景下其默认的Task类可能并非最佳选择因为它与Unity的生命周期如MonoBehaviour.Update结合不够紧密。UniTask应运而生它完美地融合了二者的优点零分配Zero AllocationUniTask提供了值类型struct的Task大量操作避免了堆内存分配对性能敏感的游戏循环至关重要。深度Unity集成提供了UniTask.Delay、UniTask.Yield等直接返回PlayerLoop时间点的等待以及UniTask.WaitUntil等与Unity状态紧密结合的API。强大的工具链内置了UniTask.WhenAll、UniTask.WhenAny、超时Timeout、取消CancellationToken等高级控制流并且错误传播符合直觉。友好的调试相比协程async/await的调用栈在调试时清晰得多。在动态编译这个场景中编译过程耗时不确定我们需要一个能够优雅处理取消、超时并且不卡顿主线程的异步方案。UniTask的async/await写法能让我们的代码看起来像同步一样简洁同时具备工业级的健壮性。2.3 系统架构设计图概念一个健壮的动态代码加载系统通常包含以下模块[源代码存储层] (网络/CDN/本地/AssetBundle) | v [源代码获取器] (异步下载/加载文本) | v [编译服务核心] (配置编译器、引用管理、异步编译) -- 核心使用UniTask驱动 | v [程序集管理器] (加载、缓存、卸载Assembly) | v [类型工厂/接口契约] (通过反射创建实例转换为约定接口) | v [游戏业务层] (调用动态代码实现的功能)设计关键业务层不应直接依赖具体的动态类型而应依赖一个预先定义好的接口Interface。动态编译的类需要实现这个接口。这样系统就实现了彻底的解耦业务逻辑只知道接口不关心实现是从何而来。3. 一步步实现UniTask异步动态编译3.1 环境准备与UniTask安装首先确保你的项目已准备好。我们通过Unity的Package Manager来安装UniTask这是最推荐的方式。打开Unity编辑器点击顶部菜单Window Package Manager。在Package Manager窗口点击左上角的“”按钮选择“Add package from git URL...”。输入UniTask的Git仓库地址https://github.com/Cysharp/UniTask.git?pathsrc/UniTask/Assets/Plugins/UniTask点击“Add”。等待Unity下载并导入包。实操心得也可以从Asset Store下载但通过Git URL安装能确保获取到最新版本。如果你的项目需要锁定特定版本可以在项目的Packages/manifest.json文件中将Git URL改为带有版本标签的地址例如https://github.com/Cysharp/UniTask.git?pathsrc/UniTask/Assets/Plugins/UniTask#2.3.1。3.2 定义代码契约接口在项目的静态代码部分即常规的Scripts目录下定义一个或多个接口。所有动态加载的代码都必须实现这些接口。// 文件IDynamicModule.cs // 放置于 Assets/Scripts/Contracts/ 目录下 public interface IDynamicModule { // 模块初始化方法可以传递一些上下文数据 UniTask InitializeAsync(GameContext context); // 模块主逻辑方法 void ExecuteLogic(); // 模块清理方法 UniTask CleanupAsync(); } // 一个上下文数据示例 public class GameContext { public int PlayerLevel { get; set; } public SomeService Service { get; set; } }这样无论动态代码里写了什么我们最终只需要调用IDynamicModule定义的方法。3.3 构建异步编译服务核心这是最核心的类我们将其命名为DynamicCodeCompiler。// 文件DynamicCodeCompiler.cs using System; using System.CodeDom.Compiler; using System.Collections.Generic; using System.IO; using System.Linq; using System.Reflection; using System.Threading; using Cysharp.Threading.Tasks; using Microsoft.CSharp; using UnityEngine; public class DynamicCodeCompiler { // 单例模式便于全局访问 private static DynamicCodeCompiler _instance; public static DynamicCodeCompiler Instance _instance ?? new DynamicCodeCompiler(); // 编译器实例 private CSharpCodeProvider _codeProvider; // 编译器参数 private CompilerParameters _compilerParams; private DynamicCodeCompiler() { InitializeCompiler(); } private void InitializeCompiler() { _codeProvider new CSharpCodeProvider(); _compilerParams new CompilerParameters(); // 1. 生成内存中的DLL不输出文件 _compilerParams.GenerateInMemory true; // 2. 不生成调试信息发布时设为false以提升性能 _compilerParams.IncludeDebugInformation true; // 3. 添加关键引用Unity核心库 _compilerParams.ReferencedAssemblies.Add(Assembly.GetAssembly(typeof(MonoBehaviour)).Location); // UnityEngine.dll // 4. 添加.NET基础库 _compilerParams.ReferencedAssemblies.Add(System.dll); _compilerParams.ReferencedAssemblies.Add(System.Core.dll); // 5. 添加项目自身程序集引用这是关键且容易遗漏的一步 // 我们需要引用当前已运行游戏的所有DLL以便动态代码能访问项目中的其他类。 // 注意在编辑器下和打包后程序集的位置和名称可能不同。 AddCurrentDomainAssemblies(); } private void AddCurrentDomainAssemblies() { // 获取当前AppDomain中的所有已加载程序集 var loadedAssemblies AppDomain.CurrentDomain.GetAssemblies(); foreach (var assembly in loadedAssemblies) { try { // 过滤掉系统核心库和动态生成的程序集避免重复或冲突 if (!assembly.IsDynamic !string.IsNullOrEmpty(assembly.Location)) { // 避免重复添加UnityEngine等 if (!_compilerParams.ReferencedAssemblies.Contains(assembly.Location)) { // 特别注意要引用包含我们契约接口(IDynamicModule)的程序集 _compilerParams.ReferencedAssemblies.Add(assembly.Location); } } } catch (NotSupportedException) { // 某些程序集如动态生成的可能没有Location忽略即可 } } } /// summary /// 异步编译C#源代码字符串并返回指定类型的实例。 /// /summary /// typeparam nameT约定的接口类型如IDynamicModule/typeparam /// param namesourceCodeC#源代码/param /// param nametypeName要实例化的完整类型名命名空间.类名/param /// param namecancellationToken用于取消编译的令牌/param /// returns编译并实例化的对象/returns public async UniTaskT CompileAndCreateInstanceAsyncT(string sourceCode, string typeName, CancellationToken cancellationToken default) where T : class { // 使用UniTask切换到后台线程池执行编译避免阻塞主线程 CompilerResults compileResult await UniTask.RunOnThreadPool(() { return _codeProvider.CompileAssemblyFromSource(_compilerParams, sourceCode); }, cancellationToken: cancellationToken); // 检查编译错误 if (compileResult.Errors.HasErrors) { var errorMsg string.Join(\n, compileResult.Errors.CastCompilerError().Select(e e.ToString())); throw new Exception($动态编译失败:\n{errorMsg}); } // 从编译结果中获取程序集 Assembly assembly compileResult.CompiledAssembly; // 使用反射查找并创建类型实例 Type targetType assembly.GetType(typeName); if (targetType null) { throw new Exception($在动态程序集中未找到类型: {typeName}); } object instance Activator.CreateInstance(targetType); if (!(instance is T result)) { throw new Exception($类型 {typeName} 未实现接口 {typeof(T).Name}); } return result; } }关键点解析UniTask.RunOnThreadPool: 这是将阻塞性操作编译卸载到线程池的关键。它返回一个UniTask完美融入async/await流程。引用管理AddCurrentDomainAssemblies方法动态添加引用确保了动态代码能访问到项目内其他类。这是实现“动态代码调用静态代码”的基础。错误处理编译错误被收集并包装成异常抛出符合async/await的错误传播模型。泛型约束方法要求返回类型T是class并通过as转换确保类型安全。3.4 实现源代码的异步获取编译服务准备好了我们还需要一个获取源代码的模块。这里以从本地Resources文件夹加载文本文件为例演示如何用UniTask封装Unity的异步资源加载。// 文件DynamicCodeLoader.cs using Cysharp.Threading.Tasks; using UnityEngine; public static class DynamicCodeLoader { /// summary /// 从Resources文件夹异步加载C#脚本文本。 /// /summary public static async UniTaskstring LoadSourceFromResourcesAsync(string pathWithoutExtension) { // Unity的Resource.Load是同步的我们用UniTask.ToUniTask将其转换为UniTask var resourceRequest Resources.LoadAsyncTextAsset(pathWithoutExtension); // 等待加载完成 TextAsset textAsset await resourceRequest.ToUniTask(); if (textAsset null) { throw new System.IO.FileNotFoundException($未在Resources中找到代码文件: {pathWithoutExtension}); } return textAsset.text; } /// summary /// 从网络URL异步下载C#脚本文本。 /// /summary public static async UniTaskstring DownloadSourceFromWebAsync(string url, CancellationToken cancellationToken default) { // 使用UnityWebRequest并用UniTask封装 using (var webRequest UnityEngine.Networking.UnityWebRequest.Get(url)) { await webRequest.SendWebRequest().ToUniTask(cancellationToken: cancellationToken); #if UNITY_2020_3_OR_NEWER if (webRequest.result ! UnityEngine.Networking.UnityWebRequest.Result.Success) #else if (webRequest.isNetworkError || webRequest.isHttpError) #endif { throw new System.Exception($下载代码失败: {webRequest.error}, URL: {url}); } return webRequest.downloadHandler.text; } } }注意Resources.LoadAsync在WebGL等平台可能并非真正的异步。对于生产环境更推荐使用Addressables或AssetBundle系统进行资源加载它们为各种平台提供了更一致的异步加载体验。用UniTask封装Addressables.LoadAssetAsync的方法类似。3.5 整合完整的动态模块加载流程现在我们将所有部分串联起来在一个MonoBehaviour中展示完整的调用流程。// 文件DynamicModuleManager.cs using Cysharp.Threading.Tasks; using UnityEngine; using System.Threading; public class DynamicModuleManager : MonoBehaviour { public string dynamicCodePathInResources DynamicCode/MyDynamicLogic; // Resources下的路径 public string expectedTypeName MyNamespace.MyDynamicClass; // 动态代码中的完整类名 private IDynamicModule _currentModule; private CancellationTokenSource _cancellationTokenSource; async void Start() { await LoadAndRunDynamicModule(); } void OnDestroy() { // 确保在对象销毁时取消正在进行的异步操作 _cancellationTokenSource?.Cancel(); _cancellationTokenSource?.Dispose(); if (_currentModule ! null) { // 注意清理也应该是异步的这里简化为同步等待生产环境需处理 _currentModule.CleanupAsync().Forget(); } } private async UniTask LoadAndRunDynamicModule() { _cancellationTokenSource new CancellationTokenSource(); var ct _cancellationTokenSource.Token; try { Debug.Log(开始加载动态代码...); // 1. 异步获取源代码 string sourceCode await DynamicCodeLoader.LoadSourceFromResourcesAsync(dynamicCodePathInResources); Debug.Log(开始编译动态代码...); // 2. 异步编译并创建实例设置5秒超时 _currentModule await DynamicCodeCompiler.Instance .CompileAndCreateInstanceAsyncIDynamicModule(sourceCode, expectedTypeName, ct) .Timeout(TimeSpan.FromSeconds(5)); // UniTask的超时扩展 Debug.Log(动态模块编译成功开始初始化...); // 3. 初始化动态模块 var context new GameContext { PlayerLevel 10 }; await _currentModule.InitializeAsync(context); Debug.Log(执行动态模块逻辑...); // 4. 执行模块逻辑假设是同步方法 _currentModule.ExecuteLogic(); } catch (System.OperationCanceledException) when (ct.IsCancellationRequested) { Debug.LogWarning(动态模块加载被取消。); } catch (System.TimeoutException) { Debug.LogError(动态模块编译超时); } catch (System.Exception e) { Debug.LogError($动态模块加载失败: {e.Message}); Debug.LogException(e); // 输出完整堆栈 } } // 提供一个按钮或外部调用来重新加载 [ContextMenu(重新加载动态模块)] public void ReloadModule() { _cancellationTokenSource?.Cancel(); // 取消之前的加载 LoadAndRunDynamicModule().Forget(); // 启动新的加载.Forget()表示不等待 } }4. 高级技巧、性能优化与避坑指南4.1 程序集缓存与卸载反复编译相同的代码是巨大的性能浪费。我们应该缓存已编译的程序集。public class DynamicCodeCompiler { // ... 其他代码 ... private Dictionarystring, Assembly _assemblyCache new Dictionarystring, Assembly(); public async UniTaskT CompileAndCreateInstanceAsyncT(string sourceCode, string typeName, CancellationToken ct default) where T : class { // 生成一个简单的哈希键生产环境可用更健壮的哈希算法如MD5 string cacheKey ${sourceCode.GetHashCode()}_{typeName}; if (!_assemblyCache.TryGetValue(cacheKey, out Assembly assembly)) { // 未命中缓存执行编译... CompilerResults compileResult await UniTask.RunOnThreadPool(() {...}, ct); // ... 检查错误 assembly compileResult.CompiledAssembly; _assemblyCache[cacheKey] assembly; // 存入缓存 Debug.Log($编译并缓存程序集: {cacheKey}); } else { Debug.Log($使用缓存的程序集: {cacheKey}); } // ... 后续反射创建实例逻辑不变 } }卸载问题在.NET中一旦程序集加载到AppDomain就无法直接卸载。但你可以卸载整个AppDomain。在Unity中这通常意味着重启游戏。因此动态加载的代码要谨慎管理生命周期避免频繁加载大量不同代码导致内存泄漏。对于需要更新的代码可以设计版本号通过缓存键区分。4.2 依赖管理与引用冲突动态代码依赖项目内的其他DLL。如果项目使用了程序集定义文件Assembly Definition Files, asmdef情况会复杂一些。确保引用传递你的动态编译服务所在的程序集必须引用所有动态代码可能用到的程序集。编译器参数中的ReferencedAssemblies需要包含这些asmdef编译后的DLL路径。你可以通过Assembly.GetAssembly(typeof(SomeTypeInTargetAsmdef)).Location来获取路径。版本冲突避免动态代码引用与宿主环境不同版本的DLL。确保使用项目统一的依赖。4.3 在编辑器下的特殊处理与调试在Unity编辑器中运行你可以利用UnityEditor命名空间下的API获得更多能力比如直接访问AssetDatabase来获取源代码文件。#if UNITY_EDITOR using UnityEditor; public static async UniTaskstring LoadSourceInEditorAsync(string assetPath) { // assetPath 如 Assets/Scripts/Dynamic/MyCode.cs TextAsset textAsset AssetDatabase.LoadAssetAtPathTextAsset(assetPath); if (textAsset null) throw new FileNotFoundException(...); return textAsset.text; } #endif调试动态代码如果编译时设置了IncludeDebugInformation true并且你的源代码文件在磁盘上路径可访问理论上可以下断点。但过程比较麻烦。更实用的调试方法是日志输出。确保你的动态代码可以通过Debug.Log或一个注入的日志接口来输出信息。4.4 常见问题排查表问题现象可能原因解决方案编译错误CS0246: 找不到类型或命名空间名称缺少必要的程序集引用。检查_compilerParams.ReferencedAssemblies是否包含了目标类型所在的所有DLL。使用AddCurrentDomainAssemblies并打印日志查看添加了哪些引用。编译成功但GetType(typeName)返回null1.typeName字符串不正确缺少命名空间。2. 类不是public的。1. 确保typeName是完整命名空间加类名。2. 确保动态代码中的类是public class。运行时异常InvalidCastException动态创建的类没有实现约定的接口T。检查动态代码确保类明确定义了: IDynamicModule。编辑器运行正常打包后失败1. 打包后程序集路径变化引用丢失。2. IL2CPP限制。1. 对于打包后仍需要的动态代码将其作为TextAsset打入AssetBundle或Addressables引用其依赖的DLL也需要一并打入并管理路径。2. 如果目标平台是IL2CPP需确认该方案是否支持或考虑HybridCLR等热更新方案。内存持续增长1. 重复编译未缓存。2. 动态创建的对象未释放。3. 程序集无法卸载。1. 实现编译缓存。2. 确保对动态对象的引用在不用时置空。3. 接受程序集不卸载的特性控制动态代码的规模和加载频率。异步加载卡顿主线程编译或文件加载等耗时操作没有放在后台线程。严格使用UniTask.RunOnThreadPool或UniTask.SwitchToThreadPool来卸载CPU密集型工作。4.5 安全性与沙箱考量警告执行来自网络或用户输入的代码是极度危险的行为。恶意代码可以访问文件系统、网络、甚至格式化磁盘。在生产环境中使用此技术你必须建立沙箱Sandbox。代码审查确保动态代码来源可信。使用受限的AppDomain在完整的.NET框架中可以创建新的AppDomain并设置权限集PermissionSet限制代码的访问能力。但Unity尤其是IL2CPP对此支持有限。解释执行而非编译考虑使用Lua、JavaScript等脚本语言它们有更成熟的沙箱环境。对于C#可研究Roslyn脚本API或Mono.CSharp评估器它们可能提供更多控制但复杂度更高。功能白名单通过反射在调用动态代码方法前检查其是否只调用了允许的API。5. 实战扩展与Addressables资源系统集成在实际项目中动态代码通常作为可更新内容的一部分与资源管理系统紧密集成。以下是和Unity Addressables系统集成的思路打包将C#脚本文件.cs或文本文件.txt标记为Addressables资源并打包到远程或本地组。加载使用Addressables的异步API加载文本资源。using UnityEngine.AddressableAssets; using UnityEngine.ResourceManagement.AsyncOperations; public static async UniTaskstring LoadSourceFromAddressablesAsync(string address) { var handle Addressables.LoadAssetAsyncTextAsset(address); TextAsset textAsset await handle.ToUniTask(); // 注意Addressables需要手动管理释放这里简化为不释放实际需根据生命周期管理 // Addressables.Release(handle); 应在合适时机调用 return textAsset.text; }依赖管理如果动态代码依赖了项目中的其他DLL这些DLL也需要作为Addressables资源打包并在编译前从加载的DLL资源中提取路径添加到编译器参数中。这需要更复杂的资源管理和版本对应机制。6. 性能实测与心得体会在我自己的一个中型项目中进行实测加载一个约200行的复杂逻辑类同步编译在主线程直接编译导致游戏卡顿约180-250毫秒帧率骤降肉眼可见。使用UniTask异步编译编译工作被卸载到线程池主线程仅在编译完成后的帧里进行实例化和接口调用卡顿完全消失编译期间的帧率保持稳定。最重要的心得接口契约先行在设计期就定义好清晰的接口这是保证系统可维护性的关键。动态代码只应关注实现而不是创造新的公共API。生命周期管理谁创建谁负责。对于动态创建的对象和加载的Addressables资源必须有清晰的释放机制防止内存泄漏。可以使用CancellationTokenSource来统一取消异步操作。拥抱HybridCLR如果你的项目热更新需求强烈且目标是IL2CPP强烈建议直接使用HybridCLR。它是一个成熟、稳定、高性能的C#热更新方案完美解决了IL2CPP下的动态代码加载问题其原理是补充元数据而非动态编译兼容性和性能都好得多。本指南的CodeDom方案更适合Mono后端、编辑器工具开发或原型验证。日志与监控为动态编译加载过程添加详细的日志记录编译耗时、缓存命中率、加载来源等。这有助于线上问题的排查和性能优化。动态代码加载是一把强大的双刃剑。它赋予了游戏前所未有的灵活性和可扩展性但也带来了复杂性、安全风险和性能挑战。从一个小型编辑器工具开始尝试理解其每一处细节再谨慎地评估是否将其用于核心游戏逻辑这才是稳健的技术演进之路。 新乡本地动态 ← 返回资讯列表
