在本系列的技巧(1)和技巧(2)中分别介绍了使用外部配置文件,使用数据库记录配置信息两种方法,不知道大家有没有想过不使用任何配置文件,也不使用数据库而直接用编程的方法来实现呢?本文将会展示如何使用编程的方法来配置Logging Application Block。首先我们需要了解一下Logging Application Block中比较重要的几个对象:
1.LogFormatter
格式化对象,LogFormatter有TextFormatter和BinaryFormatter两种,多数情况下我们会使用TextFormatter,它通过一个Template来创建,一个完整的Template格式如下:
Timestamp: {timestamp}{newline}
![](/Images/OutliningIndicators/None.gif)
Message: {message}{newline}
![](/Images/OutliningIndicators/None.gif)
Category: {category}{newline}
![](/Images/OutliningIndicators/None.gif)
Priority: {priority}{newline}
![](/Images/OutliningIndicators/None.gif)
EventId: {eventid}{newline}
![](/Images/OutliningIndicators/None.gif)
Severity: {severity}{newline}
![](/Images/OutliningIndicators/None.gif)
Title:{title}{newline}
![](/Images/OutliningIndicators/None.gif)
Machine: {machine}{newline}
![](/Images/OutliningIndicators/None.gif)
Application Domain: {appDomain}{newline}
![](/Images/OutliningIndicators/None.gif)
Process Id: {processId}{newline}
![](/Images/OutliningIndicators/None.gif)
Process Name: {processName}{newline}
![](/Images/OutliningIndicators/None.gif)
Win32 Thread Id: {win32ThreadId}{newline}
![](/Images/OutliningIndicators/None.gif)
Thread Name: {threadName}{newline}
![](/Images/OutliningIndicators/None.gif)
Extended Properties: {dictionary({key} - {value})}{newline}
这里就不具体解释每一项的含义,大家可以参考有关文档,示例代码:
const string Template = "Timestamp: {timestamp}{newline}" +
![](/Images/OutliningIndicators/None.gif)
"Message: {message}{newline}" +
![](/Images/OutliningIndicators/None.gif)
"Category: {category}{newline}" +
![](/Images/OutliningIndicators/None.gif)
"Machine: {machine}{newline}";
![](/Images/OutliningIndicators/None.gif)
TextFormatter formatter = new TextFormatter(Template);
2.TraceListener
TraceListener提供了日志记录服务,它指定的是日志将被记录到何处,数据库中或者是文本文件,Enterprise Library提供了7种
TraceListener:Database TraceListener、Email TraceListener、Flat File TraceListener、Formatter Event Log TraceListener、Msmq TraceListener、System Diagnostics TraceListener、WMI Trace Listener。每一种TraceListener都需要一个LogFormatter来对记录的信息进行格式化,例如创建一个FlatFileTraceListener实例:
const string LogFilePath = @"d:\\share\\messages.log";
![](/Images/OutliningIndicators/None.gif)
FlatFileTraceListener logFileListener =
![](/Images/OutliningIndicators/None.gif)
new FlatFileTraceListener(LogFilePath,
![](/Images/OutliningIndicators/None.gif)
"----------",
![](/Images/OutliningIndicators/None.gif)
"----------",
![](/Images/OutliningIndicators/None.gif)
formatter);
这里的formatter就是在上面创建的TextFormatter对象。
3.LogSource
LogSource其实就是TraceListener的集合,Enterprise Library允许针对不同的日志信息记录到不同地方,因此可以在LogSource中加入多个TraceListener:
LogSource mainLogSource =
![](/Images/OutliningIndicators/None.gif)
new LogSource("MainLogSource", SourceLevels.All);
![](/Images/OutliningIndicators/None.gif)
mainLogSource.Listeners.Add(logFileListener);
4.LogFilter
过滤器,对日志信息进行过滤,Enterprise Library默认提供了三种过滤器,用户也可以定义自己的过滤器,示例代码:
// 创建一个类别过滤器
![](/Images/OutliningIndicators/None.gif)
ICollection<string> categoryfilters = new List<string>();
![](/Images/OutliningIndicators/None.gif)
categoryfilters.Add(DebugCategory);
![](/Images/OutliningIndicators/None.gif)
CategoryFilter categoryFilter = new CategoryFilter("CategoryFilter", categoryfilters, CategoryFilterMode.AllowAllExceptDenied);
![](/Images/OutliningIndicators/None.gif)
![](/Images/OutliningIndicators/None.gif)
// 加入类别过滤器到集合中
![](/Images/OutliningIndicators/None.gif)
ICollection<ILogFilter> filters = new List<ILogFilter>();
了解了这四个对象,其实我们就已经知道了该如何去用编程的方法配置Logging Application Block,下面给出一个简单的例子,先写一个MyLogger静态类:
using System;
![](/Images/OutliningIndicators/None.gif)
using System.Collections.Generic;
![](/Images/OutliningIndicators/None.gif)
using System.Diagnostics;
![](/Images/OutliningIndicators/None.gif)
using Microsoft.Practices.EnterpriseLibrary.Logging;
![](/Images/OutliningIndicators/None.gif)
using Microsoft.Practices.EnterpriseLibrary.Common.Configuration;
![](/Images/OutliningIndicators/None.gif)
using Microsoft.Practices.EnterpriseLibrary.Logging.Filters;
![](/Images/OutliningIndicators/None.gif)
using Microsoft.Practices.EnterpriseLibrary.Logging.Formatters;
![](/Images/OutliningIndicators/None.gif)
using Microsoft.Practices.EnterpriseLibrary.Logging.TraceListeners;
![](/Images/OutliningIndicators/None.gif)
public static class MyLogger
![](/Images/OutliningIndicators/None.gif)
![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
![](/Images/OutliningIndicators/ContractedBlock.gif)
{
![](/Images/OutliningIndicators/InBlock.gif)
static readonly LogWriter _writer;
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
// 日至记录的类别
![](/Images/OutliningIndicators/InBlock.gif)
const string ErrorCategory = "Error";
![](/Images/OutliningIndicators/InBlock.gif)
const string DebugCategory = "Debug";
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
// 文本文件的路径
![](/Images/OutliningIndicators/InBlock.gif)
const string LogFilePath = @"d:\\share\\messages.log";
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
// 模版
![](/Images/OutliningIndicators/InBlock.gif)
const string Template = "Timestamp: {timestamp}{newline}" +
![](/Images/OutliningIndicators/InBlock.gif)
"Message: {message}{newline}" +
![](/Images/OutliningIndicators/InBlock.gif)
"Category: {category}{newline}" +
![](/Images/OutliningIndicators/InBlock.gif)
"Machine: {machine}{newline}";
![](/Images/OutliningIndicators/InBlock.gif)
static MyLogger()
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
{
![](/Images/OutliningIndicators/InBlock.gif)
// 实例化一个TextFormatter,使用前面定义的模版
![](/Images/OutliningIndicators/InBlock.gif)
TextFormatter formatter = new TextFormatter
![](/Images/OutliningIndicators/InBlock.gif)
(Template);
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
// 实例化TraceListener,记录到文本文件用FlatFileTraceListener
![](/Images/OutliningIndicators/InBlock.gif)
FlatFileTraceListener logFileListener =
![](/Images/OutliningIndicators/InBlock.gif)
new FlatFileTraceListener(LogFilePath,
![](/Images/OutliningIndicators/InBlock.gif)
"----------",
![](/Images/OutliningIndicators/InBlock.gif)
"----------",
![](/Images/OutliningIndicators/InBlock.gif)
formatter);
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
// 这里是TraceListener的集合,可以增加多个
![](/Images/OutliningIndicators/InBlock.gif)
LogSource mainLogSource =
![](/Images/OutliningIndicators/InBlock.gif)
new LogSource("MainLogSource", SourceLevels.All);
![](/Images/OutliningIndicators/InBlock.gif)
mainLogSource.Listeners.Add(logFileListener);
![](/Images/OutliningIndicators/InBlock.gif)
IDictionary<string, LogSource> traceSources = new Dictionary<string, LogSource>();
![](/Images/OutliningIndicators/InBlock.gif)
traceSources.Add(ErrorCategory, mainLogSource);
![](/Images/OutliningIndicators/InBlock.gif)
traceSources.Add(DebugCategory, mainLogSource);
![](/Images/OutliningIndicators/InBlock.gif)
// 用来表示不记录日志,这点需要注意一下
![](/Images/OutliningIndicators/InBlock.gif)
LogSource nonExistantLogSource = new LogSource("Empty");
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
// 创建一个类别过滤器
![](/Images/OutliningIndicators/InBlock.gif)
ICollection<string> categoryfilters = new List<string>();
![](/Images/OutliningIndicators/InBlock.gif)
categoryfilters.Add(DebugCategory);
![](/Images/OutliningIndicators/InBlock.gif)
CategoryFilter categoryFilter = new CategoryFilter("CategoryFilter", categoryfilters, CategoryFilterMode.AllowAllExceptDenied);
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
// 加入类别过滤器到集合中
![](/Images/OutliningIndicators/InBlock.gif)
ICollection<ILogFilter> filters = new List<ILogFilter>();
![](/Images/OutliningIndicators/InBlock.gif)
filters.Add(categoryFilter);
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
_writer = new LogWriter(filters,
![](/Images/OutliningIndicators/InBlock.gif)
traceSources,
![](/Images/OutliningIndicators/InBlock.gif)
nonExistantLogSource,
![](/Images/OutliningIndicators/InBlock.gif)
nonExistantLogSource,
![](/Images/OutliningIndicators/InBlock.gif)
mainLogSource,
![](/Images/OutliningIndicators/InBlock.gif)
ErrorCategory,
![](/Images/OutliningIndicators/InBlock.gif)
false,
![](/Images/OutliningIndicators/InBlock.gif)
true);
![](/Images/OutliningIndicators/InBlock.gif)
}
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
/**//// <summary>
![](/Images/OutliningIndicators/InBlock.gif)
/// 记录日志信息到Error,默认类别
![](/Images/OutliningIndicators/InBlock.gif)
/// </summary>
![](/Images/OutliningIndicators/InBlock.gif)
/// <param name="message">日志信息</param>
![](/Images/OutliningIndicators/InBlock.gif)
public static void Write(string message)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
{
![](/Images/OutliningIndicators/InBlock.gif)
Write(message, ErrorCategory);
![](/Images/OutliningIndicators/InBlock.gif)
}
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
/**//// <summary>
![](/Images/OutliningIndicators/InBlock.gif)
/// 记录日志信息到特定类别
![](/Images/OutliningIndicators/InBlock.gif)
/// </summary>
![](/Images/OutliningIndicators/InBlock.gif)
/// <param name="message">日志信息</param>
![](/Images/OutliningIndicators/InBlock.gif)
/// <param name="category">类别</param>
![](/Images/OutliningIndicators/InBlock.gif)
public static void Write(string message, string category)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
{
![](/Images/OutliningIndicators/InBlock.gif)
LogEntry entry = new LogEntry();
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
entry.Categories.Add(category);
![](/Images/OutliningIndicators/InBlock.gif)
entry.Message = message;
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/InBlock.gif)
_writer.Write(entry);
![](/Images/OutliningIndicators/InBlock.gif)
}
![](/Images/OutliningIndicators/InBlock.gif)
}
我们再来写一个简单的测试,注意上面的代码中我们过滤掉了Debug类别的日志信息,这样记录到文本文件中的日志信息应该只有My Error一条:
public partial class _Default : System.Web.UI.Page
![](/Images/OutliningIndicators/None.gif)
![](/Images/OutliningIndicators/ExpandedBlockStart.gif)
![](/Images/OutliningIndicators/ContractedBlock.gif)
{
![](/Images/OutliningIndicators/InBlock.gif)
protected void Page_Load(object sender, EventArgs e)
![](/Images/OutliningIndicators/InBlock.gif)
![](/Images/OutliningIndicators/ExpandedSubBlockStart.gif)
{
![](/Images/OutliningIndicators/InBlock.gif)
MyLogger.Write("My Error");
![](/Images/OutliningIndicators/InBlock.gif)
MyLogger.Write("My Debug", "Debug");
![](/Images/OutliningIndicators/InBlock.gif)
}
![](/Images/OutliningIndicators/InBlock.gif)
}
文本文件中输出的结果为:
----------
Timestamp: 2006-7-8 3:45:05
Message: My Error
Category: Error
Machine: RJ-097
----------
输出的结果与我们设想的一致,使用编程的方法配置Logging Application Block简单的就介绍到这里,你也可以使用这种方法来配置其他的应用程序块。不过使用编程的方法来配置,失去了EL的灵活性,要知道EL的根本思想就是配置驱动,但是如果掌握了这些,也许你能够更好的使用EL,在CodeProject上有人写了一篇《Plug-in Manager for Logging - Configure MSEL2 On the fly》,有兴趣的朋友不妨参考一下。
参考:
http://davidhayden.com/blog/dave/archive/2006/02/18/2805.aspx
http://geekswithblogs.net/akraus1/archive/2006/02/16/69784.aspx