截取log4j日志并输出到GUI组件

这几天在为自己写的一个网络爬虫加一个UI控制界面，之前的爬虫核心是以命令行启动的，所以日志信息由log4j直接输出的控制台，可是现在有了UI，就不能再将日志信息输出到控制台了，必须将日志信息以某种方式截取，输出到界面上。

 

在网上找了一下相关代码，确实不少，但经过实践检验之后，发现要么是代码太多太麻烦，要么是性能太差(爬虫运行时每秒钟产生日志信息超过百行很随意)，大都不适用。无奈，只好自己绞尽脑汁，才勉强做出来一个能用的。现在把代码贴出来，供学习交流，欢迎拍砖！

 

废话不多说，看代码：

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package cn.ysh.studio.gui.log;

import java.io.IOException;
import java.io.PipedReader;
import java.io.PipedWriter;
import java.io.Writer;
import org.apache.log4j.Logger;
import org.apache.log4j.Appender;
import org.apache.log4j.WriterAppender;

/**
 * 
 * 类描述：
 * 重置log4j的Appender的Writer
 * @author 杨胜寒
 * @date 2011-12-20 创建
 * @version 1.0
 */
public abstract class LogAppender extends Thread {

    protected PipedReader reader;

    public LogAppender(String appenderName) throws IOException {
        Logger root = Logger.getRootLogger();
        // 获取子记录器的输出源 
        Appender appender = root.getAppender(appenderName);
        // 定义一个未连接的输入流管道
        reader = new PipedReader();
        // 定义一个已连接的输出流管理，并连接到reader
        Writer writer = new PipedWriter(reader);
        // 设置 appender 输出流
        ((WriterAppender) appender).setWriter(writer);
    }
}

 这个类是一个基类，实际上是不能够直接使用的，由它的子类负责将来自控制台的日志信息输出到UI组件。

 

比如现在需要将日志信息截获，输出到一个JLabel组件，代码如下：

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package cn.ysh.studio.gui.log;

import java.io.IOException;
import java.util.Scanner;
import javax.swing.JLabel;

/**
 * 
 * 类描述：
 * 不间断地扫描输入流
 * 将扫描到的字符流显示在JLabel上
 * @author 杨胜寒
 * @date 2011-12-20 创建
 * @version 1.0
 */
public class LabelLogAppender extends LogAppender {

    private JLabel label;

    /**
     * 默认的构造
     * @param label 记录器名称，该记录器输出的日志信息将被截取并输出到指定的JLabel组件
     * @throws IOException 
     */
    public LabelLogAppender(JLabel label) throws IOException {
        super("label");
        this.label = label;
    }

    @Override
    public void run() {
        // 不间断地扫描输入流
        Scanner scanner = new Scanner(reader);
        // 将扫描到的字符流显示在指定的JLabel上
        while (scanner.hasNextLine()) {
            try {
                //睡眠
                Thread.sleep(100);
                String line = scanner.nextLine();
                label.setText(line);
                line = null;
                 } catch (Exception ex) {
                //异常信息不作处理
            }
        }
    }
}

 实际上，将日志信息输出到JTextArea或其他多行文本组件更加常见，比如MyEclipse或NetBeans等IDE。那么一下面的代码就展示了如何将日志截获并输出到JTextArea组件，同时自动使垂直滚动条跟随。请看到代码：

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package cn.ysh.studio.gui.log;

import java.io.IOException;
import java.util.Scanner;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;

/**
 * 
 * 类描述：
 * 不间断地扫描输入流
 * 将扫描到的字符流显示在JTextArea上
 * @author 杨胜寒
 * @date 2011-12-20 创建
 * @version 1.0
 */
public class TextAreaLogAppender extends LogAppender {

    private JTextArea textArea;
    private JScrollPane scroll;

    /**
     * 默认的构造
     * @param textArea 记录器名称，该记录器输出的日志信息将被截取并输出到指定的JTextArea组件
     * @param scroll JTextArea组件使用的滚动面板，因为在JTextArea中输出日志时，默认会使垂直滚动条自动向下滚动，若不需要此功能，此参数可省略
     * @throws IOException 
     */
    public TextAreaLogAppender(JTextArea textArea, JScrollPane scroll) throws IOException {
        super("textArea");
        this.textArea = textArea;
        this.scroll = scroll;
    }

    @Override
    public void run() {
        // 不间断地扫描输入流
        Scanner scanner = new Scanner(reader);
        // 将扫描到的字符流输出到指定的JTextArea组件
        while (scanner.hasNextLine()) {
            try {
                //睡眠
                Thread.sleep(100);
                String line = scanner.nextLine();
                textArea.append(line);
                textArea.append("\n");
                line = null;
                //使垂直滚动条自动向下滚动
                scroll.getVerticalScrollBar().setValue(scroll.getVerticalScrollBar().getMaximum());
                            } catch (Exception ex) {
                //异常不做处理
            }
        }
    }
}

 

