通过Xml文件配置log4net TextBoxAppender（自定义appender）

这是我的问题的后续问题： 灵活的日志记录界面……

我现在想为我的WinForms 2.0应用程序为多行TextBox编写一个自定义log4net appender。 其中一个StackOverflow成员devdigital已经向我指出了这个链接：

TextBox Appender

但是，本文没有介绍如何通过Xml文件配置这样的appender。 配置此appender的独特问题是我们需要将对TextBox对象的引用传递给此appender。

那么可以使用Xml文件配置它吗？ 或者这样的appender只能以编程方式配置？ 有哪些选项使其可配置或松散耦合，可能是使用Xml文件和代码的组合？

谢谢。

Answer 1

这取决于你如何配置log4net的方式，但是当log4net读取配置时通常不会创建任何表单（因此也就是textBoxes）。 因此，您需要为表单和文本框名称创建属性。 您应该检查表单是否已打开，并且在附加日志记录事件之前提供了文本框。 从头开始实现IAppender比从AppenderSkeletoninheritance更好：

 public class TextBoxAppender : AppenderSkeleton { private TextBox _textBox; public string FormName { get; set; } public string TextBoxName { get; set; } protected override void Append(LoggingEvent loggingEvent) { if (_textBox == null) { if (String.IsNullOrEmpty(FormName) || String.IsNullOrEmpty(TextBoxName)) return; Form form = Application.OpenForms[FormName]; if (form == null) return; _textBox = form.Controls[TextBoxName] as TextBox; if (_textBox == null) return; form.FormClosing += (s, e) => _textBox = null; } _textBox.AppendText(loggingEvent.RenderedMessage + Environment.NewLine); } } 

配置很简单（log4net将读取xml元素并为具有相同名称的属性提供值）：

我没有提供任何与multithreading和线程同步相关的error handling代码或代码，因为问题是关于appender配置。

Answer 2

这是所有上层注释的更新版本：线程安全，不锁定应用程序并使用转换模式：

 namespace MyNamespace { public class TextBoxAppender : AppenderSkeleton { private TextBox _textBox; public TextBox AppenderTextBox { get { return _textBox; } set { _textBox = value; } } public string FormName { get; set; } public string TextBoxName { get; set; } private Control FindControlRecursive(Control root, string textBoxName) { if (root.Name == textBoxName) return root; foreach (Control c in root.Controls) { Control t = FindControlRecursive(c, textBoxName); if (t != null) return t; } return null; } protected override void Append(log4net.Core.LoggingEvent loggingEvent) { if (_textBox == null) { if (String.IsNullOrEmpty(FormName) || String.IsNullOrEmpty(TextBoxName)) return; Form form = Application.OpenForms[FormName]; if (form == null) return; _textBox = (TextBox)FindControlRecursive(form, TextBoxName); if (_textBox == null) return; form.FormClosing += (s, e) => _textBox = null; } _textBox.BeginInvoke((MethodInvoker)delegate { _textBox.AppendText(RenderLoggingEvent(loggingEvent)); }); } } } 

配置，将其放在app.config中：

Answer 3

我修改了appender以使用multithreading。 另外，我附加了代码配置。

问候，多林

追加程序：

 public class TextBoxAppender : AppenderSkeleton { private TextBox _textBox; public TextBox AppenderTextBox { get { return _textBox; } set { _textBox = value; } } public string FormName { get; set; } public string TextBoxName { get; set; } private Control FindControlRecursive(Control root, string textBoxName) { if (root.Name == textBoxName) return root; foreach (Control c in root.Controls) { Control t = FindControlRecursive(c, textBoxName); if (t != null) return t; } return null; } protected override void Append(log4net.Core.LoggingEvent loggingEvent) { if (_textBox == null) { if (String.IsNullOrEmpty(FormName) || String.IsNullOrEmpty(TextBoxName)) return; Form form = Application.OpenForms[FormName]; if (form == null) return; _textBox = (TextBox)FindControlRecursive(form, TextBoxName); if (_textBox == null) return; form.FormClosing += (s, e) => _textBox = null; } _textBox.Invoke((MethodInvoker)delegate { _textBox.AppendText(loggingEvent.RenderedMessage + Environment.NewLine); }); } } 

组态：

  var textBoxAppender = new Util.TextBoxAppender(); textBoxAppender.TextBoxName = "textLog"; textBoxAppender.FormName = "MainTarget"; textBoxAppender.Threshold = log4net.Core.Level.All; var consoleAppender = new log4net.Appender.ConsoleAppender { Layout = new log4net.Layout.SimpleLayout() }; var list = new AppenderSkeleton[] { textBoxAppender, consoleAppender }; log4net.Config.BasicConfigurator.Configure(list); 

Answer 4

附加到文本框的实际行应该是……

 _textBox.AppendText(RenderLoggingEvent(loggingEvent)); 

…如果你想利用图案布局。 否则，它只发送消息的文本（默认布局）。

Answer 5

以上Klodoma的样本非常好。 如果将文本框更改为richtextbox，则可以对输出执行更多操作。 以下是一些按级别对消息进行颜色编码的代码：

  System.Drawing.Color text_color; switch (loggingEvent.Level.DisplayName.ToUpper()) { case "FATAL": text_color = System.Drawing.Color.DarkRed; break; case "ERROR": text_color = System.Drawing.Color.Red; break; case "WARN": text_color = System.Drawing.Color.DarkOrange; break; case "INFO": text_color = System.Drawing.Color.Teal; break; case "DEBUG": text_color = System.Drawing.Color.Green; break; default: text_color = System.Drawing.Color.Black; break; } _TextBox.BeginInvoke((MethodInvoker)delegate { _TextBox.SelectionColor = text_color; _TextBox.AppendText(RenderLoggingEvent(loggingEvent)); }); 

如果你真的想要，可以用与ColorConsoleAppender相同的方式从log4net配置映射颜色，但我留给那个下一个编码器偶然发现这个样本……

Answer 6

如果您想在应用程序中的多个位置进行日志记录，我更愿意采用以下方法。 此方法提供了通过代码动态更改控件实例的灵活性。

TextBoxAppender

 public class TextBoxAppender : AppenderSkeleton { public RichTextBox RichTextBox { get; set; } protected override void Append(LoggingEvent loggingEvent) { Action operation = () => { this.RichTextBox.AppendText(RenderLoggingEvent(loggingEvent)); }; this.RichTextBox.Invoke(operation); } } 

分配文本框实例的代码。 在开始执行日志记录的过程之前执行此操作。

  var appender = LogManager.GetRepository().GetAppenders().Where(a => a.Name == "TextBoxAppender").FirstOrDefault(); if (appender != null) ((TextBoxAppender)appender).RichTextBox = this.richTextBoxLog; 

配置