通过传入C#代码字符串（Code）动态生成一个自定义的DLL文件

最新推荐文章于 2026-02-13 01:02:44 发布

原创最新推荐文章于 2026-02-13 01:02:44 发布 · 916 阅读

15 ·

本内容遵循CC 4.0 BY-SA版权协议

标签

#c# #开发语言

C#实战教程专栏收录该内容

1256 篇文章

订阅专栏

通过传入C#代码字符串（Code）动态生成一个自定义的DLL文件。以下是实现这一需求的详细步骤和代码示例，使用C#的Microsoft.CodeAnalysis.CSharp库（Roslyn）来动态编译代码并生成DLL文件。

实现步骤

1. 创建一个控制台项目用于动态编译

使用一个C#控制台应用程序来接收Code字符串，动态编译为DLL。
需要引用Microsoft.CodeAnalysis.CSharp NuGet包来解析和编译C#代码。

2. 安装必要的NuGet包

在你的项目中添加以下NuGet包：

bash

dotnet add package Microsoft.CodeAnalysis.CSharp

3. 代码实现

以下是一个完整的C#程序，用于接收代码字符串，生成自定义DLL文件，并支持一些基本规则（如自定义命名空间、输出路径等）。

csharp

using Microsoft.CodeAnalysis;
using Microsoft.CodeAnalysis.CSharp;
using System;
using System.IO;
using System.Linq;

namespace DynamicDllGenerator
{
    class Program
    {
        static void Main(string[] args)
        {
            // 示例输入代码
            string code = @"
                namespace CustomNamespace
                {
                    public class CustomClass
                    {
                        public int Add(int a, int b)
                        {
                            return a + b;
                        }

                        public string GetMessage()
                        {
                            return ""Hello from Custom DLL!"";
                        }
                    }
                }";

            // 生成DLL的配置
            string dllName = "CustomLibrary.dll"; // 自定义DLL文件名
            string outputPath = Path.Combine(Directory.GetCurrentDirectory(), "output"); // 输出目录
            string namespaceName = "CustomNamespace"; // 命名空间（可选，用于验证）

            // 调用生成DLL的方法
            bool success = GenerateDll(code, dllName, outputPath, namespaceName);

            if (success)
                Console.WriteLine($"DLL generated successfully at: {Path.Combine(outputPath, dllName)}");
            else
                Console.WriteLine("Failed to generate DLL.");
        }

        static bool GenerateDll(string code, string dllName, string outputPath, string namespaceName)
        {
            try
            {
                // 确保输出目录存在
                Directory.CreateDirectory(outputPath);

                // 解析代码为语法树
                SyntaxTree syntaxTree = CSharpSyntaxTree.ParseText(code);

                // 定义元数据引用（添加必要的引用，如System）
                string[] defaultReferences = new[]
                {
                    MetadataReference.CreateFromFile(typeof(object).Assembly.Location),
                    MetadataReference.CreateFromFile(typeof(Console).Assembly.Location)
                };

                // 创建编译选项
                var compilationOptions = new CSharpCompilationOptions(
                    outputKind: OutputKind.DynamicallyLinkedLibrary, // 输出为DLL
                    optimizationLevel: OptimizationLevel.Release // 优化级别
                );

                // 创建编译对象
                var compilation = CSharpCompilation.Create(
                    assemblyName: Path.GetFileNameWithoutExtension(dllName),
                    syntaxTrees: new[] { syntaxTree },
                    references: defaultReferences,
                    options: compilationOptions);

                // 输出DLL文件路径
                string dllPath = Path.Combine(outputPath, dllName);

                // 编译并生成DLL
                using (var dllStream = new FileStream(dllPath, FileMode.Create))
                {
                    var emitResult = compilation.Emit(dllStream);

                    if (!emitResult.Success)
                    {
                        // 输出编译错误
                        var errors = emitResult.Diagnostics
                            .Where(d => d.Severity == DiagnosticSeverity.Error)
                            .Select(d => d.GetMessage());
                        Console.WriteLine("Compilation errors:");
                        foreach (var error in errors)
                        {
                            Console.WriteLine(error);
                        }
                        return false;
                    }
                }

                return true;
            }
            catch (Exception ex)
            {
                Console.WriteLine($"Error generating DLL: {ex.Message}");
                return false;
            }
        }
    }
}

