【springboot】日志记录

太过爱你忘了你带给我的痛 2024-03-27 11:06 65阅读 0赞

## 常见日志框架介绍 ##

日志就是把项目的运行状况打印在控制台或文件中，以方便项目的调试

日志框架分为抽象层和实现层

### 抽象层 ###

*  JCL（Jakarta Commons Logging）
 *  SLF4j（Simple Logging Facade for Java）

### 实现层 ###

*  JUL（java.util.logging）
 *  Log4j
 *  Log4j2
 *  Logback

## Springboot ##

SpringBoot 默认选择的是 SLF4J + Logback 的组合，如果不需要更改为其他日志系统（如 Log4j2 等），则无需多余的配置，LogBack 默认会将日志打印到控制台上。

> 由于新建的 Spring Boot 项目一般都会引用 spring-boot-starter 或者 spring-boot-starter-web，而这两个起步依赖中都已经包含了对于 spring-boot-starter-logging 的依赖，所以，我们无需额外添加依赖。

![在这里插入图片描述][691aa9eefe4844c7acce3fe36fd8723f.png]

import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    @Controller
    public class UploadFileController {
        
        Logger logger = LoggerFactory.getLogger(getClass());
        @GetMapping("/test")
        public void test1(){
        
            logger.trace("trace日志");
            logger.debug("debug日志");
            logger.info("info日志");
            logger.warn("warn日志");
            logger.error("error日志");
        }
     }

![在这里插入图片描述][d41a96c41fba449c9a2520626fa3c089.png]

> 如果项目中使用了lombok插件，可以使用@Slf4j注解 直接获取log  
> 参考资料：https://blog.csdn.net/qq\_40435659/article/details/114370663
> 
>     import org.slf4j.Logger;
>     import org.slf4j.LoggerFactory;
>     @Controller
>     @Slf4j
>     public class UploadFileController {
>          
>       
>        @GetMapping("/test")
>       public void test1(){
>          
>         log.trace("trace日志");
>        log.debug("debug日志");
>         log.info("info日志");
>        log.warn("warn日志");
>        log.error("error日志");
>     }
>     }

## 日志级别 ##

（1）日志级别从小到大为 trace < debug < info < warn < error < fatal，由于默认日志级别设置为 INFO，因此上面样例 trace 和 debug 级别的日志都看不到。  
（2）我们可以在 applicaition.properties 或application.yml文件中修改日志级别。比如下面将全局日志级别都改成 trace，因此系统所有的日志都能看到：

logging:
    	level:
    		root: trace

> 劝你不要这样干，不然你的控制台会有无穷多的输出

## 将日志输出到文件 ##

生成日志文件  
（1）除了将日志打印到控制台中，项目上线后通常还需要将日志输出到文件。我们只需要通过 logging.file.path 配置文件存放路径即可：

logging:
    	file:
    		path: D:\\upload2\\

![在这里插入图片描述][1600006ca2434e8bb35259ee94b76380.png]

（2）通过 logging.file.path 生成的日志文件名字为 spring.log，如果需要自定义文件名字，则通过 logging.file.name 属性进行配置（此时不需要再配置 logging.file.path）：

logging:
    	file:
    		name: D:\\upload2\\fileuploadproject.log

![在这里插入图片描述][11953c2bd2a64c2ebd973ec5bba4019a.png]  
（3）无论何种设置，Spring Boot 都会自动按天分割日志文件，也就是说每天都会自动生成一个新的 log 文件，而之前的会自动打成 GZ 压缩包。  
![在这里插入图片描述][4f5e683f30ea44e0a803f3b5c23b14c4.png]  
（4）除此之外，我们还可以设置日志文件的保留时间，以及单个文件的大小：

日志文件大小
    logging.file.max-size=10MB
    保留的日志时间
    logging.file.max-history=10

## 输出格式 ##

（1）我们可以分别修改在控制台输出的日志格式，以及文件中日志输出的格式：  
符号说明：

%d{HH:mm:ss.SSS}：日志输出时间
    %-5level：日志级别，并且使用 5 个字符靠左对齐
    %thread：输出日志的进程名字，这在 Web 应用以及异步任务处理中很有用
    %logger：日志输出者的名字
    %msg：日志消息
    %n：平台的换行符

*  修改在控制台输出的日志格式

logging:
      pattern:
        console: "%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n"

*  修改输出到文件的日志格式

logging:
      pattern:
        console: "%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n"
        file: "%d{yyyy-MM-dd HH:mm:ss} [%thread] %-5level %logger{36} - %msg%n"

> 因为含有%，所以格式要放到双引号的字符串中

（2）上面效果图可以发现，原先 Spring Boot 默认使用 Logback 来进行日志输出时，控制台不同参数会输出为不同的颜色。而一旦我们修改了日志格式，彩色也随之消失。如果想让不同类型的数据具有不同的高亮效果，可以改用如下配置：

*  修改在控制台输出的日志格式  
    `logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} %clr(%5p) [%thread] %clr(%logger){cyan} : %msg%n`
 *  修改输出到文件的日志格式  
    `logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger : %msg%n`

（3）如果觉得类名太长（%logger），我们还可以将其设置个长度限制。比如下面限制长度为 45 个字符，超过得话包名部分会变成缩写：

*  修改在控制台输出的日志格式  
    `logging.pattern.console=%d{yyyy-MM-dd HH:mm:ss} %clr(%5p) [%thread] %clr(%logger{45}){cyan} : %msg%n`
 *  修改输出到文件的日志格式  
    `logging.pattern.file=%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger : %msg%n`

> 参考资料
> 
>  *  https://www.hangge.com/blog/cache/detail\_2826.html
>  *  https://howtodoinjava.com/spring-boot2/logging/configure-logging-application-yml/

[691aa9eefe4844c7acce3fe36fd8723f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/9b897ed648ef4e5191d085596e270fbf.png
[d41a96c41fba449c9a2520626fa3c089.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/c93ec53e25034f82a48f423e02ce4105.png
[1600006ca2434e8bb35259ee94b76380.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/f6949efa5244418182908c283957d16f.png
[11953c2bd2a64c2ebd973ec5bba4019a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/0c438e678d684b77aa60c653c7291f47.png
[4f5e683f30ea44e0a803f3b5c23b14c4.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/03/27/019e1111636648dfaebfb08d6d6eec78.png