slf4j绑定log4j使用

系列文章目录

前言

slf4j译为简单日志门面，是日志框架的抽象,实现了日志框架一些通用的api，而log4j和logback是众多日志框架中的几种。
log4j和logback可以单独的使用，也可以绑定slf4j一起使用。

1. 单独使用。分别调用框架自己的方法来输出日志信息。
2. 绑定slf4j一起使用。调用slf4j的api来输入日志信息，具体使用与底层日志框架无关（需要底层框架的配置文件）

结构图：

官方文档: https://www.slf4j.org/manual.html

本文主要是操作下slf4j绑定log4j

一、jar包支持

主要是如下三个包：
slf4j-log4j12.jar （适配器，桥接slf4j转log4j）
slf4j-api.jar （slf4j core 使用slf4j必须添加，这是slf4j日志门面，基本上为接口）
log4j.jar （ log4j日志实现）

使用Maven，则只需添加适配器jar包依赖即可：

<dependency>
    <groupId>org.slf4j</groupId>
    <artifactId>slf4j-log4j12</artifactId>
    <version>1.7.21</version>
</dependency>

二、配置文件

log4j的正常运行需要配置文件，配置文件类型（二选一）：

1. log4j.xml
2. log4j.properties

log4j.properties的配置文件书写和字段含义可以参考链接:
http://www.blogjava.net/alexprefect/articles/372959.html
https://blog.csdn.net/lgxzzz/article/details/119751533

这里使用xml配置，配置文件如下

<?xml version="1.0" encoding="UTF-8"?>
<!DOCTYPE log4j:configuration SYSTEM "log4j.dtd">

<log4j:configuration>

    <!-- 将日志信息输出到控制台 -->
    <appender name="ConsoleAppender" class="org.apache.log4j.ConsoleAppender">
        <!-- 设置日志输出的样式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 设置日志输出的格式 -->
            <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss:SSS} %-5p [method:%l] %m%n" />
        </layout>
        <!--过滤器设置输出的级别-->
        <filter class="org.apache.log4j.varia.LevelRangeFilter">
            <!-- 设置日志输出的最小级别 -->
            <param name="levelMin" value="DEBUG" />
            <!-- 设置日志输出的最大级别 -->
            <param name="levelMax" value="ERROR" />
            <!-- 设置日志输出的xxx，默认是false -->
            <param name="AcceptOnMatch" value="true" />
        </filter>
    </appender>

    <!-- 将日志信息输出到文件，但是当文件的大小达到某个阈值的时候，日志文件会自动回滚 -->
    <appender name="RollingFileAppender" class="org.apache.log4j.RollingFileAppender">
        <!-- 设置日志信息输出文件全路径名 -->
        <param name="File" value="D:/myCode/学习/log/logFolder/RollingFileAppender.log" />
        <!-- 设置是否在重新启动服务时，在原有日志的基础添加新日志 -->
        <param name="Append" value="true" />
        <!-- 设置保存备份回滚日志的最大个数 -->
        <param name="MaxBackupIndex" value="10" />
        <!-- 设置当日志文件达到此阈值的时候自动回滚，单位可以是KB，MB，GB，默认单位是KB -->
        <param name="MaxFileSize" value="10KB" />
        <!-- 设置日志输出的样式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 设置日志输出的格式 -->
            <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss:SSS} %-5p [method:%l] %m%n" />
        </layout>
    </appender>

    <!-- 将日志信息输出到文件，可以配置多久产生一个新的日志信息文件 -->
    <appender name="DailyRollingFileAppender" class="org.apache.log4j.DailyRollingFileAppender">
        <!-- 设置日志信息输出文件全路径名 -->
        <param name="File" value="D:/myCode/学习/log/logFolder/DailyRollingFileAppender.log" />
        <!-- 设置日志每分钟回滚一次，即产生一个新的日志文件 -->
        <param name="DatePattern" value="'.'yyyy-MM-dd-HH-mm'.log'" />
        <!-- 设置日志输出的样式 -->
        <layout class="org.apache.log4j.PatternLayout">
            <!-- 设置日志输出的格式 -->
            <param name="ConversionPattern" value="%d{yyyy-MM-dd HH:mm:ss:SSS} %-5p [method:%l] %m%n" />
        </layout>
    </appender>

    <!-- 指定logger的设置，additivity指示是否遵循缺省的继承机制-->
    <logger name="DailyRollingFileAppender" additivity="true">
        <level value ="WARN"/>
        <appender-ref ref="DailyRollingFileAppender"/>
    </logger>

    <!--指定logger的设置，additivity指示是否遵循缺省的继承机制 -->
    <logger name="RollingFileAppender" additivity="true">
        <level value ="ERROR"/>
        <appender-ref ref="RollingFileAppender"/>
    </logger>

    <!-- 根logger的设置-->
    <root>
        <level value ="info"/>
        <appender-ref ref="ConsoleAppender"/>
        <appender-ref ref="DailyRollingFileAppender"/>
        <appender-ref ref="RollingFileAppender"/>
    </root>

</log4j:configuration>

三、代码测试

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

public class TestLog4j {

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

    public static void main(String[] args) {
        // 打印日志信息
        logger.trace("slf4j-log4j日志输出：This is trace message.");
        logger.debug("slf4j-log4j日志输出：This is debug message.");
        logger.info("slf4j-log4j日志输出：This is info message.");
        logger.warn("slf4j-log4j日志输出：This is warn message.");
        logger.error("slf4j-log4j日志输出：This is error message.");

        String key = "x";
        String value = "a";
        // 使用占位符输出日志信息
        logger.info("The {} = {}.", key, value);
        logger.info("The [{}] = [{}].", key, value);
        try {
            int i = 1 / 0;
        } catch (Exception e) {
            // 将系统异常信息写入日志
            logger.error("出现异常：", e);
        }
    }
}

测试结果

输出到文件

试下来，其实就是软件工程的思维，可以直接使用log4j，但这样不便于后续日志系统的变更，所以引入slf4j，也就是面向接口编程，具体需要使用哪个日志系统，则可以灵活改变