Spring Boot日志框架实践

摘要：概述应用中，日志一般分为以下个级别错误信息警告信息一般信息调试信息跟踪信息使用的作为内部的日志框架，其仅仅是一个日志接口，在实际应用中需要为该接口来指定相应的日志实现。默认的日志实现是，是自带的日志包，此外当然也支持这类很流行的日志实现。

Java应用中，日志一般分为以下5个级别：

ERROR 错误信息

WARN 警告信息

INFO 一般信息

DEBUG 调试信息

TRACE 跟踪信息

Spring Boot使用Apache的Commons Logging作为内部的日志框架，其仅仅是一个日志接口，在实际应用中需要为该接口来指定相应的日志实现。

SpringBt默认的日志实现是Java Util Logging，是JDK自带的日志包，此外SpringBt当然也支持Log4J、Logback这类很流行的日志实现。

统一将上面这些日志实现统称为日志框架

下面我们来实践一下！

注： 本文首发于 My 公众号 CodeSheep ，可 长按 或 扫描 下面的 小心心 来订阅 ↓ ↓ ↓

首先application.properties文件中加配置：

logging.level.root=INFO

控制器部分代码如下：

package com.hansonwang99.controller;

import com.hansonwang99.K8sresctrlApplication;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/testlogging")
public class LoggingTestController {
    private static Logger logger = LoggerFactory.getLogger(K8sresctrlApplication.class);
    @GetMapping("/hello")
    public String hello() {
        logger.info("test logging...");
        return "hello";
    }
}

运行结果

由于将日志等级设置为INFO，因此包含INFO及以上级别的日志信息都会打印出来

这里可以看出，很多大部分的INFO日志均来自于SpringBt框架本身，如果我们想屏蔽它们，可以将日志级别统一先全部设置为ERROR，这样框架自身的INFO信息不会被打印。然后再将应用中特定的包设置为DEBUG级别的日志，这样就可以只看到所关心的包中的DEBUG及以上级别的日志了。

控制特定包的日志级别

application.yml中改配置

logging:
  level:
    root: error
    com.hansonwang99.controller: debug

很明显，将root日志级别设置为ERROR，然后再将com.hansonwang99.controller包的日志级别设为DEBUG，此即：即先禁止所有再允许个别的 设置方法

控制器代码

package com.hansonwang99.controller;

import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/testlogging")
public class LoggingTestController {
    private Logger logger = LoggerFactory.getLogger(this.getClass());
    @GetMapping("/hello")
    public String hello() {
        logger.info("test logging...");
        return "hello";
    }
}

运行结果

可见框架自身的INFO级别日志全部藏匿，而指定包中的日志按级别顺利地打印出来

将日志输出到某个文件中

logging:
  level:
    root: error
    com.hansonwang99.controller: debug
  file: ${user.home}/logs/hello.log

运行结果

使用Spring Boot Logging，我们发现虽然日志已输出到文件中，但控制台中依然会打印一份，发现用org.slf4j.Logger是无法解决这个问题的

pom.xml中添加依赖

       
            org.springframework.boot
            spring-boot-starter-web
            
                
                    org.springframework.boot
                    spring-boot-starter-logging
                
            
        
        
            org.springframework.boot
            spring-boot-starter-log4j2
        

在resources目录下添加log4j2.xml文件，内容如下：

其他代码都保持不变

运行程序发现控制台没有日志输出，而hello2.log文件中有内容，这符合我们的预期：

而且日志格式和pattern="%d{HH:mm:ss,SSS} %p %c (%L) - %m%n"格式中定义的相匹配

pom.xml配置：

        
            org.springframework.boot
            spring-boot-starter-web
            
                
                    org.springframework.boot
                    spring-boot-starter-logging
                
            
        

        
            org.springframework.boot
            spring-boot-starter-log4j2
        

log4j2.xml配置

    

        springboot-web
        logs/${app_name}

    
    
        
            
        

        
            
                
                
            
            
            
                
                
                
                
            
            
            
        

        
            
                
                
            
            
            
                
                
                
                
            
            
            
        

        
            
            
            
                
                
                
                
            
            
            
        

    

    


        
            
            
            
            
        

    

控制器代码：

package com.hansonwang99.controller;

import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/testlogging")
public class LoggingTestController {
    private final Logger logger = LogManager.getLogger(this.getClass());
    @GetMapping("/hello")
    public String hello() {
        for(int i=0;i<10_0000;i++){
            logger.info("info execute index method");
            logger.warn("warn execute index method");
            logger.error("error execute index method");
        }
        return "My First SpringBoot Application";
    }
}

运行结果

日志会根据不同的级别存储在不同的文件，当日志文件大小超过2M以后会分多个文件压缩存储，生产环境的日志文件大小建议调整为20-50MB。

作者更多的原创文章在此，欢迎观赏

My Personal Blog

作者更多的SpringBt实践文章在此：

Spring Boot应用监控实战

SpringBoot应用部署于外置Tomcat容器

ElasticSearch搜索引擎在SpringBt中的实践

初探Kotlin+SpringBoot联合编程

Spring Boot日志框架实践

SpringBoot优雅编码之：Lombok加持

如果有兴趣，也可以抽点时间看看作者一些关于容器化、微服务化方面的文章：

利用K8S技术栈打造个人私有云 连载文章

从一份配置清单详解Nginx服务器配置

Docker容器可视化监控中心搭建

利用ELK搭建Docker容器化应用日志中心

RPC框架实践之：Apache Thrift

RPC框架实践之：Google gRPC

微服务调用链追踪中心搭建

Docker容器跨主机通信

Docker Swarm集群初探

高效编写Dockerfile的几条准则