實務上常遇到這樣的需求:一份組態檔描述分站站台位址與資料庫中商戶編號前綴的對應關係,需要在程式啟動時讀進來。把它作為「嵌入資源」打包進組件,可以省去部署時另外管理檔案的麻煩。
<?XML version="1.0" encoding="utf-8"?> <!-- 組態 DoMain 和 商家編號前綴對應組態 --> <DoMain> <SubMain name="qz" pre="01002"></SubMain> <SubMain name="yw" pre="01003"></SubMain> <SubMain name="wl" pre="01030"></SubMain> <SubMain name="cq" pre="02001"></SubMain> <SubMain name="cq" pre="02002"></SubMain> </DoMain>
接著在 Visual Studio 裡點選檔案屬性,把「建置動作」設為嵌入資源。這一步是關鍵,少了它,後面的程式碼永遠找不到檔案。
引入該組件之後,於應用程式啟動事件中讀取:
protected void Application_Start(object sender, EventArgs e)
{
// log4net.Config.XmlConfigurator.Configure(new System.IO.FileInfo("Log4Net.config"));
// 系統一啟動,最先組態分站和城市 Prov 代碼的映射
Assembly assembly = Assembly.Load("程序集名稱");
Stream stream = assembly.GetManifestResourceStream(
"程序集名稱.DoMainMapping.cfg.XML");
XmlDocument xmlDoc = null;
xmlDoc = new XmlDocument();
xmlDoc.Load(stream);
}
執行到這裡,就能取得這份組態檔的內容了。
第一,資源名稱必須完全正確。GetManifestResourceStream 用的是資源的邏輯名稱,預設由「預設命名空間 + 資料夾路徑 + 檔名」組成,且一律以句點分隔。名字寫錯時它不會報錯,只會回傳 null,接著在 xmlDoc.Load(stream) 這行丟出參數為空的例外——症狀很容易誤導人往檔案路徑的方向找。除錯時可以先用 assembly.GetManifestResourceNames() 把實際名稱全部印出來確認。
第二,記得釋放 Stream。嵌入資源的資料流由組件維護,用完應該包在 using 區塊裡,或明確呼叫 Dispose,避免長期累積佔用。若這份組態整個應用程式生命週期都用得到,比較好的做法是在啟動時讀一次、解析成字典物件後放進快取,後續直接取用,不必每次重複開啟資料流。
順帶一提,如果組態內容會由維運人員隨時調整,那麼嵌入資源並不適合——它需要重新編譯才能生效。這種情況應該改用 app.config 或獨立的外置 XML 檔,並搭配組態變更的重新載入機制。