为什么 NuGet 在 NuGet 包更新期间将带有 assemblyBinding 的 app.config 添加到 LIBRARY 项目？

Question

难道这些信息仅在可执行文件的项目中是必需的吗？

如何禁用此文件创建？

NuGet 2.8

编辑

库项目在 NuGet 2.7 中是例外，通过修复此问题在 2.8 中更改了行为：http://nuget.codeplex.com/workitem/3827 提交：https://github.com/NuGet/NuGet2/commit/448652d028e3f01ba4022e147baaf4e1fb3f969b

Answer 1

NuGet 包管理器将程序集绑定重定向添加到库项目的原因是，有些项目类型的输出类型是库，但有一些特殊机制可以确保库的应用程序或 Web 配置文件将在运行时应用。这与您可能熟悉的更典型的库用法相反，其中根本不使用库的配置文件。

例如，Azure SDK 1.8+ 中的 Azure Web 和 Worker 角色项目将生成库，但是当它们被 IIS 包装在 exe 中时，库的配置文件将被设置为默认那个exe。这样，您无需显式发布与包装可执行文件which is how it used to be done 同名的特殊配置文件即可获得所有应用程序配置。现在构建过程输出重命名的配置文件（例如 app.config -> myWebRoleLibrary.dll.config），一切正常。

XUnit also does something similar;加载测试程序集的 app.config 而不是测试运行进程的应用配置。

值得一提的是，你也可以manually load a config file in any project，图书馆与否。您必须确保配置文件最终位于正确的位置，但这是可能的。但是，这不太适用于绑定重定向，因为这些重定向通常仅由 CLR 中的程序集加载器使用。我想你可以勾搭 AssemblyLoad，但现在我们正在努力重新发明轮子。

那么，“在我的图书馆项目中是否有必要”的答案？是也许。如果您的库项目不是 Web 或辅助角色或测试项目，并且它没有手动加载配置文件，那么 app.config 可能是良性的，但没有必要。

至于禁用它，您只能在 Visual Studio 级别执行此操作。您可以在 VS2019 中找到该选项：工具 -> 选项... -> NuGet 包管理器 -> 常规 -> 跳过应用绑定重定向。

什么使用我的配置文件？

编译器 (csc.exe)

编译器使用正在构建的程序集的配置文件有一个原因：to find and use supportPortability elements。

上面的链接列出了您需要该编译器选项的罕见场景，但绝大多数用户不需要。可以这么说，如果您不知道自己是否在使用该功能，那您就没有。

它不解析配置文件的任何其他元素，包括程序集绑定重定向，这是 NuGet 添加的元素。

构建引擎 (msbuild)

MSBuild 在其几个步骤中使用应用配置，但重要的是不 来查找主要依赖项，它将以/reference: 选项的形式传递给 csc.exe。

为了查找主要引用，MSBuild（特别是 ResolveAssemblyReference 任务）将搜索the common targets file 中枚举的路径集合。如果它在您的 csproj 中找不到显式依赖项，它将发出警告，并且可能会在编译需要依赖项时进一步发出错误。

之后它将搜索传递依赖。它不会将这些文件传递给编译器，而是使用它们生成一个文件列表，这些文件需要在后续构建步骤中考虑，例如生成许可证文件、信任信息和建议的绑定重定向。此步骤确实考虑项目的配置文件，并专门使用其绑定重定向来通知传递依赖项列表。请务必注意，构建 exe 将在构建过程中不考虑其库的 app.config 文件，并且库的 app.config 不会改变库的 dll 的生成方式。

运行时 (CLR)

CLR 使用config files 到change the way it locates assemblies。

IIS

IIS 将读取您的 web.config 文件的元素以更改您的网络应用程序的行为方式。例如，caching characteristics。

应用程序

应用程序可以使用ConfigurationManager从配置文件中手动检索配置数据。

Answer 2

程序集绑定重定向在类库中与在可执行项目中一样有效。

考虑一下；在构建应用程序时，编译器如何知道要使用哪个版本的引用程序集（对于类库）？

在没有重定向的情况下，这通常可以正常工作，但是当您偶然发现具有 GAC 版本的程序集的机器时，您可能会遇到麻烦。

我建议您阅读assembly binding redirect documentation 以更好地了解它的用途和作用。

NuGet 添加了带有重定向功能的 app.config 来帮助您，坦率地说，我不知道额外的 app.config 是否可以让一切按预期工作。

从今天开始，它将为所有项目添加重定向，但以下类型除外：

• WiX
• JS
• 内梅勒
• C++
• Synergex
• Visual Studio
• Windows 应用商店应用

据我所知，没有办法关闭它。如果这是一个问题，你可以create an issue at Github。

添加程序集绑定重定向的源代码可以在here找到。

Answer 3

我创建了一个小控制台应用程序，它检查 app.config 文件的所有日期，然后自动将它们从您的 .csproj 和文件中删除。待办事项：从 tfs 中删除。 也许这会有所帮助。

class Program
{
    private static string RootFolder;
    private static string AppConfigName;
    private static bool AskConfirmation = true;
    static void Main(string[] args)
    {
        try
        {
            AppConfigName = "app.config";
            RootFolder = @"<Your project path>";
            ScanDir(RootFolder);
            Console.WriteLine();
            Console.WriteLine("DONE!");
            Console.WriteLine("Press ENTER to finish...");
            Console.ReadLine();

        }
        catch (Exception ex)
        {
            Console.WriteLine(ex.Message);
        }
    }

    private static void ScanDir(string directoryParent)
    {
        var dirs = Directory.GetDirectories(directoryParent);
        foreach (var dir in dirs)
        {
            var dirInfo = new DirectoryInfo(dir);
            if (dirInfo.Name == "bin" || dirInfo.Name == "obj" || dirInfo.Name == "debug" || dirInfo.Name == "tempPE" || dirInfo.Name == "java" || dirInfo.Name == "res") continue;
            var files = Directory.GetFiles(dir, "app.config");
            if (files.Length == 0)
            {
                ScanDir(dir);
                continue;
            }
            Process(dir);
            //ScanDir(dir);
        }
    }

    private static void Process(string dir)
    {
        var fi = new FileInfo(Path.Combine(dir, AppConfigName));
        if (fi.CreationTime.Date != DateTime.Now.Date) return;
        if (AskConfirmation)
        {
            Console.WriteLine("Scan " + dir.Replace(RootFolder, ""));
            Console.Write("Remove (y)es or (n)o ?");
            var key = Console.ReadKey();
            Console.WriteLine();
            if (key.Key.ToString() =="Y")
                // remove app.config
                RemoveAppConfig(dir, fi);
        }
        else
            RemoveAppConfig(dir, fi);
    }

    private static void RemoveAppConfig(string dir, FileInfo fi)
    {
        var csProjs = Directory.GetFiles(dir, "*.csproj");
        foreach (var csProj in csProjs)
        {
            var txt = File.ReadAllText(csProj);
            txt = Regex.Replace(txt,"<None Include=\"App.Config\" />", "",RegexOptions.IgnoreCase);
            File.Delete(csProj);
            File.WriteAllText(csProj, txt);
        }
        File.Delete(fi.FullName);
        // todo: undo in tfs
        Console.WriteLine("Deleted");
    }
}