备案控制台
探索云世界
开发者社区 开发与运维 文章 正文

如何自建appender扩展Log4j框架

2017-11-02 1088
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：
  1 ．log4j 概述
log4j 环境包括三个主要组件：
logger（日志记录器）：控制要启用或禁用哪些日志记录语句。可以对日志记录器指定如下级别： ALL 、 DEBUG、 INFO 、 WARN 、 ERROR , FATAL 。
layout（布局）：根据用户的愿望格式化日志记录请求。
appender：向目的地发送格式化的输出。
2 ．理解 appender
log4j 框架允许向任何日志记录器附加多个 appender。可以在任何时候对某个日子记录器添加（或删除）appender。附随 log4j 分发的 appender 有多个，包括：
ConsoleAppender;FileAppender;SMTPAppender ;JDBCAppender;JMSAppender;NTEventLogAppender;SyslogAppender。
也可以创建自己的自定义 appender。
3．本工程设计的目标
通过自建appender类，来实现：
[1]在控制台输出日志；
[2]在log文件输出日志；
[3]在应用程序中建立日志模块（在UI层表现为建立一个日志面板），输出日志；
[4]对于不同包路径下的日志独立输出（在UI层表现为分不同的面板输出）。
4.预备知识
你可以在下面2篇文章中找到Log4j的相关基础介绍。
5．项目文件分布与效果
文件分布如图一所示。我们对于com.log.one包下的所有java文件中的日志信息输出到log one模块（图二）；对于com.log.two包下的所有java文件中的日志信息输出到log two模块（图四）。本文只象征性的建立了两个测试文件，分别放在两个包下。
com.log.one.LogTestOne.java
public   class  LogTestOne {
     private   final   static  Logger  log  = Logger.getLogger(LogTestOne. class );
     public   void  doLog(){
        log .debug( "TestOne debug" );
        log .info( "TestOne info" );
        log .warn( "TestOne warn" );
        log .error( "TestOne error" );
        log .fatal( "TestOne fatal" );
    }
}
 
com.log.two.LogTestTwo.java
public   class  LogTestTwo {
     private   final   static  Logger  log  = Logger.getLogger(LogTestTwo. class );
     public   void  doLog() {
        log .debug( "TestTwo debug" );
        log .info( "TestTwo info" );
        log .warn( "TestTwo warn" );
        log .error( "TestTwo error" );
        log .fatal( "TestTwo fatal" );
    }
}
 
图一
 
对于应用程序中的日志模块，提供一些UI层的基本操作，包括清空（图二，图四）；变灰（图三）；复制到粘贴板。
The Main Text象征性的表示主应用程序的所有操作。
图二
 
图三
 
图四
 
同时在控制台输出所有日志信息。（图五）
图五
 
    同时在文本文件中输出所有日志信息。（图六）
图六
6．log4j.xml
本项目使用如下日志配置文件，将其放在项目的classpath下。
<! DOCTYPE  log4j:configuration  SYSTEM  "log4j.dtd" >
< log4j:configuration  xmlns:log4j = "http://jakarta.apache.org/log4j/"  debug = "false" >  
    <!-- =================== -->
    <!-- Appenders           -->
    <!-- =================== -->
    < appender  name = "CONSOLE"  class = "org.apache.log4j.ConsoleAppender" >
       < errorHandler  class = "org.apache.log4j.helpers.OnlyOnceErrorHandler" />
       < param  name = "Target"  value = "System.out" />
       < param  name = "Threshold"  value = "DEBUG" />
       < layout  class = "org.apache.log4j.PatternLayout" >
          <!-- The default pattern: Date Priority [Category] Message\n -->
          < param  name = "ConversionPattern"  value = "%-5p %l%m%n" />
       </ layout >
    </ appender >
 
    < appender  name = "FILE"  class = "org.apache.log4j.RollingFileAppender" >
      < errorHandler  class = "org.apache.log4j.helpers.OnlyOnceErrorHandler" />
      < param  name = "File"  value = "logui.log" />
      < param  name = "Threshold"  value = "INFO" />
      < param  name = "Append"  value = "false" />
      < param  name = "MaxFileSize"  value = "5000KB" />
      < param  name = "MaxBackupIndex"  value = "50" />
      < layout  class = "org.apache.log4j.PatternLayout" >
        < param  name = "ConversionPattern"  value = "%d %-5p [%c{1}] %m%n" />
      </ layout >     
    </ appender >
     
    < appender  name = "ONE"  class = "com.log.utils.LogOneAppender" >
       < errorHandler  class = "org.apache.log4j.helpers.OnlyOnceErrorHandler" />
    </ appender >
  
     < appender  name = "TWO"  class = "com.log.utils.LogTwoAppender" >
       < errorHandler  class = "org.apache.log4j.helpers.OnlyOnceErrorHandler" />
    </ appender >
  
    <!-- =============== -->
    <!-- Loggers         -->
    <!-- =============== -->
    < logger  name = "com.log.one" >
      < level  value = "DEBUG"  />
      < appender-ref  ref = "ONE" />
      < appender-ref  ref = "CONSOLE" />
    </ logger >
  
     < logger  name = "com.log.two" >
      < level  value = "DEBUG"  />
      < appender-ref  ref = "TWO" />
      < appender-ref  ref = "CONSOLE" />
    </ logger >
  
    < root >
       < priority  value = "INFO"  />
       < appender-ref  ref = "FILE" />
    </ root >
