img

GitHub

Java / github

dhshenc

个人站

看清自己，认清现实~

日志框架

| 阅读：次

简介

  • 在项目开发过程中，我们可以通过 debug 查找问题。而在线上环境我们查找问题只能通过打印日志的方式查找问题。因此对于一个项目而言，日志记录是一个非常重要的问题。因此，如何选择一个合适的日志记录框架也非常重要。

常见日志框架

  • 在Java开发中，目前常用的日志框架包括Log4j 1，Log4j 2，Commons Logging，Slf4j，Logback，Jul。
  • 这些日志记录框架各有各的特点，各有各的应用场景。了解这些框架的特点及应用场景，有利于我们做技术选型的时候做出正确的判断。
框架 说明
Log4j Apache Log4j是一个基于Java的日志记录工具。它是由Ceki首创的，现在则是Apache软件基金会的一个项目。 Log4j是几种Java日志框架之一。
Log4j 2 Apache Log4j 2是apache开发的一款Log4j的升级产品。
Commons Logging Apache基金会所属的项目，是一套Java日志接口，之前叫Jakarta Commons Logging，后更名为Commons Logging。
Slf4j 类似于Commons Logging，是一套简易Java日志门面，本身并无日志的实现。（Simple Logging Facade for Java，缩写Slf4j）。
Logback 一套日志组件的实现(Slf4j阵营)
Jul (Java Util Logging),自Java1.4以来的官方日志实现。

Java日志框架历史：

  • 1996年早期，欧洲安全电子市场项目组决定编写它自己的程序跟踪API(Tracing API)。经过不断的完善，这个API终于成为一个十分受欢迎的Java日志软件包，即Log4j（由Ceki创建）。
  • 后来Log4j成为Apache基金会项目中的一员,Ceki也加入Apache组织。后来Log4j近乎成了Java社区的日志标准。据说Apache基金会还曾经建议Sun引入Log4j到Java的标准库中，但Sun拒绝了。
  • 2002年Java1.4发布，Sun推出了自己的日志库JUL(Java Util Logging),其实现基本模仿了Log4j的实现。在JUL出来以前，Log4j就已经成为一项成熟的技术，使得Log4j在选择上占据了一定的优势。
  • 接着，Apache推出了Jakarta Commons Logging，JCL只是定义了一套日志接口(其内部也提供一个Simple Log的简单实现)，支持运行时动态加载日志组件的实现，也就是说，在你应用代码里，只需调用Commons Logging的接口，底层实现可以是Log4j，也可以是Java Util Logging。
  • 后来(2006年)，Ceki不适应Apache的工作方式，离开了Apache。然后先后创建了Slf4j(日志门面接口，类似于Commons Logging)和Logback(Slf4j的实现)两个项目，并回瑞典创建了QOS公司，QOS官网上是这样描述Logback的：The Generic，Reliable Fast&Flexible Logging Framework(一个通用，可靠，快速且灵活的日志框架)。
  • 现今，Java日志领域被划分为两大阵营：Commons Logging阵营和Slf4j阵营。
  • Commons Logging在Apache大树的笼罩下，有很大的用户基数。但有证据表明，形式正在发生变化。2013年底有人分析了GitHub上30000个项目，统计出了最流行的100个Libraries，可以看出Slf4j的发展趋势更好。
  • Apache眼看有被Logback反超的势头，于2012-07重写了Log4j 1.x，成立了新的项目Log4j 2, Log4j 2具有Logback的所有特性。

日志

  • 未来使用Slf4j与Logback组合会越来越多
  • (1)Slf4j实现机制决定Slf4j限制较少，使用范围更广
  • (2)Logback拥有更好的性能。
  • (3)Logback文档免费。

log4j的使用

使用的Maven项目

  • 导入jar包依赖:
<!--门面commons-logging-->
<dependency>
  <groupId>commons-logging</groupId>
  <artifactId>commons-logging</artifactId>
  <version>x.x</version>
</dependency> 

<dependency>
  <groupId>log4j</groupId>
  <artifactId>log4j</artifactId>
  <version>x.x.xx</version>
</dependency>

