1. 简介

项⽬源码: https://gitee.com/leifengyang/spring-boot-3

视频:https://www.bilibili.com/video/BV1Es4y1q7Bf

1.1. 前置知识

  • Java17

  • Spring、SpringMVC、MyBatis

  • Maven、IDEA

1.2. 环境要求

环境&⼯具

版本(or later)

SpringBoot

3.0.5+

IDEA

2021.2.1+

Java

17+

Maven

3.5+

Tomcat

10.0+

Servlet

5.0+

GraalVM Community

22.3+

Native Build Tools

0.9.19+

1.3. SpringBoot是什么

SpringBoot 帮我们简单、快速地创建⼀个独⽴的、⽣产级别的 Spring 应⽤(说明:SpringBoot底层是Spring)

⼤多数 SpringBoot 应⽤只需要编写少量配置即可快速整合 Spring 平台以及第三⽅技术特性:

  • 快速创建 独⽴ Spring 应⽤

  • SSM:导包、写配置、启动运⾏

  • 直接 嵌⼊ Tomcat、Jetty or Undertow(⽆需部署 war 包)【Servlet容器】

  • linux java tomcat mysql: war 放到 tomcat 的 webapps下

  • jar: java环境; java -jar

  • 重点:提供可选的starter,简化应⽤整合

  • 场景启动器(starter):web、json、邮件、oss(对象存储)、异步、定时任务、缓存...

  • 导包⼀堆,控制好版本。

  • 为每⼀种场景准备了⼀个依赖; web-starter。mybatis-starter

  • 重点:按需⾃动配置 Spring 以及 第三⽅库

  • 如果这些场景我要使⽤(⽣效)。这个场景的所有配置都会⾃动配置好。

  • 约定⼤于配置:每个场景都有很多默认配置。

  • ⾃定义:配置⽂件中修改⼏项就可以

  • 提供⽣产级特性:如 监控指标、健康检查、外部化配置等

  • 监控指标、健康检查(k8s)、外部化配置

  • ⽆代码⽣成、⽆xml

总结:简化开发,简化配置,简化整合,简化部署,简化监控,简化运维。

2. 快速体验

场景:浏览器发送/hello请求,返回"Hello,Spring Boot 3!"

2.1. 开发流程

2.1.1. 创建项⽬

maven 项⽬

<!--	所有springboot项⽬都必须继承⾃  spring-boot-starter-parent -->
<parent>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-parent</artifactId>
  <version>3.0.5</version>
</parent>

2.1.2. 导⼊场景

场景启动器

<dependencies>
  <!-- web开发的场景启动器 -->
  <dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
  </dependency>
</dependencies>

2.1.3. 主程序

@SpringBootApplication //这是⼀个SpringBoot应⽤
public class MainApplication {
    public static void main(String[] args) { SpringApplication.run(MainApplication.class,args);
                                           }
}

2.1.4. 业务

@RestController
public class HelloController {
    @GetMapping("/hello")
    public String hello(){
        return "Hello,Spring Boot 3!";
    }
}

2.1.5. 测试

默认启动访问: localhost:8080

2.1.6. 打包

<!-- SpringBoot应用打包插件-->
<build>
  <plugins>
    <plugin>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-maven-plugin</artifactId>
    </plugin>
  </plugins>
</build>

mvn clean package 把项⽬打成可执⾏的jar包

java -jar demo.jar 启动项⽬

2.2. 特性⼩结

2.2.1. 简化整合

导⼊相关的场景,拥有相关的功能。场景启动器

https://docs.spring.io/spring-boot/docs/current/reference/html/using.html#using.build-systems.starters

  • 官⽅提供的场景:命名为:spring-boot-starter-*

  • 第三⽅提供场景:命名为:*-spring-boot-starter

场景⼀导⼊,万物皆就绪

2.2.2. 简化开发

⽆需编写任何配置,直接开发业务

2.2.3. 简化配置

application.properties

  • 集中式管理配置。只需要修改这个⽂件就⾏ 。

  • 配置基本都有默认值

https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties

2.2.4. 简化部署

打包为可执⾏的jar包。

linux服务器上有java环境。

2.2.5. 简化运维

修改配置(外部放⼀个application.properties⽂件)、监控、健康检查。

.....

3. Spring Initializr 创建向导

⼀键创建好整个项⽬结构

