C# Log4net输出到窗体

通过Xml文件配置log4net TextBoxAppender(自定义appender)

qfugit 发布于 2019-02-19 • 在 c# • 最后更新 2019-02-19 13:26 • 109 浏览

接下来是我的问题：Flexible Logging Interface... 我现在想为我的WinForms 2.0应用程序编写一个多行TextBox的自定义log4net appender。其中一位StackOverflow成员devdigital已经指出了我的这一联系： TextBox Appender 但是，本文并未介绍如何通过Xml文件配置这样的appender。配置这个appender的唯一问题是我们需要将一个对TextBox对象的引用传递给这个appender。 那么是否可以使用Xml文件来配置它？或者这样的appender只能以编程方式配置？有什么选择使它尽可能可配置或松散耦合，可能是使用Xml文件和代码的组合？ 谢谢。

6 个回复

raut 2019-02-19

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

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元素并为具有相同名称的属性提供值)：

<appender name="textbox" type="Foo.TextBoxAppender, Foo">
  <formName value="Form1"/>
  <textBoxName value="textBox1"/>
  <layout type="log4net.Layout.PatternLayout">
    <conversionPattern value="%date %-5level %logger - %message" />
  </layout>      
</appender>
<root>
  <level value="INFO" />
  <appender-ref ref="textbox"/>
</root>

我没有提供任何与多线程和线程同步相关的错误处理代码或代码，因为问题是关于appender配置。

faut 2019-02-19

以上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配置映射颜色，但我留给那个下一个编码器偶然发现这个样本......

nomnis 2019-02-19

如果你想在你的多个地方进行日志记录，我更喜欢以下方法 应用。此方法可以灵活地动态更改控件实例 通过代码。 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;

配置

<log4net debug="false">
    <appender name="TextBoxAppender" type="SecurityAudit.UI.TextBoxAppender">
      <layout type="log4net.Layout.PatternLayout">
        <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
      </layout>
    </appender>
    <root>
      <priority value="DEBUG" />
      <appender-ref ref="TextBoxAppender" />
    </root>
  </log4net>

nea 2019-02-19

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

_textBox.AppendText(RenderLoggingEvent(loggingEvent));

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

iullam 2019-02-19

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

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中：

<appender name="textboxAppender" type="MyNamespace.TextBoxAppender, MyNamespace">
  <formName value="MainForm"/>
  <textBoxName value="textBoxLog"/>
  <layout type="log4net.Layout.PatternLayout">
    <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
  </layout>
</appender>
<root>
  <level value="DEBUG" />
  <appender-ref ref="RollingFileAppender" />
  <appender-ref ref="textboxAppender" />
</root>   

hquae 2019-02-19

我修改了appender以使用多线程。 另外，我附加了代码配置。 问候， 多林 追加程序：

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);