配置文件:log4j.properties

  ### set log levels - for more verbose logging change 'info' to 'debug' ，'off' ###
  log4j.rootLogger=info, stdout,file

  ###1 direct log messages to stdout ###
  log4j.appender.stdout=org.apache.log4j.ConsoleAppender
  log4j.appender.stdout.Target=System.err
  log4j.appender.stdout.layout=org.apache.log4j.PatternLayout
  log4j.appender.stdout.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

  ###2 direct messages to file mylog.log ###
  log4j.appender.file=org.apache.log4j.FileAppender
  log4j.appender.file.File=mylog.log
  log4j.appender.file.layout=org.apache.log4j.PatternLayout
  log4j.appender.file.layout.ConversionPattern=%d{ABSOLUTE} %5p %c{1}:%L - %m%n

  ###3每天生成一个文件
log4j.appender.daily=org.apache.log4j.DailyRollingFileAppender
  log4j.appender.daily.File=soso.log
  log4j.appender.daily.Append=true
  log4j.appender.daily.Threshold=INFO
  log4j.appender.daily.ImmediateFlush=true
  #生成一个配置文件 命名  soso.8888-88-88-88 时间
  log4j.appender.daily.DatePattern='_'yyyy-MM-dd'.txt'
  log4j.appender.daily.layout=org.apache.log4j.PatternLayout
  log4j.appender.daily.layout.ConversionPattern=[%-5p] %d(%r) --> [%t] %l: %m %x %n

  ###4控制每个滚动日志文件大小和个数
  log4j.appender.R=org.apache.log4j.RollingFileAppender  
  log4j.appender.R.Threshold=DEBUG  
  log4j.appender.R.File=test.log  
  log4j.appender.R.layout=org.apache.log4j.PatternLayout  
  log4j.appender.R.layout.ConversionPattern=%d{yyyy-MM-dd HH:mm:ss} [%5p] - %c -%F(%L) -%m%n
  log4j.appender.R.MaxFileSize=1kb
  log4j.appender.R.MaxBackupIndex=5

java类测试:

  //注意：包别导错org.apache.log4j.Logger;
  Logger logger = LogManager.getLogger(LogDemo2.class.getName());
  //门面使用
  //Log logger = LogFactory.getLog(Demo2.class.getName());
//使用日志
  logger.trace("跟踪信息");
  logger.debug("调试信息");
  logger.info("信息");
  logger.warn("警告信息");
  logger.error("错误信息");
  logger.fatal("致命错误");

log4j 2.x的使用

  • 添加jar包依赖
  • 注意:如果和commons-logging配合使用需要添加log4j-jcl依赖
  <!--门面commons-logging-->
  <dependency>
      <groupId>commons-logging</groupId>
      <artifactId>commons-logging</artifactId>
      <version>x.x</version>
  </dependency> 
  <!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-core -->
  <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-core</artifactId>
      <version>x.xx.x</version>
  </dependency>
  <dependency>
      <groupId>org.apache.logging.log4j</groupId>
      <artifactId>log4j-jcl</artifactId>
      <version>x.xx.x</version>
  </dependency>

配置文件：log4j2.xml

  • 这里简单的配置，复杂的配置可以去百度搜索
<?xml version="1.0" encoding="UTF-8"?>
<Configuration>
    <Appenders>
        <Console name="STDOUT" target="SYSTEM_OUT">
            <PatternLayout pattern="%d %-5p [%t] %C{2} (%F:%L) - %m%n"/>
        </Console>
    </Appenders>
    <Loggers>
        <Root level="warn">
            <AppenderRef ref="STDOUT"/>
        </Root>
    </Loggers>
</Configuration>

Java测试代码

  //注意导包
  //org.apache.logging.log4j.LogManager;
  //org.apache.logging.log4j.Logger;
  Logger logger = LogManager.getLogger(LogDemo2.class.getName());
  //门面使用
  //Log logger = LogFactory.getLog(Demo2.class.getName());
  //等同于logger.entry();但此方法在新版本好像已经废弃
  logger.trace("entry");	
  logger.error("Did it again!");
  logger.info("这是info级信息");
  logger.debug("这是debug级信息");
  logger.warn("这是warn级信息");
  logger.fatal("严重错误");
  logger.trace("exit");

