java 单机接口限流处理方案
259
2022-09-11
SpringBoot 日志的配置及输出应用教程
SpringBoot 日志的配置及输出应用教程
目录默认配置日志级别输出格式修改默认日志配置自定义日志配置普通日志配置文件带有 spring 标识的日志配置文件
默认配置
Spring Boot 默认使用 SLF4J+Logback 记录日志，并提供了默认配置，即使我们不进行任何额外配，也可以使用 SLF4J+Logback 进行日志输出。
常见的日志配置包括日志级别、日志的输入出格式等内容。
日志级别
日志的输出都是分级别的，当一条日志信息的级别大于或等于配置文件的级别时，就对这条日志进行记录。
常见的日志级别如下（优先级依次升高）。
序号
日志级别
说明
1
trace
追踪，指明程序运行轨迹。
2
debug
调试，实际应用中一般将其作为最低级别，而 trace 则很少使用。
fTXvwFkTin 3
info
输出重要的信息，使用较多。
4
warn
警告，使用较多。
5
error
错误信息，使用较多。
输出格式
我们可以通过以下常用日志参数对日志的输出格式进行修改，如下表。
序号
输出格式
说明
1
%d{yyyy-MM-dd HH:mm:ss, SSS}
日志生产时间,输出到毫秒的时间
2
%-5level
输出日志级别，-5 表示左对齐并且固定输出 5 个字符，如果不足在右边补 0
3
%logger 或%c
logger 的名称
4
%thread或 %t
输出当前线程名称
fTXvwFkTin 5
%p
日志输出格式
6
%message或 %msg或%m
日志内容，即 logger.info("message")
7
%n
换行符
8
%class 或 %C
输出 java 类名
9
%file 或 %F
输出文件名
10
%L
输出错误行号
11
%method或%M
输出方法名
12
%l
输出语句所在的行数, 包括类名、方法名、文件名、行数
13
hostName
本地机器名
14
hostAddress
本地 ip 地址
示例 1
下面我们通过一个实例，来查看 Spring Boot 提供了哪些默认日志配置。
1. 在 Spring Boot 中编写 Java 测试类，代码如下。
package net.biancheng.www;
import org.junit.jupiter.api.Test;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.boot.test.context.SpringBootTest;
@SpringBootTest
class SpringbootLoggingApplicationTests {
Logger logger = LoggerFactory.getLogger(getClass());
/**
* 测试日志输出
* SLF4J 日志级别从小到大trace>debug>info>warn>error
*/
@Test
void logTest() {
//日志级别 由低到高
logger.trace("trace 级别日志");
logger.debug("debug 级别日志");
logger.info("info 级别日志");
logger.warn("warn 级别日志");
logger.error("error 级别日志");
}
}
2. 执行该测试，控制台输出如下图。
图1：Spring Boot 日志级别
通过控制台输出结果可知，Spring Boot 日志默认级别为 info，日志输出内容默认包含以下元素：
时间日期
日志级别
进程 ID
分隔符：---
线程名：方括号括起来（可能会截断控制台输出）
Logger 名称
日志内容
修改默认日志配置
我们可以根据自身的需求，通过全局配置文件（application.properties/yml）修改 Spring Boot 日志级别和显示格式等默认配置。
在 application.properties 中，修改 Spring Boot 日志的默认配置，代码如下。
#日志级别
logging.level.net.biancheng.www=trace
#使用相对路径的方式设置日志输出的位置（项目根目录目录\my-log\mylog\spring.log）
#logging.file.path=my-log/myLog
#绝对路径方式将日志文件输出到 【项目所在磁盘根目录\springboot\logging\my\spring.log】
logging.file.path=/spring-boot/logging
#控制台日志输出格式
logging.pattern.console=%d{yyyy-MM-dd hh:mm:ss} [%thread] %-5level %logger{50} - %msg%n
#日志文件输出格式
logging.pattern.file=%d{yyyy-MM-dd} === [%thread] === %-5level === %logger{50} === - %msg%n
执行测试代码，执行结果如下。
图2：Spring Boot 日志修改默认配置
从图 2 可以看到，控制台中日志的输出格式与 application.properties 中的 logging.pattern.console 配置一致。
查看本地日志文件 spring.log，该文件日志输出内容如下图。
图3：本地日志文件 spring.log
从图 3 可以看到，本地日志文件中的日志输出格式与 application.properties 中 logging.pattern.file 配置一致。
自定义日志配置
在 Spring Boot 的配置文件 application.porperties/yml 中，可以对日志的一些默认配置进行修改，但这种方式只能修改个别的日志配置，想要修改更多的配置或者使用更高级的功能，则需要通过日志实现框架自己的配置文件进行配置。
Spring 官方提供了各个日志实现框架所需的配置文件，用户只要将指定的配置文件放置到项目的类路径下即可。
日志框架
配置文件
Logback
logback-spring.xml、logback-spring.groovy、logback.xml、logback.groovy
Log4j2
log4j2-spring.xml、log4j2.xml
JUL (Java Util Logging)
logging.properties
从上表可以看出，日志框架的配置文件基本上被分为 2 类：
普通日志配置文件，即不带 srping 标识的配置文件，例如 logback.xml；
带有 spring 表示的日志配置文件，例如 logback-spring.xml。
这两种日志配置文件在使用时大不相同，下面我们就对它们分别进行介绍。
普通日志配置文件
我们将 logback.xml、log4j2.xml 等不带 spring 标识的普通日志配置文件，放在项目的类路径下后，这些配置文件会跳过 Spring Boot，直接被日志框架加载。通过这些配置文件，我们就可以达到自定义日志配置的目的。
示例
1. 将 logback.xml 加入到 Spring Boot 项目的类路径下（resources 目录下），该配置文件配置内容如下。
%msg%n
2. 启动该项目并启动测试程序，结果如下。
. ____ _ __ _ _
/\\ / ___'_ __ _ _(_)_ __ __ _ \ \ \ \
( ( )\___ | '_ | '_| | '_ \/ _` | \ \ \ \
\\/ ___)| |_)| | | | | || (_| | ) ) ) )
' |____| .__|_| |_|_| |_\__, | / / / /
=========|_|==============|___/=/_/_/_/
:: Spring Boot :: (v2.5.0)
2021-05-24 14:51:11 [main]**************** INFO n.biancheng.SpringBootLoggingApplicationTests - Starting SpringBootLoggingApplicationTests using Java 1.8.0_131 on LAPTOP-C67MRMAG with PID 20080 (started by 79330 in D:\eclipse workSpace4\spring-boot-logging)
2021-05-24 14:51:11 [main]**************** DEBUG n.biancheng.SpringBootLoggingApplicationTests - Running with Spring Boot v2.5.0, Spring v5.3.7
2021-05-24 14:51:11 [main]**************** INFO n.biancheng.SpringBootLoggingApplicationTests - The following profiles are active: dev
2021-05-24 14:51:13 [main]**************** INFO n.biancheng.SpringBootLoggingApplicationTests - Started SpringBootLoggingApplicationTests in 2.058 seconds (JVM running for 3.217)
2021-05-24 14:51:13 [main]**************** DEBUG n.biancheng.SpringBootLoggingApplicationTests - debug 级别日志
2021-05-24 14:51:13 [main]**************** INFO n.biancheng.SpringBootLoggingApplicationTests - info 级别日志
2021-05-24 14:51:13 [main]**************** WARN n.biancheng.SpringBootLoggingApplicationTests - warn 级别日志
2021-05-24 14:51:13 [main]**************** ERROR n.biancheng.SpringBootLoggingApplicationTests - error 级别日志
带有 spring 标识的日志配置文件
Spring Boot 推荐用户使用 logback-spring.xml、log4j2-spring.xml 等这种带有 spring 标识的配置文件。这种配置文件被放在项目类路径后，不会直接被日志框架加载，而是由 Spring Boot 对它们进行解析，这样就可以使用 Spring Boot 的高级功能 Profile，实现在不同的环境中使用不同的日志配置。
示例
1. 将 logback.xml 文件名修改为 logback-spring.xml，并将配置文件中日志输出格式的配置修改为使用 Profile 功能的配置。
2. 配置内容修改前，日志输出格式配置如下。
......
......
3. 修改 logback-spring.xml 的配置内容，通过 Profile 功能实现在不同的环境中使用不同的日志输出格式，配置如下。
......
......
4. 在 Spring Boot 项目的 application.yml 中，激活开发环境（dev）的 Profile，配置内容如下。
#默认配置
server:
port: 8080
#切换配置
spring:
profiles:
active: dev
---
#开发环境
server:
port: 8081
spring:
config:
activate:
on-profile: dev
---
#测试环境
server:
port: 8082
spring:
config:
activate:
on-profile: test
---
#生产环境
server:
port: 8083
spring:
config:
activate:
on-profile: prod
5. 启动 Spring Boot 并执行测试代码，控制台输出如下。
图4：dev 环境日志输出结果
6. 修改 appplication.yml 中的配置，激活测试环境（test）的 Profile，配置如下。
#默认配置
server:
port: 8080
#切换配置
spring:
profiles:
active: test
---
#开发环境
server:
port: 8081
spring:
config:
activate:
on-profile: dev
---
#测试环境
server:
port: 8082
spring:
config:
activate:
on-profile: test
---
#生产环境
server:
port: 8083
spring:
config:
activate:
on-profile: prod
7. 重启 Spring Boot 并执行测试代码，控制台输出如下。
图5：test 环境日志输出结果
版权声明：本文内容由网络用户投稿，版权归原作者所有，本站不拥有其著作权，亦不承担相应法律责任。如果您发现本站中有涉嫌抄袭或描述失实的内容，请联系我们jiasou666@gmail.com 处理，核实后本网站将在24小时内删除侵权内容。
相关文章
发表评论
暂时没有评论，来抢沙发吧~