spring log4j 配置 profile spring使用log4j2

转载

mob64ca13fa2f9e 2024-06-07 10:50:33

Log在SpringBoot中的实现

log4j与slf4j的区别

log4j : 即 log for java；Java的日志4英文名 four 与for同音
slf4j : simple log facade for java ：简单日志门面

区别：
log4j是真正实现日志功能的产品，像这样的产品有很多

slf4j 是一个适配器，我们通过调用slf4j的日志方法统一打印我们的日志，而可以忽略其他日志的具体方法，这样，当我们的系统换了一个日志源后，不需要更改代码：

假设日志系统A的info日志输出方法如下
A.message();
日志系统B的info日志输出方法如下
B.show();
log4j的info日志输出方法如下：
logger.getInfo()     //演示用  实际不是这个方法

slf4j的实现就是：
slf4j slf4j = new slf4j (A);
log.info();
这样我们用的就是日志系统A的方法，

现在假设我们的系统所在环境仅仅有log4j的日志输出环境，那么原来系统仅仅需要配置新的日志源即可
slf4j slf4j = new slf4j (log4j);

而不需要更改其他代码

接口用于定制规范，可以有多个实现，使用时是面向接口的(导入的包都是 slf4j 的包而不是具体某个日志框架中的包)，即直接和接口交互，不直接使用实现，所以可以任意的更换实现而不用更改代码中的日志相关代码。

比如：slf4j 定义了一套日志接口，项目中使用的日志框架是logback，开发中调用的所有接口都是 slf4j 的，不直接使用 logback，调用是自己的工程调用 slf4j 的接口，slf4j 的接口去调用 logback 的实现，可以看到整个过程应用程序并没有直接使用 logback，当项目需要更换更加优秀的日志框架时(如log4j2)只需要引入 log4j2 的 jar 和 Llg4j2 对应的配置文件即可，完全不用更改 Java 代码中的日志相关的代码 logger.info(“xxx”)，也不用修改日志相关的类的导入的包( import org.slf4j.Logger; import org.slf4j.LoggerFactory;)

总结：使用日志接口便于更换为其他日志框架。

log4j2和log4j

简单来说就是log4j2是log4j的升级版本，我们拥抱新的技术，不是我们不去刨根问底追根溯源，诚然那样会更了解这门技术，但是人生苦短，狄云在雪山里不也是学会了血刀门的刀法才能在奸诈的花铁干手下活下来的。

日志级别

在log4j2中，共有8个级别，按照从低到高为：ALL < TRACE < DEBUG < INFO < WARN < ERROR < FATAL < OFF。

All:最低等级的，用于打开所有日志记录.

Trace:是追踪，就是程序推进一下.

Debug:指出细粒度信息事件对调试应用程序是非常有帮助的.

Info:消息在粗粒度级别上突出强调应用程序的运行过程.

Warn:输出警告及warn以下级别的日志.

Error:输出错误信息日志.

Fatal:输出每个严重的错误事件将会导致应用程序的退出的日志.

OFF:最高等级的，用于关闭所有日志记录.

依赖配置

原来的配置是

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

修改为

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
            <!-- 去掉logback配置 -->
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.springframework.boot/spring-boot-starter-log4j2 -->
        <!-- 引入log4j2依赖 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-log4j2</artifactId>
            <version>2.4.3</version>
        </dependency>

配置文件

/main/resources下新建文件log4j2.xml，内容如下,直接复制即可

