log4j+slf4j管理日志项目迁移logback+slf4j

Posted 2020-10-15

作为一个刚踏入java语言的小学生，最近被安排了一个任务，原有的项目中使用的是log4j日志管理 要转换成logbacak的日志管理。介于之前并未深究log4j和logback日志，所以做起来也很是头疼，不得不查询资料问别人，才勉强完成，所以记录一下从头的步骤，以供别人参考，有不对地方还请大神斧正。

首先提供一下log4j和slf4j以及logback的关系图

第一步：我们项目是log4j+转slf4j管理的，要替换成logback，所以需要删除掉log4j和slf4j-log4j12的所有jar包依赖，项目中用到了maven依赖传递无法直接删除，我在maven的pom文件排除了相关依赖。

<exclusions>
<exclusion>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-api</artifactId>
</exclusion>
<exclusion>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-core</artifactId>
</exclusion>
<exclusion>
<groupId>org.apache.logging.log4j</groupId>
<artifactId>log4j-slf4j-impl</artifactId>
</exclusion>
<exclusion>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-log4j12</artifactId>
</exclusion>
</exclusions>

第二步：然后引入相关logback的jar包依赖

<!-- logback日志配置开始 -->
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>slf4j-api</artifactId>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-classic</artifactId>
<version>1.1.2</version>
</dependency>
<dependency>
<groupId>ch.qos.logback</groupId>
<artifactId>logback-core</artifactId>
<version>1.1.2</version>
</dependency>
<dependency>
<groupId>org.slf4j</groupId>
<artifactId>log4j-over-slf4j</artifactId>
<version>1.7.7</version>
</dependency>
<!-- logback日志配置结束 -->

第三步：将原有的log4j.xml或者是log4j.properties删除掉，添加进来logback的配置文件logback.xml，格式依照网上的模板只是改变一下相应的输出位置和文件路径以及日志级别等

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
<!-- 定义日志文件 输入位置 -->
<property name="log_dir" value="/logs/log" />
<!-- 控制台输出 -->
<appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
<encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
<pattern>%d %-5p %c{2} - [%m]%n</pattern>
</encoder>
</appender>
<!-- 按照每天生成日志文件 -->
<appender name="DEFAULT-APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${log_dir}/default/default.log.%d{yyyyMMdd}</FileNamePattern>
<!-- 日志生成30天有效 -->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder charset="UTF-8">
<pattern>%d %-5p %c{2} - [%m]%n</pattern>
</encoder>
</appender>

<appender name="BUSINESS-APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志文件输出的文件名-->
<FileNamePattern>${log_dir}/business/business.log.%d{yyyyMMdd}</FileNamePattern>
<!-- 日志生成30天有效 -->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder charset="UTF-8">
<pattern>%d %-5p %c{2} - [%m]%n</pattern>
</encoder>
</appender>

<!-- ERROR级别日志 -->
<!-- 滚动记录文件，先将日志记录到指定文件，当符合某个条件时，将日志记录到其他文件 RollingFileAppender -->
<appender name="ERROR-APPENDER" class="ch.qos.logback.core.rolling.RollingFileAppender">
<!-- 过滤器，只记录ERROR级别的日志 -->
<filter class="ch.qos.logback.classic.filter.LevelFilter">
<level>ERROR</level>
<onMatch>ACCEPT</onMatch>
<onMismatch>DENY</onMismatch>
</filter>
<!-- 最常用的滚动策略，它根据时间来制定滚动策略.既负责滚动也负责出发滚动 -->
<rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
<!--日志输出位置 -->
<fileNamePattern>${log_dir}/error/error.log.%d{yyyyMMdd}</fileNamePattern>
<!-- 保留 30天数据-->
<MaxHistory>30</MaxHistory>
</rollingPolicy>
<encoder charset="UTF-8">
<pattern>%d %-5p %c{2} - [%m]%n</pattern>
</encoder>
</appender>
<logger name="com.logs.user.log" additivity="false">
<level value="INFO"/>
<appender-ref ref="BUSINESS-APPENDER"/>
<appender-ref ref="ERROR-APPENDER"/>
</logger>
<!-- 日志输出级别 -->
<root level="DEBUG">
<appender-ref ref="DEFAULT-APPENDER" />
<appender-ref ref="ERROR-APPENDER" />
<appender-ref ref="STDOUT" />
</root>
</configuration>

最后一步：查看代码中引用的依赖和代码是否正确。

我们项目中有的用了slf4j，所以这个不用更改代码，因为logback适配到slf4j的代码完全与log4j一样。

如果是用了log4j管理的，那就要更改代码了。例如我们项目：

import org.log4j.Logger;引用了log4j的依赖

private static final Logger LOGGER = Logger.getLogger(Testcache.class)

更改后的代码：

import org.slf4j.Logger;

import org.slf4j.LoggerFactory;

private static final Logger LOGGER = LoggerFactory.getLogger(Testcache.class)；

这样就结束了。也可以写一个本地方法来测试一下：

import org.slf4j.LoggerFactory;

import org.slf4j.Logger;

public class Test {

private static Logger logger = (Logger) LoggerFactory.getLogger(Test.class);

public static void main(String[] args) {
logger.debug("debug");
logger.info("info");
logger.error("error");
}
}

执行这个main方法查看日志的输出路径、位置、格式、都正确以后就ok了。