作為開發人員,您始終需要處理應用程式配置數據。常見的示例是INI 文件,XML文件, .NET配置文件(也稱為“ .config”),Windows註冊表和命令行(argv)參數。配置文件的優點是它們載入速度快,不占用大量空間且易於編輯。Nini是一個功能強大的 .NET配置庫,旨在幫助快速構建高度... ...
目錄
Nini .NET配置庫(http://nini.sourceforge.net/)
VB代碼的註釋我保留了原文註釋,它和C#註釋的內容是一樣的,下載鏈接在文章末尾。
1.簡介
1.1什麼是應用程式配置數據?
作為開發人員,您始終需要處理應用程式配置數據。常見的示例是INI 文件,XML文件, .NET配置文件(也稱為“ .config”),Windows註冊表和命令行(argv)參數。配置文件的優點是它們載入速度快,不占用大量空間且易於編輯。
1.2問題
嘗試創建配置文件訪問方案不能滿足程式員或最終用戶的需求。為了給出真實的生活場景,我為一個使用Windows註冊表API(應用程式編程介面)配置其原始程式的組織工作。後來,他們開發了自己的ASP配置類。大約在同一時間,另一個小組開發了一個API,該API可從資料庫中獲取數據。然後,當ASP.NET出現時,他們開始使用Web.config。在短短的幾年之內,配置數據源的數量就從一增加到了四個!不用說,獲取配置數據通常成為一項艱巨的任務。以下是可以改進配置管理的三個主要方面:
- API
開發人員使用配置文件格式,以使其應用程式在儘可能短的時間內運行。但是,通常在事後才添加用於訪問此數據的API,從而導致API不夠靈活。在很小的應用程式中,這可能不是問題,但是隨著程式代碼庫的增長,配置信息通常會遍及整個應用程式代碼。 - 最終用戶
配置文件通常不會考慮最終用戶。通常,配置選項是簡潔的編程術語,只有最勇敢的用戶才敢更改它們。這導致開發人員不得不編寫複雜的配置文件編輯器,或更糟糕的是,它們會完全重新設計其原始API。 - 多個配置源
隨著您軟體的成熟,添加更多應用程式配置類型的情況並不少見(例如我之前給您的示例)。這通常是由於合併其他項目中的代碼,新的改進格式以及遷移到不同的編程平臺而引起的。這迫使程式員學習多個API。最終結果是代碼不一致,也不適合新程式員。不會替換舊的配置文件,因為程式員及其經理不適應更改成熟的代碼。編輯文件的用戶可以抵制此更改,因為他們希望不學習新的文件格式。
1.3介紹Nini
Nini是一個功能強大的 .NET配置 庫,旨在幫助快速構建高度可配置的應用程式。Nini提供了一種解決方案,試圖消除上述問題。它提供了一個大型功能集,可為您提供從概念到成熟產品的每個階段都將使用的功能。這是通過簡單但靈活的API實現的,該API提供了對基礎配置源的抽象。它解決了我上面描述的所有問題。我們將在下麵的示例中看到如何完成此操作。
2.入門
2.1一個簡單的例子
為了向您展示Nini如何解決這些問題,讓我們來看一個示例。首先,讓我們看一個示例配置文件。對於本手冊中的大多數示例,我將選擇INI 格式。INI文件是一種久經考驗的真實配置文件類型,用於諸如MySQL,PHP和Samba之類的著名開源項目 。實際上,Nini支持多種INI文件類型。它們非常簡單且易於編輯,因此仍然是非常受歡迎的選擇。Nini包含它自己的INI解析器類(IniDocument),該類 完全用C#編寫,沒有 Windows API代碼,因此它是跨平臺的。這是此示例的MyApp.ini文本:
; MyApp.ini
[Logging]
File Name = MyApp.log
MessageColumns = 5
MaxFileSize = 40000000000000
以下是一段C#示例代碼,它描述瞭如何從上述文件中的INI文件訪問配置數據:
using Nini.Config;
IConfigSource source = new IniConfigSource("MyApp.ini");
string fileName = source.Configs["Logging"].Get("File Name");
int columns = source.Configs["Logging"].GetInt("MessageColumns");
long fileSize = source.Configs["Logging"].GetLong("MaxFileSize");
這是VB中的示例:
Imports Nini.Config
Dim source As New IniConfigSource("MyApp.ini")
Dim fileName As String = source.Configs("Logging").Get("File Name")
Dim columns As Integer = source.Configs("Logging").GetInt("MessageColumns")
Dim fileSize As Long = source.Configs("Logging").GetLong("MaxFileSize")
好的,那個例子給您帶來了一些麻煩。首先,我們使用Nini.Config將Nini的配置名稱空間包含在虛構的應用程式中。接下來,我們使用IniConfigSource 類載入INI文件。在Nini中,每種配置文件類型都有其自己的“ Source”類。此類知道如何載入和保存文件。這些類中的每一個都實現IConfigSource 介面,因此您可以更輕鬆地抽象地使用多種配置類型。載入文件後,所有部分(在本例中為[Logging]部分)都將轉換為介面IConfig。 並添加到Source類的集合中。IConfig類提供了非常快速的訪問許可權,以檢索,添加或刪除配置密鑰(例如上述INI文件中的“文件名”)。IConfig類的方法包括 Get, GetString, GetInt, GetFloat, GetDouble和GetLong 方法。所有以“ Get”為首碼的方法都將重載以提供更多數據。接下來的幾節描述瞭如何使用這些重載。
2.2預設值
有時,配置文件中不會出現選項。這可能是因為尚未將其添加到項目的主版本中,或者應將其對用戶保密。對於這些情況,Nini提供了重載的方法,這些方法允許程式員定義預設值。
這是C#中的示例:
// 將缺少預設值設置為 "Default result".
string missing = config.Get("Missing Config", "Default result");
// 設置smallNumber為預設值,50
int smallNumber = config.GetInt("Not Present", 50);
這是VB中的相同示例:
' Sets missing to the default value, "Default result".
Dim missing As String = config.Get("Missing Config", "Default result")
' Sets smallNumber to the default value, 50.
Dim smallNumber As Integer = config.GetInt("Not Present", 50)
2.3設置、保存和刪除鍵
也可以設置新值並將其保存到配置文件中。調用Set方法將更改現有值,或者如果不存在則將其添加。這是一個例子:
config.Set("File Name", "MyNewFile.log");
config.Set("MessageColumns", 45);
config.Remove("File Name");
source.Save();
但是,有必要調用Save方法來保存文件,但是,您還可以在IConfigSource上設置AutoSave屬性,並且每次調用Set方法時,該屬性都會自動保存文件。如果要將文檔保存到其他路徑或對象,則IniConfigSource, XmlConfigSource和DotNetConfigSource 類都保存重載的Save方法,這些方法使您可以保存到新路徑或TextWriter:
這是C#中的示例:
using System.IO;
IniConfigSource source = new IniConfigSource("Test.ini");
StringWriter writer = new StringWriter();
source.Save(writer); // 保存到StringWriter(TextWriter)
source.Save("some/new/path.ini"); // 保存到新路徑
這是VB中的示例:
Imports System.IO
Dim source As IniConfigSource = new IniConfigSource("Test.ini")
Dim writer As New StringWriter()
source.Save(writer) ' Save to StringWriter(TextWriter)
source.Save("some/new/path.ini") ' Save to new path
2.4添加和刪除配置
在特定情況下,您將需要自己添加和刪除IConfigs。Nini具有完成這兩項操作的簡單方法。這是我創建新配置然後立即將其刪除的示例。
這是C#中的示例:
IConfig newConfig = source.AddConfig("NewConfig");
source.Configs.Remove(newConfig);
這是VB中的示例:
Dim newConfig As IConfig = source.AddConfig("NewConfig")
source.Configs.Remove(newConfig)
2.5鍵值擴展
在許多情況下,您會發現您的鍵值取決於其他鍵的值。例如,您有一個根路徑配置值,以及使用此路徑的文件的多個值,例如以下示例:
[File Path]
RootPath = C:\Program Files\My Program
Logging = MyApp.log
WebPage = index.html
如果沒有Nini,則如果要將“ RootPath”的值與“ Logging”和“ WebPage”結合使用,則必須執行難看的字元串連接才能獲得“ C: Program Files My Program index.html”。在Nini中,您不需要這樣做:
[File Path]
RootPath = C:\Program Files\My Program
Logging = ${RootPath}\MyApp.log
WebPage = ${RootPath}\index.html
這可以為您自己串聯它們省去很多麻煩,並使您的代碼更整潔。如果要從其他部分獲取值,則可以執行上述操作,但是要在部分名稱後添加一個橫條(“ |”),如下所示:$ {section | key}。當您準備執行替換時,請調用ExpandKeyValues(註意:以前稱為ReplaceKeyValues)
這是C#中的示例:
IConfigSource source = new IniConfigSource("MyApp.ini");
source.ExpandKeyValues();
這是VB中的示例:
Dim source As New IConfigSource("MyApp.ini")
source.ExpandKeyValues()
調用ExpandKeyValues時,它會一次更改配置文件中的所有鍵。這使代碼執行更快,因為它不需要替換每個Get / GetString / GetInt / etc調用上的鍵值。但是,這意味著如果要使用保存配置文件,它將用擴展值覆蓋以前的值。如果您不希望發生這種情況,則可以使用GetExpanded方法。
; 這會將日誌記錄設置為 "C:\Program Files\My Program\MyApp.log"
IConfigSource source = new IniConfigSource("MyApp.ini");
string logging = source.Configs["File Path"].GetExpanded("Logging");
這就是創建第一個Nini配置的應用程式很容易。以下各節將介紹Nini的一些更高級的功能。
3.高級主題
3.1合併
合併是一項非常強大的功能,允許開發人員將來自多個源的配置數據組合到一個對象中。您可以將無數種不同的配置類型組合到一個IConfigSource中!您可以將多個INI,XML和註冊表文件添加到同一對象中。你覺得很酷嗎?這是一個如何將INI文件與XML文件合併的示例。
這是C#中的示例:
IConfigSource mainSource = new IniConfigSource("MyApp.ini");
IConfigSource xmlSource = new XmlConfigSource("MyApp.xml");
mainSource.Merge(xmlSource);
// 現在,您可以從mainSource和xmlSource訪問任何IConfig
string xmlValue = mainSource.Configs["SomeXmlSection"].Get("AnOption");
這是VB中的示例:
Dim mainSource As New IniConfigSource("MyApp.ini")
Dim xmlSource As New XmlConfigSource("MyApp.xml")
mainSource.Merge(xmlSource)
' Now you can access any IConfig from mainSource and xmlSource
Dim xmlValue As String = mainSource.Configs("SomeXmlSection").Get("AnOption")
當數據在文件之間合併時,任何同名的IConfig或包含相同密鑰的IConfig都將覆蓋之前的文件。對於具有不同配置需求的客戶端的用戶來說,這非常重要。您可以在一個文件中創建預設配置設置,並具有特定於客戶端的文件,如果需要,該文件將覆蓋主文件的設置。這將節省您大量的工作。它對我有用。
3.2價值別名
許多配置文件的選項對於程式員來說是清楚的,但對非程式員來說卻很混亂。為了使非程式員更容易理解配置文件,一種常見的做法是使鍵和值更像普通的人類對話框那樣讀取。讓我們看一個示例,說明如何使用易於理解的字元串值返回布爾值。首先,讓我們從AliasExample INI文件開始:
; AliasExample.ini
[Web Browser]
Block Popups = ON
Check For Default Browser = Off
Error Level = warn
如您所見,我不是使用每個鍵的值都使用“ 1”或“ true”之類的值,而是使用了“ On”和“ Off”,希望它們可以使用戶更容易理解。您還將註意到,每個值之間的大小寫不完全是大寫或小寫。我這樣做是為了提出觀點。用戶很難記住要在特定鍵值中放置什麼值,因此要使它們變得更容易一點也不 要使他們也記住要使用哪種情況!忽略大小寫的問題是您的代碼看起來很醜陋,如以下示例所示:
bool blockPopUps = (config.Get("Block Popups").ToLower() == "on");
讓我們為該文件定義一些規則,使它們成為規則。我們希望 BlockPopUps部分的 值在值設置為“ On”時返回布爾值true,而在值設置為“ Off”時返回false值。此外,我希望錯誤級別將整數值設置為“ Warn”時返回100,而將值設置為“ Error”時返回200。下麵的代碼顯示如何向IConfigSource的Alias屬性添加規則,該屬性定義了我在上一段中剛剛定義的規則。
這是C#中的示例:
IConfigSource source = new IniConfigSource("AliasExample.ini");
// 創建兩個布爾別名。
source.Alias.AddAlias("On", true);
source.Alias.AddAlias("Off", false);
// 設置兩個整數別名。
source.Alias.AddAlias("Error Level", "Warn", 100);
source.Alias.AddAlias("Error Level", "Error", 200);
IConfig config = source.Configs["Web Browser"];
bool blockPopUps = config.GetBoolean("BlockPopUps");
int errorCode = config.GetInt("Error Code", true);
這是VB中的示例:
Dim source As New IniConfigSource("AliasExample.ini")
' Creates two Boolean aliases.
source.Alias.AddAlias("On", True)
source.Alias.AddAlias("Off", False)
' Sets two integer aliases.
source.Alias.AddAlias("Error Level", "Warn", 100)
source.Alias.AddAlias("Error Level", "Error", 200)
Dim config As IConfig = source.Configs("Web Browser")
Dim blockPopUps = config.GetBoolean("BlockPopUps")
int errorCode = config.GetInt("Error Code", True)
對AddAlias的前兩個調用 將布爾值添加到文本“ On”和“ Off”。此方法的接下來的兩個調用將別名文本添加到“錯誤級別”配置中,並將文本分別為“警告”和“錯誤”以及數字值100和200。接下來,我獲取了關鍵數據。GetInt方法已重載,因此,如果參數設置為true,則它將以別名而不是文字整數值載入數據。
3.3鍵值清單
Nini沒有用於返回信息列表的專用方法。這是因為 .NET Framework 的String.Split方法已經有了使用小技巧的 方法。這是一個INI文件,其中伺服器列表由豎線(“ |”)分隔符分隔:
[MailServers]
ServerList = "http://mail.yahoo.com/|http://www.hotmail.com/|http://www.mail.com/"
現在,使用Split方法,我們將伺服器列表作為字元串數組返回:
string[] serverList = source.Configs["MailServers"].Get("ServerList").Split('|');
這是VB中的示例:
Dim serverList() As String = source.Configs("MailServers").Get("ServerList").Split('|')
您可以使用Split方法使用任意數量的分度器。要有創造力。只需選擇一個不會用作鍵值的分度符即可。
3.4活動
Nini允許開發人員以非連接方式執行操作,從而使事情變得容易。通常,第一個對象可以只使用IConfig,而不必擔心其他對象如何使用它。但是,有時候知道更改配置數據的時間很有用。Nini添加了許多事件來幫助處理這些情況。
在以下情況下,類需要在保存IConfigSource時通知。
這是一個C#示例:
void SourceLoad()
{
source = new IniConfigSource();
source.Saved += new EventHandler(this.source_Saved);
}
void source_Saved(object sender, EventArgs e)
{
// 在這裡執行保存操作
}
這是一個VB示例:
Sub SourceLoad()
{
source = New IniConfigSource()
source.Saved += New EventHandler(Me.source_Saved)
}
Sub source_Saved(sender As object, e As EventArgs) Handles source.Saved
{
' perform save actions here
}
還有更多事件,例如Load,KeySet,KeyRemoved,ConfigAdded和ConfigRemoved。
4.配置類型
4.1 Ini文件
Nini具有使用100%C#編寫的內置INI解析器。這意味著,與其他INI解析器不同,它將在任何.NET平臺上運行,而不僅僅是運行Windows的平臺。另外,解析器的編寫旨在提高靈活性,這就是為什麼它支持多種INI文件類型的原因。當前支持的文件類型如下:
- Windows style (Win32 API GetPrivateProfileString)
- MySQL style
- Python Style
- Samba style
- Nini standard
區分大小寫
IniConfigSource類具有一個允許值不區分大小寫的屬性。對於使用不區分大小寫的舊Win32 API GetPrivateProfileString函數從系統升級軟體的人們,這可能是理想的。這是一個如何使用它的示例:
; 註意,load方法只是將文件名傳遞給構造函數的替代方法。
IConfigSource source = new IniConfigSource();
source.Load("MyApp.ini");
source.CaseSensitive = false;
4.2 XML文件
Nini擁有自己的XML配置文件結構。與.NET配置文件格式相比,它提供了更大的靈活性。它的主要優點是您可以擁有多個XML配置文件,並且格式更加簡潔。這是格式的示例。您會發現它非常類似於INI文件。配置值與先前示例中的INI相同:
<!-- MyApp.xml -->
<Nini>
<Section Name="Logging">
<Key Name="File Name" Value="MyApp.log" />
<Key Name="MessageColumns" Value="5" />
<Key Name="MaxFileSize" Value="40000000000000" />
</Section>
</Nini>
載入文件非常簡單:
// 載入XML文件
XmlConfigSource source = new XmlConfigSource("MyApp.xml");
// 檢索值
long maxFileSize = source.Configs["Logging"].GetLong("MaxFileSize");
這是VB中的示例:
' Loads the XML file
Dim source As New XmlConfigSource("MyApp.xml")
' Retrieves a value
Dim maxFileSize As Long = source.Configs("Logging").GetLong("MaxFileSize")
4.3 Windows註冊表配置
如果您使用的是許多Microsoft Windows操作系統之一,則可以從Windows註冊表訪問數據。這是註冊表項的示例鍵路徑:
HKEY_LOCAL_MACHINE\Sofware\MyApp\Logging
"File Name" "MyApp.log" REG_SZ
"MessageColumns" "5" REG_DWORD
"MaxFileSize" "40000000" REG_DWORD
要訪問此代碼,該方法比其他方法要複雜一些。您必須創建到註冊表項的映射。此功能還將使您能夠將許多註冊表項合併到一個IConfigSource中。這是一些訪問它的示例代碼。
這是C#中的示例:
using Microsoft.Win32;
RegistryConfigSource source = new RegistryConfigSource();
// 載入註冊表樹
source.AddMapping(Registry.LocalMachine, "Software\\MyApp\\Logging");
// 檢索值
long maxFileSize = source.Configs["Logging"].GetLong("MaxFileSize");
這是VB中的示例:
Imports Microsoft.Win32
Dim source As New RegistryConfigSource()
' Loads the registry tree
source.AddMapping(Registry.LocalMachine, "Software\\MyApp\\Logging")
' Retrieves a value
Dim maxFileSize As Long = source.Configs("Logging").GetLong("MaxFileSize")
如果您想遞歸地檢索指定註冊表項下的所有數據,也可以使用一種方法來完成。
如果要使所有子鍵位於具有統一名稱的鍵下,則可以執行以下操作:
using Microsoft.Win32;
// 載入註冊表樹及其下的所有節點
RegistryConfigSource source = new RegistryConfigSource();
source.AddMapping(Registry.LocalMachine, "Software\\MyApp", RegistryRecurse.Flattened);
string maxFileSize = source.Configs["MyApp"].GetString("SomeConfig");
long maxFileSize = source.Configs["Logging"].GetLong("MaxFileSize");
這是VB中的示例:
Imports Microsoft.Win32
' Loads the registry tree and all nodes beneath it without
Dim source As New RegistryConfigSource()
source.AddMapping(Registry.LocalMachine, "Software\\MyApp", RegistryRecurse.Flattened)
Dim maxFileSize As String = source.Configs("MyApp").GetString("SomeConfig");
Dim maxFileSize As Long = source.Configs("Logging").GetLong("MaxFileSize")
4.4 .NET配置文件
.NET Framework具有使用特定XML格式的自己的配置文件機制 。您可能在ASP.NET中以web.config 文件的形式熟悉它們。如果將它們與Windows窗體,控制台應用程式或服務一起使用,則將它們稱為[APP NAME] .exe.config文件。為了支持仍在其應用程式中使用此配置文件格式的用戶,Nini也支持這些文件。
<!-- ExampleApp.exe.config -->
<configuration>
<configSections>
<section name="Logging" type="System.Configuration.NameValueSectionHandler" />
</configSections>
<Logging>
<add key="File Name" value="MyApp.log" />
<add key="MessageColumns" value="5" />
<add key="MaxFileSize" value="40000000000000" />
</Logging>
</configuration>
訪問數據與載入INI或XML文件非常相似:
IConfigSource source = new DotNetConfigSource(DotNetConfigSource.GetFullConfigPath());
string fileName = source.Configs["Logging"].Get("File Name");
int columns = source.Configs["Logging"].GetInt("MessageColumns");
long fileSize = source.Configs["Logging"].GetLong("MaxFileSize");
這是VB中的示例:
Dim source As New DotNetConfigSource(DotNetConfigSource.GetFullConfigPath())
Dim fileName As String = source.Configs("Logging").Get("File Name")
Dim columns As Integer = source.Configs("Logging").GetInt("MessageColumns")
Dim fileSize As Long = source.Configs("Logging").GetLong("MaxFileSize")
4.5命令行(Argv)配置
自從編程開始以來,應用程式就具有接受命令行開關的能力。這些開關只是在應用程式首次啟動時傳遞給應用程式的字元串。Windows程式Xcopy具有許多命令行 開關 ,而出色的下載應用程式wget也具有其自己的 開關 。如果您想更多地瞭解.NET中命令行參數的工作方式, 請單擊此處(鏈接無效)。我們的第一個示例與您迄今為止看到的其他示例非常相似。區別在於 AddSwitch 需要為每個鍵配置調用方法。有一個短鍵和一個長鍵可用於獲取配置數據。
這是C#中的示例:
public static int Main(string[] args)
{
ArgvConfigSource source = new ArgvConfigSource(args);
source.AddSwitch("Logging", "file-name", "f");
source.AddSwitch("Logging", "columns", "c");
source.AddSwitch("Logging", "max-file-size", "m");
if(args.Length > 0)
{
string fileName = source.Configs["Logging"].Get("file-name");
int columns = source.Configs["Logging"].GetInt("columns");
long fileSize = source.Configs["Logging"].GetLong("max-file-size");
}
}
這是VB中的示例:
Public Static Function Main(args() As String) As Integer
Dim source As New ArgvConfigSource(args)
source.AddSwitch("Logging", "file-name", "f")
source.AddSwitch("Logging", "columns", "c")
source.AddSwitch("Logging", "max-file-size", "m")
If (args.Length > 0) Then
Dim fileName As String = source.Configs("Logging").Get("file-name")
Dim columns As Integer = source.Configs("Logging").GetInt("columns")
Dim fileSize As Long = source.Configs("Logging").GetLong("max-file-size")
End If
End Function
5.有效使用Nini
5.1多個用戶的處理配置
您可能會註意到,.NET 1.0和1.1的ConfigurationSettings類僅提供檢索配置值的方法。這是因為對於程式員來說,以編程方式更改整個應用程式的配置值通常是一個壞主意。全局配置應用程式的方式由管理員決定。因此,我建議您不要更改應用程式級別設置。
但是,至關重要的是,您必須允許用戶根據自己的個人喜好配置應用程式。Nini允許您創建許多不同的配置文件源,因此只需將配置文件放在正確的目錄中即可。Windows程式的標準是應用程式數據目錄:
C:\Documents and Settings[username]\Local Settings\Application Data[Application Name]\Settings.ini
您可以通過以下路徑以編程方式獲取此路徑:
string folder = Environment.GetFolderPath(Environment.SpecialFolder.ApplicationData);
5.2在資料庫中存儲配置數據
如果您正在運行ASP.NET應用程式,則每個系統中可能會有多個用戶。您可能還需要編輯許多用戶設置。大多數Web應用程式都完全配置有資料庫,因此以下是將Nini與資料庫一起使用的示例。
這是一個帶有SQL Server表的非常簡單的示例。這可以很容易地適應任何其他資料庫。這是資料庫表的結構:
CREATE TABLE UserSettings
(
UserId ID,
Settings TEXT
);
ConfigSettings欄位存儲Nini配置值。現在,您可以像這樣載入Nini配置值:
string userId = GetUserId(); // retrieve the user id somehow
SqlCommand command = new SqlCommand("SELECT Settings FROM UserSettings WHERE ID = "
+ userId, connection);
connection.Open();
SqlDataReader reader = command.ExecuteReader();
if(reader.HasRows) {
reader.Read();
IConfigSource source = new XmlConfigSource(new StringReader(reader.GetString(0)));
}
reader.Close();
connection.Close();
5.3自動創建配置文件
對於任何開發項目而言,能夠自動創建構建都是必不可少的。有幾種工具可以完成此任務,例如批處理(.bat)腳本,但是.NET Framework最受歡迎的選擇可能是 NAnt。您可能會發現自己需要使用構建管理系統來創建配置文件。為了使這些工作更輕鬆,Nini項目提供了NiniEdit(Nini命令行配置編輯器)。使用此應用程式,您可以創建和編輯任何基於文件的配置數據。NiniEditor包含在Examples目錄中的每個Nini版本中。
讓我們添加一個示例,說明如何在構建中使用NiniEdit。在第一個示例中,假設您的構建是一個批處理文件,並且您需要以編程方式創建以下INI文件:
[General]
Debug = false
Logging = On
[Logging]
FilePath = C:\temp\MyApp.log
以下調用將自動創建配置文件:
:: Create the new configuration file
niniedit --new --set-type=ini MyApp.ini
niniedit --add=General MyApp.ini
niniedit --add=Logging MyApp.ini
niniedit --config=General --set-key=Debug,false MyApp.ini
niniedit --config=General --set-key=Logging,On MyApp.ini
niniedit --config=Logging --set-key=FilePath,C:\temp\MyApp.log MyApp.ini
如果您在NAnt中執行相同的操作,則可以執行以下操作:
<exec program="niniedit" commandline="-n -s INI MyApp.ini" />
<exec program="niniedit" commandline="-a General MyApp.ini" />
<exec program="niniedit" commandline="-a Logging MyApp.ini" />
<exec program="niniedit" commandline="-c General -k Debug,false MyApp.ini" />
<exec program="niniedit" commandline="-c General -k Logging,On MyApp.ini" />
<exec program="niniedit" commandline="-c Logging -k FilePath,C:\temp\MyApp.log MyApp.ini" />
這裡的所有都是它的。NiniEdit具有其他功能,例如列出配置,鍵,鍵值和刪除鍵的功能。如果沒有其他問題,請以NiniEdit為例,說明如何使用Nini編寫自己的命令行應用程式。
5.4以編程方式創建配置文件
有時,使用應用程式以編程方式創建配置文件可能會很有用。使用Nini進行此操作非常容易。
假設您要創建在任一示例中創建的相同INI文件:
[General]
Debug = false
Logging = On
[Logging]
FilePath = C:\temp\MyApp.log
在代碼中創建代碼的方法如下:
IniConfigSource source = new IniConfigSource();
IConfig config = source.AddConfig("General");
config.Set("Debug", "false");
config.Set("Logging", "On");
config = source.AddConfig("Logging");
config.Set("FilePath", "C:\\temp\\MyApp.log");
source.Save("MyApp.ini");
5.5為您的應用程式選擇正確的配置文件類型
Nini的編寫旨在使所有配置文件類型都成為一流公民。這是因為每種配置文件類型都有其自身的優點和缺點。下麵的列表包含一些基本準則:
INI
- 速度-文件類型的解析速度非常快,因此它的載入和保存速度可能比其他類型更快。
- 可讀性-在配置類型中,這可能對用戶最不可怕。如果您要讓用戶手動更改此配置文件,那麼我強烈建議您使用此格式。
- 安裝程式-INI文件受許多類型的安裝程式支持(Wise,NSIS,僅舉幾例)。如果您需要構建來編輯這些文件,那麼絕對可以這樣做。
XML
- 速度-XML解析器要載入很多信息,因此這可能是最慢的。
- 可讀性-這種格式對於初學者來說有點嚇人。
- 支持-所有編程語言都支持此功能,因此,如果其他應用程式正在訪問數據,那麼這是一個很好的類型。
- 安裝程式-由於配置文件沒有標準的XML格式,因此安裝程式通常不支持此格式。
.NET配置文件
- 速度-XML解析器要載入很多信息,因此這可能是最慢的。
- 可讀性-這種格式對於初學者來說有點嚇人。
- 安裝程式-.NET Framework將這些配置文件用於其他配置。如果將.NET配置和您自己的應用程式配置選項混合使用,我建議不要使用它。
Windows註冊表
- 速度-快速檢索配置數據。隨著註冊表越來越多地填充數據,檢索速度的確會變慢。這被認為是定期重新安裝Windows可以使電腦運行更快的原因之一。
- 可讀性-如果您確實不希望用戶能夠配置應用程式,則應使用此類型。觸摸註冊表可能會導致嚴重問題,因此建議除非必要,否則不要使用它。但是,請註意,如果您的支持人員需要用戶調整配置設置,他們將遇到與用戶相同的問題。除此之外,配置文件編輯器是眾所周知的並且很成熟。
- 安裝程式-大多數安裝程式支持讀取和編輯註冊表項,因此這是一個不錯的選擇。
沒有完美的配置類型,因為每個配置都有自己的優勢。如果最終選擇的配置文件類型不適合您的情況,則不要驚慌。Nini提取了您要訪問的文件類型,因此您必須更改的代碼量應該最少。
本教程就是這樣。希望對您有所幫助!如果您有任何關於改進本手冊的問題或建議,請訪問Nini主頁,並使用論壇,錯誤跟蹤器或功能請求工具來表達自己的意見。