logback的使用

  • logback是java的日志开源组件，是log4j创始人写的，性能比log4j要好，目前主要分为3个模块
  1. logback-core:核心代码模块
  2. logback-classic:log4j的一个改良版本，同时实现了slf4j的接口，这样你如果之后要切换其他日志组件也是一件很容易的事
  3. logback-access:访问模块与Servlet容器集成提供通过Http来访问日志的功能
  • 添加jar依赖
<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-core</artifactId>
  <version>1.2.3</version>
</dependency>
<dependency>
  <groupId>ch.qos.logback</groupId>
  <artifactId>logback-classic</artifactId>
  <version>1.2.3</version>
</dependency>
<dependency>
  <groupId>org.slf4j</groupId>
  <artifactId>slf4j-api</artifactId>
  <version>1.7.26</version>
</dependency>
  • 添加配置logback.xml
<?xml version="1.0" encoding="UTF-8"?>
<configuration >
   <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
   <property name="LOG_HOME" value="filename" /><!-- 日志文件的家目录 -->
   <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss" /><!-- 生成指定格式的时间戳，用于日志文件的唯一命名 -->
   <!-- 控制台输出 -->
   <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
       <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
           <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
           <pattern>%d{yyyy-MM-dd HH:mm:ss.SSS} [%thread] %-5level %logger{50} - %msg%n</pattern>
       </encoder>
   </appender>

   <appender name="fileAppender" class="ch.qos.logback.core.FileAppender">
       <immediateFlush>true</immediateFlush><!-- 立即刷新输出流，设置为 false 可以提高日志吞吐量 -->
       <file>${LOG_HOME}${bySecond}.log</file><!-- 日志文件路径 -->
       <encoder><!-- 日志输出格式，必须指定，否则不会往文件输出内容 -->
           <pattern>%d{HH:mm:ss.SSS} [%thread] %-5level %logger{5} - %msg%n</pattern>
       </encoder>
       <append>true</append><!-- 追加 -->
       <prudent>false</prudent><!-- 关闭严格模式，也提高日志吞吐量(3倍)，默认false -->
   </appender>

   <!-- 日志输出级别 -->
   <root level="DEBUG">
       <appender-ref ref="STDOUT" />
   </root>
</configuration>
  • 测试代码:
  //注意导包
  //import org.slf4j.Logger;
  //import org.slf4j.LoggerFactory;
  Logger logger = LoggerFactory.getLogger(LogBackTest.class.getName());
  //使用门面
  //Log log = LogFactory.getLog(Log4jTest3.class.getName());
  logger.trace("跟踪信息3");
  logger.debug("调试信息3");
  logger.info("信息3");
  logger.warn("警告信息3");
  logger.error("错误信息3");

配置说明

输出方式appender一般有5种：

  • org.apache.log4j.RollingFileAppender(滚动文件，自动记录最新日志)
  • org.apache.log4j.ConsoleAppender (控制台)
  • org.apache.log4j.FileAppender (文件)
  • org.apache.log4j.DailyRollingFileAppender (每天产生一个日志文件)
  • org.apache.log4j.WriterAppender (将日志信息以流格式发送到任意指定的地方)

日记记录的优先级priority，按照从低到高为：

  • 共有8个级别:All < Trace < Debug < Info < Warn < Error < Fatal < OFF

格式说明layout中的参数都以%开始，后面不同的参数代表不同的格式化信息（参数按字母表顺序列出）：

  • %c 输出所属类的全名，可在修改为 %d{Num} ,Num类名输出的维（如：”org.apache.elathen.ClassName”,%C{2}将输出elathen.ClassName）
  • %d 输出日志时间其格式为 %d{yyyy-MM-dd HH:mm:ss,SSS}，可指定格式 如 %d{HH:mm:ss}
  • %l 输出日志事件发生位置，包括类目名、发生线程，在代码中的行数
  • %n 换行符
  • %m 输出代码指定信息，如info(“message”),输出message
  • %p 输出优先级，即 FATAL ,ERROR 等
  • %r 输出从启动到显示该log信息所耗费的毫秒数
  • %t 输出产生该日志事件的线程名

转载请注明：Memory的博客 » 点击阅读原文

打赏一个呗

取消

感谢您的支持，我会继续努力的!

扫码支持
扫码支持
扫码打赏，你说多少就多少

打开支付宝扫一扫，即可进行扫码打赏哦