java项目的日志解决方案

最新推荐文章于 2024-05-28 16:48:16 发布

zdkdchao

最新推荐文章于 2024-05-28 16:48:16 发布

阅读量2k

点赞数

文章标签： java

本文链接：https://blog.csdn.net/qq_34224565/article/details/122140494

版权

一、context

Java项目开发过程中免不了要使用日志系统，据调查，java项目10%的代码是日志代码。
目前比较主流的日志框架有slf4j、log4j、log4j2、logback。那么这些日志系统究竟有什么联系和区别呢？
在这里插入图片描述

Slf4j

全称是Simple Loging Facade For Java，仅仅是一个为Java程序提供日志输出的统一接口因为日志具有很强的标准性，所以发明了Slf4j来方便的切换不同的日志底层实现。相当于一个框架接口，Log4j、LogBack相当于框架实现。
单独的slf4j是不能工作的，必须搭配其他具体的日志实现方案。虽然编译的时候没问题但运行的时候会抛错SLF4J: Failed to load class"org.slf4j.impl.StaticLoggerBinder".
在这里插入图片描述

log4j

于2015年停止更新。

LogBack

与Log4j同出一源，都出自Ceki Gülcü之手（log4j的原型是由Ceki Gülcü贡献给Apache基金会的）。logback拥有更好的特性，是用来取代log4j的一个日志实现方案。
Logback是slf4j的原生实现，与Log4j不同（Log4j可以脱离Slf4j单独使用），logback并不建议单独使用，它需要与sfl4j结合起来使用。
分为下面几个模块：
logback-core：其它两个模块的基础模块。
logback-classic：它是log4j的一个改良版本，同时它也完整地实现了slf4j API。
logback-access：访问模块与Servlet容器集成提供通过Http来访问日志的功能。

Log4j2

是Log4j的升级版本。只要log4j版本号2开头的，就是Log4j2。
在多线程情况下，异步日志器具有比Log4j 1.x和Logback高出10倍的吞吐性能以及更低的延迟。
log4j2支持scala

这3种实现都支持configuration、xml、properties配置文件。Log4j2还支持yml、yaml、json、jsn

二、operation&配置文件说明

log4j.xml&& logback.xml && log4j2.xml语法层面非常类似。为了节省篇幅，下面以logback.xml为例子，详细讲解各个属性配置。

1.java

注意：因为3个实现框架都有自己的Logger和LoggerFactory，所以导包时，一定要导org.slf4j.的Logger和LoggerFactory

package logback;  
  
import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
  
public class LogbackDemo {  
	//使用工厂创建logger
    private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);  
    public static void main(String[] args) {  
        log.trace("======trace");  
        log.debug("======debug");  
        log.info("======info");  
        log.warn("======warn");  
        log.error("======error");  
           
        String name = "Aub";  
        String message = "3Q";  
        String[] fruits = { "apple", "banana" };  
          
        // logback提供的可以使用变量的打印方式，结果为"Hello,Aub!"  
        log.info("Hello,{}!", name);  
          
        // 可以有多个参数,结果为“Hello,Aub! 3Q!”  
        log.info("Hello,{}!   {}!", name, message);  
          
        // 可以传入一个数组，结果为"Fruit:  apple,banana"  
        log.info("Fruit:  {},{}", fruits);   
    }  
}

2.根节点configuration

有scan、scanPeriod、debug三个属性。

scan: 当此属性设置为true时，配置文件如果发生改变，将会被重新加载，默认值为true
scanPeriod: 设置监测配置文件是否有修改的时间间隔，如果没有给出时间单位，默认单位是毫秒。当scan为true时，此属性生效。默认的时间间隔为1分钟
debug: 当此属性设置为true时，将打印出logback内部日志信息，实时查看logback运行状态。默认值为false

<!-- 每60s检测一次配置文件修改，不打印logback自身的日志--> 
<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <contextName>myAppName</contextName>  
      <!-- 其他配置省略-->  
</configuration>

3.一级子节点

property && contextName && timestamp&& appender && logger && root

property

用来定义变量
有两个属性，name和value；定义变量后，可以使“${}”来使用变量。

contextName：用于区分不同应用程序，每个logger都关联到各自的contextName，也就是进程

timestamp

