.NET 6 NuGet包读取内嵌HTML文件失败，求排查解决方法

问题根源 #

两种方法失效的核心原因都是NuGet包未正确包含目标HTML文件，或文件的嵌入/复制配置未生效：

• 嵌入资源方法：文件未被标记为嵌入资源，或资源名称拼写错误
• 输出目录复制方法：打包时未将Components文件夹及文件纳入NuGet包，导致安装后目标项目输出目录无对应文件

方法一：将HTML作为嵌入资源（推荐） #

此方式将文件嵌入程序集，不会出现文件缺失问题，是最可靠的方案。

1. 配置文件属性 #

右键Components下的每个HTML文件，设置：

• 生成操作：嵌入的资源
• 复制到输出目录：不复制

2. 确认资源名称 #

GetManifestResourceStream的参数是完整资源名称，格式为[项目根命名空间].[文件夹路径].[文件名]（比如项目命名空间为HtmlTestReporter，则资源名为HtmlTestReporter.Components.MainBody.html）。

可通过以下代码列出所有可用资源名称，避免拼写错误：

var assembly = typeof(Reporter).Assembly;
foreach (var name in assembly.GetManifestResourceNames())
{
    Console.WriteLine(name);
}

3. 修正读取代码 #

public class Reporter
{
    public string ReadComponent(string componentName)
    {
        var assembly = typeof(Reporter).Assembly;
        // 替换为你的项目根命名空间
        var resourcePath = $"HtmlTestReporter.Components.{componentName}.html";
        
        using var stream = assembly.GetManifestResourceStream(resourcePath);
        if (stream == null)
            throw new FileNotFoundException($"未找到嵌入资源: {resourcePath}");
        
        using var reader = new StreamReader(stream);
        return reader.ReadToEnd();
    }
}

4. 打包配置 #

无需额外修改.csproj，只要开启GeneratePackageOnBuild，嵌入资源会自动包含在NuGet包的程序集中：

<PropertyGroup>
    <TargetFramework>net6.0</TargetFramework>
    <GeneratePackageOnBuild>true</GeneratePackageOnBuild>
</PropertyGroup>

方法二：将HTML复制到输出目录（适合需独立访问文件的场景） #

1. 配置文件属性 #

右键HTML文件，设置：

• 生成操作：内容
• 复制到输出目录：如果较新则复制

2. 修改项目文件，确保文件被打包 #

在NuGet项目的.csproj中添加以下配置，将Components下的HTML文件标记为NuGet内容文件，安装后会自动复制到目标项目输出目录：

<ItemGroup>
    <Content Include="Components\**\*.html">
        <Pack>true</Pack>
        <PackagePath>contentFiles\any\any\Components\</PackagePath>
        <CopyToOutputDirectory>PreserveNewest</CopyToOutputDirectory>
    </Content>
</ItemGroup>

3. 修正读取代码 #

.NET 6+中推荐用AppContext.BaseDirectory替代Assembly.Location，避免单文件发布等场景下路径错误：

public class Reporter
{
    public string ReadComponent(string componentName)
    {
        var baseDir = AppContext.BaseDirectory;
        var filePath = Path.Combine(baseDir, "Components", $"{componentName}.html");
        
        if (!File.Exists(filePath))
            throw new FileNotFoundException($"未找到文件: {filePath}");
        
        return File.ReadAllText(filePath);
    }
}

验证步骤 #

1. 重新生成NuGet包，可通过7-Zip打开.nupkg文件，确认嵌入资源/内容文件已包含
2. 卸载测试项目中的旧包，清理输出目录后重新安装新包
3. 运行测试项目验证读取逻辑

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