C#源生成器中Roslyn无法加载外部Core.dll的问题求助

针对你开发C#源生成器时遇到的Roslyn无法自动加载Core.dll的问题，以下是几个可行的生产级解决方案：

1. 将Core.dll嵌入到源生成器程序集 #

把Core.dll作为嵌入资源打包到源生成器的程序集中，让Roslyn无需外部查找即可加载。

• 操作步骤：
  1. 在Core.dll项目中，将输出的DLL文件设置为嵌入资源（右键文件→属性→生成操作→嵌入的资源）。
  2. 在源生成器的Initialize方法中注册AppDomain.CurrentDomain.AssemblyResolve事件，当需要加载Core.dll时，从嵌入资源中提取并加载：

     public void Initialize(IncrementalGeneratorInitializationContext context)
     {
         AppDomain.CurrentDomain.AssemblyResolve += (sender, args) =>
         {
             var assemblyName = new AssemblyName(args.Name).Name;
             if (assemblyName != "Core") return null;
     
             var resourceName = $"YourGeneratorAssemblyName.Core.dll";
             using var stream = Assembly.GetExecutingAssembly().GetManifestResourceStream(resourceName);
             if (stream == null) return null;
     
             var assemblyBytes = new byte[stream.Length];
             stream.Read(assemblyBytes, 0, assemblyBytes.Length);
             return Assembly.Load(assemblyBytes);
         };
     
         // 其他源生成器逻辑...
     }
     

• 优势：无需依赖外部文件部署，彻底解决路径查找问题；
• 劣势：会增加源生成器程序集的体积。

2. 通过NuGet包自动部署Core.dll #

将源生成器和Core.dll打包为同一个NuGet包，利用NuGet的依赖机制自动将Core.dll部署到消费者项目的正确位置。

• 操作步骤：
  1. 在源生成器项目中，对Core.dll的引用设置CopyLocal=true（右键引用→属性→复制到本地→是）。
  2. 在NuSpec文件中，确保Core.dll被包含在包的analyzers目录下：

     <files>
       <file src="bin/Release/netstandard2.0/Core.dll" target="analyzers/dotnet/cs/" />
       <file src="bin/Release/netstandard2.0/YourGenerator.dll" target="analyzers/dotnet/cs/" />
     </files>
     

  3. 发布NuGet包后，开发者安装包时，Core.dll会被自动复制到项目的.nuget/packages/yourgenerator/version/analyzers/dotnet/cs目录，Roslyn编译时会自动扫描该目录查找依赖。
• 优势：符合标准的NuGet包分发流程，开发者无需手动操作；
• 劣势：需要维护NuGet包的打包配置。

3. 在编译用户实现类时显式添加MetadataReference #

当源生成器需要编译开发者实现接口的类时，显式将Core.dll的元数据引用添加到编译上下文，确保Roslyn能找到接口定义。

• 关键代码示例：

  // 获取Core.dll的完整路径（从源生成器所在目录获取）
  var coreAssemblyPath = Path.Combine(
      Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location),
      "Core.dll");
  
  // 创建编译时添加MetadataReference
  var compilation = CSharpCompilation.Create(
      "TempCompilation",
      syntaxTrees: new[] { userImplementationSyntaxTree },
      references: new[] {
          MetadataReference.CreateFromFile(coreAssemblyPath),
          MetadataReference.CreateFromFile(typeof(object).Assembly.Location)
          // 其他必要的系统引用
      });
  

• 优势：直接针对编译上下文解决依赖问题，避免加载上下文冲突；
• 劣势：需要手动管理编译所需的所有引用，代码复杂度稍高。

4. 使用Assembly.LoadFrom指定完整路径加载 #

在源生成器中获取Core.dll的绝对路径，直接用Assembly.LoadFrom加载，绕过Roslyn的默认查找逻辑：

• 代码示例：

  // 获取源生成器程序集所在目录
  var generatorDir = Path.GetDirectoryName(Assembly.GetExecutingAssembly().Location);
  var coreDllPath = Path.Combine(generatorDir, "Core.dll");
  var coreAssembly = Assembly.LoadFrom(coreDllPath);
  
  // 后续使用coreAssembly创建实例、调用方法
  

• 注意：此方法需确保Core.dll和源生成器DLL处于同一目录（可通过NuGet打包或复制本地实现）。

为什么AssemblyResolve在调试时有效但编译时无效？ #

调试时，源生成器运行在IDE（如Visual Studio）的主进程中，AssemblyResolve事件会被IDE的AppDomain捕获；而执行dotnet build或CI编译时，源生成器运行在Roslyn的独立编译进程中，该进程的AppDomain可能未正确注册你的事件处理器，导致无法触发解析逻辑。

内容的提问来源于stack exchange，提问作者Adam Paquette