Spring Boot 输出 JSON 格式日志

WHY

随着分布式和微服务的普及，我们的服务实体更多更分散，为了能够集中高效的查看日志我们会用像 EFK（Elasticsearch + FluentBit + Kibana） 这样的日志系统。而将日志以 JSON 格式输出则能帮助日志系统更好的解析日志，而作为运维人员也可能更加清晰高效的查看日志。

HOW

1. 在 pom.xml 中添加 logback 依赖：

...
<dependency>
    <groupId>net.logstash.logback</groupId>
    <artifactId>logstash-logback-encoder</artifactId>
    <version>5.2</version>
    <scope>runtime</scope>
    <exclusions>
        <exclusion>
            <groupId>ch.qos.logback</groupId>
            <artifactId>logback-core</artifactId>
        </exclusion>
    </exclusions>
</dependency>
...

2. 在 src/main/resource 下添加 logback-spring.xml 配置文件：

<?xml version="1.0" encoding="UTF-8"?>
<configuration>
<include resource="org/springframework/boot/logging/logback/defaults.xml"/>
  <appender name="STDOUT" class="ch.qos.logback.core.ConsoleAppender">
    <encoder class="net.logstash.logback.encoder.LogstashEncoder">
      <fieldNames>
        <timestamp>@ts</timestamp>
        <version>[ignore]</version>
        <levelValue>[ignore]</levelValue>
      </fieldNames>
    </encoder>
  </appender>
 
  <root level="INFO">
    <appender-ref ref="STDOUT" />
  </root>
</configuration>

3. 部分日志无法 json 化需要特殊处理，比如 banner 因无法 json 化也无需被采集可以通过配置来关闭：

spring.main.banner-mode: "off"