今日は、.net で設定ファイルを読み書きするさまざまな方法について説明します。 このブログでは、各種設定ファイルの読み書き操作を紹介していきます。 内容は比較的直感的であるため、空論はあまりなく、実際のデモコードのみが含まれており、実戦開発におけるさまざまなシナリオを再現することのみを目的としています。皆さんも気に入っていただければ幸いです。
通常、.NET 開発プロセスでは、config ファイルと xml ファイルという 2 種類の構成ファイルに遭遇します。 今日のブログの例では、これら 2 つのカテゴリの構成ファイルのさまざまな操作も紹介します。 構成ファイルでは、appSetting の使用方法を紹介するのではなく、主に独自のカスタム構成ノードを作成する方法を説明します。
注意: この記事で説明されている構成ファイルは、一般的な XML ファイルではなく、特に app.config または web.config を指します。 このタイプの構成ファイルでは、.net Framework によっていくつかの構成ノードが定義されているため、シリアル化を通じて単純に読み書きすることはできません。
config ファイル - カスタム構成ノード
カスタム構成ノードが必要なのはなぜですか?
実際、多くの人は構成ファイルを使用するときに appSetting を直接使用し、そこにすべての構成パラメーターを詰め込んでいますが、パラメーターが多すぎると、このアプローチの欠点が明らかになります。 appSetting の項目にはキー名でのみアクセスでき、複雑な階層ノードや強力な型はサポートできません。また、このセットのみを使用するため、完全に無関係なパラメーターも Together に配置する必要があることがわかります。
この悩みを解消したいですか？カスタム構成ノードは、この問題を解決する実現可能な方法です。
まず、app.config または web.config にカスタム構成ノードを追加する方法を見てみましょう。 このブログでは、ノード構成をカスタマイズする 4 つの方法を紹介します。最終的な構成ファイルは次のとおりです。
<?xml version="1.0" encoding="utf-8" ?>
<configuration>
<configSections>
<section name="MySection111" type="RwConfigDemo.MySection1, RwConfigDemo" />
<section name="MySection222" type="RwConfigDemo.MySection2, RwConfigDemo" />
<section name="MySection333" type="RwConfigDemo.MySection3, RwConfigDemo" />
<section name="MySection444" type="RwConfigDemo.MySection4, RwConfigDemo" />
</configSections>
<MySection111 username="fish-li" url="http://www.jb51.net/"></MySection111>
<MySection222>
<users username="fish" password="liqifeng"></users>
</MySection222>
<MySection444>
<add key="aa" value="11111"></add>
<add key="bb" value="22222"></add>
<add key="cc" value="33333"></add>
</MySection444>
<MySection333>
<Command1>
<![CDATA[
create procedure ChangeProductQuantity(
@ProductID int,
@Quantity int
)
as
update Products set Quantity = @Quantity
where ProductID = @ProductID;
]]>
</Command1>
<Command2>
<![CDATA[
create procedure DeleteCategory(
@CategoryID int
)
as
delete from Categories
where CategoryID = @CategoryID;
]]>
</Command2>
</MySection333>
</configuration>同時に、すべてのサンプル コードも提供します (記事の最後でダウンロードできます)。デモ プログラムのインターフェイスは次のとおりです。
設定ファイル - プロパティ
まず、最も単純なカスタム ノードを見てみましょう。各設定値は属性の形式で存在します。
<MySection111 username="fish-li" url="http://www.php.cn/"></MySection111>
実装コードは次のとおりです。
public class MySection1 : ConfigurationSection
{
[ConfigurationProperty("username", IsRequired = true)]
public string UserName
{
get { return this["username"].ToString(); }
set { this["username"] = value; }
}
[ConfigurationProperty("url", IsRequired = true)]
public string Url
{
get { return this["url"].ToString(); }
set { this["url"] = value; }
}
}概要:
1. 基本クラスとして ConfigurationSection を持つクラスを定義し、ConfigurationProperty のコンストラクターで渡された名前文字列を各属性に追加します。各パラメータの属性名。
2. 属性の値を読み書きするには、基本クラスによって保存される this[] を呼び出す必要があります。それを保存するフィールドを自分で設計しないでください。
3. 解析する構成ノードを使用するには、
注: 次に、他の 3 つの構成ノードを紹介します。少し複雑ですが、いくつかの基本的なことはこのノードと同じなので、後で説明は繰り返しません。
設定ファイル - 要素
各設定項目は XML 要素の形式で存在します:
<MySection222> <users username="fish" password="liqifeng"></users> </MySection222>
実装コードは次のとおりです:
public class MySection2 : ConfigurationSection
{
[ConfigurationProperty("users", IsRequired = true)]
public MySectionElement Users
{
get { return (MySectionElement)this["users"]; }
}
}
public class MySectionElement : ConfigurationElement
{
[ConfigurationProperty("username", IsRequired = true)]
public string UserName
{
get { return this["username"].ToString(); }
set { this["username"] = value; }
}
[ConfigurationProperty("password", IsRequired = true)]
public string Password
{
get { return this["password"].ToString(); }
set { this["password"] = value; }
}
}
概要:
1 . ConfigurationSection を基本クラスとしてクラスをカスタマイズします。
2 それぞれの属性に [ConfigurationProperty] を追加し、ConfigurationElement の継承クラスに特定の構成プロパティを記述します。
config ファイル - CDATA
構成パラメーターに SQL スクリプトや HTML コードなどの長いテキストが含まれる場合は、CDATA ノードが必要になります。 2 つの SQL スクリプトを含む構成を実装するとします。
<MySection333>
<Command1>
<![CDATA[
create procedure ChangeProductQuantity(
@ProductID int,
@Quantity int
)
as
update Products set Quantity = @Quantity
where ProductID = @ProductID;
]]>
</Command1>
<Command2>
<![CDATA[
create procedure DeleteCategory(
@CategoryID int
)
as
delete from Categories
where CategoryID = @CategoryID;
]]>
</Command2>
</MySection333>
実装コードは次のとおりです:
public class MySection3 : ConfigurationSection
{
[ConfigurationProperty("Command1", IsRequired = true)]
public MyTextElement Command1
{
get { return (MyTextElement)this["Command1"]; }
}
[ConfigurationProperty("Command2", IsRequired = true)]
public MyTextElement Command2
{
get { return (MyTextElement)this["Command2"]; }
}
}
public class MyTextElement : ConfigurationElement
{
protected override void DeserializeElement(System.Xml.XmlReader reader, bool serializeCollectionKey)
{
CommandText = reader.ReadElementContentAs(typeof(string), null) as string;
}
protected override bool SerializeElement(System.Xml.XmlWriter writer, bool serializeCollectionKey)
{
if( writer != null )
writer.WriteCData(CommandText);
return true;
}
[ConfigurationProperty("data", IsRequired = false)]
public string CommandText
{
get { return this["data"].ToString(); }
set { this["data"] = value; }
}
}
概要: 実装については、通常、MySection2 を参照できます。 ,
2. 各 ConfigurationElement の XML の読み取りと書き込み方法を制御します。これは、SerializeElement メソッドと DeserializeElement
<MySection444> <add key="aa" value="11111"></add> <add key="bb" value="22222"></add> <add key="cc" value="33333"></add> </MySection444>
1. コレクション内の各パラメーター項目に対して ConfigurationElement を継承する派生クラスを作成します。MySection1 を参照してください。
2.コレクション、特に主な実装は、基本クラスのメソッドを呼び出すことです。
3. ConfigurationSection の継承クラスを作成するときは、[ConfigurationProperty] のパラメーターに注意してください。
MySection1 mySectioin1 = (MySection1)ConfigurationManager.GetSection("MySection111");
txtUsername1.Text = mySectioin1.UserName;
txtUrl1.Text = mySectioin1.Url;
MySection2 mySectioin2 = (MySection2)ConfigurationManager.GetSection("MySection222");
txtUsername2.Text = mySectioin2.Users.UserName;
txtUrl2.Text = mySectioin2.Users.Password;
MySection3 mySection3 = (MySection3)ConfigurationManager.GetSection("MySection333");
txtCommand1.Text = mySection3.Command1.CommandText.Trim();
txtCommand2.Text = mySection3.Command2.CommandText.Trim();
MySection4 mySection4 = (MySection4)ConfigurationManager.GetSection("MySection444");
txtKeyValues.Text = string.Join("\r\n",
(from kv in mySection4.KeyValues.Cast<MyKeyValueSetting>()
let s = string.Format("{0}={1}", kv.Key, kv.Value)
select s).ToArray());写配置文件：
Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
MySection1 mySectioin1 = config.GetSection("MySection111") as MySection1;
mySectioin1.UserName = txtUsername1.Text.Trim();
mySectioin1.Url = txtUrl1.Text.Trim();
MySection2 mySection2 = config.GetSection("MySection222") as MySection2;
mySection2.Users.UserName = txtUsername2.Text.Trim();
mySection2.Users.Password = txtUrl2.Text.Trim();
MySection3 mySection3 = config.GetSection("MySection333") as MySection3;
mySection3.Command1.CommandText = txtCommand1.Text.Trim();
mySection3.Command2.CommandText = txtCommand2.Text.Trim();
MySection4 mySection4 = config.GetSection("MySection444") as MySection4;
mySection4.KeyValues.Clear();
(from s in txtKeyValues.Lines
let p = s.IndexOf('=')
where p > 0
select new MyKeyValueSetting { Key = s.Substring(0, p), Value = s.Substring(p + 1) }
).ToList()
.ForEach(kv => mySection4.KeyValues.Add(kv));
config.Save();
小结：在修改配置节点前，我们需要调用ConfigurationManager.OpenExeConfiguration()，然后调用config.GetSection()在得到节点后，转成我们定义的节点类型， 然后就可以按照强类型的方式来修改我们定义的各参数项，最后调用config.Save();即可。
注意：
1. .net为了优化配置节点的读取操作，会将数据缓存起来，如果希望使用修改后的结果生效，您还需要调用ConfigurationManager.RefreshSection(".....")
2. 如果是修改web.config，则需要使用 WebConfigurationManager
读写 .net framework中已经定义的节点
前面一直在演示自定义的节点，那么如何读取.net framework中已经定义的节点呢？
假如我想读取下面配置节点中的发件人。
<system.net>
<mailSettings>
<smtp from="Fish.Q.Li@newegg.com">
<network />
</smtp>
</mailSettings>
</system.net>
读取配置参数：
SmtpSection section = ConfigurationManager.GetSection("system.net/mailSettings/smtp") as SmtpSection;
labMailFrom.Text = "Mail From: " + section.From;
写配置文件：
Configuration config = ConfigurationManager.OpenExeConfiguration(ConfigurationUserLevel.None);
SmtpSection section = config.GetSection("system.net/mailSettings/smtp") as SmtpSection;
section.From = "Fish.Q.Li@newegg.com2";
config.Save();
xml配置文件
前面演示在config文件中创建自定义配置节点的方法，那些方法也只适合在app.config或者web.config中，如果您的配置参数较多， 或者打算将一些数据以配置文件的形式单独保存，那么，直接读写整个XML将会更方便。 比如：我有一个实体类，我想将它保存在XML文件中，有可能是多条记录，也可能是一条。
这次我来反过来说，假如我们先定义了XML的结构，是下面这个样子的，那么我将怎么做呢？
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfMyCommand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MyCommand Name="InsretCustomer" Database="MyTestDb">
<Parameters>
<Parameter Name="Name" Type="DbType.String" />
<Parameter Name="Address" Type="DbType.String" />
</Parameters>
<CommandText>insret into .....</CommandText>
</MyCommand>
</ArrayOfMyCommand>
对于上面的这段XML结构，我们可以在C#中先定义下面的类，然后通过序列化及反序列化的方式来实现对它的读写。
C#类的定义如下：
public class MyCommand
{
[XmlAttribute("Name")]
public string CommandName;
[XmlAttribute]
public string Database;
[XmlArrayItem("Parameter")]
public List<MyCommandParameter> Parameters = new List<MyCommandParameter>();
[XmlElement]
public string CommandText;
}
public class MyCommandParameter
{
[XmlAttribute("Name")]
public string ParamName;
[XmlAttribute("Type")]
public string ParamType;
}
有了这二个C#类，读写这段XML就非常容易了。以下就是相应的读写代码：
private void btnReadXml_Click(object sender, EventArgs e)
{
btnWriteXml_Click(null, null);
List<MyCommand> list = XmlHelper.XmlDeserializeFromFile<List<MyCommand>>(XmlFileName, Encoding.UTF8);
if( list.Count > 0 )
MessageBox.Show(list[0].CommandName + ": " + list[0].CommandText,
this.Text, MessageBoxButtons.OK, MessageBoxIcon.Information);
}
private void btnWriteXml_Click(object sender, EventArgs e)
{
MyCommand command = new MyCommand();
command.CommandName = "InsretCustomer";
command.Database = "MyTestDb";
command.CommandText = "insret into .....";
command.Parameters.Add(new MyCommandParameter { ParamName = "Name", ParamType = "DbType.String" });
command.Parameters.Add(new MyCommandParameter { ParamName = "Address", ParamType = "DbType.String" });
List<MyCommand> list = new List<MyCommand>(1);
list.Add(command);
XmlHelper.XmlSerializeToFile(list, XmlFileName, Encoding.UTF8);
}
小结：
1. 读写整个XML最方便的方法是使用序列化反序列化。
2. 如果您希望某个参数以Xml Property的形式出现，那么需要使用[XmlAttribute]修饰它。
3. 如果您希望某个参数以Xml Element的形式出现，那么需要使用[XmlElement]修饰它。
4. 如果您希望为某个List的项目指定ElementName，则需要[XmlArrayItem]
5. 以上3个Attribute都可以指定在XML中的映射别名。
6. 写XML的操作是通过XmlSerializer.Serialize()来实现的。
7. 读取XML文件是通过XmlSerializer.Deserialize来实现的。
8. List或Array项，请不要使用[XmlElement]，否则它们将以内联的形式提升到当前类，除非你再定义一个容器类。
XmlHelper的实现如下：
public static class XmlHelper
{
private static void XmlSerializeInternal(Stream stream, object o, Encoding encoding)
{
if( o == null )
throw new ArgumentNullException("o");
if( encoding == null )
throw new ArgumentNullException("encoding");
XmlSerializer serializer = new XmlSerializer(o.GetType());
XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.NewLineChars = "\r\n";
settings.Encoding = encoding;
settings.IndentChars = " ";
using( XmlWriter writer = XmlWriter.Create(stream, settings) ) {
serializer.Serialize(writer, o);
writer.Close();
}
}
/// <summary>
/// 将一个对象序列化为XML字符串
/// </summary>
/// <param name="o">要序列化的对象</param>
/// <param name="encoding">编码方式</param>
/// <returns>序列化产生的XML字符串</returns>
public static string XmlSerialize(object o, Encoding encoding)
{
using( MemoryStream stream = new MemoryStream() ) {
XmlSerializeInternal(stream, o, encoding);
stream.Position = 0;
using( StreamReader reader = new StreamReader(stream, encoding) ) {
return reader.ReadToEnd();
}
}
}
/// <summary>
/// 将一个对象按XML序列化的方式写入到一个文件
/// </summary>
/// <param name="o">要序列化的对象</param>
/// <param name="path">保存文件路径</param>
/// <param name="encoding">编码方式</param>
public static void XmlSerializeToFile(object o, string path, Encoding encoding)
{
if( string.IsNullOrEmpty(path) )
throw new ArgumentNullException("path");
using( FileStream file = new FileStream(path, FileMode.Create, FileAccess.Write) ) {
XmlSerializeInternal(file, o, encoding);
}
}
/// <summary>
/// 从XML字符串中反序列化对象
/// </summary>
/// <typeparam name="T">结果对象类型</typeparam>
/// <param name="s">包含对象的XML字符串</param>
/// <param name="encoding">编码方式</param>
/// <returns>反序列化得到的对象</returns>
public static T XmlDeserialize<T>(string s, Encoding encoding)
{
if( string.IsNullOrEmpty(s) )
throw new ArgumentNullException("s");
if( encoding == null )
throw new ArgumentNullException("encoding");
XmlSerializer mySerializer = new XmlSerializer(typeof(T));
using( MemoryStream ms = new MemoryStream(encoding.GetBytes(s)) ) {
using( StreamReader sr = new StreamReader(ms, encoding) ) {
return (T)mySerializer.Deserialize(sr);
}
}
}
/// <summary>
/// 读入一个文件，并按XML的方式反序列化对象。
/// </summary>
/// <typeparam name="T">结果对象类型</typeparam>
/// <param name="path">文件路径</param>
/// <param name="encoding">编码方式</param>
/// <returns>反序列化得到的对象</returns>
public static T XmlDeserializeFromFile<T>(string path, Encoding encoding)
{
if( string.IsNullOrEmpty(path) )
throw new ArgumentNullException("path");
if( encoding == null )
throw new ArgumentNullException("encoding");
string xml = File.ReadAllText(path, encoding);
return XmlDeserialize<T>(xml, encoding);
}
}
xml配置文件 - CDATA
在前面的演示中，有个不完美的地方，我将SQL脚本以普通字符串的形式输出到XML中了：
<CommandText>insret into .....</CommandText>
显然，现实中的SQL脚本都是比较长的，而且还可能会包含一些特殊的字符，这种做法是不可取的，好的处理方式应该是将它以CDATA的形式保存， 为了实现这个目标，我们就不能直接按照普通字符串的方式来处理了，这里我定义了一个类 MyCDATA：
public class MyCDATA : IXmlSerializable
{
private string _value;
public MyCDATA() { }
public MyCDATA(string value)
{
this._value = value;
}
public string Value
{
get { return _value; }
}
XmlSchema IXmlSerializable.GetSchema()
{
return null;
}
void IXmlSerializable.ReadXml(XmlReader reader)
{
this._value = reader.ReadElementContentAsString();
}
void IXmlSerializable.WriteXml(XmlWriter writer)
{
writer.WriteCData(this._value);
}
public override string ToString()
{
return this._value;
}
public static implicit operator MyCDATA(string text)
{
return new MyCDATA(text);
}
}
我将使用这个类来控制CommandText在XML序列化及反序列化的行为，让它写成一个CDATA形式， 因此，我还需要修改CommandText的定义，改成这个样子：
public MyCDATA CommandText;
最终，得到的结果是：
<?xml version="1.0" encoding="utf-8"?>
<ArrayOfMyCommand xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns:xsd="http://www.w3.org/2001/XMLSchema">
<MyCommand Name="InsretCustomer" Database="MyTestDb">
<Parameters>
<Parameter Name="Name" Type="DbType.String" />
<Parameter Name="Address" Type="DbType.String" />
</Parameters>
<CommandText><![CDATA[insret into .....]]></CommandText>
</MyCommand>
</ArrayOfMyCommand>
xml文件读写注意事项
通常，我们使用使用XmlSerializer.Serialize()得到的XML字符串的开头处，包含一段XML声明元素：
<?xml version="1.0" encoding="utf-8"?>
由于各种原因，有时候可能不需要它。为了让这行字符消失，我见过有使用正则表达式去删除它的，也有直接分析字符串去删除它的。 这些方法，要么浪费程序性能，要么就要多写些奇怪的代码。总之，就是看起来很别扭。 其实，我们可以反过来想一下：能不能在序列化时，不输出它呢？ 不输出它，不就达到我们期望的目的了吗？
在XML序列化时，有个XmlWriterSettings是用于控制写XML的一些行为的，它有一个OmitXmlDeclaration属性，就是专门用来控制要不要输出那行XML声明的。 而且，这个XmlWriterSettings还有其它的一些常用属性。请看以下演示代码：
using( MemoryStream stream = new MemoryStream() ) {
XmlWriterSettings settings = new XmlWriterSettings();
settings.Indent = true;
settings.NewLineChars = "\r\n";
settings.OmitXmlDeclaration = true;
settings.IndentChars = "\t";
XmlWriter writer = XmlWriter.Create(stream, settings);
使用上面这段代码，我可以：
1. 不输出XML声明。
2. 指定换行符。
3. 指定缩进字符。
如果不使用这个类，恐怕还真的不能控制XmlSerializer.Serialize()的行为。
XMLを読み書きする方法は以前に紹介しましたが、どうやって始めればよいでしょうか? XML ファイルがないため、プログラムはそれを読み取ることができません。では、正しい形式の XML を取得するにはどうすればよいでしょうか? 答えは、まずコードを記述し、読み取るオブジェクトを作成し、ジャンク データを入力してから、それを XML に書き込む (逆シリアル化) ことで、生成された XML ファイルの特定の形式を参照するか、他のノードを追加できます。 (リスト)、または上記のジャンク データを変更して、最終的に正しい形式で使用可能な XML ファイルを取得します。
設定パラメータを保存するための推奨方法
多くのコンポーネントやフレームワークが設定パラメータを設定ファイルに含めることを好むことがよく見られますが、それらの設計者は、自分の作品のパラメータがより複雑であり、カスタマイズされた設定を作成することを好む可能性があります。 .ノード。 その結果、構成ファイルには多数の構成パラメータが含まれます。最も厄介なことは、次回他のプロジェクトがこれを使用したい場合、引き続き設定を行わなければならないことです。
.net は常に XCOPY を提唱してきましたが、この規則に準拠するコンポーネントやフレームワークがそれほど多くないことがわかりました。 したがって、コンポーネントやフレームワークを設計するときは、次のことをお勧めします。
1. この種の設定は [再利用] するのに非常に不便です。
2. パラメーターを公開するための構成ファイルと API インターフェイスを同時に提供できますか? 構成パラメーターを保存する方法はユーザーが決定します。
構成ファイルと XML ファイルの違い
本質的に、構成ファイルも XML ファイルですが、少し異なります。これは、.net Framework が構成ファイルの多くの構成セクションを事前定義しているためだけではありません。 ASP.NET アプリケーションの場合、web.config にパラメータを設定すると、web.config が変更される限り、Web サイトが再起動されるという利点があります。コードは常に最新のパラメータで更新できます。走る。一方で、デメリットもあります。おそらく、さまざまな理由から、Web サイトの再起動には時間がかかり、Web サイトの応答に影響を与えるため、Web サイトを再起動したくないのです。 この機能については、web.config がこうなっているのは仕方がないとしか言いようがありません。
ただし、XML を使用すると、上記の機能を直接取得することはできません。 XML ファイルは弊社で管理されているためです。
この時点で、次のことを考えたことはありますか? XML を使用するときに、どのようにすればそれらの利点も享受できるでしょうか?
ユーザーが構成ファイルを変更した後、Web サイトを再構築することなく、プログラムが最新のパラメーターですぐに実行できることを願っています。
この記事のすべてのサンプルコードはここからダウンロードできます。デモ
以上がこの記事の全内容です。皆さんの学習に役立つことを願っています。また、皆さんも PHP 中国語 Web サイトをサポートしていただければ幸いです。
.net で構成ファイルを読み書きするさまざまな方法の詳細については、PHP 中国語 Web サイトの関連記事に注目してください。
![[Web フロントエンド] Node.js クイック スタート](https://img.php.cn/upload/course/000/000/067/662b5d34ba7c0227.png)