按照上述方式封转之后，他们的使用就非常简单了。在窗体组件绘制完成后，就可以启动他们了：

/*
 * To change this template, choose Tools | Templates
 * and open the template in the editor.
 */
package cn.ysh.studio.gui.test;

import cn.ysh.studio.gui.log.LabelLogAppender;
import cn.ysh.studio.gui.log.TextAreaLogAppender;
import javax.swing.JFrame;
import javax.swing.JLabel;
import javax.swing.JOptionPane;
import javax.swing.JScrollPane;
import javax.swing.JTextArea;
import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory;

/**
 * 
 * 类描述：
 * 测试日志输出到UI组件
 * @author 杨胜寒
 * @date 2011-12-24 创建
 * @version 1.0
 */
public class LogDemoJFrame extends JFrame {

    private JLabel logLabel;
    private JScrollPane logScrollPane;
    private JTextArea logTextArea;
    private final static Log log = LogFactory.getLog(LogDemoJFrame.class);

    public LogDemoJFrame() {
        logLabel = new javax.swing.JLabel();
        logScrollPane = new javax.swing.JScrollPane();
        logTextArea = new javax.swing.JTextArea();
        setDefaultCloseOperation(javax.swing.WindowConstants.EXIT_ON_CLOSE);
        logLabel.setText(" ");

        logTextArea.setColumns(20);
        logTextArea.setRows(5);
        logScrollPane.setViewportView(logTextArea);

        javax.swing.GroupLayout layout = new javax.swing.GroupLayout(getContentPane());
        getContentPane().setLayout(layout);
        layout.setHorizontalGroup(
                layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING).addGroup(layout.createSequentialGroup().addContainerGap().addComponent(logLabel, javax.swing.GroupLayout.DEFAULT_SIZE, 610, Short.MAX_VALUE).addContainerGap()).addComponent(logScrollPane, javax.swing.GroupLayout.Alignment.TRAILING, javax.swing.GroupLayout.DEFAULT_SIZE, 630, Short.MAX_VALUE));
        layout.setVerticalGroup(
                layout.createParallelGroup(javax.swing.GroupLayout.Alignment.LEADING).addGroup(layout.createSequentialGroup().addContainerGap().addComponent(logLabel).addPreferredGap(javax.swing.LayoutStyle.ComponentPlacement.RELATED).addComponent(logScrollPane, javax.swing.GroupLayout.DEFAULT_SIZE, 305, Short.MAX_VALUE)));

        pack();
    }

    public void initLog() {
        try {
            Thread t1, t2;
            t1 = new LabelLogAppender(logLabel);
            t2 = new TextAreaLogAppender(logTextArea, logScrollPane);
            t1.start();
            t2.start();
        } catch (Exception e) {
            JOptionPane.showMessageDialog(this, e, "绑定日志输出组件错误", JOptionPane.ERROR_MESSAGE);
        }
    }

    public static void main(String[] s) {
        LogDemoJFrame logDemoFrame = new LogDemoJFrame();
        logDemoFrame.initLog();
        logDemoFrame.setVisible(true);
        for (int i = 0; i < 1000; i++) {
            log.info("测试日志输出:" + i);
        }
    }
}

 很简单的一个Demo，仅供参考。

下面是我的Log4j日志配置信息:

log4j.appender.label=org.apache.log4j.ConsoleAppender
log4j.appender.label.layout=org.apache.log4j.PatternLayout
log4j.appender.label.layout.ConversionPattern=%m%n

log4j.appender.textArea=org.apache.log4j.ConsoleAppender
log4j.appender.textArea.layout=org.apache.log4j.PatternLayout
log4j.appender.textArea.layout.ConversionPattern=%-d{yyyy-MM-dd HH:mm:ss}  [ %p ]  %m%n

log4j.rootLogger=INFO,label,textArea

 其实鉴于上述方法，还可以实现更多自定义log4j日志输出功能，在此不再赘述。

 

原创文章，转载请注明出处: http://www.yshjava.cn/post/322.html

 

 

 

评论

4 楼 夜曲6763 2013-10-24  

谢谢分享！

3 楼 hankqin 2013-09-04  

原来是我log4j没有配置

2 楼 hankqin 2013-09-04  

老兄啊  把你的例子copy下来运和报错,基础浅薄，不知道报错原因.
JOptionPane.showMessageDialog(this, e, "绑定日志输出组件错误", JOptionPane.ERROR_MESSAGE);

这段代码报错了.

1 楼 liutao1600 2013-05-05  

太感谢了！！！！！！