SpringBoot —— 日志基本操作

个人简介：Java领域新星创作者；阿里云技术博主、星级博主、专家博主；正在Java学习的路上摸爬滚打，记录学习的过程~
个人主页：.29.的博客
学习社区：进去逛一逛~

---

@(SpringBoot —— 日志基本操作)

一、日志的作用

---

日志（log）作用：

1.编程期调试代码

2.运营期记录信息：

• 记录日常运营重要信息（峰值流量、平均响应时长…）
• 记录应用报错信息（错误堆栈）
• 记录运维过程数据（扩容、宕机、报警…）

二、日志级别

---

• TRACE: 运行堆栈信息，使用率低
• DEBUG: 程序员调试代码使用
• INFO: 记录运维过程数据
• WARN: 记录运维过程报警数据
• ERROR: 记录错误堆栈信息
• FATAL: 灾难信息，合并计入ERROR

三、日志的使用

---

1. 控制层组件中，创建记录日志的对象，并记录日志信息：

• 日志默认使用info级别，只能看到info及以上级别的信息，此时debug级别的日志信息不可见

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;

/**
 * @author .29.
 * @create 2023-03-31 19:40
 */
@RestController
@RequestMapping("/books")
public class BookController {
    //一、创建记录日志的对象
    private static final Logger log = LoggerFactory.getLogger(BookController.class);

    @GetMapping
    public String get(){
        System.out.println("SpringBoot is running ...");

        //二、记录日志信息
        //日志默认使用info级别，只能看到info及以上级别的信息，此时debug级别的日志信息不可见
        log.debug("debug...");
        log.info("info...");
        log.warn("warn...");
        log.error("error...");
        return "test springboot use log";
    }
}

• 快速创建日志对象的技巧：

导入lombok依赖，在控制层组件使用 @Slf4j 注解

        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>

import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

/**
 * @author .29.
 * @create 2023-03-31 19:40
 */
@Slf4j
@RestController
@RequestMapping("/books")
public class BookController {
    //一、创建记录日志的对象
//    private static final Logger log = LoggerFactory.getLogger(BookController.class);

    @GetMapping
    public String get(){
        System.out.println("SpringBoot is running ...");

        //二、记录日志信息
        //日志默认使用info级别，只能看到info及以上级别的信息，此时debug级别的日志信息不可见
        log.debug("debug...");
        log.info("info...");
        log.warn("warn...");
        log.error("error...");
        return "test springboot use log";
    }
}

2. 显示debug级别日志信息的方案：

在SpringBoot配置文件application.yml中设置：

方式一：

# 方式一：开启debug模式，输出调试信息，常用于检查系统运行状况
debug: true

方式二（推荐）：

# 方式一：开启debug模式，输出调试信息，常用于检查系统运行状况
#debug: true   

# 方式二：设置日志级别，root表示根节点，即整体应用日志级别
logging:
  level:
    root: debug

四、设置日志级别

---

在SpringBoot配置文件application.yml中设置：

• 单独设置某个包的日志级别

# 整体应用info级别，单独设置某个包为debug级别
logging:
  level:
    root: info
    com.haojin.springboot.springbootlog.controller: debug  # 单独设置某个包的日志级别

• 设置分组，对某个组设置日志级别

# 设置日志级别
logging:
  level:
    root: info
    # 对组ebank设置日志级别为debug
    ebank: debug

  # 设置分组ebank
  group:
    ebank: com.haojin.springboot.springbootlog.controller,com.haojin.springboot.springbootlog.service

五、设置日期输出格式

---

在SpringBoot配置文件application.yml中设置：

• %d —— 日期
• %m —— 消息
• %n —— 换行

# 设置日志输出格式
loggin:
  pattern:
    console: "%d - %m%n"

六、日志写入文件

---

• 设置日志文件：server.log 中

# 日志会写入日志文件：
logging:
  file:
    name: server.log

• 日志文件详细配置：

logging:
    name: server.log
  logback:
    rollingpolicy:
      max-file-size: 10KB  #设置文件极限大小
      file-name-pattern: server.%d{yyyy-MM-dd}.%i.log #设置日志命名格式

---