DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
用 XML 打造好維護的系統日誌機制
編輯:XML詳解     

在一個稍具規模的系統裡,日誌是最容易被低估、卻在故障排查時最被依賴的一塊。如果軟體要同時維護多個開發版本,把日誌文案與對應規則硬寫進程式碼,不用多久就會演變成難以收拾的局面。以下分享一種把日誌定義抽到外部 XML 檔案的實作思路。

一、先定義日誌設定檔

在執行檔所在目錄放一份 LogMessage.XML,作為日誌的「字典」:

<?xml version="1.0" encoding="gb2312"?>
<log-File fileName="ObtGcom.log"/>
<log-Driver logDriverName="ObtGcomLogDriver"/>
<log-Mappings>
  <log-Mapping code="VPR1001" logType="warning" logMessage="not printer"/>
  <log-Mapping code="VPR1002" logType="warning" logMessage="122System error"/>
</log-Mappings>

三個區塊各司其職:log-File 決定日誌檔名,log-Driver 指定負責寫入的驅動,log-Mappings 則是「代碼 → 等級 → 訊息」的對照表。

二、程式碼裡只留代碼

使用時先引入標頭檔 ObtGcomCommonLog.h,然后在需要記錄的位置呼叫:

ObtGcomCommonLog::writeMesLog(CString code);

傳入的 code 就是 XML 中 log-Mapping 的 code 屬性。程式碼裡看不到任何一句提示文字,這正是這個設計的關鍵——訊息的內容與語氣完全交給設定檔決定。

三、多語言版本只需換一份 XML

要出中文版,把同一份檔案的內容替換即可,程式碼一行都不用改:

<?xml version="1.0" encoding="gb2312"?>
<log-File fileName="ObtGcom.log"/>
<log-Driver logDriverName="ObtGcomLogDriver"/>
<log-Mappings>
  <log-Mapping code="VPR1001" logType="warning" logMessage="印表機異常"/>
  <log-Mapping code="VPR1002" logType="warning" logMessage="系統錯誤 122"/>
</log-Mappings>

四、這樣做換來什麼

  • 文案與邏輯分離:修改措辭、調整枚舉層級,不必重新編譯。
  • 多語言成本極低:新增語系只要多準備一份 XML,甚至可透過 encoding 屬性切換編碼。
  • 日誌可讀性提升:程式碼中到處是 VPR1001 這類代碼,比散落的中英文提示更容易統一管理與 grep。
  • 便於擴充:日誌等級、輸出檔名、驅動方式都在同一處調整。

實務上建議再補一層保護:當 XML 找不到或某個 code 未定義時,要有預設訊息(例如直接輸出代碼本身)並記錄一次警告,避免設定檔出錯反而讓日誌機制整個失效。

XML學習教程| jQuery入門知識| AJAX入門| Dreamweaver教程| Fireworks入門知識| SEO技巧| SEO優化集錦|
Copyright © DIV+CSS佈局教程網 All Rights Reserved