</ log4j:configuration >
这里除常规的CONSOLE和FILE appender，增加两个appender，ONE和TWO，分别通过自建类LogOneAppender和LogTwoAppender定义。
public   class  LogOneAppender  extends  AppenderSkeleton{
     public  LogOneAppender() {}
     protected   void  append(LoggingEvent event) {
       LogUI.log(event);
    }
     public   void  close() {}
     public   boolean  requiresLayout() {
        return   false ;
    }
}
 
public   class  LogTwoAppender  extends  AppenderSkeleton{
     public  LogTwoAppender() {}
     protected   void  append(LoggingEvent event) {
       LogUI.log(event);
    }
     public   void  close() {}
     public   boolean  requiresLayout() {
        return   false ;
    }
}
在logger中通过logger name,com.log.one和com.log.two指定到上述的appender。
7．主界面设计LogUI.java
主面板为frame，其中嵌入LogPanel。log类的实体是一个Log4Jmonitor类的实例，通过它的addLogArea方法可以添加日志模块，其中的第二个参数对应log4j配置文件中的logger name。这里还提供一个Cache功能，即如果在主类(LogUI)或日志类(Log4Jmonitor)还没有实例化之前，已经有日志信息，则进行缓存。
public   class  LogUI {
     private   static  LogUI  instance ;
     private   static  JFrame  frame ;
     private  Log4JMonitor  logMonitor ;
     private   static  List<Object>  logCache  =  new  ArrayList<Object>();
     public  LogUI() {
        instance  =  this ;
    }
     ///////////////////////UI
     private   void  buildUI() {
        frame .addWindowListener( new  WindowAdapter() {
            public   void  windowClosing(WindowEvent e) {
              System.exit(0);
           }
       });
        frame .getContentPane().add(buildContentPanel(), BorderLayout. CENTER );
        frame .setDefaultCloseOperation(JFrame. DO_NOTHING_ON_CLOSE );
        frame .setSize(100, 75);
    }
 
     private  Component buildContentPanel() {
       JSplitPane contentSplit =  new  JSplitPane();
       contentSplit.setTopComponent( new  JTextArea( "The Main Text" ));
       contentSplit.setBottomComponent(buildLogPanel());
       contentSplit.setDividerLocation(550);
       contentSplit.setResizeWeight(1);
        return  contentSplit;
    }
 
     private  Component buildLogPanel() {
        logMonitor  =  new  Log4JMonitor();
        logMonitor .addLogArea( "log one" ,  "com.log.one" ,  true ).setLevel(
              Level. DEBUG );
        logMonitor .addLogArea( "log two" ,  "com.log.two" ,  true ).setLevel(
              Level. DEBUG );
        for  (Object message :  logCache ) {
            logMonitor .logEvent(message);
       }
        return   logMonitor ;
    }
 
     public   void  show() {
       buildUI();
        frame .setVisible( true );
    }
     ////////////////////Log
     public   static   synchronized   void  log( final  Object msg) {
        if  ( instance  ==  null  ||  instance . logMonitor  ==  null ) {
            logCache .add(msg);
            return ;
       }
        if  (SwingUtilities.isEventDispatchThread()) {
            instance . logMonitor .logEvent(msg);
       }  else  {
           SwingUtilities.invokeLater( new  Runnable() {
               public   void  run() {
                   instance . logMonitor .logEvent(msg);
              }
           });
       }
    }
     //////////////////Test Cases
     public   void  doTests(){
       LogTestOne one= new  LogTestOne();
       one.doLog();
       LogTestTwo two= new  LogTestTwo();
       two.doLog();
    }
   