获取当前时间的字符串，不同的name对应不同的格式。特殊的property
2个属性：
key 标识此的名字；
datePattern 设置将当前时间（解析配置文件的时间）转换为字符串的模式，遵循java.txt.SimpleDateFormat的格式。

<!-- 将解析配置文件的时间作为上下文名称-->  
<configuration scan="true" scanPeriod="60 seconds" debug="false">  
      <timestamp key="bySecond" datePattern="yyyyMMdd'T'HHmmss"/>   
      <contextName>${bySecond}</contextName>  
      <!-- 其他配置省略-->  
</configuration>

appender：

具体干活的角色，需要设置它服务的对象，比如是全局、还是包、还是类。
可以控制日志输出（位置（文件、控制台）、格式、分割、滚动）
它有很多子节点，最重要的是name节点与class节点。

name：该appender的命名，用来作为变量在logger节点中使用

class：appender实现类的全限定名，定义log的输出位置、展示形式（文件、控制台）、分割、滚动等功能

ch.qos.logback.core.ConsoleAppender：将日志输出到控制台

encoder：日志格式化的配置
target：字符串 System.out 或者 System.err ，默认 System.out ；

<configuration>  
  
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">  
    <encoder>  
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg %n</pattern>  
    </encoder>  
  </appender>  
  
  <root level="DEBUG">  
    <appender-ref ref="STDOUT" />  
  </root>  
</configuration>

ch.qos.logback.core.FileAppender：将日志输出到文件

file：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
append：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
encoder：日志格式化的配置
prudent：如果是 true，日志会被安全的写入文件，即使其他的FileAppender也在向此文件做写入操作，效率低，默认是 false。

<configuration>  
  
  <appender name="FILE" class="ch.qos.logback.core.FileAppender">  
    <file>testFile.log</file>  
    <append>true</append>  
    <encoder>  
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>  
    </encoder>  
  </appender>  
          
  <root level="DEBUG">  
    <appender-ref ref="FILE" />  
  </root>  
</configuration>

ch.qos.logback.core.RollingFileAppender

滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件。
有以下子节点：

file：被写入的文件名，可以是相对目录，也可以是绝对目录，如果上级目录不存在会自动创建，没有默认值。
append：如果是 true，日志被追加到文件结尾，如果是 false，清空现存文件，默认是true。
encoder：日志格式化的配置
rollingPolicy:当发生滚动时，决定 RollingFileAppender 的行为，涉及文件移动和重命名。
triggeringPolicy : 告知 RollingFileAppender 何时激活滚动。
prudent：当为true时，不支持FixedWindowRollingPolicy。支持TimeBasedRollingPolicy，但是有两个限制，1不支持也不允许文件压缩，2不能设置file属性，必须留空。
rollingPolicy：
TimeBasedRollingPolicy：最常用的滚动策略，它根据时间来制定滚动策略，既负责滚动也负责出发滚动。有以下子节点：
fileNamePattern:
必要节点，包含文件名及“%d”转换符， “%d”可以包含一个java.text.SimpleDateFormat指定的时间格式，如：%d{yyyy-MM}。如果直接使用 %d，默认格式是 yyyy-MM-dd。RollingFileAppender 的file字节点可有可无，通过设置file，可以为活动文件和归档文件指定不同位置，当前日志总是记录到file指定的文件（活动文件），活动文件的名字不会改变；如果没设置file，活动文件的名字会根据fileNamePattern 的值，每隔一段时间改变一次。“/”或者“\”会被当做目录分隔符。
maxHistory:
可选节点，控制保留的归档文件的最大数量，超出数量就删除旧文件。假设设置每个月滚动，且maxHistory是6，则只保存最近6个月的文件，删除之前的旧文件。注意，删除旧文件是，那些为了归档而创建的目录也会被删除。
FixedWindowRollingPolicy：根据固定窗口算法重命名文件的滚动策略。有以下子节点：
minIndex:窗口索引最小值
maxIndex:窗口索引最大值，当用户指定的窗口过大时，会自动将窗口设置为12。
fileNamePattern :
必须包含“%i”例如，假设最小值和最大值分别为1和2，命名模式为 mylog%i.log,会产生归档文件mylog1.log和mylog2.log。还可以指定文件压缩选项，例如，mylog%i.log.gz 或者没有log%i.log.zip