<?xml version="1.0" encoding="UTF-8"?>
<!--Configuration后面的status，这个用于设置log4j2自身内部的信息输出，可以不设置，当设置成trace时，你会看到log4j2内部各种详细输出-->
<!--monitorInterval：Log4j能够自动检测修改配置 文件和重新配置本身，设置间隔秒数-->
<configuration monitorInterval="5">
    <!--日志级别以及优先级排序: OFF > FATAL > ERROR > WARN > INFO > DEBUG > TRACE > ALL -->

    <!--变量配置-->
    <Properties>
        <!-- 格式化输出：%date表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度 %msg：日志消息，%n是换行符-->
        <!-- %logger{36} 表示 Logger 名字最长36个字符 -->
        <property name="LOG_PATTERN" value="%date{HH:mm:ss.SSS} [%thread] %-5level %logger{36} - %msg%n" />
        <!-- 定义日志存储的路径 ，FILE_PATH其实就是在根目录下创建了/logs/log4j2，FILE_NAME主要是在生成压缩包的时候才会用到,推荐根据自己的项目名做更改-->
        <property name="FILE_PATH" value="./logs/log4j2" />
        <property name="FILE_NAME" value="crud" />
    </Properties>

    <appenders>

        <console name="Console" target="SYSTEM_OUT">
            <!--输出日志的格式-->
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <!--控制台只输出level及其以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
        </console>

        <!--文件会打印出所有信息，这个log每次运行程序会自动清空，由append属性决定，适合临时测试用-->
        <File name="Filelog" fileName="${FILE_PATH}/test.log" append="false">
            <PatternLayout pattern="${LOG_PATTERN}"/>
        </File>

        <!-- 这个会打印出所有的info及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileInfo" fileName="${FILE_PATH}/info.log" filePattern="${FILE_PATH}/${FILE_NAME}-INFO-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="info" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的warn及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileWarn" fileName="${FILE_PATH}/warn.log" filePattern="${FILE_PATH}/${FILE_NAME}-WARN-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="warn" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

        <!-- 这个会打印出所有的error及以下级别的信息，每次大小超过size，则这size大小的日志会自动存入按年份-月份建立的文件夹下面并进行压缩，作为存档-->
        <RollingFile name="RollingFileError" fileName="${FILE_PATH}/error.log" filePattern="${FILE_PATH}/${FILE_NAME}-ERROR-%d{yyyy-MM-dd}_%i.log.gz">
            <!--控制台只输出level及以上级别的信息（onMatch），其他的直接拒绝（onMismatch）-->
            <ThresholdFilter level="error" onMatch="ACCEPT" onMismatch="DENY"/>
            <PatternLayout pattern="${LOG_PATTERN}"/>
            <Policies>
                <!--interval属性用来指定多久滚动一次，默认是1 hour-->
                <TimeBasedTriggeringPolicy interval="1"/>
                <SizeBasedTriggeringPolicy size="10MB"/>
            </Policies>
            <!-- DefaultRolloverStrategy属性如不设置，则默认为最多同一文件夹下7个文件开始覆盖-->
            <DefaultRolloverStrategy max="15"/>
        </RollingFile>

    </appenders>

    <!--Logger节点用来单独指定日志的形式，比如要为指定包下的class指定不同的日志级别等。-->
    <!--然后定义loggers，只有定义了logger并引入的appender，appender才会生效-->
    <loggers>

        <!--过滤掉spring和mybatis的一些无用的DEBUG信息-->
        <logger name="org.mybatis" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </logger>
        <!--监控系统信息-->
        <!--若是additivity设为false，则 子Logger 只会在自己的appender里输出，而不会在 父Logger 的appender里输出。-->
        <Logger name="org.springframework" level="info" additivity="false">
            <AppenderRef ref="Console"/>
        </Logger>

        <root level="info">
            <appender-ref ref="Console"/>
            <appender-ref ref="Filelog"/>
            <appender-ref ref="RollingFileInfo"/>
            <appender-ref ref="RollingFileWarn"/>
            <appender-ref ref="RollingFileError"/>
        </root>
    </loggers>

</configuration>

配置

在项目配置文件application.yml中新增配置

logging:
  config: classpath:log4j2.xml

如何使用

package com.crud.controller;

import com.crud.entity.User;
import com.crud.service.impl.UserServiceImpl;
import com.crud.utils.PageRequest;
import com.crud.utils.RedisUtils;
import com.crud.utils.Result;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;
import java.util.concurrent.TimeUnit;

@RestController
@RequestMapping("/crud")
public class UserController {
    // 注意一定要引入slf4j.Logger，第一次使用可能会倒入其他的，然后在这里就提示需要转型
    private static final Logger log = LoggerFactory.getLogger(UserController.class);
    @RequestMapping(value = "/redis",method = RequestMethod.POST)
    public String redis(@RequestParam(value = "id")Integer id){
        User user=userService.getUserById(id);
        String username=user.getUsername();
        boolean hasKey=redisUtils.hasKey(username);
        if (hasKey){
            Object value=redisUtils.get(username);
            String str = value.toString();
            log.error("从缓存中取出来的数据为:"+str);
            return "从缓存中取出来的数据为"+str;
        }else {
            log.error("从数据库中取数据");
            redisUtils.set(username,user,100000);
            return "从数据库中取数据"+user.toString();
        }
    }
}

日志输出：

14:10:30.504 [http-nio-8082-exec-2] ERROR com.crud.controller.UserController - 从数据库中取数据