     public   static   void  main(String[] args)  throws  Exception {
        frame  =  new  JFrame( "LogUI " );
       LogUI logUi =  new  LogUI();
        logUi.show();
       logUi.doTests();
    }
}
8．log类的实体Log4Jmonitor
通过此类来建立日志模块。其中用到的JlogList.java（见附件）提供对日志模块的所有基本功能。addLogArea方法增加日志模块。logEvent方法对输出的日志事件类型做出判断，对该日志所属的日志模块（本实例为com.log.one和com.log.two）做出判断。
public   class  Log4JMonitor  extends  JTabbedPane {
     private  JLogList  defaultLogArea ;
     public  Log4JMonitor() {
        super (JTabbedPane. BOTTOM , JTabbedPane. SCROLL_TAB_LAYOUT );
    }
     public  JLogList addLogArea(String title, String loggerName,
            boolean  isDefault) {
       JLogList logArea =  new  JLogList(title);
       logArea.addLogger(loggerName, !isDefault);
       addTab(title, logArea);
        if  (isDefault)
            defaultLogArea  = logArea;
        return  logArea;
    }
     public   void  logEvent(Object msg) {
        if  (msg  instanceof  LoggingEvent) {
           LoggingEvent event = (LoggingEvent) msg;
           String loggerName = event.getLoggerName();
            for  ( int  c = 0; c < getTabCount(); c++) {
              Component tabComponent = getComponentAt(c);
               if  (tabComponent  instanceof  JLogList) {
                  JLogList logArea = (JLogList) tabComponent;
                   if  (logArea.monitors(loggerName)) {
                     logArea.addLine(msg);
                  }
              }
           }
       }  else   if  ( defaultLogArea  !=  null ) {
            defaultLogArea .addLine(msg);
       }
    }
     public   boolean  hasLogArea(String loggerName) {
        for  ( int  c = 0; c < getTabCount(); c++) {
           Component tabComponent = getComponentAt(c);
            if  (tabComponent  instanceof  JLogList) {
              JLogList logArea = (JLogList) tabComponent;
               if  (logArea.monitors(loggerName)) {
                   return   true ;
              }
           }
       }
        return   false ;
    }
}
 

本文转自zhangjunhd51CTO博客，原文链接：http://blog.51cto.com/zhangjunhd/48895，如需转载请自行联系原作者
文章标签：
日志服务
Java
C++
缓存
关键词：
Log4j appender
appender Log4j
相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
科技小先锋
目录
相关文章
taro_秋刀鱼
|
监控 Java
通过Alibaba Cloud Log Log4j Appender采集日志到阿里云日志服务
Log4j是Apache的一个开放源代码项目，通过使用Log4j，您可以控制日志信息输送的目的地是控制台、文件、GUI组件、甚至是套接口服务器、NT的事件记录器、UNIX Syslog守护进程等；您也可以控制每一条日志的输出格式；通过定义每一条日志信息的级别，您能够更加细致地控制日志的生成过程。
taro_秋刀鱼
5510 0
李博 bluemind
|
Arthas Java 测试技术
Java技术周刊第9期：自定义log4j的appender写es日志
Java的开发者们：云栖社区已有5000位Java开发者，发布了30000+Java文章（文章列表），沉淀了7000+的Java精品问答（问答列表）。 Java技术周刊将会为大家介绍最新的Java技术与动态、预告活动、最热问答、直播教程等，欢迎大家订阅Java技术周刊。
李博 bluemind
7588 0
神牛003
|
监控 Java Docker
自定义log4j的appender写es日志
本篇和大家分享的是自定义log4j的appender，用es来记录日志并且通过kibana浏览es记录；就目前互联网或者一些中大型公司通常会用到第三方组合elk，其主要用写数据到es中，然后通过可视化工具kibana来做直观数据查看和统计；本篇内容节点如下： docker快速搭建es，es he...
神牛003
3990 0
北洲
|
缓存 监控 Java
日志服务接入方式之loghub log4j appender
使用Loghub Log4j Appender，您可以控制日志的输出目的地为阿里云日志服务,使用Loghub Log4j Appender的好处 客户端日志不落盘：既数据生产后直接通过网络发往服务端。 对于已经使用log4j记录日志的应用，只需要简单修改配置文件就可以将日志传输到日志服务。 异
北洲
11976 0
雪地脚印
|
SQL 缓存 Java
深入Log4J源码之Appender
雪地脚印
2050 0
edwardsbean
|
算法 Java 应用服务中间件
使用Flume Log4j Appender正确的姿势
<br><div style="orphans:2; widows:2; font-size:13px; margin:0px; font-family:Monaco,Menlo,'Ubuntu Mono',Consolas,source-code-pro,SimSun,Song,宋体,幼圆,Heiti,黑体,文泉驿等宽正黑,文泉驿正黑,monospace"> <h2 style="fo
edwardsbean
2296 0
edwardsbean
|
Java
修改Flume Log4j Appender
<div class="entry-content" style="margin:0px; padding:0px; border:0px; font-family:'PT Serif',Georgia,Times,'Times New Roman',serif; line-height:27.59375px; font-size:18px; vertical-align:baseline
edwardsbean
2073 0
诸葛子房
|
4月前
|
Java Spring
spring boot 配置log4j 日志
spring boot 配置log4j 日志
诸葛子房
69 0
爱吃糖的范同学
|
3月前
|
Java Spring
【Spring Boot】logback和log4j日志异常处理
【1月更文挑战第25天】【Spring Boot】logback和log4j日志异常处理
爱吃糖的范同学
111 0
愿天堂没有BUG（公众号同名）
|
5月前
|
XML JSON Java
最牛逼 Java 日志框架—Log4j2，性能无敌，横扫对手
Logback 算是JAVA 里一个老牌的日志框架，从06年开始第一个版本，迭代至今也十几年了。不过logback最近一个稳定版本还停留在 2017 年，好几年都没有更新；logback的兄弟 slf4j 最近一个稳定版也是2017年，有点凉凉的意思。
愿天堂没有BUG（公众号同名）
127 0