triggeringPolicy:

SizeBasedTriggeringPolicy：查看当前活动文件的大小，如果超过指定大小会告知 RollingFileAppender 触发当前活动文件滚动。只有一个节点:

maxFileSize:这是活动文件的大小，默认值是10MB。

example1：
每天生成一个日志文件，保存30天的日志文件。

<configuration>   
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">   
      
    <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">   
      <fileNamePattern>logFile.%d{yyyy-MM-dd}.log</fileNamePattern>   
      <maxHistory>30</maxHistory>    
    </rollingPolicy>   
   
    <encoder>   
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
    </encoder>   
  </appender>    
   
  <root level="DEBUG">   
    <appender-ref ref="FILE" />   
  </root>   
</configuration>

example2：
按照固定窗口模式生成日志文件，当文件大于20MB时，生成新的日志文件。窗口大小是1到3，当保存了3个归档文件后，将覆盖最早的日志。

<configuration>   
  <appender name="FILE" class="ch.qos.logback.core.rolling.RollingFileAppender">   
    <file>test.log</file>   
   
    <rollingPolicy class="ch.qos.logback.core.rolling.FixedWindowRollingPolicy">   
      <fileNamePattern>tests.%i.log.zip</fileNamePattern>   
      <minIndex>1</minIndex>   
      <maxIndex>3</maxIndex>   
    </rollingPolicy>   
   
    <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">   
      <maxFileSize>5MB</maxFileSize>   
    </triggeringPolicy>   
    <encoder>   
      <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
    </encoder>   
  </appender>   
           
  <root level="DEBUG">   
    <appender-ref ref="FILE" />   
  </root>   
</configuration>

另外还有SocketAppender、SMTPAppender、DBAppender、SyslogAppender、SiftingAppender，并不常用，这些就不在这里讲解了，大家可以参考官方文档。当然大家可以编写自己的Appender。

encoder：
负责两件事，一是把日志信息转换成字节数组，二是把字节数组写入到输出流。

目前PatternLayoutEncoder 是唯一有用的且默认的encoder ，有一个pattern节点，用来设置日志的输入格式。使用“%”加“转换符”方式，如果要输出“%”，则必须用“\”对“%”进行转义。

<encoder>   
   <pattern>%-4relative [%thread] %-5level %logger{35} - %msg%n</pattern>   
</encoder>

logger

有时需要给某个程序下的某个类、包单独设置appender。
用来设置某一个包或者具体的某一个类的日志打印级别、以及指定<appender>。<loger>有name属性，一个可选的level和一个可选的addtivity属性。
name:
用来指定受此loger约束的某一个包或者具体的某一个类。
level:
用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，还有一个特俗值INHERITED或者同义词NULL，代表强制执行上级的级别。
如果未设置此属性，那么当前loger将会继承上级的级别。

addtivity:
是否向上级loger传递打印信息。默认是true。

loger可以包含零个或多个appender-ref元素，标识这个appender将会添加到这个loger。
在这里插入图片描述

root

根logger，即本应用默认的logger组件。注意root和logger是并列的标签。
没有单独设置logger的类，全都用root中设置的level、class、encoder

只有一个level属性，应为已经被命名为"root"
level:
用来设置打印级别，大小写无关：TRACE, DEBUG, INFO, WARN, ERROR, ALL 和 OFF，不能设置为INHERITED或者同义词NULL。
默认是DEBUG。

root可以包含零个或多个appender-ref元素，标识这个appender将会添加到这个loger。

这里其实就是给LogbackDemo这个类设置了一个logger，只不过写在了代码中而已，只在这个LogbackDemo.class中生效
package logback;  
  
import org.slf4j.Logger;  
import org.slf4j.LoggerFactory;  
  
public class LogbackDemo {  
    private static Logger log = LoggerFactory.getLogger(LogbackDemo.class);  
    public static void main(String[] args) {  
        log.trace("======trace");  
        log.debug("======debug");  
        log.info("======info");  
        log.warn("======warn");  
        log.error("======error");  
    }  
}

三、application

1.多环境日志输出