3. 应⽤分析

3.1. 依赖管理机制

思考:

1、为什么导⼊starter-web所有相关依赖都导⼊进来?

  • 开发什么场景,导⼊什么场景启动器。

  • maven依赖传递原则。A-B-C: A就拥有B和C

  • 导⼊ 场景启动器。 场景启动器 ⾃动把这个场景的所有核⼼依赖全部导⼊进来

2、为什么版本号都不⽤写?

  • 每个boot项⽬都有⼀个⽗项⽬spring-boot-starter-parent

  • parent的⽗项⽬是spring-boot-dependencies

  • ⽗项⽬ 版本仲裁中⼼,把所有常⻅的jar的依赖版本都声明好了。

  • ⽐如:mysql-connector-j

3、⾃定义版本号

  • 利⽤maven的就近原则

  • 直接在当前项⽬properties标签中声明⽗项⽬⽤的版本属性的key

  • 直接在导⼊依赖的时候声明版本

4、第三⽅的jar包

  • boot⽗项⽬没有管理的需要⾃⾏声明好

<!-- https://mvnrepository.com/artifact/com.alibaba/druid -->
<dependency>
  <groupId>com.alibaba</groupId>
  <artifactId>druid</artifactId>
  <version>1.2.16</version>
</dependency>

3.2. ⾃动配置机制

3.2.1. 初步理解

  • ⾃动配置的 Tomcat、SpringMVC 等

  • 导⼊场景,容器中就会⾃动配置好这个场景的核⼼组件。

  • 以前:DispatcherServlet、ViewResolver、CharacterEncodingFilter....

  • 现在:⾃动配置好的这些组件

  • 验证:容器中有了什么组件,就具有什么功能

public static void main(String[] args) {
    //java10: 局部变量类型的自动推断
    var ioc = SpringApplication.run(MainApplication.class, args);
    //1、获取容器中所有组件的名字
    String[] names = ioc.getBeanDefinitionNames();
    //2、挨个遍历:
    // dispatcherServlet、beanNameViewResolver、characterEncodingFilter、multipartResolver
    // SpringBoot把以前配置的核心组件现在都给我们自动配置好了。
    for (String name : names) {
        System.out.println(name);
    }
}
  • 默认的包扫描规则

  • @SpringBootApplication 标注的类就是主程序类

  • SpringBoot只会扫描主程序所在的包及其下面的子包,自动的component-scan功能

  • 自定义扫描路径

  • @SpringBootApplication(scanBasePackages = "com.atguigu")

  • @ComponentScan("com.atguigu") 直接指定扫描的路径

  • 配置默认值

  • 配置文件的所有配置项是和某个类的对象值进行一一绑定的。

  • 绑定了配置文件中每一项值的类: 属性类。

  • 比如:

  • ServerProperties绑定了所有Tomcat服务器有关的配置

  • MultipartProperties绑定了所有文件上传相关的配置

  • ....参照官方文档:或者参照 绑定的 属性类。

  • 按需加载自动配置

  • 导入场景spring-boot-starter-web

  • 场景启动器除了会导入相关功能依赖,导入一个spring-boot-starter,是所有starterstarter,基础核心starter

  • spring-boot-starter导入了一个包 spring-boot-autoconfigure。包里面都是各种场景的AutoConfiguration自动配置类

  • 虽然全场景的自动配置都在 spring-boot-autoconfigure这个包,但是不是全都开启的。

  • 导入哪个场景就开启哪个自动配置

总结: 导入场景启动器、触发 spring-boot-autoconfigure这个包的自动配置生效、容器

中就会具有相关场景的功能

3.2.2. 完整流程

思考:

1、SpringBoot怎么实现导⼀个整合starter、写⼀些简单配置,应⽤就能跑起来,我们⽆需关⼼整合

2、为什么Tomcat的端⼝号可以配置在application.properties中,并且Tomcat能启动成功?

3、导⼊场景后哪些⾃动配置能⽣效?

⾃动配置流程细节梳理:

1、导⼊starter-web:导⼊了web开发场景

  • 1、场景启动器导⼊了相关场景的所有依赖:starter-jsonstarter-tomcatspringmvc

  • 2、每个场景启动器都引⼊了⼀个spring-boot-starter, 核心场景启动器

  • 3、核⼼场景启动器引⼊了spring-boot-autoconfigure包。

  • 4、spring-boot-autoconfigure⾥⾯囊括了所有场景的所有配置。

  • 5、只要这个包下的所有类都能⽣效,那么相当于SpringBoot官⽅写好的整合功能就⽣效了。

  • 6、SpringBoot默认却扫描不到spring-boot-autoconfigure下写好的所有配置类。

