整理修改的一个日志类,用生产与消费模式实现,消费模式用了异步执行
using System;
using System.Collections.Generic;
using System.Linq;
using System.Text;
using System.IO;
using System.Threading;
namespace Wyw.Log
{
/// <summary>
/// 日志类
/// </summary>
/// <remarks>
/// 当调用Write方法时不会造成线程阻塞,而是立即完成方法调用,因此调用线程不用等待日志写入文件之后才返回。
/// </remarks>
public class Logger
{
public static void Write(string msgText)
{
Write(DateTime.Now, MsgType.Information, "", msgText);
}
/// <summary>
/// 写日志基础方法
/// </summary>
/// <param name="msgDataTime"></param>
/// <param name="msgType"></param>
/// <param name="msgLocation"></param>
/// <param name="msgText"></param>
public static void Write(DateTime msgDataTime, MsgType msgType, string msgLocation, string msgText)
{
QueueManager qm = new QueueManager();
qm.WriteToQueue(msgDataTime, msgType, msgLocation, msgText);
}
#region QueueManager
/// <summary>
/// 企业应用框架的日志类
/// </summary>
private class QueueManager : IDisposable
{
/// <summary>
/// 日志对象的缓存队列
/// </summary>
private static Queue<Msg> msgsQueue;
/// <summary>
/// 日志文件保存的路径
/// </summary>
private static string path = "Logs\\";
/// <summary>
/// 日志写入文件线程的控制标记,true为正在写入
/// </summary>
private static bool state=false;
/// <summary>
/// 日志文件生命周期的时间标记
/// </summary>
private static DateTime TimeSign;
/// <summary>
/// 日志文件写入流对象
/// </summary>
private static StreamWriter writer;
private delegate void workDelegate();
private static workDelegate workDg;
/// <summary>
/// 初始化
/// </summary>
public QueueManager()
{
if (msgsQueue == null)
{
if (!Directory.Exists(path))
Directory.CreateDirectory(path);
msgsQueue = new Queue<Msg>();
workDg = new workDelegate(work);
}
}
/// <summary>
/// 写入新日志,根据指定的日志对象Msg
/// </summary>
/// <param name="msg">日志内容对象</param>
private void WriteToQueue(Msg msg)
{
if (msg != null)
{
lock (msgsQueue)
{
msgsQueue.Enqueue(msg);
}
}
if (msgsQueue.Count>0&&!state)
{
state = true;
workDg.BeginInvoke(null, null);
}
}
/// <summary>
/// 日志写入文件线程执行的方法,消费者
/// </summary>
private void work()
{
Msg msg = null;
//判断队列中是否存在待写入的日志
while (msgsQueue.Count > 0)
{
lock (msgsQueue)
{
msg = msgsQueue.Dequeue();
}
if (msg != null)
{
WriteToFile(msg);
}
}
state = false;
FileClose();
}
/// <summary>
/// 通过判断文件的到期时间标记将决定是否创建新文件。
/// </summary>
/// <returns></returns>
private string GetFilename()
{
DateTime now = DateTime.Now;
string format = "yyyyMMdd'.log'";
TimeSign = new DateTime(now.Year, now.Month, now.Day);
TimeSign = TimeSign.AddDays(1);
return now.ToString(format);
}
/// <summary>
/// 写入日志文本到文件的方法
/// </summary>
/// <param name="msg"></param>
private void WriteToFile(Msg msg)
{
try
{
if (writer == null)
{
FileOpen();
}
//判断文件到期标志,如果当前文件到期则关闭当前文件创建新的日志文件
if (DateTime.Now >= TimeSign)
{
FileClose();
FileOpen();
}
writer.WriteLine(string.Format("{0}", msg.Datetime) + "\t" + msg.Type + "\t" + msg.Location + "\t" + msg.Text);
writer.Flush();
}
catch (Exception e)
{
Console.Out.Write(e);
}
}
//打开文件准备写入
private void FileOpen()
{
writer = new StreamWriter(path + GetFilename(), true, Encoding.UTF8);
}
//关闭打开的日志文件
private void FileClose()
{
if (writer != null)
{
writer.Flush();
writer.Close();
writer.Dispose();
writer = null;
}
}
/// <summary>
/// 写入新日志,根据指定的日志时间、日志内容和信息类型写入新日志
/// </summary>
/// <param name="dt">日志时间</param>
/// <param name="text">日志内容</param>
/// <param name="type">信息类型</param>
public void WriteToQueue(DateTime msgDataTime, MsgType msgType, string msgLocation, string msgText)
{
WriteToQueue(new Msg(msgDataTime, msgType, msgLocation, msgText));
}
#region IDisposable 成员
/// <summary>
/// 销毁日志对象
/// </summary>
public void Dispose()
{
state = false;
}
#endregion
#endregion
#region Msg
/// <summary>
/// 表示一个日志记录的对象
/// </summary>
private class Msg
{
//日志记录的时间
private DateTime datetime;
//日志记录的类型
private MsgType type;
/// <summary>
/// 日志位置
/// </summary>
private string location;
//日志记录的内容
private string text;
/// <summary>
/// 创建新的日志记录实例;
/// </summary>
/// <param name="msgDataTime"></param>
/// <param name="msgType"></param>
/// <param name="msgLocation"></param>
/// <param name="msgText"></param>
public Msg(DateTime msgDataTime, MsgType msgType, string msgLocation, string msgText)
{
datetime = msgDataTime;
type = msgType;
location = msgLocation;
text = msgText;
}
/// <summary>
/// 获取或设置日志记录的时间
/// </summary>
public DateTime Datetime
{
get { return datetime; }
set { datetime = value; }
}
public string Location
{
get { return location; }
set { location = value; }
}
/// <summary>
/// 获取或设置日志记录的消息类型
/// </summary>
public MsgType Type
{
get { return type; }
set { type = value; }
}
/// <summary>
/// 获取或设置日志记录的文本内容
/// </summary>
public string Text
{
get { return text; }
set { text = value; }
}
}
}
#endregion
#region MsgType
/// <summary>
/// 日志消息类型的枚举
/// </summary>
public enum MsgType
{
/// <summary>
/// 普通信息类型的日志记录
/// </summary>
Information,
/// <summary>
/// 警告信息类型的日志记录
/// </summary>
Warning,
/// <summary>
/// 错误信息类型的日志记录
/// </summary>
Error,
/// <summary>
/// 成功信息类型的日志记录
/// </summary>
Success,
/// <summary>
/// 致命类型的日志记录
/// </summary>
Fatal
}
#endregion
}
}