SpringBoot>04 -日志配置

简介:

日志在项目中是非常重要的，本文介绍了springboot默认的日志配置，及使用logback 自定义日志配置。

日志管理：

springboot默认集成了 Commons Logging ,只需在配置文件中配置即可:

# 日志级别 TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF 默认 INFO
# 屏蔽某个或者多个包下不输出日志也不记录日志到文件内
# 也可以改变某个包下的日志输出等级，只需要将'OFF'改成对应等级即可
# 在application.yml配置文件内，off必须添加双引号，否则不会生效。
logging.level.com.coolron.user.controller=off
# 如需显示 sql 语句  只需要改mapper(dao) 接口所在包的日志级别即可
logging.level.com.coolron.user.dao=debug

# Spring Boot默认配置只会输出到控制台，并不会记录到文件中，但是我们通常生产环境使用时都需要以文件方式记录
# 配置 logging.file或 logging.path属性即可输出日志到文件
# 可以是绝对路径，也可以是相对路径
#logging.file=my.log
logging.path=./log
# 控制台多彩输出
spring.output.ansi.enabled=DETECT

测试:
请求接口：http://localhost:8088/user/getInfo/3
项目中生成日志文件：
在这里插入图片描述
控制台：

至此日志管理功能基本完成。

自定义日志配置：

也可使用自定义的日志配置，此处选择logback举例。Spring Boot官方推荐优先使用带有-spring的文件名作为你的日志配置（如使用logback-spring.xml，而不是logback.xml），命名为logback-spring.xml的日志配置文件。

可以通过logging.config属性指定自定义的名字：

logging.config=classpath:customName-config.xml

将logback-spring.xml文件放src/main/resources下即可。
在这里插入图片描述
logback-spring.xml 配置文件:

<?xml version="1.0" encoding="UTF-8"?>
<configuration debug="false">
    <!--使用spring扩展profile支持，要以logback-spring.xml命名-->

    <!-- 彩色日志 -->
    <!-- 彩色日志依赖的渲染类 -->
    <conversionRule conversionWord="clr" converterClass="org.springframework.boot.logging.logback.ColorConverter" />
    <conversionRule conversionWord="wex" converterClass="org.springframework.boot.logging.logback.WhitespaceThrowableProxyConverter" />
    <conversionRule conversionWord="wEx" converterClass="org.springframework.boot.logging.logback.ExtendedWhitespaceThrowableProxyConverter" />
    <!-- 彩色日志格式 -->
    <property name="CONSOLE_LOG_PATTERN" value="${CONSOLE_LOG_PATTERN:-%clr(%d{yyyy-MM-dd HH:mm:ss.SSS}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}}" />
    <property name="FILE_LOG_PATTERN" value="%-12(%d{yyyy-MM-dd HH:mm:ss.SSS}) |-%-5level [%thread] %c [%L] -| %msg%n" />
    <!--定义日志文件的存储地址 勿在 LogBack 的配置中使用相对路径-->
    <property name="LOG_HOME" value="./logs" />

    <!-- 控制台彩色日志输出 -->
    <appender name="CONSOLE" class="ch.qos.logback.core.ConsoleAppender">
        <encoder>
            <pattern>${CONSOLE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
    </appender>
    <!-- 按照每天生成日志文件 -->
    <appender name="FILE"  class="ch.qos.logback.core.rolling.RollingFileAppender">
       <!-- <File>./logs/btmpool.log</File>--><!--不指定会出现Linux无法输出文件-->
        <rollingPolicy class="ch.qos.logback.core.rolling.TimeBasedRollingPolicy">
            <!--日志文件输出的文件名-->
            <FileNamePattern>${LOG_HOME}/runtime.log.%d{yyyy-MM-dd}.log</FileNamePattern>
            <!--日志文件保留天数-->
            <MaxHistory>30</MaxHistory>
        </rollingPolicy>
        <encoder class="ch.qos.logback.classic.encoder.PatternLayoutEncoder">
            <!--格式化输出：%d表示日期，%thread表示线程名，%-5level：级别从左显示5个字符宽度%msg：日志消息，%n是换行符-->
            <pattern>${FILE_LOG_PATTERN}</pattern>
            <charset>utf8</charset>
        </encoder>
        <!--日志文件最大的大小-->
        <triggeringPolicy class="ch.qos.logback.core.rolling.SizeBasedTriggeringPolicy">
            <MaxFileSize>10MB</MaxFileSize>
        </triggeringPolicy>
    </appender>

    <!-- 输出 sql 配置成 DEBUG 级别 多个包需要一次指定-->
    <logger name="com.coolron.user.dao" level="DEBUG"/>
    <!--<logger name="com.coolron.city.dao" level="DEBUG"/>-->

    <!-- 日志输出级别 -->
    <root level="INFO">
        <appender-ref ref="CONSOLE" />
        <appender-ref ref="FILE" />
    </root>
</configuration>

日志测试：

改造 UserController：

@Slf4j
@RestController
@RequestMapping(value = "user")
public class UserController {

    // Lombok 注解 @Slf4j 等效下面
    // private Logger log = LoggerFactory.getLogger(this.getClass());

    @Autowired
    private UserService userService;

    /**
     * 通过用户 id 获取用户信息
     * @param id
     * @return
     */
    @GetMapping(value = "getInfo/{id}")
    public User getInfo(@PathVariable("id") Integer id) {

        // 推荐日志头上加上系统时间,方便查找时追踪
        long systemTime = System.currentTimeMillis();
        log.info(systemTime + ": 根据id获取用户信息>>>用户id为: {}", id);
        User user = userService.getInfo(id);

        // 此处的 user对象 并没有生成 toString() 方法, @Data 注解起效
        log.info(systemTime + ": 用户信息>>>" + user.toString());
        return user;
    }
}

推荐加上系统时间： 如涉及到多方法的调用，可将请求最开始的系统时间传入需调用的方法中，并加到日志的头上，查找时可以通过该时间确定是同一个请求的日志。

日志的打印方式： 可使用 “ + ” 拼接字符串，也可使用 { } 注入结果。
请求接口：http://localhost:8088/user/getInfo/3 结果如下
在这里插入图片描述
至此,自定义日志配置完成。

说明：

此公众号主要是以学习、分享为主。互联网相关的文章很多，如有雷同，还望包涵，如有错误，希望留言或联系我指出。

联系我：
QQ：1421925880
相关springboot、springcloud、docker等文章关注微信公众号：
在这里插入图片描述