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

Question

这是对我的问题的跟进：C# 中灵活的日志接口设计

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

TextBox Appender

然而，该文章并未描述如何通过Xml文件配置此类appender。配置这个appender的独特问题在于我们需要将一个TextBox对象的引用传递给这个appender。

那么是否可能使用Xml文件进行配置？或者这样的appenders只能通过编程进行配置？有哪些选项可以使它尽可能地可配置或松耦合，也许是使用Xml文件和代码的组合？

谢谢。

- AllSolutions

---

在xml配置文件中，有命名参数。你不能使用它来获取文本框的名称吗？然后在运行时使用：Control[] Items = Controls.Find("textBoxLog4Net", false); 来获取访问权限？ - Steve Wellens

但据我所知，Controls 是 Form 的一个属性；那么问题就变成了 appender 应该引用哪个表单，或者 appender 如何从 Xml 文件中获取对 Form 对象的引用？ - AllSolutions

Answer 1

这取决于您如何配置log4net，但通常在log4net读取配置时不会创建表单（因此也没有文本框）。因此，您需要为表单和文本框名称创建属性。并且在追加日志事件之前，应检查表单是否已打开并且提供了文本框。另外，最好从AppenderSkeleton继承，而不是从头开始实现IAppender：

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>

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

- Sergey Berezovskiy

---

看起来不错...但是FormName如何能够识别出Form类的哪个实例，如果同一个Form类被多次实例化。而且我需要将最后几行移植到.NET 2.0。 - AllSolutions

@AllSolutions 如果有多个同名表单，则 OpenForms [FormName] 将返回首先打开的表单。您可以像这样搜索文本框 _textBox = form.Controls [TextBoxName] as TextBox。 - Sergey Berezovskiy

非常好的回答。但我认为更正确的做法是使用 Layout.Format(writer, loggingEvent);（并构造适当的 StringWriter）。 - Steve Folly

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

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

- klodoma

---

为什么你不在几个小时前就给我看这个？比我之前构建的庞然大物简单了10倍，并且它可以连接到配置文件。对于与RichTextBox一起使用需要进行一些小修改，但是非常准确。 - WernerCD

对于使用VB.Net而不是C#的任何人，只需留下一条评论：必须将FormName和TextBoxName声明为属性才能使其正常工作。 - JonS

我已经添加了一个WPF版本在下面 - 感谢@klodoma - GreyCloud

Answer 3

我修改了附加器以支持多线程，同时我也附上了代码配置。

祝好， Dorin

附加器：

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

- Dorin

---

如果日志事件来自于 UI 线程之外，它会挂起。 - Alexey Zimarev

@AlexeyZimarev：看起来你需要调用BeginInvoke。请参见http://social.msdn.microsoft.com/Forums/vstudio/en-US/a35e5298-33c4-4461-b956-bf265484219e/controlinvoke-hangs-the-application获取详细信息。 - Chris R. Donnelly

是的，BeginInvoke解决了挂起的问题。请查看我发布的完整示例。 - klodoma

谢谢。我使用了这个，并在Invoke方法调用周围添加了if (!_textBox.IsDisposed)。我在应用程序关闭时遇到了问题。被记录的窗体不是主窗体，因此FormClosing事件从未被触发。 - Steve Folly

这对我完全没用... 我设置了log4net.config而不是你的配置直接通过代码，我启用了调试，一切都 -_- 也可以写入文件，但在UI中没有任何东西。 - Mecanik

Answer 4

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

如果你真的想这样做，颜色可以从log4net配置文件中映射，方式与ColorConsoleAppender相同，但我会把这个留给下一个程序员去尝试...

- Roger Hill

Answer 5

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

_textBox.AppendText(RenderLoggingEvent(loggingEvent));

如果您想利用模式布局，则需要进行相关设置。否则，它将仅发送消息的文本（默认布局）。

- skinnyoldcoot

Answer 6

这是klodoma答案的WPF/XAML版本。

  public class TextBoxAppender : AppenderSkeleton {
    private TextBox AppenderTextBox { get; set; }
    private Window window;

    public string WindowName { get; set; }
    public string TextBoxName { get; set; }

    private T FindControl<T>(Control root, string textBoxName) where T:class{
        if (root.Name == textBoxName) {
            return root as T;
        }

        return root.FindName(textBoxName) as T;
    }

    protected override void Append(log4net.Core.LoggingEvent loggingEvent) {
        if (window == null || AppenderTextBox == null) {
            if (string.IsNullOrEmpty(WindowName) ||
                string.IsNullOrEmpty(TextBoxName))
                return;

            foreach (Window window in Application.Current.Windows) {
                if (window.Name == WindowName) {
                    this.window = window;
                }
            }
            if (window == null)
                return;

            AppenderTextBox = FindControl<TextBox>(window, TextBoxName);
            if (AppenderTextBox == null)
                return;

            window.Closing += (s, e) => AppenderTextBox = null;
        }
        window.Dispatcher.BeginInvoke( new Action(delegate {
            AppenderTextBox.AppendText(RenderLoggingEvent(loggingEvent));
        }));
    }

以及日志配置

 <appender name="textboxAppender" type="Namespace.TextBoxAppender, Namespace">
<windowName value="Viewer"/>
<textBoxName value="LogBox"/>
<layout type="log4net.Layout.PatternLayout">
  <conversionPattern value="%date [%thread] %-5level %logger [%property{NDC}] - %message%newline" />
</layout>

不要忘记给你的窗口命名（必须与窗口类型名称不同）。

- GreyCloud

Answer 7

如果您想在应用程序中的多个位置记录日志，我建议以下方法。这种方法可以通过代码动态更改控制实例，具有灵活性。

文本框附加器。

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>

- shanmuga raja