(这些配置类给我们做了整合操作),默认只扫描主程序所在的包。

2、主程序:@SpringBootApplication

  • 1、@SpringBootApplication由三个注解组成@SpringBootConfiguration@EnableAutoConfiguratio@ComponentScan

  • 2、SpringBoot默认只能扫描⾃⼰主程序所在的包及其下⾯的⼦包,扫描不到spring-boot-autoconfigure包中官⽅写好的配置类

  • 3、@EnableAutoConfigurationSpringBoot 开启⾃动配置的核⼼。

  • 1.是由@Import(AutoConfigurationImportSelector.class)提供功能:批量给容器中导⼊组件。

  • 2. SpringBoot启动会默认加载 142个配置类。

  • 3. 这142个配置类来⾃于spring-boot-autoconfigure下META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports⽂件指定的

  • 项⽬启动的时候利⽤ @Import 批量导⼊组件机制把autoconfigure包下的142xxAutoConfiguration 类导⼊进来(⾃动配置类

  • 虽然导⼊了142个⾃动配置类

  • 4、按需⽣效:

  • 并不是这142个⾃动配置类都能⽣效

  • 每⼀个⾃动配置类,都有条件注解@ConditionalOnxxx,只有条件成⽴,才能⽣效

3、 ⾃动配置类xxxxAutoConfiguration

  • 1、给容器中使⽤@Bean 放⼀堆组件。

  • 2、每个⾃动配置类都可能有这个注解@EnableConfigurationProperties(ServerProperties.class),⽤来把配置⽂件中配的指定前缀的属性值封装到xxxPropertie属性类

  • 3、以Tomcat为例:把服务器的所有配置都是以server开头的。配置都封装到了属性类中。

  • 4、给容器中放的所有组件的⼀些核⼼参数,都来⾃于xxxProperties,xxxProperties 都是和配置⽂件绑定。

  • 只需要改配置⽂件的值,核⼼组件的底层参数都能修改

4、写业务,全程⽆需关⼼各种整合(底层这些整合写好了,⽽且也⽣效了)


核⼼流程总结:

1、导⼊starter,就会导⼊autoconfigure包。

2、autoconfigure包⾥⾯ 有⼀个⽂件META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports,⾥⾯指定的所有启动要加载的⾃动配置类

3、@EnableAutoConfiguration 会⾃动的把上⾯⽂件⾥⾯写的所有⾃动配置类都导⼊进来。 xxxAutoConfiguration 是有条件注解进⾏按需加载

4、 xxxAutoConfiguration给容器中导⼊⼀堆组件,组件都是从xxxProperties中提取属性值

5、xxxProperties⼜是和配置⽂件进⾏了绑定

效果:导⼊starter、修改配置⽂件,就能修改底层⾏为。

3.2.3. 如何学好SpringBoot

框架的框架、底层基于Spring。能调整每⼀个场景的底层⾏为。100%项⽬⼀定会⽤到底层⾃定义

摄影:

  • 傻⽠:⾃动配置好。

  • 单反:焦距、光圈、快⻔、感光度....

  • 傻⽠+单反:

  1. 理解⾃动配置原理

  1. 导⼊starter --> ⽣效xxxxAutoConfiguration --> 组件 --> xxxProperties --> 配置⽂件

  1. 理解其他框架底层

  1. 拦截器

  1. 可以随时定制化任何组件

  1. 配置⽂件

  2. ⾃定义组件

普通开发:导⼊starter,Controller、Service、Mapper、偶尔修改配置⽂件

⾼级开发:⾃定义组件、⾃定义配置、⾃定义starter

核⼼:

  • 这个场景⾃动配置导⼊了哪些组件,我们能不能Autowired进来使⽤

  • 能不能通过修改配置改变组件的⼀些默认参数

  • 需不需要⾃⼰完全定义这个组件

  • 场景定制化

最佳实战:

  • 选场景,导⼊到项⽬

  • 官⽅:starter

  • 第三⽅:去仓库搜

  • 写配置,改配置⽂件关键项

  • 数据库参数(连接地址、账号密码...)

  • 分析这个场景给我们导⼊了哪些能⽤的组件

  • ⾃动装配这些组件进⾏后续使⽤

  • 不满意boot提供的⾃动配好的默认组件

  • 定制化

  • 改配置

  • ⾃定义组件

整合redis:

  • 场景AutoConfiguration 就是这个场景的⾃动配置类

  • 写配置:

  • 分析到这个场景的⾃动配置类开启了哪些属性绑定关系

  • @EnableConfigurationProperties(RedisProperties.class)

  • 修改redis相关的配置

  • 分析组件:

  • 分析到StringRedisTemplate给容器中放了RedisAutoConfiguration

  • 给业务代码中⾃动装配StringRedisTemplate

  • 定制化

  • 修改配置⽂件

  • ⾃定义组件,⾃⼰给容器中放⼀个StringRedisTemplate

4. 核⼼技能

4.1. 常⽤注解

SpringBoot摒弃XML配置⽅式,改为全注解驱动

4.1.1. 组件注册

@Configuration、@SpringBootConfiguration、 @Bean、@Scope

@Controller、 @Service、@Repository、@Component 、@Import

@ComponentScan

步骤:

1、@Configuration 编写⼀个配置类

2、在配置类中,⾃定义⽅法给容器中注册组件。配合@Bean

3、或使⽤@Import 导⼊第三⽅的组件

4.1.2. 条件注解

如果注解指定的条件成⽴,则触发指定⾏为

@ConditionalOnXxx

@ConditionalOnClass:如果类路径中存在这个类,则触发指定⾏为

@ConditionalOnMissingClass:如果类路径中不存在这个类,则触发指定⾏为

@ConditionalOnBean:如果容器中存在这个Bean(组件),则触发指定⾏为 @ConditionalOnMissingBean:如果容器中不存在这个Bean(组件),则触发指定⾏为

场景:

  • 如果存在FastsqlException 这个类,给容器中放一个Cat 组件,名cat01,

  • 否则,就给容器中放一个Dog 组件,名dog01

  • 如果系统中有dog01 这个组件,就给容器中放一个 User组件,名zhangsan

  • 否则,就放一个User,名叫lisi

@ConditionalOnBean(value=组件类型,name=组件名字):判断容器中是否有这个类型的组件,并且名字是指定的值

@ConditionalOnRepositoryType (org.springframework.boot.autoconfigure.data) @ConditionalOnDefaultWebSecurity (org.springframework.boot.autoconfigure.security) @ConditionalOnSingleCandidate (org.springframework.boot.autoconfigure.condition) @ConditionalOnWebApplication (org.springframework.boot.autoconfigure.condition) @ConditionalOnWarDeployment (org.springframework.boot.autoconfigure.condition) @ConditionalOnJndi (org.springframework.boot.autoconfigure.condition)

@ConditionalOnResource (org.springframework.boot.autoconfigure.condition) @ConditionalOnExpression (org.springframework.boot.autoconfigure.condition)

@ConditionalOnClass (org.springframework.boot.autoconfigure.condition)

@ConditionalOnEnabledResourceChain (org.springframework.boot.autoconfigure.web) @ConditionalOnMissingClass (org.springframework.boot.autoconfigure.condition) @ConditionalOnNotWebApplication (org.springframework.boot.autoconfigure.condition) @ConditionalOnProperty (org.springframework.boot.autoconfigure.condition) @ConditionalOnCloudPlatform (org.springframework.boot.autoconfigure.condition) @ConditionalOnBean (org.springframework.boot.autoconfigure.condition) @ConditionalOnMissingBean (org.springframework.boot.autoconfigure.condition) @ConditionalOnMissingFilterBean (org.springframework.boot.autoconfigure.web.servlet)

@Profile (org.springframework.context.annotation)

@ConditionalOnInitializedRestarter (org.springframework.boot.devtools.restart)

@ConditionalOnGraphQlSchema (org.springframework.boot.autoconfigure.graphql) @ConditionalOnJava (org.springframework.boot.autoconfigure.condition)

4.1.3. 属性绑定

@ConfigurationProperties: 声明组件的属性和配置⽂件哪些前缀开始项进⾏绑定

@EnableConfigurationProperties:快速注册注解:

  • 场景:SpringBoot默认只扫描⾃⼰主程序所在的包。如果导⼊第三⽅包,即使组件上标注了 @Component、@ConfigurationProperties 注解,也没⽤。因为组件都扫描不进来,此时使⽤这个注解就可以快速进⾏属性绑定并把组件注册进容器

将容器中任意组件(Bean)的属性值和配置⽂件的配置项的值进⾏绑定

  • 1、给容器中注册组件(@Component、@Bean)

  • 2、使⽤@ConfigurationProperties 声明组件和配置⽂件的哪些配置项进⾏绑定

更多注解参照:Spring注解驱动开发【1-26集】

4.2. YAML配置⽂件

痛点:SpringBoot 集中化管理配置,application.properties

问题:配置多以后难阅读和修改,层级结构辨识度不⾼

YAML 是 "YAML Ain't a Markup Language"(YAML 不是⼀种标记语⾔)。在开发的这种语⾔

时,YAML 的意思其实是:"Yet Another Markup Language"(是另⼀种标记语⾔)。

  • 设计⽬标,就是⽅便⼈类读写

  • 层次分明,更适合做配置⽂件

  • 使⽤.yamlyml作为⽂件后缀

4.2.1. 基本语法

  • ⼤⼩写敏感

  • 使⽤缩进表示层级关系,k: v,使⽤空格分割k,v

  • 缩进时不允许使⽤Tab键,只允许使⽤空格。换⾏

  • 缩进的空格数⽬不重要,只要相同层级的元素左侧对⻬即可

  • # 表示注释,从这个字符⼀直到⾏尾,都会被解析器忽略。

⽀持的写法:

  • 对象:键值对的集合,如:映射(map)/ 哈希(hash) / 字典(dictionary)

  • 数组:⼀组按次序排列的值,如:序列(sequence) / 列表(list)

  • 纯量:单个的、不可再分的值,如:字符串、数字、bool、⽇期

4.2.2. 示例

@Component
@ConfigurationProperties(prefix = "person") //和配置文件person前缀的所有配置进
行绑定
@Data //自动生成JavaBean属性的getter/setter
//@NoArgsConstructor //自动生成无参构造器
//@AllArgsConstructor //自动生成全参构造器
public class Person {
    private String name;
    private Integer age;
    private Date birthDay;
    private Boolean like;
    private Child child; //嵌套对象
    private List<Dog> dogs; //数组(里面是对象)
    private Map<String,Cat> cats; //表示Map
}
@Data
public class Dog {
    private String name;
    private Integer age;
}
@Data
public class Child {
    private String name;
    private Integer age;
    private Date birthDay;
    private List<String> text; //数组
}
@Data
public class Cat {
    private String name;
    private Integer age;
}

properties表示法

person.name=张三
person.age=18
person.birthDay=2010/10/12 12:12:12
person.like=true
person.child.name=李四
person.child.age=12
person.child.birthDay=2018/10/12
person.child.text[0]=abc
person.child.text[1]=def
person.dogs[0].name=小黑
person.dogs[0].age=3
person.dogs[1].name=小白
person.dogs[1].age=2
person.cats.c1.name=小蓝
person.cats.c1.age=3
person.cats.c2.name=小灰
person.cats.c2.age=2

yaml表示法

person:
  name: 张三
  age: 18
  birthDay: 2010/10/10 12:12:12
  like: true
  child:
    name: 李四
    age: 20
    birthDay: 2018/10/10
    text: ["abc","def"]
dogs:
  - name: 小黑
    age: 3
  - name: 小白
    age: 2
cats:
c1:
name: 小蓝
age: 3
c2: {name: 小绿,age: 2} #对象也可用{}表示

4.2.3. 细节

  • birthDay 推荐写为 birth-day

  • ⽂本:

  • 单引号不会转义【\n 则为普通字符串显示】

  • 双引号会转义【\n会显示为换⾏符】

  • ⼤⽂本

  • |开头,大文本写在下层,保留文本格式,换行符正确显示

  • >开头,大文本写在下层,折叠换行符

  • 多文档合并

  • 使用 ---可以把多个yaml文档合并在一个文档中,每个文档区依然认为内容独立

4.2.4. ⼩技巧:lombok

简化JavaBean 开发。⾃动⽣成构造器、getter/setter、⾃动⽣成Builder模式等

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

使⽤@Data等注解

4.3. ⽇志配置

规范:项目开发不要编写 System.out.println(),应该用日志记录信息

感兴趣⽇志框架关系与起源可参考https://www.bilibili.com/video/BV1gW411W76m 视频 21~27集

4.3.1. 简介

  1. Spring使⽤commons-logging作为内部⽇志,但底层⽇志实现是开放的。可对接其他⽇志框架。

  1. spring5及以后 commons-logging被spring直接⾃⼰写了。

  1. ⽀持 jullog4j2,logback。SpringBoot 提供了默认的控制台输出配置,也可以配置输出为⽂件。

  2. logback是默认使⽤的。

  3. 虽然⽇志框架很多,但是我们不⽤担⼼,使⽤ SpringBoot 的默认配置就能⼯作的很好。

SpringBoot怎么把⽇志默认配置好的

1、每个starter场景,都会导入一个核心场景spring-boot-starter

2、核心场景引入了日志的所用功能spring-boot-starter-logging

3、默认使用了logback + slf4j组合作为默认底层日志

4、日志是系统一启动就要用xxxAutoConfiguration是系统启动好了以后放好的组件,后来用的。

5、日志是利用监听器机制配置好的。ApplicationListener

6、日志所有的配置都可以通过修改配置文件实现。以logging开始的所有配置。

4.3.2. ⽇志格式

2023-03-31T13:56:17.511+08:00 INFO 4944 --- [ main] o.apache.catalina.core.StandardService : Starting service [Tomcat]
2023-03-31T13:56:17.511+08:00 INFO 4944 --- [ main] o.apache.catalina.core.StandardEngine : Starting Servlet engine: [Apache Tomcat/10.1.7]

默认输出格式:

  • 时间和⽇期:毫秒级精度

  • ⽇志级别:ERROR, WARN, INFO, DEBUG, or TRACE.

  • 进程 ID

  • ---: 消息分割符

  • 线程名: 使⽤[]包含

  • Logger 名: 通常是产⽣⽇志的类名

  • 消息: ⽇志记录的内容

注意: logback 没有FATAL级别,对应的是ERROR

默认值:参照: spring-bootadditional-spring-configuration-metadata.json文件

默认输出格式值: %clr(%d{${LOG_DATEFORMAT_PATTERN:-yyyy-MM-dd'T'HH:mm:ss.SSSXXX}}){faint} %clr(${LOG_LEVEL_PATTERN:-%5p}) %clr(${PID:- }){magenta} %clr(---){faint} %clr([%15.15t]){faint} %clr(%-40.40logger{39}){cyan} %clr(:){faint} %m%n${LOG_EXCEPTION_CONVERSION_WORD:-%wEx}

可修改为: '%d{yyyy-MM-dd HH:mm:ss.SSS} %-5level [%thread] %logger{15} ===> %msg%n'

4.3.3. 记录⽇志

Logger logger = LoggerFactory.getLogger(getClass());

或者使用Lombok的@Slf4j注解

4.3.4. ⽇志级别

  • 由低到⾼:ALL,TRACE, DEBUG, INFO, WARN, ERROR,FATAL,OFF

  • 只会打印指定级别及以上级别的⽇志

  • ALL:打印所有⽇志

  • TRACE:追踪框架详细流程⽇志,⼀般不使⽤

  • DEBUG:开发调试细节⽇志

  • INFO:关键、感兴趣信息⽇志

  • WARN:警告但不是错误的信息⽇志,⽐如:版本过时

  • ERROR:业务错误⽇志,⽐如出现各种异常

  • FATAL:致命错误⽇志,⽐如jvm系统崩溃

  • OFF:关闭所有⽇志记录

  • 不指定级别的所有类,都使⽤root指定的级别作为默认级别

  • SpringBoot⽇志默认级别是 INFO

  1. application.properties/yaml中配置logging.level.<logger-name>=<level>指定日志级别

  2. level可取值范围: TRACE, DEBUG, INFO, WARN, ERROR, FATAL, or OFF,定义
    LogLevel类中

  3. root 的logger-nameroot,可以配置logging.level.root=warn,代表所有未指定日志级别都
    使用 root 的 warn 级别

4.3.5. ⽇志分组

⽐较有⽤的技巧是:

将相关的logger分组在⼀起,统⼀配置。SpringBoot 也⽀持。⽐如:Tomcat 相关的⽇志统⼀设置

logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomca t
logging.level.tomcat=trace

SpringBoot 预定义两个组

Name

Loggers

web

org.springframework.core.codec,org.springframework.http, org.springframework.web, org.springframework.boot.actuate.endpoint.web, org.springframework.boot.web.servlet.ServletContextInitializerBeans

sql

org.springframework.jdbc.core, org.hibernate.SQL, org.jooq.tools.LoggerListener

4.3.6. ⽂件输出

SpringBoot 默认只把⽇志写在控制台,如果想额外记录到⽂件,可以在application.properties中添加logging.file.name or logging.file.path配置项。

logging.file.name

logging.file.path

示例

效果

未指定

未指定

仅控制台输出

指定

未指定

my.log

写⼊指定⽂件。可以加路径

未指定

指定

/var/log

写⼊指定⽬录,⽂件名为spring.log

指定

指定

logging.file.name为准

4.3.7. ⽂件归档与滚动切割

归档:每天的⽇志单独存到⼀个⽂档中。

切割:每个⽂件10MB,超过⼤⼩切割成另外⼀个⽂件。

  1. 每天的⽇志应该独⽴分割出来存档。如果使⽤logback(SpringBoot 默认整合),可以通过 application.properties/yaml⽂件指定⽇志滚动规则。

  2. 如果是其他⽇志系统,需要⾃⾏配置(添加log4j2.xmllog4j2-spring.xml

  3. ⽀持的滚动规则设置如下

配置项

描述

logging.logback.rollingpolicy.file-name- pattern

⽇志存档的⽂件名格式(默认值:

${LOG_FILE}.%d{yyyy-MM-dd}.%i.gz

logging.logback.rollingpolicy.clean-history- on-start

应⽤启动时是否清除以前存档(默认值: false

logging.logback.rollingpolicy.max-file-size

存档前,每个⽇志⽂件的最⼤⼤⼩(默认值: 10MB

logging.logback.rollingpolicy.total-size-cap

⽇志⽂件被删除之前,可以容纳的最⼤⼤⼩

(默认值:0B)。设置1GB则磁盘存储超过 1GB ⽇志后就会删除旧⽇志⽂件

logging.logback.rollingpolicy.max-history

⽇志⽂件保存的最⼤天数(默认值:7).

4.3.8. ⾃定义配置

通常我们配置 application.properties就够了。当然也可以⾃定义。⽐如:

⽇志系统

⾃定义

Logback

logback-spring.xml, logback-spring.groovy,logback.xml, or logback.groovy

Log4j2

log4j2-spring.xml orlog4j2.xml

JDK (Java Util Logging)

logging.properties

如果可能,我们建议您在日志配置中使用-spring变量(例如,logback-spring.xml而不是 logback.xml)。如果您使用标准配置文件,spring 无法完全控制日志初始化。

最佳实战:自己要写配置,配置文件名加上 xx-spring.xml

4.3.9. 切换⽇志组合

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-web</artifactId>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter</artifactId>
  <exclusions>
    <exclusion>
      <groupId>org.springframework.boot</groupId>
      <artifactId>spring-boot-starter-logging</artifactId>
    </exclusion>
  </exclusions>
</dependency>
<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-log4j2</artifactId>
</dependency>

log4j2⽀持yaml和json格式的配置⽂件

格式

依赖

⽂件名

YAML

com.fasterxml.jackson.core:jackson-databind

+ com.fasterxml.jackson.dataformat:jackson- dataformat-yaml

log4j2.yaml + log4j2.yml

JSON

com.fasterxml.jackson.core:jackson-databind

log4j2.json + log4j2.jsn

4.3.10. 最佳实战

  1. 导⼊任何第三⽅框架,先排除它的⽇志包,因为Boot底层控制好了⽇志

  2. 修改application.properties配置⽂件,就可以调整⽇志的所有⾏为。如果不够,可以编写⽇志框架⾃⼰的配置⽂件放在类路径下就⾏,⽐如log4j2-spring.xmllogback-spring.xml

  3. 如需对接专业⽇志系统,也只需要把 logback 记录的⽇志灌倒 kafka之类的中间件,这和 SpringBoot没关系,都是⽇志框架⾃⼰的配置,修改配置⽂件即可

  4. 业务中使⽤slf4j-api记录⽇志。不要再 sout 了