14:10:44.284 [http-nio-8082-exec-3] ERROR com.crud.controller.UserController - 从缓存中取出来的数据为:User(id=1, username=markerhub, avatar=https://image-1300566513.cos.ap-guangzhou.myqcloud.com/upload/images/5a9f48118166308daba8b6da7e466aab.jpg, email=xxx@xxx.com, password=96e79218965eb72c92a549dd5a330112, status=0, created=2021-06-02 17:52:01, last_login=null)

生成的持久化日志文件

在项目的根目录/logs/log4j2里有日志文件

返回取看一下刚才直接复制的log4j2.xml

<property name="FILE_PATH" value="./logs/log4j2" />
    fileName="${FILE_PATH}/error.log"

@Slf4j

如果不想每次都写private final Logger logger = LoggerFactory.getLogger(当前类名.class); 可以用注解@Slf4j;

前提：安装了lombok

package com.crud.controller;

import com.crud.entity.User;
import com.crud.service.impl.UserServiceImpl;
import com.crud.utils.PageRequest;
import com.crud.utils.RedisUtils;
import com.crud.utils.Result;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;
@Slf4j
@RestController
@RequestMapping("/crud")
public class UserController {
    @Autowired
    private UserServiceImpl userService;
    @Autowired
    private RedisUtils redisUtils;
    @RequestMapping(value = "/redis",method = RequestMethod.POST)
    public String redis(@RequestParam(value = "id")Integer id){
        User user=userService.getUserById(id);
        String username=user.getUsername();
        boolean hasKey=redisUtils.hasKey(username);
        if (hasKey){
            Object value=redisUtils.get(username);
            String str = value.toString();
            log.error("从缓存中取出来的数据为:"+str);
            return "从缓存中取出来的数据为"+str;
        }else {
            log.error("从数据库中取数据");
            redisUtils.set(username,user,100000);
            return "从数据库中取数据"+user.toString();
        }
    }
}

报错

后来呢按照上面的教程，再次执行的时候，就报错了

SLF4J: Class path contains multiple SLF4J bindings.
SLF4J: Found binding in [jar:file:/Users/zc/.m2/repository/ch/qos/logback/logback-classic/1.2.11/logback-classic-1.2.11.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: Found binding in [jar:file:/Users/zc/.m2/repository/org/apache/logging/log4j/log4j-slf4j-impl/2.17.2/log4j-slf4j-impl-2.17.2.jar!/org/slf4j/impl/StaticLoggerBinder.class]
SLF4J: See http://www.slf4j.org/codes.html#multiple_bindings for an explanation.
SLF4J: Actual binding is of type [ch.qos.logback.classic.util.ContextSelectorStaticBinder]
Logging system failed to initialize using configuration from 'classpath:log4j2.xml'
java.lang.IllegalStateException: Logback configuration error detected: 
ERROR in ch.qos.logback.core.joran.spi.Interpreter@8:17 - no applicable action for [Properties], current ElementPath  is [[configuration][Properties]]
ERROR in ch.qos.logback.core.joran.spi.Interpreter@11:108 - no applicable action for [property], current ElementPath  is [[configuration][Properties][property]]
ERROR in ch.qos.logback.core.joran.spi.Interpreter@13:60 - no applicable action for [property], current ElementPath  is [[configuration][Properties][property]]
ERROR in ch.qos.logback.core.joran.spi.Interpreter@14:51 - no applicable action for [property], current ElementPath  is [[configuration][Properties][property]]
ERROR in ch.qos.logback.core.joran.spi.Interpreter@17:16 - no applicable action for [appenders], current ElementPath  is [[configuration][appenders]]

spring log4j 配置 profile spring使用log4j2_java

实际是 spring-boot-starter 自带日志依赖而不是 spring-boot-starter-web，下面才是正确的

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

如何快速正确的解决类似重复依赖的问题

下面的内容我没尝试过，抄来的

1 右键pom.xml -> Maven -> Show Dependencies

没有的怎么办呢
原因：IDEA之前为了启动快，关闭了maven扩展插件，重新打开即可。

2 搜索重复的jar包被哪些上层依赖

比如这里要搜索的是 logback-classic-1.2.3.jar 在哪里被依赖

在上面打开的依赖关系图中 crtl + f 打开搜索，然后输入搜索内容 logback-classic，如下:

点击找到的logback-classic ，会看到如下依赖关系:

spring log4j 配置 profile spring使用log4j2_sed_02

3 找到了需要排除的jar被谁用到
那就在pom.xml中用排除掉，
如下:

<dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter</artifactId>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-logging</artifactId>
                </exclusion>
            </exclusions>
        </dependency>

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。