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

如何自建appender扩展Log4j框架

2017-11-02 1089
版权
版权声明：
本文内容由阿里云实名注册用户自发贡献，版权归原作者所有，阿里云开发者社区不拥有其著作权，亦不承担相应法律责任。具体规则请查看《 阿里云开发者社区用户服务协议》和 《阿里云开发者社区知识产权保护指引》。如果您发现本社区中有涉嫌抄袭的内容，填写 侵权投诉表单进行举报，一经查实，本社区将立刻删除涉嫌侵权内容。
简介：
  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框架
日志服务框架
Log4j appender
appender Log4j
相关实践学习
日志服务之使用Nginx模式采集日志
本文介绍如何通过日志服务控制台创建Nginx模式的Logtail配置快速采集Nginx日志并进行多维度分析。
科技小先锋
目录
相关文章
童小纯
|
4月前
|
存储 Java 数据库
若依框架----源码分析（@Log）
若依框架----源码分析（@Log）
童小纯
289 0
阿甘兄
|
5月前
|
Java API 开发者
Java日志框架整理
Java日志框架整理
阿甘兄
62 0
bug丶小狼人
|
7月前
|
SQL 监控 前端开发
tp5框架Fastadmin中的Log日志如何去用
tp5框架Fastadmin中的Log日志如何去用
bug丶小狼人
210 0
愿天堂没有BUG（公众号同名）
|
6月前
|
XML JSON Java
最牛逼 Java 日志框架—Log4j2，性能无敌，横扫对手
Logback 算是JAVA 里一个老牌的日志框架，从06年开始第一个版本，迭代至今也十几年了。不过logback最近一个稳定版本还停留在 2017 年，好几年都没有更新；logback的兄弟 slf4j 最近一个稳定版也是2017年，有点凉凉的意思。
愿天堂没有BUG（公众号同名）
133 0
岁岁种桃花儿
|
5月前
|
前端开发 Java
日志框架：基于Logback实现链路追踪
日志框架：基于Logback实现链路追踪
岁岁种桃花儿
269 0
游客pyivdsdmxqiee
|
1天前
|
XML Java Maven
Springboot整合与使用log4j2日志框架【详解版】
该文介绍了如何在Spring Boot中切换默认的LogBack日志系统至Log4j2。首先，需要在Maven依赖中排除`spring-boot-starter-logging`并引入`spring-boot-starter-log4j2`。其次，创建`log4j2-spring.xml`配置文件放在`src/main/resources`下，配置包括控制台和文件的日志输出、日志格式和文件切分策略。此外，可通过在不同环境的`application.yml`中指定不同的log4j2配置文件。最后，文章提到通过示例代码解释了日志格式中的各种占位符含义。
游客pyivdsdmxqiee
5 0
程序三两行
|
22天前
|
Java 测试技术 Spring
Spring系列文章：Spring集成Log4j2⽇志框架、整合JUnit
Spring系列文章：Spring集成Log4j2⽇志框架、整合JUnit
程序三两行
10 0
风水道人
|
2月前
|
监控 Java 测试技术
日志框架到底是Logback 还是 Log4j2
日志框架到底是Logback 还是 Log4j2
风水道人
20 0
GoodTime
|
6月前
|
开发框架 .NET 测试技术
.NET Core 日志记录程序和常用日志记录框架
本文主要内容为.NET Core的日志记录程序和常使用的日志记录框架的简单使用 首先，打开VS2019新建一个ASP.NET Core Web Api项目，项目创建好后会有一个集成好的天气预报的类和控制器，接下来，我们的方法就在天气控制器里完成。
GoodTime
50 0
wljslmz
|
3月前
|
监控 前端开发
如何从零开始搭建一个前端日志框架？
【2月更文挑战第8天】
wljslmz
69 2
如何从零开始搭建一个前端日志框架？

热门文章

最新文章

  • 1
    更优性能与性价比，从自建 ELK 迁移到 SLS 开始
  • 2
    全新架构！日志服务 SLS 自研免登录方案发布
  • 3
    使用 SPL 高效实现 Flink SLS Connector 下推
  • 4
    nacos常见问题之日志一直报403如何解决
  • 5
    使用Java代码打印log日志
  • 6
    Linux手动清理Linux脚本日志定时清理日志和log文件执行表达式
  • 7
    /var/log/auth.log日志详解
  • 8
    工具变量法(两阶段最小二乘法2SLS)线性模型分析人均食品消费时间序列数据和回归诊断（下）
  • 9
    Dubbo日志文件输出到指定目录 如何定义？
  • 10
    Linux&Windows 日志分析 陇剑杯 CTF
  • 1
    [MySQL]事务原理之redo log,undo log
    46
  • 2
    在云效中，如果你看不到错误日志，可能是因为错误日志没有被正确地输出或者存储
    16
  • 3
    Windows环境下面启动jar包，输出的日志出现乱码的解决办法
    59
  • 4
    Flink CDC产品常见问题之sql运行中查看日志任务失败如何解决
    48
  • 5
    全新架构！日志服务 SLS 自研免登录方案发布
    87449
  • 6
    Python使用多线程解析超大日志文件
    28
  • 7
    Loguru：Python中强大的日志库
    50
  • 8
    Python如何在打印日志时隐藏明文密码？
    38
  • 9
    【二十九】springboot整合logback实现日志管理
    61
  • 10
    【七】springboot整合AOP实现日志操作
    45

    • 相关课程

    更多
  • 日志服务SLS实现云产品可观测
  • 日志服务 SLS 可观测数据分析平台介绍
  • 大数据知识图谱系列—基于ELK+Flink日志全观测最佳实践
  • 场景实践-基于阿里云Quick BI 对MOOC网站日志分析

    • 相关电子书

    更多
  • PostgresChina2018_赖思超_PostgreSQL10_hash索引的WAL日志修改版final
  • Kubernetes下日志实时采集、存储与计算实践
  • 日志数据采集与分析对接

    • 相关实验场景

    更多
  • 使用CloudLens管理SLS日志采集
  • 使用CloudLens采集PolarDB日志并进行审计分析
  • 使用CloudLens采集RDS日志并进行审计分析
  • 基于SLS快速实现业务可观测
  • 使用日志服务SLS进行OSS可观测分析
  • 多账号体系下使用日志服务中心化的管理日志
    • 下一篇
    2024年阿里云免费云服务器及学生云服务器申请教程参考