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

以下是我的问题：

现在，我想为我的WinForms 2.0应用程序的多行文本框编写一个自定义log4net appender。StackOverflow成员devdigital已经向我指出了以下链接：

但是，本文并没有描述如何通过Xml文件配置这样的附加器。配置此appender的唯一问题是，我们需要将对TextBox对象的引用传递给此appender

那么，是否可以使用Xml文件对其进行配置？或者只能通过编程方式配置这些附加器？使用Xml文件和代码的组合，有哪些选项可以使其尽可能可配置或松散耦合

---

谢谢。

这取决于您如何配置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配置的

我修改了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);

---

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

_textBox.AppendText(RenderLoggingEvent(loggingEvent));

---

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

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

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的样本相当不错。如果将文本框更改为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配置映射颜色，但我将此留给下一位编码人员偶然发现此示例…

如果您希望在计算机中的多个位置进行日志记录，我更喜欢下面的方法 应用这种方法提供了动态更改控件实例的灵活性 通过代码

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

分配textbox实例的代码。在启动进行日志记录的进程之前，请执行此操作

 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>

---

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

公共类TextBoxAppender:AppenderSkeleton{
专用文本框附录文本框{get；set；}
私人窗口；
公共字符串WindowName{get；set；}
公共字符串TextBoxName{get；set；}
私有T FindControl（控件根，字符串textBoxName），其中T:class{
if（root.Name==textBoxName）{
返回根作为T；
}
将root.FindName（textBoxName）返回为T；
}
受保护的覆盖无效附加（log4net.Core.LoggingEvent LoggingEvent）{
如果（窗口==null | |附录文本框==null）{
if（string.IsNullOrEmpty（WindowName）||
string.IsNullOrEmpty（TextBoxName））
返回；
foreach（Application.Current.Windows中的窗口）{
如果（window.Name==WindowName）{
this.window=窗口；
}
}
如果（窗口==null）
返回；
AppenderTextBox=FindControl（窗口，TextBoxName）；
if（AppenderTextBox==null）
返回；
window.Closing+=（s，e）=>AppenderTextBox=null；
}
window.Dispatcher.BeginInvoke（新操作（委托{
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>

---

不要忘记为窗口指定一个名称（必须与窗口类型名称不同）

在xml配置文件中，有命名的参数。您不能用它来获取textbox的名称吗？然后使用：Control[]Items=Controls.Find（“textBoxLog4Net”，false）；在运行时获取访问权限？但据我所知，控件是表单的一个属性；然后问题就变成了appender应该引用哪个表单，或者appender如何从Xml文件中获取对表单对象的引用？看起来不错……但是如果相同的表单类是我，FormName如何识别表单类的哪个实例呢多次安装。我需要将最后几行移植到.NET2。0@AllSolutions如果有多个表单具有相同的名称，则

OpenForms[FormName]

将返回首先打开的表单。您可以像这样搜索文本框

\u textbox=form.Controls[TextBoxName]作为TextBox

非常好的答案。但我认为更正确的是，您应该使用

Layout.Format（writer，loggingEvent）；

（构造适当的StringWriter）如果日志事件来自UI线程外部，则hangs@AlexeyZimarev：您似乎必须调用BeginInvoke。有关详细信息，请参阅。是的，BeginInvoke解决了挂起问题。请参阅我发布的完整示例。谢谢。我使用了此选项，还添加了

if（！\u textBox.IsDisposed）

调用Invoke方法时出现问题。我在关闭应用程序时遇到问题。记录到的表单不是主表单，因此FormClosing事件从未触发。这对我根本不起作用…我在日志中设置了log4net.config，而不是您的配置

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