<configuration>
    ...
 
    <!-- 测试环境+开发环境. 多个使用逗号隔开. -->
    <springProfile name="test,dev">
        <logger name="com.example.demo.controller" level="DEBUG" additivity="false">
            <appender-ref ref="consoleLog"/>
        </logger>
    </springProfile>
 
    <!-- 生产环境. -->
    <springProfile name="prod">
        <logger name="com.example.demo.controller" level="INFO" additivity="false">
            <appender-ref ref="consoleLog"/>
        </logger>
    </springProfile>
</configuration>

server:
  port: 9010
 
spring:
  profiles:
    active: dev #application.yml增加环境选择的配置。active: 【test、dev、prod】，根据 active 的环境，自动采用上面配置的springProfile的 logger 日志
  datasource:
    url: jdbc:mysql://localhost:3306/test?characterEncoding=utf8
    username: root
    password: root
 
mybatis:
    type-aliases-package: org.larry.springboot.entity
    mapper-locations: classpath:mapper/**/*.xml
    check-config-location: true

2.导包、切换实现框架

导包时，只需要到slf4j，不需要指定实现框架
切换实现框架时，只需要修改pom然后添加对应的配置文件即可

log4j

<dependencies>
    <!-- 接口层：SLF4j的API-->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-api</artifactId>
    </dependency>
    <!-- 适配层：SLF4j与log4j的纽带-->
    <dependency>
        <groupId>org.slf4j</groupId>
        <artifactId>slf4j-log4j12</artifactId>
    </dependency>
    <!-- 实现层：Log4j的真正实现-->
    <dependency>
        <groupId>log4j</groupId>
        <artifactId>log4j</artifactId>
    </dependency>
</dependencies>

但是，查看适配层slf4j-log4j12的pom文件的依赖，发现其自身依赖于org.slf4j.slf4j-api && log4j.log4j。
因此，若忽略org.slf4j.slf4j-api && log4j.log4j版本的限制，上述的依赖关系等同于

<dependencies>
    <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-log4j12</artifactId>
    </dependency>
</dependencies>

logback

<dependencies>
    <!-- 接口层：SLF4j的API-->
    <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
    </dependency>
    <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-classic</artifactId>
    </dependency>
    <dependency>
       <groupId>ch.qos.logback</groupId>
       <artifactId>logback-core</artifactId>
    </dependency>
</dependencies>

log4j2

<dependencies>
    <!-- 接口层：SLF4j的API-->
    <dependency>
       <groupId>org.slf4j</groupId>
       <artifactId>slf4j-api</artifactId>
    </dependency>
    <!-- 适配层：SLF4j与log4j2的纽带-->
    <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-slf4j-impl</artifactId>
    </dependency>
    <!-- 实现层：Log4j2的真正实现-->
    <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-api</artifactId>
    </dependency>
    <dependency>
       <groupId>org.apache.logging.log4j</groupId>
       <artifactId>log4j-core</artifactId>
    </dependency>
</dependencies>

3.日志框架优先级

Slf4j通过查找class文件"org/slf4j/impl/StaticLoggerBinder.class"来识别当前的日志系统。
此时，若当前的应用既依赖了LOG4j的适配层，又同时依赖了LOG4j2的适配层，或同时依赖了logback，那么会发生什么呢？
在这里插入图片描述
Slf4j会抛出异常，告诉用户当前应用存在多个日志系统。但不会终止程序运行，因为会自动使用优先级高的
那么此时，SLF4j采用的是哪一套日志系统呢？
通过实验可知，Slf4j会根据依赖包的加载顺序不同，使用不同的日志系统。

zdkdchao

关注

0
点赞
踩
7

收藏

觉得还不错? 一键收藏
0
评论
java项目的日志解决方案

Java项目开发过程中免不了要使用日志系统，据调查，java项目10%的代码是日志代码。目前比较主流的日志系统有slf4j、log4j、log4j2、logback。那么这些日志系统究竟有什么联系和区别呢？Slf4j，全称是Simple Loging Facade For Java，仅仅是一个为Java程序提供日志输出的统一接口，因为日志具有很强的标准性，所以发明了Slf4j来方便的切换不同的日志底层实现。相当于一个框架接口，Log4j、LogBack相当于框架实现。log4j于2015年停止更新
复制链接

扫一扫