如何用Roslyn将.NET 6.0代码编译为单一可执行文件

问题原因 #

你用Roslyn编译的代码仅生成了框架依赖的可执行文件，但没有生成.NET 6运行时必需的配置文件（.runtimeconfig.json、.deps.json），也未打包核心运行时组件。而Visual Studio编译时会自动生成这些配置文件，若选择单文件发布还会将所有依赖打包进exe，因此VS生成的文件可正常运行。

解决方法 #

1. 让框架依赖的exe正常运行 #

若不需要单文件，仅需确保程序在装有.NET 6运行时的机器上运行，需补充生成运行时配置文件：

var syntaxTree = CSharpSyntaxTree.ParseText(source);

var compilation = CSharpCompilation.Create("program.exe")
    .WithOptions(new CSharpCompilationOptions(OutputKind.ConsoleApplication))
    .AddReferences(Net60.References.All)
    .AddSyntaxTrees(syntaxTree);

EmitResult emitResult = compilation.Emit(Path.Combine(path, "program.exe"));

if (emitResult.Success)
{
    // 生成runtimeconfig.json，指定依赖的.NET框架版本
    var runtimeConfig = @"{
        ""runtimeOptions"": {
            ""tfm"": ""net6.0"",
            ""framework"": {
                ""name"": ""Microsoft.NETCore.App"",
                ""version"": ""6.0.0""
            }
        }
    }";
    File.WriteAllText(Path.Combine(path, "program.runtimeconfig.json"), runtimeConfig);
    
    MessageBox.Show("编译完成。");
}
else
{
    MessageBox.Show($"编译遇到 {emitResult.Diagnostics.Length} 个错误", "编译错误");
    foreach (var diagnostic in emitResult.Diagnostics)
    {
        MessageBox.Show($"{diagnostic.GetMessage()}\n行: {diagnostic.Location.GetLineSpan().StartLinePosition.Line} - 列: {diagnostic.Location.GetLineSpan().StartLinePosition.Character}", "错误");
    }
}

此方式要求目标机器已安装.NET 6桌面运行时。

2. 编译为单一独立exe（自包含模式） #

Roslyn本身仅负责编译代码，单文件打包是.NET SDK的发布功能，因此需借助MSBuild完成自包含发布，将所有运行时依赖打包进单个exe：

var source = @"using System;

namespace test
{
    internal static class Program
    {
        static void Main()
        {
            Console.WriteLine(""Test"");
            Console.ReadKey(true);
        }
    }
}";

var targetPath = path; // 你的输出目录
var runtimeIdentifier = "win-x64"; // 根据目标平台选择，如win-x86、linux-x64等

// 创建临时项目文件
var tempProjPath = Path.Combine(Path.GetTempPath(), "temp_singlefile.csproj");
var projContent = $@"<Project Sdk=""Microsoft.NET.Sdk"">
  <PropertyGroup>
    <OutputType>Exe</OutputType>
    <TargetFramework>net6.0</TargetFramework>
    <RuntimeIdentifier>{runtimeIdentifier}</RuntimeIdentifier>
    <PublishSingleFile>true</PublishSingleFile>
    <SelfContained>true</SelfContained>
    <PublishDir>{targetPath}</PublishDir>
    <AssemblyName>program</AssemblyName>
    <DebugType>None</DebugType> <!-- 可选，移除调试信息减小体积 -->
  </PropertyGroup>
</Project>";
File.WriteAllText(tempProjPath, projContent);

// 创建临时源码文件
var tempCsPath = Path.Combine(Path.GetTempPath(), "Program.cs");
File.WriteAllText(tempCsPath, source);

// 调用MSBuild执行发布
var msbuildPath = string.Empty;
// 优先从.NET SDK目录获取MSBuild
var dotNetSdkPath = Path.Combine(RuntimeEnvironment.GetRuntimeDirectory(), "..", "..", "MSBuild", "Current", "Bin", "MSBuild.exe");
if (File.Exists(dotNetSdkPath))
{
    msbuildPath = dotNetSdkPath;
}
else
{
    // fallback到Visual Studio安装目录的MSBuild
    msbuildPath = @"C:\Program Files\Microsoft Visual Studio\2022\Community\MSBuild\Current\Bin\MSBuild.exe";
}

var processStartInfo = new ProcessStartInfo
{
    FileName = msbuildPath,
    Arguments = $"{tempProjPath} /t:Publish /p:Configuration=Release",
    UseShellExecute = false,
    RedirectStandardError = true,
    CreateNoWindow = true
};

using var process = Process.Start(processStartInfo);
process.WaitForExit();

if (process.ExitCode == 0)
{
    MessageBox.Show("单文件exe编译发布完成。");
}
else
{
    var errorMsg = process.StandardError.ReadToEnd();
    MessageBox.Show($"发布失败：\n{errorMsg}", "发布错误");
}

// 清理临时文件
File.Delete(tempProjPath);
File.Delete(tempCsPath);

关键说明 #

• 自包含模式会将.NET 6运行时和所有依赖打包进exe，无需目标机器安装.NET运行时，但exe体积会较大。
• 可根据需求调整RuntimeIdentifier适配不同平台，或开启PublishTrimmed=true修剪未使用的代码以减小体积（需注意可能导致反射相关功能异常）。

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