DIV CSS 佈局教程網

您现在的位置: DIV+CSS佈局教程網 >> 網頁腳本 >  >> XML學習教程 >> XML詳解
用 XML 檔記錄操作日誌:DataSet 天生就適合的做法
編輯:XML詳解     

操作日誌可以寫進資料庫、純文字檔或 XML 檔。本文選擇 XML,理由有三點:

  • 不佔用資料庫空間,歷史日誌想刪就刪,不必擔心影響線上資料。
  • DataTable 讀寫 XML 都是原生支援,ReadXml 與 WriteXml 一來一往即可,不必自己組字串或寫解析器。
  • 查看方便——直接用記事本打開 XML 就能看,要統計或篩選時再讀進 DataTable 用程式處理。

一、建立資料集結構

先定義 JobLogDataSet.xsd,包含六個欄位:TraceLevel(日誌類型)、User(使用者)、DateTime(操作時間)、Module(模組)、Function(功能)、Message(訊息)。欄位不夠可以自己擴充。其中 TraceLevel 對應 Info、Warning、Error、Trace、Off 五種層級。

二、定義日誌類型

/// <summary>
/// 日誌類型
/// </summary>
public enum LogType
{
    /// <summary>一般資訊</summary>
    Info,
    /// <summary>警告</summary>
    Warning,
    /// <summary>錯誤</summary>
    Error,
    /// <summary>追蹤</summary>
    Trace,
    /// <summary>不記錄日誌</summary>
    Off
}

三、寫日誌

設計上每個檔案存一天的紀錄,檔名格式為 JobLog yyyy-MM-dd.xml。流程是:檔案不存在就先建一份空表,接著讀回既有內容、附加一筆新記錄、再整份寫回。遇到 Off 層級直接返回,不留下任何痕跡。

/// <summary>
/// 寫日誌
/// </summary>
public static void WriteLog(LogType logType, string user, string module,
                            string function, string message)
{
    try
    {
        //類型為 Off 的不記錄
        if (logType == LogType.Off) return;

        JobLogDataSet.JobLogDataTable t = new JobLogDataSet.JobLogDataTable();

        //每天一個檔案:JobLog yyyy-MM-dd.xml
        string jobLogFile = AppDomain.CurrentDomain.BaseDirectory
                          + "JobLog " + DateTime.Today.ToString("yyyy-MM-dd") + ".xml";
        if (!File.Exists(jobLogFile))
            t.WriteXml(jobLogFile);      //先建立空檔,帶出結構

        t.ReadXml(jobLogFile);           //讀回既有記錄

        JobLogDataSet.JobLogRow r = t.NewJobLogRow();
        r.TraceLevel = logType.ToString();
        r.User       = user;
        r.DateTime   = DateTime.Now;
        r.Module     = module;
        r.Function   = function;
        r.Message    = message;
        t.AddJobLogRow(r);

        t.WriteXml(jobLogFile);          //整份寫回
    }
    catch (Exception)
    {
        //日誌失敗不應中斷主流程,這裡刻意吞掉例外
    }
}

這個「讀—加—寫」的模式簡單可靠,缺點是每次寫入都要重讀整份檔案,日誌量大時 I/O 成本會線性上升。若日誌頻繁,建議改為先累積在記憶體中,定時或關機時再一次落盤。

四、讀日誌

讀取時用 Directory.GetFiles 抓出所有 JobLog*.xml,逐一讀進暫存表,再用 ImportRow 併入主表,一次拿到跨日的完整紀錄。

/// <summary>
/// 讀日誌
/// </summary>
/// <returns>回傳合併後的日誌 DataTable</returns>
public static JobLogDataSet.JobLogDataTable ReadLog()
{
    JobLogDataSet.JobLogDataTable jobLogDataTable = new JobLogDataSet.JobLogDataTable();
    try
    {
        //取出應用程式目錄下所有日誌檔
        string[] jobLogFiles = Directory.GetFiles(
            AppDomain.CurrentDomain.BaseDirectory, "JobLog*.xml", SearchOption.TopDirectoryOnly);

        foreach (string jobLogFile in jobLogFiles)
        {
            if (!File.Exists(jobLogFile)) continue;

            //讀入暫地表
            JobLogDataSet.JobLogDataTable t = new JobLogDataSet.JobLogDataTable();
            t.ReadXml(jobLogFile);

            //併入主表
            foreach (JobLogDataSet.JobLogRow r in t)
                jobLogDataTable.ImportRow(r);
        }
        return jobLogDataTable;
    }
    catch (Exception)
    {
        return jobLogDataTable;   //出錯時回傳空表,讓呼叫端不至于崩潰
    }
}

五、使用方式

需要留下的地方直接呼叫即可,例如:

LogUtil.WriteLog(LogType.Info, "admin", "訂單模組", "SubmitOrder", "訂單 A1234 建立成功");
LogUtil.WriteLog(LogType.Error, "admin", "訂單模組", "SubmitOrder", "庫存查詢逾時");

幾個實務上的提醒

第一,多執行緒或多人同時寫入同一支 XML 檔會發生檔案鎖定衝突,Web 應用建議加鎖(lock)或改用專用日誌元件。第二,訊息內容若含使用者輸入,寫入前應做 XML 特殊字元處理,避免破壞文件結構。第三,XML 是純文字,敏感欄位若要記錄,記得先遮罩或加密。第四,日誌檔會隨時間累積,最好加一支排程定期清理超過保存期限的檔案。

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