.NET 6中如何从NuGet包获取MetadataReference并实现运行时加载？

必要依赖 #

首先安装以下NuGet包：

• NuGet.Packaging
• NuGet.Frameworks
• Microsoft.CodeAnalysis.CSharp

实现代码 #

using System.IO;
using System.Linq;
using NuGet.Packaging;
using NuGet.Frameworks;
using Microsoft.CodeAnalysis;

public static MetadataReference GetMetadataReferenceFromNupkg(string nupkgPath, NuGetFramework targetFramework)
{
    using var inputStream = new FileStream(nupkgPath, FileMode.Open, FileAccess.Read);
    using var packageReader = new PackageArchiveReader(inputStream);

    // 获取包内所有lib目录下的程序集文件
    var libItems = packageReader.GetLibItems().ToList();
    
    // 匹配目标框架的程序集（优先精确匹配，无则找兼容框架）
    var matchingItems = libItems.Where(item => item.TargetFramework.IsCompatibleWith(targetFramework))
                                .OrderByDescending(item => item.TargetFramework) // 优先选择最匹配的框架
                                .FirstOrDefault();

    if (matchingItems == null || !matchingItems.Items.Any())
    {
        throw new InvalidOperationException($"未找到与{targetFramework.GetShortFolderName()}兼容的程序集");
    }

    // 取第一个程序集文件（若包内有多个，可根据需求调整逻辑）
    var assemblyEntry = matchingItems.Items.First();
    using var assemblyStream = packageReader.GetStream(assemblyEntry);

    // 创建MetadataReference
    return MetadataReference.CreateFromStream(assemblyStream);
}

// 使用示例
var targetFramework = NuGetFramework.Parse("net6.0");
var metadataRef = GetMetadataReferenceFromNupkg(@"C:\path\to\your\package.nupkg", targetFramework);

关键说明 #

• 框架匹配：使用IsCompatibleWith确保找到与当前运行环境兼容的程序集，若包内有多个框架版本，通过排序优先选择最匹配的。
• 程序集选择：示例中取第一个程序集，若包内包含多个dll（如分模块的包），可根据文件名或需求调整筛选逻辑。
• 依赖处理：如果目标包有依赖，需要递归处理依赖包的MetadataReference，否则编译时会出现缺少依赖的错误。
• 运行时加载：若需要在运行时加载程序集而非仅获取元数据，可结合Assembly.LoadFrom或AssemblyLoadContext，但需注意文件释放问题（可以先将dll提取到临时目录再加载）。

替代方案（直接提取程序集） #

如果不需要Roslyn的MetadataReference，仅需获取程序集文件，可将dll提取到本地目录：

public static void ExtractAssemblyFromNupkg(string nupkgPath, NuGetFramework targetFramework, string outputDir)
{
    using var inputStream = new FileStream(nupkgPath, FileMode.Open, FileAccess.Read);
    using var packageReader = new PackageArchiveReader(inputStream);

    var libItems = packageReader.GetLibItems().ToList();
    var matchingItems = libItems.Where(item => item.TargetFramework.IsCompatibleWith(targetFramework))
                                .OrderByDescending(item => item.TargetFramework)
                                .FirstOrDefault();

    if (matchingItems == null) return;

    Directory.CreateDirectory(outputDir);
    foreach (var item in matchingItems.Items)
    {
        var outputPath = Path.Combine(outputDir, Path.GetFileName(item));
        using var assemblyStream = packageReader.GetStream(item);
        using var outputStream = new FileStream(outputPath, FileMode.Create, FileAccess.Write);
        assemblyStream.CopyTo(outputStream);
    }
}

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