28

別のアプリケーションの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);

これは、1つの副作用を除いて、うまく機能します。新しく保存された.configファイルは、元のXMLコメントをすべて失いますが、AppSettings領域内でのみ失われます。元の構成ファイルのAppSettings領域からXMLコメントを保持することは可能ですか？

すばやくコンパイルして実行したい場合は、完全なソースのペーストビンを次に示します。

4

3 に答える 3

31

私はReflector.Netに飛び込んで、このクラスの逆コンパイルされたソースを調べました。簡単な答えはノーです、それはコメントを保持しません。Microsoftがクラスを作成した方法は、構成クラスのプロパティからXMLドキュメントを生成することです。コメントは構成クラスに表示されないため、XMLに戻されません。

そして、これをさらに悪化させるのは、Microsoftがこれらのクラスをすべて封印したため、新しいクラスを派生させて独自の実装を挿入できないことです。唯一のオプションは、コメントをAppSettingsセクションの外に移動するか、XmlDocumentまたはXDocumentクラスを使用して構成ファイルを解析することです。

ごめん。これは、Microsoftが計画していなかったエッジケースです。

于 2009-12-29T00:39:17.623 に答える
4

コメントを保存するために使用できるサンプル関数を次に示します。一度に1つのキーと値のペアを編集できます。また、ファイルの一般的な使用方法に基づいてファイルを適切にフォーマットするためにいくつかのものを追加しました（必要に応じて簡単に削除できます）。これが将来誰か他の人に役立つことを願っています。

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;
    }
}
于 2015-11-13T19:33:59.793 に答える
2

コメントが重要な場合は、ファイルを手動で（XmlDocumentまたは新しいLinq関連のAPIを介して）読み取って保存することが唯一の選択肢である可能性があります。ただし、これらのコメントが重要でない場合は、それらを手放すか、（冗長ではありますが）データ要素として埋め込むことを検討します。

于 2009-12-27T19:38:55.193 に答える