ConfigurationManager 可以保留 Save() 上的 XML 注释吗？

Question

我编写了一个小实用程序，允许我更改另一个应用程序的 App.config 文件的简单 AppSetting，然后保存更改：

 //save a backup copy first.
 var cfg = ConfigurationManager.OpenExeConfiguration(pathToExeFile);
 cfg.SaveAs(cfg.FilePath + "." + DateTime.Now.ToFileTime() + ".bak"); 

 //reopen the original config again and update it.
 cfg = ConfigurationManager.OpenExeConfiguration(pathToExeFile);
 var setting = cfg.AppSettings.Settings[keyName];
 setting.Value = newValue;

 //save the changed configuration.
 cfg.Save(ConfigurationSaveMode.Full); 

除了一个副作用之外，这效果很好。 新保存的.config文件会丢失所有原始XML注释，但仅限于AppSettings区域内。是否可以保留原始配置文件AppSettings区域中的XML注释？

如果您想快速编译并运行它，这里有一个完整源代码的粘贴箱。< /em>

Answer 1

我跳进 Reflector.Net 并查看了该类的反编译源代码。简短的回答是否定的，它不会保留评论。 Microsoft 编写该类的方式是根据配置类的属性生成 XML 文档。由于注释不会出现在配置类中，因此它们不会返回到 XML 中。

更糟糕的是，微软密封了所有这些类，因此您无法派生新类并插入自己的实现。您唯一的选择是将注释移到 AppSettings 部分之外，或者使用 XmlDocument 或 XDocument 类来解析配置文件。

对不起。这是微软没有计划到的边缘情况。

Answer 2

这是一个可用于保存评论的示例函数。它允许您一次编辑一个键/值对。我还添加了一些内容，以便根据我常用的文件方式很好地格式化文件（如果需要，您可以轻松删除它）。我希望这可以帮助其他人在未来。

public static bool setConfigValue(Configuration config, string key, string val, out string errorMsg) {
    try {
        errorMsg = null;
        string filename = config.FilePath;

        //Load the config file as an XDocument
        XDocument document = XDocument.Load(filename, LoadOptions.PreserveWhitespace);
        if(document.Root == null) {
            errorMsg = "Document was null for XDocument load.";
            return false;
        }
        XElement appSettings = document.Root.Element("appSettings");
        if(appSettings == null) {
            appSettings = new XElement("appSettings");
            document.Root.Add(appSettings);
        }
        XElement appSetting = appSettings.Elements("add").FirstOrDefault(x => x.Attribute("key").Value == key);
        if (appSetting == null) {
            //Create the new appSetting
            appSettings.Add(new XElement("add", new XAttribute("key", key), new XAttribute("value", val)));
        }
        else {
            //Update the current appSetting
            appSetting.Attribute("value").Value = val;
        }


        //Format the appSetting section
        XNode lastElement = null;
        foreach(var elm in appSettings.DescendantNodes()) {
            if(elm.NodeType == System.Xml.XmlNodeType.Text) {
                if(lastElement?.NodeType == System.Xml.XmlNodeType.Element && elm.NextNode?.NodeType == System.Xml.XmlNodeType.Comment) {
                    //Any time the last node was an element and the next is a comment add two new lines.
                    ((XText)elm).Value = "\n\n\t\t";
                }
                else {
                    ((XText)elm).Value = "\n\t\t";
                }
            }
            lastElement = elm;
        }

        //Make sure the end tag for appSettings is on a new line.
        var lastNode = appSettings.DescendantNodes().Last();
        if (lastNode.NodeType == System.Xml.XmlNodeType.Text) {
            ((XText)lastNode).Value = "\n\t";
        }
        else {
            appSettings.Add(new XText("\n\t"));
        }

        //Save the changes to the config file.
        document.Save(filename, SaveOptions.DisableFormatting);
        return true;
    }
    catch (Exception ex) {
        errorMsg = "There was an exception while trying to update the config value for '" + key + "' with value '" + val + "' : " + ex.ToString();
        return false;
    }
}

Answer 3

如果评论很重要，那么您唯一的选择可能就是阅读并阅读它。手动保存文件（通过 XmlDocument 或新的 Linq 相关 API）。然而，如果这些评论并不重要，我要么放弃它们，要么考虑将它们嵌入为（尽管是多余的）数据元素。