4. 代码说明

输入参数：
- code：C#代码字符串，定义了DLL的内容（如类、方法等）。
- dllName：生成的DLL文件名（如CustomLibrary.dll）。
- outputPath：DLL文件的输出目录。
- namespaceName：可选，用于验证代码是否符合特定命名空间规则。
功能：
- 使用Roslyn解析C#代码，生成语法树。
- 配置编译选项，指定输出为DLL。
- 添加必要的引用（如System）。
- 编译代码并输出到指定路径。
- 处理编译错误并返回结果。
规则支持：
- 你可以扩展代码以支持更多规则，例如：
  - 验证code是否包含特定命名空间。
  - 设置DLL版本号（通过AssemblyVersion属性）。
  - 添加强命名（通过密钥文件）。

5. 使用示例

假设你想生成一个DLL，包含一个计算器类：

运行上述程序，传入以下code：

csharp

namespace CustomNamespace
{
    public class CustomClass
    {
        public int Add(int a, int b)
        {
            return a + b;
        }

        public string GetMessage()
        {
            return "Hello from Custom DLL!";
        }
    }
}

指定输出：
- dllName：CustomLibrary.dll
- outputPath：./output
运行程序后，output/CustomLibrary.dll将被生成。

6. 测试生成的DLL

创建一个新的控制台项目，引用生成的DLL：

csharp

using CustomNamespace;

class Program
{
    static void Main()
    {
        var instance = new CustomClass();
        Console.WriteLine(instance.Add(5, 3)); // 输出 8
        Console.WriteLine(instance.GetMessage()); // 输出 Hello from Custom DLL!
    }
}

将CustomLibrary.dll添加到项目引用（在Visual Studio中右键项目 > 添加引用）。
确保DLL的依赖（如System）已正确解析。

7. 扩展规则

如果你有特定规则，请提供更多细节，我可以帮你实现。例如：

命名空间校验：

csharp

if (!code.Contains($"namespace {namespaceName}"))
{
    Console.WriteLine($"Code must contain namespace {namespaceName}");
    return false;
}

添加元数据：修改compilationOptions以包含版本信息：

csharp

compilationOptions = compilationOptions.WithMetadataImportOptions(MetadataImportOptions.All)
    .WithAssemblyIdentityComparer(DesktopAssemblyIdentityComparer.Default);

强命名：生成密钥文件并签名：

bash

sn -k MyKey.snk

在代码中添加：

csharp

compilationOptions = compilationOptions.WithCryptoKeyFile("MyKey.snk");

8. 注意事项

依赖管理：如果code中使用外部库（如Newtonsoft.Json），需添加对应的元数据引用：

csharp
```
MetadataReference.CreateFromFile("path/to/Newtonsoft.Json.dll")
```
错误处理：确保捕获所有可能的编译错误，并提供清晰的反馈。
性能：对于大型代码字符串，解析和编译可能需要时间，建议异步操作：

csharp
```
async Task<bool> GenerateDllAsync(...) { ... }
```

9. 运行环境

确保安装了.NET SDK（推荐.NET 8.0或更高版本）。
项目需引用Microsoft.CodeAnalysis.CSharp（版本根据你的.NET版本选择）。

10. 自动化脚本

如果你想通过命令行调用：

bash

dotnet run --project DynamicDllGenerator.csproj

可以将code、 dllName、 outputPath作为命令行参数传入：

csharp

string code = args[0];
string dllName = args[1];
string outputPath = args[2];

总结

上述代码提供了一个通用的解决方案，用于根据传入的C#代码字符串动态生成DLL文件。如果你有具体的规则（例如命名空间要求、特定方法签名、版本控制等），请提供更多细节，我可以进一步优化代码或添加额外功能！