SpringBoot3 全栈指南教程——尚硅谷学习笔记 2023年_数据分析

您的位置：上海毫米网络优化公司 > 业务范围 > 数据分析 >

SpringBoot3 全栈指南教程——尚硅谷学习笔记 2023 年

SpringBoot3 全栈指南教程——尚硅谷学习笔记 2023 年

一、Spring Boot 3-核心特性

第 1 章 SpringBoot3-快速入门

1.1 简介

1.1.1 前置知识
1.1.2 环境要求
1.1.3 SpringBoot 是什么

1.2 快速体验

1.2.1 开发流程

1.2.1.1 创建项目
1.2.1.2 导入场景
1.2.1.3 主程序
1.2.1.4 业务
1.2.1.5 测试
1.2.1.6 打包

1.2.2 特性小结

1.2.2.1 简化整合
1.2.2.2 简化开发
1.2.2.3 简化配置
1.2.2.4 简化部署
1.2.2.5 简化运维
1.2.2.6 Spring Initializr 创建向导

1.3 应用分析

1.3.1 依赖管理机制

1.3.2 自动配置机制

1.3.2.1 初步理解
1.3.2.2 完整流程
1.3.2.3 如何学好 SpringBoot

1.4 核心技能

1.4.1 常用注解

1.4.1.1 组件注册
1.4.1.2 条件注解
1.4.1.3 属性绑定

1.4.2 YAML 配置文件

1.4.2.1. 基本语法
1.4.2.2 示例
1.4.2.3 细节
1.4.2.4. 小技巧：lombok

1.4.3 日志配置

1.4.3.1 简介
1.4.3.2 日志格式
1.4.3.3 记录日志
1.4.3.4 日志级别
1.4.3.5 日志分组
1.4.3.6 文件输出
1.4.3.7 文件归档与滚动切割
1.4.3.8 自定义配置
1.4.3.9 切换日志组合
1.4.3.10 最佳实战

第 2 章 SpringBoot3-Web 开发

2.1 WebMvcAutoConfiguration 原理

2.1.1 生效条件
2.1.2 效果
2.1.3 WebMvcConfigurer 接口
2.1.4 静态资源规则源码
2.1.5 EnableWebMvcConfiguration 源码
2.1.6 为什么容器中放一个 WebMvcConfigurer 就能配置底层行为
2.1.7 WebMvcConfigurationSupport

2.2 Web 场景

2.2.1 自动配置
2.2.2 默认效果

2.3 静态资源

2.3.1 默认规则

2.3.1.1 静态资源映射
2.3.1.2 静态资源缓存
2.3.1.3 欢迎页
2.3.1.4 Favicon
2.3.1.5 缓存实验

2.3.2 自定义静态资源规则

2.3.2.1 配置方式
2.3.2.2 代码方式

2.4 路径匹配

2.4.1 Ant 风格路径用法
2.4.2 模式切换

2.5 内容协商

2.5.1 多端内容适配

2.5.1.1 默认规则
2.5.1.2 效果演示
2.5.1.3 配置协商规则与支持类型

2.5.2 自定义内容返回

2.5.2.1 增加 yaml 返回支持
2.5.2.2 思考：如何增加其他
2.5.2.3 HttpMessageConverter 的示例写法

2.5.3 内容协商原理 HttpMessageConverter

2.5.3.1 @ResponseBody 由 HttpMessageConverter 处理
2.5.3.2 WebMvcAutoConfiguration 提供几种默认 HttpMessageConverters

2.6 模板引擎

2.6.1 Thymeleaf 整合

2.6.2 基础语法

2.6.2.1 核心用法
2.6.2.2 语法示例
2.6.2.3 属性设置
2.6.2.4 遍历
2.6.2.5 判断
2.6.2.6 属性优先级
2.6.2.7 行内写法
2.6.2.8 变量选择
2.6.2.9 模板布局
2.6.2.10 devtools
2.7 国际化

2.8 错误处理

2.8.1 默认机制

2.8.2 自定义错误响应

2.8.2.1 自定义 json 响应
2.8.2.2 自定义页面响应
2.8.3 最佳实战

2.9 嵌入式容器

2.9.1 自动配置原理
2.9.2 自定义
2.9.3 最佳实践

2.10 全面接管 SpringMVC

2.10.1 WebMvcAutoConfiguration 到底自动配置了哪些规则
2.10.2 @EnableWebMvc 禁用默认行为
2.10.3 WebMvcConfigurer 功能

2.11 最佳实践

2.11.1 三种方式
2.11.2 两种模式

2.12 Web 新特性

2.12.1 Problemdetails

2.12.2 函数式 Web

2.12.2.1 场景
2.12.2.2 核心类
2.12.2.3 示例

第 3 章 SpringBoot3-数据访问

3.1 创建 SSM 整合项目
3.2 配置数据源
3.3 配置 MyBatis
3.4 CRUD 编写
3.5 自动配置原理
3.6 快速定位生效的配置

3.7 扩展：整合其他数据源

3.7.1 Druid 数据源
3.8 附录：示例数据库

第 4 章 SpringBoot3-基础特性

4.1 SpringApplication

4.1.1 自定义 banner
4.1.2 自定义 SpringApplication
4.1.3 FluentBuilder API

4.2 Profiles

4.2.1 使用

4.2.1.1 指定环境
4.2.1.2 环境激活
4.2.1.3 环境包含
4.2.2 Profile 分组
4.2.3 Profile 配置文件

4.3 外部化配置

4.3.1 配置优先级
4.3.2 外部配置
4.3.3 导入配置
4.3.4 属性占位符

4.4 单元测试 JUnit5

4.4.1 整合

4.4.2 测试

4.4.2.1 组件测试
4.4.2.2 注解
4.4.2.3 断言
4.4.2.4 嵌套测试
4.4.2.5 参数化测试

第 5 章 SpringBoot3-核心原理

5.1 事件和监听器

5.1.1 生命周期监听

5.1.1.1 监听器 SpringApplicationRunListener
5.1.1.2 生命周期全流程

5.1.2 事件触发时机

5.1.2.1 各种回调监听器
5.1.2.2 完整触发流程
5.1.2.3 SpringBoot 事件驱动开发

5.2 自动配置原理

5.2.1 入门理解

5.2.1.1 自动配置流程
5.2.1.2 SPI 机制
5.2.1.3 功能开关

5.2.2 进阶理解

5.2.2.1 @SpringBootApplication
5.2.2.2 完整启动加载流程

5.3 自定义 starter

5.3.1 业务代码
5.3.2 基本抽取
5.3.3 使用@EnableXxx 机制

5.3.4 完全自动配置

一、Spring Boot 3-核心特性

第 1 章 SpringBoot3-快速入门

1.1 简介

1.1.1 前置知识

Java17
Spring、SpringMVC、MyBatis

Maven、IDEA

1.1.2 环境要求

环境&工具	版本
SpringBoot	3.1.3+
IDEA	2022.3.3+
Java	17+
Maven	3.8.1+
Tomcat	10.1.12+
Servlet	5.0.0+
GraalVM Community	22.3+
Native Build Tools	0.9.19+

1.1.3 SpringBoot 是什么

SpringBoot 帮我们简单、快速地创建一个独立的、生产级别的 Spring 应用（说明：SpringBoot 底层是 Spring）。

大多数 SpringBoot 应用只需要编写少量配置即可快速整合 Spring 平台以及第三方技术。

特性：

快速创建独立 Spring 应用。

SSM：导包、配置、启动运行。

直接嵌入 Tomcat、Jetty 或 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。

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

1.2 快速体验

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

1.2.1 开发流程

1.2.1.1 创建项目

maven 项目



    org.springframework.boot
    spring-boot-starter-parent
    3.1.3

1.2.1.2 导入场景

场景启动器


    
    
        org.springframework.boot
        spring-boot-starter-web

1.2.1.3 主程序

package com.myxh.springboot;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
 * @author MYXH
 * @date 2023/9/11
 * @description 启动 SpringBoot 项目的主入口程序
 */
// 这是一个 SpringBoot 应用
@SpringBootApplication
public class MainApplication
{
    public static void main(String[] args)
    {
       SpringApplication.run(MainApplication.class, args);
    }
}

1.2.1.4 业务

package com.myxh.springboot.controller;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;
/**
 * @author MYXH
 * @date 2023/9/11
 */
@RestController
public class HelloController
{
    @GetMapping("/hello")
    public String hello()
    {
        return "Hello, Spring Boot 3!";
    }
}

1.2.1.5 测试

默认启动访问：localhost:8080

1.2.1.6 打包


    
        
        
            org.springframework.boot
            spring-boot-maven-plugin

mvn clean package 把项目打成可执行的 jar 包。

java -jar boot3-01-demo-1.0-SNAPSHOT.jar 启动项目。

1.2.2 特性小结

1.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。

场景一导入，万物皆就绪。

1.2.2.2 简化开发

无需编写任何配置，直接开发业务。

1.2.2.3 简化配置

application.properties：

集中式管理配置，只需要修改这个文件就行。
配置基本都有默认值。

能写的所有配置都在：https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties

1.2.2.4 简化部署

打包为可执行的 jar 包。

Linux 服务器上有 Java 环境。

1.2.2.5 简化运维

修改配置（外部放一个 application.properties 文件）、监控、健康检查…

1.2.2.6 Spring Initializr 创建向导

一键创建好整个项目结构。

SpringBoot3 全栈指南教程——尚硅谷学习笔记 2023年,Spring Initializr 创建向导,第1张

1.3 应用分析

1.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 父项目没有管理的需要自行声明好。


    com.alibaba
    druid
    1.2.16

SpringBoot3 全栈指南教程——尚硅谷学习笔记 2023年,依赖管理机制,第2张

1.3.2 自动配置机制

1.3.2.1 初步理解

自动配置的 Tomcat、SpringMVC 等。

导入场景，容器中就会自动配置好这个场景的核心组件。
以前：DispatcherServlet、ViewResolver、CharacterEncodingFilter…
现在：自动配置好的这些组件。

验证：容器中有了什么组件，就具有什么功能。

package com.myxh.springboot;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
/**
* @author MYXH
* @date 2023/9/11
* @description 启动 SpringBoot 项目的主入口程序
*/
// 主程序：com.myxh.springboot
// @SpringBootConfiguration
// @EnableAutoConfiguration
// @ComponentScan("com.myxh.springboot")
// @SpringBootApplication(scanBasePackages = "com.myxh.springboot")
// 这是一个 SpringBoot 应用
@SpringBootApplication
public class MainApplication
{
    public static void main(String[] args)
    {
        // Java10：局部变量类型的自动推断
        var ioc = SpringApplication.run(MainApplication.class, args);
        // 1、获取容器中所有组件的名字
        String[] beanNames = ioc.getBeanDefinitionNames();
        // 2、挨个遍历
        /*
        dispatcherServlet、beanNameViewResolver、characterEncodingFilter、multipartResolver
        SpringBoot 把以前配置的核心组件现在都给自动配置好了
        */
        for (String beanName : beanNames)
        {
            System.out.println("beanName = " + beanName);
        }
    }
}

默认的包扫描规则。

@SpringBootApplication 标注的类就是主程序类。
SpringBoot 只会扫描主程序所在的包及其下面的子包，自动的 component-scan 功能。

自定义扫描路径。

@SpringBootApplication(scanBasePackages = “com.myxh.springboot”)
@ComponentScan("com.myxh.springboot") 直接指定扫描的路径。

配置默认值。

配置文件的所有配置项是和某个类的对象值进行一一绑定的。
绑定了配置文件中每一项值的类：属性类。

比如：

ServerProperties 绑定了所有 Tomcat 服务器有关的配置。
MultipartProperties 绑定了所有文件上传相关的配置。
参照官方文档 https://docs.spring.io/spring-boot/docs/current/reference/html/application-properties.html#appendix.application-properties.server，或者参照绑定的属性类。

按需加载自动配置。

导入场景 spring-boot-starter-web。
场景启动器除了会导入相关功能依赖，导入一个 spring-boot-starter，是所有 starter 的 starter，基础核心 starter。
spring-boot-starter 导入了一个包 spring-boot-autoconfigure。包里面都是各种场景的 AutoConfiguration 自动配置类。

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

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

总结：导入场景启动器、触发 spring-boot-autoconfigure 这个包的自动配置生效、容器中就会具有相关场景的功能。

1.3.2.2 完整流程

思考：

1、SpringBoot 怎么实现导一个 starter、写一些简单配置，应用就能跑起来，无需关心整合。

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

3、导入场景后哪些自动配置能生效？

SpringBoot3 全栈指南教程——尚硅谷学习笔记 2023年,完整流程,第3张

自动配置流程细节梳理：

1、导入 starter-web：导入了 web 开发场景。

1、场景启动器导入了相关场景的所有依赖：starter-json、starter-tomcat、springmvc。
2、每个场景启动器都引入了一个 spring-boot-starter，核心场景启动器。
3、核心场景启动器引入了 spring-boot-autoconfigure 包。
4、spring-boot-autoconfigure 里面囊括了所有场景的所有配置。
5、只要这个包下的所有类都能生效，那么相当于 SpringBoot 官方写好的整合功能就生效了。

6、SpringBoot 默认却扫描不到 spring-boot-autoconfigure 下写好的所有配置类。（这些配置类做了整合操作），默认只扫描主程序所在的包。

2、主程序：@SpringBootApplication。

1、@SpringBootApplication 由三个注解组成@SpringBootConfiguration、@EnableAutoConfiguration、@ComponentScan。
2、SpringBoot 默认只能扫描自己主程序所在的包及其下面的子包，扫描不到 spring-boot-autoconfigure 包中官方写好的配置类。

3、@EnableAutoConfiguration：SpringBoot 开启自动配置的核心。

① 是由 @Import(AutoConfigurationImportSelector.class) 提供功能：批量给容器中导入组件。
② SpringBoot 启动会默认加载 146 个配置类。
③ 这 146 个配置类来自于 spring-boot-autoconfigure 下 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 文件指定的。
④ 项目启动的时候利用 @Import 批量导入组件机制把 autoconfigure 包下的 146 xxxAutoConfiguration 类导入进来（自动配置类）。

4、按需生效：

虽然导入了 146 个自动配置，并不是这 146 个自动配置类都能生效。

每一个自动配置类，都有条件注解 @ConditionalOnXxx，只有条件成立，才能生效。

3、xxxAutoConfiguration 自动配置类。

1、给容器中使用 @Bean 放一堆组件。
2、每个自动配置类都可能有这个注解 @EnableConfigurationProperties(ServerProperties.class)，用来把配置文件中配的指定前缀的属性值封装到 xxxProperties 属性类中。
3、以 Tomcat 为例：把服务器的所有配置都是以 server 开头的。配置都封装到了属性类中。
4、给容器中放的所有组件的一些核心参数，都来自于 xxxProperties。xxxProperties 都是和配置文件绑定。

5、只需要改配置文件的值，核心组件的底层参数都能修改。

4、写业务，全程无需关心各种整合（底层这些整合写好了，而且也生效了）。

核心流程总结：

1、导入 starter，就会导入 autoconfigure 包。

2、autoconfigure 包里面有一个文件 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports,里面指定的所有启动要加载的自动配置类。

3、@EnableAutoConfiguration 会自动的把上面文件里面写的所有自动配置类都导入进来。xxxAutoConfiguration 是有条件注解进行按需加载。

4、xxxAutoConfiguration 给容器中导入一堆组件，组件都是从 xxxProperties 中提取属性值。

5、xxxProperties 又是和配置文件进行了绑定。

效果：导入 starter、修改配置文件，就能修改底层行为。

1.3.2.3 如何学好 SpringBoot

框架的框架、底层基于 Spring。能调整每一个场景的底层行为。100%项目一定会用到底层自定义。

摄影：

傻瓜：自动配置好。
单反：焦距、光圈、快门、感光度…

傻瓜+单反：

1、理解自动配置原理。

① 导入 starter -> 生效 xxxAutoConfiguration -> 组件 -> xxxProperties -> 配置文件。

2、理解其他框架底层。

① 拦截器。

3、可以随时定制化任何组件。

① 配置文件。

② 自定义组件。

普通开发：导入 starter，Controller、Service、Mapper、偶尔修改配置文件。

高级开发：自定义组件、自定义配置、自定义 starter。

核心：

这个场景自动配置导入了哪些组件，能不能 Autowired 进来使用。
能不能通过修改配置改变组件的一些默认参数。
需不需要自己完全定义这个组件。

场景定制化。

最佳实战：

选场景，导入到项目。

官方：starter。
第三方：去仓库搜。

写配置，改配置文件关键项。

数据库参数（连接地址、账号密码…）。

分析这个场景导入了哪些能用的组件。

自动装配这些组件进行后续使用。

不满意 SprngBoot 提供的自动配好的默认组件。

定制化。
改配置。

自定义组件。

整合 redis：

选场景：spring-boot-starter-data-redis。

场景 AutoConfiguration 就是这个场景的自动配置类。

写配置：

分析到这个场景的自动配置类开启了哪些属性绑定关系。
@EnableConfigurationProperties(RedisProperties.class)。
修改 redis 相关的配置。

分析组件：

分析到 RedisAutoConfiguration 给容器中放了 StringRedisTemplate。
给业务代码中自动装配 StringRedisTemplate。

定制化：

修改配置文件。

自定义组件，自己给容器中放一个 StringRedisTemplate。

1.4 核心技能

1.4.1 常用注解

SpringBoot 摒弃 XML 配置方式，改为全注解驱动。

1.4.1.1 组件注册

@Configuration、@SpringBootConfiguration

@Bean、@Scope

@Controller、 @Service、@Repository、@Component

@Import

@ComponentScan

步骤：

1、@Configuration 编写一个配置类。

2、在配置类中，自定义方法给容器中注册组件。配合@Bean。

3、或使用@Import 导入第三方的组件。

1.4.1.2 条件注解

如果注解指定的条件成立，则触发指定行为。

@ConditionalOnXxx

@ConditionalOnClass：如果类路径中存在这个类，则触发指定行为。

@ConditionalOnMissingClass：如果类路径中不存在这个类，则触发指定行为。

@ConditionalOnBean：如果容器中存在这个 Bean（组件），则触发指定行为。

@ConditionalOnMissingBean：如果容器中不存在这个 Bean（组件），则触发指定行为。

场景：

如果存在 FastsqlException 这个类，给容器中放一个 Cat 组件，命名 cat1。

否则，就给容器中放一个 Dog 组件，命名 dog1。

如果系统中有 dog1 这个组件，就给容器中放一个 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)

1.4.1.3 属性绑定

@ConfigurationProperties：声明组件的属性和配置文件哪些前缀开始项进行绑定。

@EnableConfigurationProperties：快速注册注解：

场景：SpringBoot 默认只扫描自己主程序所在的包。如果导入第三方包，即使组件上标注了 @Component、@ConfigurationProperties 注解也没用。因为组件都扫描不进来，此时使用这个注解就可以快速进行属性绑定并把组件注册进容器。

将容器中任意组件（Bean）的属性值和配置文件的配置项的值进行绑定。

1、给容器中注册组件（@Component、@Bean）。

2、使用 @ConfigurationProperties 声明组件和配置文件的哪些配置项进行绑定。

1.4.2 YAML 配置文件

痛点：SpringBoot 集中化管理配置，application.properties。

问题：配置多以后难阅读和修改，层级结构辨识度不高。

YAML 是 “YAML Ain’t a Markup Language”（YAML 不是一种标记语言）。在开发的这种语言时，YAML 的意思其实是：“Yet Another Markup Language”（是另一种标记语言）。

设计目标，就是方便人类读写。

层次分明，更适合做配置文件。

使用 .yaml 或 .yml 作为文件后缀。

1.4.2.1. 基本语法

大小写敏感。
使用缩进表示层级关系，k: v，使用空格分割 k, v。
缩进时不允许使用 Tab 键，只允许使用空格。
缩进的空格数目不重要，只要相同层级的元素左侧对齐即可。

# 表示注释，从这个字符一直到行尾，都会被解析器忽略。

支持的写法：

对象：键值对的集合，例如：映射（map）、哈希（hash）、字典（dictionary）。
数组：一组按次序排列的值，例如：序列（sequence）、列表（list）。

纯量：单个的、不可再分的值，例如：字符串、数字、bool、日期。

1.4.2.2 示例

package com.myxh.springboot.bean;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.Date;
import java.util.List;
import java.util.Map;
/**
 * @author MYXH
 * @date 2023/9/11
 */
@Component
// 和配置文件 person 前缀的所有配置进行绑定
@ConfigurationProperties(prefix = "person")
// 自动生成无参构造器
@NoArgsConstructor
// 自动生成全参构造器
@AllArgsConstructor
// 自动生成 JavaBean 属性的 getter/setter
@Data
public class Person
{
    private String name;
    private Integer age;
    private Date birthDay;
    private Boolean like;
    // 嵌套对象
    private Child child;
    // 数组（里面是对象）
    private List dogs;
    // Map
    private Map cats;
}

package com.myxh.springboot.bean;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.stereotype.Component;
import java.util.Date;
import java.util.List;
/**
 * @author MYXH
 * @date 2023/9/11
 */
@Component
@NoArgsConstructor
@AllArgsConstructor
@Data
public class Child
{
    private String name;
    private Integer age;
    private Date birthDay;
    // 数组
    private List text;
}

package com.myxh.springboot.bean;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.stereotype.Component;
/**
 * @author MYXH
 * @date 2023/9/11
 */
@Component
@NoArgsConstructor
@AllArgsConstructor
@Data
public class Dog
{
    private String name;
    private Integer age;
}

package com.myxh.springboot.bean;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.stereotype.Component;
/**
 * @author MYXH
 * @date 2023/9/11
 */
@Component
@NoArgsConstructor
@AllArgsConstructor
@Data
public class Cat
{
    private String name;
    private Integer age;
}

properties 表示法。

server.port=8080
spring.servlet.multipart.max-file-size=10MB
# 配置 Redis
spring.data.redis.host=localhost
spring.data.redis.port=6379
# properties 表示复杂对象
person.name=张三
person.age=35
person.birthDay=1988/01/01 00:00:00
person.like=true
person.child.name=李四
person.child.age=12
person.child.birthDay=2011/01/01
person.child.text[0]=hello
person.child.text[1]=world
person.dogs[0].name=小黑
person.dogs[0].age=2
person.dogs[1].name=小白
person.dogs[1].age=1
person.cats.cat1.name=小蓝
person.cats.cat1.age=2
person.cats.cat2.name=小灰
person.cats.cat2.age=1

yaml 表示法。

# 1、k: v，k v 之前是空格区分
# 2、属性有层级关系，使用下一行，空两个空格
# 3、左侧对齐的代表同一层级的属性
---
server:
  port: 8080
  # port: 8081
spring:
  servlet:
    multipart:
      max-file-size: 10MB
  # 配置 Redis
  data:
    redis:
      host: localhost
      port: 6379
# 下边是一个单独文档
---
# yaml 表示复杂对象
person:
  name: 张三
  age: 35
  birth-day: 1988/01/01 00:00:00
  like: true
  child:
    name: 李四
    age: 12
    birth-day: 2011/01/01
    # text: ["he\nllo",'wor\nld']
    text:
      - "he\nllo"
      - 'wor\nld'
      - |
        cats:
          cat1:
            name: 小蓝
            age: 2
          # 对象也可用 {} 表示
          cat2: {name: 小灰,age: 1}
      - >
        cats:
        cat1:
        name: 小蓝
        age: 2
        # 对象也可用 {} 表示
        cat2: {name: 小灰,age: 1}
  dogs:
    # 数组也可用 - 表示
    - name: 小黑
      age: 2
    - name: 小白
      age: 1
  cats:
    cat1:
      name: 小蓝
      age: 2
    # 对象也可用 {} 表示
    cat2: { name: 小灰, age: 1 }

1.4.2.3 细节

birthDay 推荐写为 birth-day。

文本：

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

大文本：

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

> 开头，大文本写在下层，折叠换行符。

多文档合并：

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

1.4.2.4. 小技巧：lombok

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


    org.projectlombok
    lombok
    compile

使用 @Data 等注解。

1.4.3 日志配置

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

SpringBoot3 全栈指南教程——尚硅谷学习笔记 2023年,日志配置,第4张

1.4.3.1 简介

1、Spring 使用 commons-logging 作为内部日志，但底层日志实现是开放的。可对接其他日志框架。

① spring5 及以后 commons-logging 被 spring 直接自己实现了。

2、支持 jul，log4j2，logback。SpringBoot 提供了默认的控制台输出配置，也可以配置输出为文件。

3、logback 是默认使用的。

4、虽然日志框架很多，但是不用担心，使用 SpringBoot 的默认配置就能工作的很好。

SpringBoot 怎么把日志默认配置好的。

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

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

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

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

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

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

1.4.3.2 日志格式

2023-09-14 20:24:43.709  INFO 96528 --- [main] o.s.b.w.e.t.TomcatWebServer              : Tomcat initialized with port(s): 8080 (http)
2023-09-14 20:24:43.712  INFO 96528 --- [main] o.a.c.c.AprLifecycleListener             : Loaded Apache Tomcat Native library [2.0.5] using APR version [1.7.4].

默认输出格式：

时间和日期：毫秒级精度。
日志级别：ERROR, WARN, INFO, DEBUG, TRACE。
进程 ID。
---：消息分割符。
线程名：使用[]包含。
Logger 名：通常是产生日志的类名。

消息：日志记录的内容。

注意：logback 没有 FATAL 级别，对应的是 ERROR。

默认值：参照：spring-boot 包 additional-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。

1.4.3.3 记录日志

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

或者使用 Lombok 的@Slf4j 注解。

1.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.=指定日志级别。

2、level 可取值范围：TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF，定义在 LogLevel 类中。

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

1.4.3.5 日志分组

比较有用的技巧是：

将相关的 logger 分组在一起，统一配置。SpringBoot 也支持。比如：Tomcat 相关的日志统一设置。

logging.group.tomcat=org.apache.catalina,org.apache.coyote,org.apache.tomcat
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

1.4.3.6 文件输出

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

logging.file.name	logging.file.path	示例	效果
未指定	未指定	无	仅控制台输出。
指定	未指定	my.log	写入指定文件。可以加路径。
未指定	指定	./log	写入指定目录，文件名为 spring.log。
指定	指定	无	以 logging.file.name 为准。

1.4.3.7 文件归档与滚动切割

归档：每天的日志单独存到一个文档中。

切割：每个文件 10MB，超过大小切割成另外一个文件。

1、每天的日志应该独立分割出来存档。如果使用 logback（SpringBoot 默认整合），可以通过 application.properties/yaml 文件指定日志滚动规则。

2、如果是其他日志系统，需要自行配置（添加 log4j2.xml 或 log4j2-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)。

1.4.3.8 自定义配置

通常配置 application.properties 就够了。当然也可以自定义。比如：

日志系统	自定义
Logback	logback-spring.xml, logback-spring.groovy, logback.xml, logback.groovy
Log4j2	log4j2-spring.xml or log4j2.xml
JDK (Java Util Logging)	logging.properties

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

最佳实战：自己要写配置，配置文件名加上 xxx-spring.xml。

1.4.3.9 切换日志组合


    org.springframework.boot
    spring-boot-starter-web



    org.springframework.boot
    spring-boot-starter
    
        
            org.springframework.boot
            spring-boot-starter-logging
        
    


    org.springframework.boot
    spring-boot-starter-log4j2

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

1.4.3.10 最佳实战

1、导入任何第三方框架，先排除它的日志包，因为 Boot 底层控制好了日志。

2、修改 application.properties 配置文件，就可以调整日志的所有行为。如果不够，可以编写日志框架自己的配置文件放在类路径下就行，比如 logback-spring.xml，log4j2-spring.xml。

3、如需对接专业日志系统，也只需要把 logback 记录的日志灌倒 kafka 之类的中间件，这和 SpringBoot 没关系，都是日志框架自己的配置，修改配置文件即可。

4、业务中使用 slf4j-api 记录日志，不要再用 System.out.println() 了

第 2 章 SpringBoot3-Web 开发

SpringBoot 的 Web 开发能力，由 SpringMVC 提供。

2.1 WebMvcAutoConfiguration 原理

2.1.1 生效条件

// 在这些自动配置之后
@AutoConfiguration(after = { DispatcherServletAutoConfiguration.class,
    TaskExecutionAutoConfiguration.class,
    ValidationAutoConfiguration.class })
// 如果是 Web 应用就生效，类型有 SERVLET、REACTIVE（响应式 Web）
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({ Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class })
// 容器中没有这个 Bean，才生效，默认就是没有
@ConditionalOnMissingBean(WebMvcConfigurationSupport.class)
// 优先级
@AutoConfigureOrder(Ordered.HIGHEST_PRECEDENCE + 10)
@ImportRuntimeHints(WebResourcesRuntimeHints.class)
public class WebMvcAutoConfiguration
{
}

2.1.2 效果

1、放了两个 Filter：

① HiddenHttpMethodFilter：页面表单提交 Rest 请求（GET、POST、PUT、DELETE）。

② FormContentFilter：表单内容 Filter，GET（数据放 URL 后面）、POST（数据放请求体）请求可以携带数据，PUT、DELETE 的请求体数据会被忽略。

2、给容器中放了 WebMvcConfigurer 组件：给 SpringMVC 添加各种定制功能。

① 所有的功能最终会和配置文件进行绑定。
② WebMvcProperties：spring.mvc 配置文件。

③ WebProperties：spring.web 配置文件。

@Configuration(proxyBeanMethods = false)
// 额外导入了其他配置
@Import(EnableWebMvcConfiguration.class)
@EnableConfigurationProperties({ WebMvcProperties.class, WebProperties.class })
@Order(0)
public static class WebMvcAutoConfigurationAdapter implements WebMvcConfigurer, ServletContextAware
{
}

2.1.3 WebMvcConfigurer 接口

提供了配置 SpringMVC 底层的所有组件入口。

SpringBoot3 全栈指南教程——尚硅谷学习笔记 2023年,WebMvcConfigurer 接口,第5张

2.1.4 静态资源规则源码

@Override
public void addResourceHandlers(ResourceHandlerRegistry registry)
{
    if (!this.resourceProperties.isAddMappings())
    {
        logger.debug("Default resource handling disabled");
        return;
    }
    addResourceHandler(registry, this.mvcProperties.getWebjarsPathPattern(),
        "classpath:/META-INF/resources/webjars/");
    addResourceHandler(registry, this.mvcProperties.getStaticPathPattern(),
        (registration) -> {
        registration.addResourceLocations(this.resourceProperties.getStaticLocations());
        if (this.servletContext != null)
        {
            ServletContextResource resource = new ServletContextResource(this.servletContext, SERVLET_LOCATION);
            registration.addResourceLocations(resource);
        }
    });
}

1、规则一：访问 /webjars/** 路径就去 classpath:/META-INF/resources/webjars/ 下找资源。

① Maven 导入依赖。

2、规则二：访问 /** 路径就去静态资源默认的四个位置找资源。

① classpath:/META-INF/resources/
② classpath:/resources/
③ classpath:/static/

④ classpath:/public/

3、规则三：静态资源默认都有缓存规则的设置。

① 所有缓存的设置，直接通过配置文件：spring.web。
② cachePeriod：缓存周期，多久不用找服务器要新的，默认没有缓存周期，以秒为单位。
③ cacheControl：HTTP 缓存控制，https://developer.mozilla.org/zh-CN/docs/Web/HTTP/Caching 。

④ useLastModified：是否使用最后一次修改，配合 HTTP Cache 规则。

如果浏览器访问了一个静态资源 index.js，如果服务这个资源没有发生变化，下次访问的时候就可以直接让浏览器用自己缓存中的东西，而不用给服务器发请求。

registration.setCachePeriod(getSeconds(this.resourceProperties.getCache().getPeriod()));
registration.setCacheControl(this.resourceProperties.getCache().getCachecontrol().toHttpCacheControl());
registration.setUseLastModified(this.resourceProperties.getCache().isUseLastModified());

2.1.5 EnableWebMvcConfiguration 源码

/*
SpringBoot 给容器中放 WebMvcConfigurationSupport 组件
如果自己放了 WebMvcConfigurationSupport 组件，SpringBoot 的 WebMvcAutoConfiguration 都会失效
 */
@Configuration(proxyBeanMethods = false)
@EnableConfigurationProperties(WebProperties.class)
public static class EnableWebMvcConfiguration extends DelegatingWebMvcConfiguration implements ResourceLoaderAware
{
}

1、HandlerMapping：根据请求路径 /xxx 找那个 handler 能处理请求。

① WelcomePageHandlerMapping：

(1) 访问 /\*\* 路径下的所有请求，都在以前四个静态资源路径下找，欢迎页也一样。

(2) 找 index.html：只要静态资源的位置有一个 index.html 页面，项目启动默认访问。

2.1.6 为什么容器中放一个 WebMvcConfigurer 就能配置底层行为

1、WebMvcAutoConfiguration 是一个自动配置类，它里面有一个 EnableWebMvcConfiguration。

2、EnableWebMvcConfiguration 继承于 DelegatingWebMvcConfiguration，这两个都生效。

3、DelegatingWebMvcConfiguration 利用依赖注入把容器中所有 WebMvcConfigurer 注入进来。

4、别人调用 DelegatingWebMvcConfiguration 的方法配置底层规则，而它调用所有 WebMvcConfigurer 的配置底层方法。

2.1.7 WebMvcConfigurationSupport

提供了很多的默认设置。

判断系统中是否有相应的类：如果有，就加入相应的 HttpMessageConverter

jackson2Present = ClassUtils.isPresent("com.fasterxml.jackson.databind.ObjectMapper", classLoader) &&
    ClassUtils.isPresent("com.fasterxml.jackson.core.JsonGenerator", classLoader);
jackson2XmlPresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.xml.XmlMapper", classLoader);
jackson2SmilePresent = ClassUtils.isPresent("com.fasterxml.jackson.dataformat.smile.SmileFactory", classLoader);

2.2 Web 场景

2.2.1 自动配置

1、整合 web 场景。


    org.springframework.boot
    spring-boot-starter-web

2、引入了 autoconfigure 功能。

3、@EnableAutoConfiguration 注解使用 @Import(AutoConfigurationImportSelector.class) 批量导入组件。

4、加载 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports 文件中配置的所有组件。

5、所有自动配置类如下。

org.springframework.boot.autoconfigure.web.client.RestTemplateAutoConfiguration
org.springframework.boot.autoconfigure.web.embedded.EmbeddedWebServerFactoryCustomizerAutoConfiguration
// ==============以下是响应式 Web 场景==============
org.springframework.boot.autoconfigure.web.reactive.HttpHandlerAutoConfiguration
org.springframework.boot.autoconfigure.web.reactive.ReactiveMultipartAutoConfiguration
org.springframework.boot.autoconfigure.web.reactive.ReactiveWebServerFactoryAutoConfiguration
org.springframework.boot.autoconfigure.web.reactive.WebFluxAutoConfiguration
org.springframework.boot.autoconfigure.web.reactive.WebSessionIdResolverAutoConfiguration
org.springframework.boot.autoconfigure.web.reactive.error.ErrorWebFluxAutoConfiguration
org.springframework.boot.autoconfigure.web.reactive.function.client.ClientHttpConnectorAutoConfiguration
org.springframework.boot.autoconfigure.web.reactive.function.client.WebClientAutoConfiguration
// ===============================================
org.springframework.boot.autoconfigure.web.servlet.DispatcherServletAutoConfiguration
org.springframework.boot.autoconfigure.web.servlet.ServletWebServerFactoryAutoConfiguration
org.springframework.boot.autoconfigure.web.servlet.error.ErrorMvcAutoConfiguration
org.springframework.boot.autoconfigure.web.servlet.HttpEncodingAutoConfiguration
org.springframework.boot.autoconfigure.web.servlet.MultipartAutoConfiguration
org.springframework.boot.autoconfigure.web.servlet.WebMvcAutoConfiguration

6、绑定了配置文件的一堆配置项。

① SpringMVC 的所有配置 spring.mvc。
② Web 场景通用配置 spring.web。
③ 文件上传配置 spring.servlet.multipart。

④ 服务器的配置 server，比如：编码方式

2.2.2 默认效果

默认配置：

1、包含了 ContentNegotiatingViewResolver 和 BeanNameViewResolver 组件，方便视图解析。

2、默认的静态资源处理机制：静态资源放在 static 文件夹下即可直接访问。

3、自动注册了 Converter, GenericConverter, Formatter 组件，适配常见数据类型转换和格式化需求。

4、支持 HttpMessageConverters，可以方便返回 json 等数据类型。

5、注册 MessageCodesResolver，方便国际化及错误消息处理。

6、支持静态 index.html。

7、自动使用 ConfigurableWebBindingInitializer，实现消息处理、数据绑定、类型转化、数据校验等功能。

重要：

如果想保持 boot mvc 的默认配置，并且自定义更多的 mvc 配置，比如：interceptors, formatters, view controllers 等。可以使用 @Configuration 注解添加一个 WebMvcConfigurer 类型的配置类，并且不要标注 @EnableWebMvc。

如果想保持 boot mvc 的默认配置，但要自定义核心组件实例，比如：RequestMappingHandlerMapping, RequestMappingHandlerAdapter, 或 ExceptionHandlerExceptionResolver，给容器中放一个 WebMvcRegistrations 组件即可。

如果想全面接管 Spring MVC，@Configuration 标注一个配置类，并加上 @EnableWebMvc 注解，实现 WebMvcConfigurer 接口。

2.3 静态资源

2.3.1 默认规则

2.3.1.1 静态资源映射

静态资源映射规则在 WebMvcAutoConfiguration 中进行了定义：

1、/webjars/** 的所有路径资源都在 classpath:/META-INF/resources/webjars/。

2、/** 的所有路径资源都在 classpath:/META-INF/resources/、classpath:/resources/、classpath:/static/、classpath:/public/。

3、所有静态资源都定义了缓存规则。【浏览器访问过一次，就会缓存一段时间】，但此功能参数无默认值。

① period：缓存间隔，默认 0 秒。
② cacheControl：缓存控制，默认无。

③ useLastModified：是否使用 lastModified 头，默认 false。

2.3.1.2 静态资源缓存

如前面所述

1、所有静态资源都定义了缓存规则。【浏览器访问过一次，就会缓存一段时间】，但此功能参数无默认值。

① period：缓存间隔，默认 0 秒。
② cacheControl：缓存控制，默认无。

③ useLastModified：是否使用 lastModified 头，默认 false。

2.3.1.3 欢迎页

欢迎页规则在 WebMvcAutoConfiguration 中进行了定义：

1、在静态资源目录下找 index.html 模板页。

2、没有就在 templates 下找 index.html 模板页。

2.3.1.4 Favicon

1、在静态资源目录下找 favicon.ico。

2.3.1.5 缓存实验

server.port=8080
# 1、spring.web：
# ① 配置国际化的区域信息
# ② 静态资源策略（开启、处理链、缓存）
# 开启静态资源映射规则
spring.web.resources.add-mappings=true
# 设置缓存
spring.web.resources.cache.period=3600
# 缓存详细合并项控制，覆盖 period 配置
# 浏览照第一次请求服务器，服务器告诉浏览器此资源缓存 7200 秒，7200 秒以内的所有此资源访问不用发给服务器请求，7200 秒以后发请求给服务器
spring.web.resources.cache.cachecontrol.max-age=7200
# 共享缓存
spring.web.resources.cache.cachecontrol.cache-public=true
# 使用资源 last-modified 时间，来对比服务器和浏览照的资源是否相同没有变化，相同返回 304
spring.web.resources.cache.use-last-modified=true

2.3.2 自定义静态资源规则

自定义静态资源路径、自定义缓存规则。

2.3.2.1 配置方式

spring.mvc：静态资源访问前缀路径。

spring.web：

静态资源缓存策略。

# 2、spring.mvc
# ① 自定义 webjars 路径前缀
spring.mvc.webjars-path-pattern=/webjars/**
# ② 静态资源访问路径前缀
spring.mvc.static-path-pattern=/static/**

2.3.2.2 代码方式

容器中只要有一个 WebMvcConfigurer 组件，配置的底层行为都会生效。

@EnableWebMvc，禁用 boot 的默认配置。

package com.myxh.springboot.web.config;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.CacheControl;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.util.concurrent.TimeUnit;
/**
 * @author MYXH
 * @date 2023/9/18
 */
// 禁用 Spring Boot 的默认配置
// @EnableWebMvc
// 这是一个配置类，给容器中放一个 WebMvcConfigurer 组件，就能自定义底层
@Configuration
public class MyConfig implements WebMvcConfigurer
{
    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry)
    {
        // 保留默认规则
        WebMvcConfigurer.super.addResourceHandlers(registry);
        // 新增自定义规则
        registry.addResourceHandler("/static/**")
                .addResourceLocations("classpath:/image/, classpath:/static/")
                .setCacheControl(CacheControl.maxAge(7200, TimeUnit.SECONDS));
    }
}

package com.myxh.springboot.web.config;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.CacheControl;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.util.concurrent.TimeUnit;
/**
 * @author MYXH
 * @date 2023/9/18
 */
// 禁用 Spring Boot 的默认配置
// @EnableWebMvc
// 这是一个配置类，给容器中放一个 WebMvcConfigurer 组件，就能自定义底层
@Configuration
public class MyConfig
{
    @Bean
    public WebMvcConfigurer webMvcConfigurer()
    {
        return new WebMvcConfigurer()
        {
            /**
             * 配置静态资源
             *
             * @param registry 注册表
             */
            @Override
            public void addResourceHandlers(ResourceHandlerRegistry registry)
            {
                // 保留默认规则
                WebMvcConfigurer.super.addResourceHandlers(registry);
                // 新增自定义规则
                registry.addResourceHandler("/static/**")
                        .addResourceLocations("classpath:/image/, classpath:/static/")
                        .setCacheControl(CacheControl.maxAge(7200, TimeUnit.SECONDS));
            }
        };
    }
}

2.4 路径匹配

Spring5.3 之后加入了更多的请求路径匹配的实现策略。

以前只支持 AntPathMatcher 策略, 现在提供了 PathPatternParser 策略，并且可以指定到底使用那种策略。

2.4.1 Ant 风格路径用法

Ant 风格的路径模式语法具有以下规则：

\*：表示任意数量的字符。
?：表示任意一个字符。
\*\*：表示任意数量的目录。
{}：表示一个命名的模式占位符。

[]：表示字符集合，例如[a-z]表示小写字母。

例如：

\*.html 匹配任意名称，扩展名为 .html 的文件。
/folder1/\*/\*.java 匹配在 folder1 目录下的任意两级目录下的 .java 文件。
/folder2/\*\*/\*.jsp 匹配在 folder2 目录下任意目录深度的 .jsp 文件。

/{type}/{id}.html 匹配任意文件名为 {id}.html，在任意命名的 {type} 目录下的文件。

注意：Ant 风格的路径模式语法中的特殊字符需要转义，例如：

要匹配文件路径中的星号，则需要转义为\\\\*。

要匹配文件路径中的问号，则需要转义为 \\\\?。

2.4.2 模式切换

AntPathMatcher 与 PathPatternParser。

PathPatternParser 在 jmh 基准测试下，有 6~8 倍吞吐量提升，降低 30%~40% 空间分配率。

PathPatternParser 兼容 AntPathMatcher 语法，并支持更多类型的路径模式。

PathPatternParser “**” 多段匹配的支持仅允许在模式末尾使用。

package com.myxh.springboot.web.controller;
import jakarta.servlet.http.HttpServletRequest;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;
/**
 * @author MYXH
 * @date 2023/9/18
 */
@Slf4j
@RestController
public class HelloController
{
    /**
     * 默认使用新版 PathPatternParser 进行路径匹配
     * 不能匹配 ** 在中间的情况，其他情况和 antPathMatcher语法兼容
     *
     * @param request 请求
     * @param path 路径
     * @return uri
     */
    @GetMapping("/a*/b?/**/{p1:[a-f]+}/**")
    public String hello(HttpServletRequest request, @PathVariable("p1") String path)
    {
        log.info("路径变量 p1：{}", path);
        String uri = request.getRequestURI();
        return uri;
    }
}

总结：

使用默认的路径匹配规则，是由 PathPatternParser 提供的。

如果路径中间需要有 **，替换成 ant 风格路径。

2.5 内容协商

一套系统适配多端数据返回。

2.5.1 多端内容适配

2.5.1.1 默认规则

1、SpringBoot 多端内容适配。

① 基于请求头内容协商：（默认开启）

(1)客户端向服务端发送请求，携带 HTTP 标准的 Accept 请求头。

[1] Accept: application/json、text/xml、text/yaml。
[2] 服务端根据客户端请求头期望的数据类型进行动态返回。

② 基于请求参数内容协商：（需要开启）

[1] 发送请求 GET /projects/spring-boot?format=json。
[2] 匹配到 @GetMapping("/projects/spring-boot")。
[3] 根据参数协商，优先返回 json 类型数据【需要开启参数匹配设置】。

[4] 发送请求 GET /projects/spring-boot?format=xml，优先返回 xml 类型数据。

2.5.1.2 效果演示

请求同一个接口，可以返回 json 和 xml 不同格式数据。

1、引入支持写出 xml 内容依赖。



    com.fasterxml.jackson.dataformat
    jackson-dataformat-xml

2、标注注解。

package com.myxh.springboot.web.bean;
import com.fasterxml.jackson.dataformat.xml.annotation.JacksonXmlRootElement;
import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
/**
 * @author MYXH
 * @date 2023/9/18
 */
// 可以写出为 xml 文档
@JacksonXmlRootElement
@Component
// 和配置文件 person 前缀的所有配置进行绑定
@ConfigurationProperties(prefix = "user")
// 自动生成无参构造器
@NoArgsConstructor
// 自动生成全参构造器
@AllArgsConstructor
// 自动生成 JavaBean 属性的 getter/setter
@Data
public class User
{
    private Long id;
    private String userName;
    private String password;
    private Integer age;
    private String email;
    private String role;
}

3、开启基于请求参数的内容协商。

# 开启基于请求参数的内容协商功能，默认参数名：format，默认此功能不开启
spring.mvc.contentnegotiation.favor-parameter=true
# 指定内容协商时使用的参数名，默认是 format
spring.mvc.contentnegotiation.parameter-name=type

4、效果。

SpringBoot3 全栈指南教程——尚硅谷学习笔记 2023年,效果演示,第7张

SpringBoot3 全栈指南教程——尚硅谷学习笔记 2023年,效果演示,第8张

2.5.1.3 配置协商规则与支持类型

1、修改内容协商方式。

# 开启基于请求参数的内容协商功能，默认参数名：format，默认此功能不开启
spring.mvc.contentnegotiation.favor-parameter=true
# 指定内容协商时使用的参数名，默认是 format
spring.mvc.contentnegotiation.parameter-name=type

2、大多数 MediaType 都是开箱即用的。也可以自定义内容类型，例如：

# 增加一种新的内容类型
spring.mvc.contentnegotiation.media-types.yaml=text/yaml
spring.mvc.contentnegotiation.media-types.yml=text/yml

2.5.2 自定义内容返回

2.5.2.1 增加 yaml 返回支持

导入依赖。



    com.fasterxml.jackson.dataformat
    jackson-dataformat-yaml

把对象写出成 YAML。

package com.myxh.springboot.web.controller;
import com.myxh.springboot.web.bean.User;
/**
 * @author MYXH
 * @date 2023/9/18
 */
public class HelloController
{
    public static void main(String[] args) throws JsonProcessingException
    {
        User user = new User();
        user.setId(1L);
        user.setUserName("MYXH");
        user.setPassword("520.ILY!");
        user.setAge(21);
        user.setEmail("1735350920@qq.com");
        YAMLFactory factory = new YAMLFactory().disable(YAMLGenerator.Feature.WRITE_DOC_START_MARKER);
        ObjectMapper mapper = new ObjectMapper(factory);
        String userYaml = mapper.writeValueAsString(user);
        System.out.println("userYaml = " + userYaml);
    }
}

编写配置。

# 增加一种新的内容类型
spring.mvc.contentnegotiation.media-types.yaml=text/yaml
spring.mvc.contentnegotiation.media-types.yml=text/yml

增加 HttpMessageConverter 组件，专门负责把对象写出为 yaml 格式。

package com.myxh.springboot.web.config;
import com.myxh.springboot.web.component.MyYamlHttpMessageConverter;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.http.converter.HttpMessageConverter;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
import java.util.List;
/**
 * @author MYXH
 * @date 2023/9/18
 */
// 禁用 Spring Boot 的默认配置
// @EnableWebMvc
// 这是一个配置类，给容器中放一个 WebMvcConfigurer 组件，就能自定义底层
@Configuration
public class MyConfig
{
    @Bean
    public WebMvcConfigurer webMvcConfigurer()
    {
        return new WebMvcConfigurer()
        {
            /**
             * 配置一个能把对象转为 yaml 的 messageConverter
             *
             * @param converters 最初是转换器的空列表
             */
            @Override
            public void configureMessageConverters(List> converters)
            {
                converters.add(new MyYamlHttpMessageConverter());
            }
        };
    }
}

2.5.2.2 思考：如何增加其他

配置媒体类型支持:

spring.mvc.contentnegotiation.media-types.yaml=text/yaml。

编写对应的 HttpMessageConverter，要告诉 Boot 这个支持的媒体类型。

按照 HttpMessageConverter 的示例写法。

把 MessageConverter 组件加入到底层。

容器中放一个 WebMvcConfigurer 组件，并配置底层的 MessageConverter。

2.5.2.3 HttpMessageConverter 的示例写法

package com.myxh.springboot.web.component;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;
import com.fasterxml.jackson.dataformat.yaml.YAMLGenerator;
import org.springframework.http.HttpInputMessage;
import org.springframework.http.HttpOutputMessage;
import org.springframework.http.MediaType;
import org.springframework.http.converter.AbstractHttpMessageConverter;
import org.springframework.http.converter.HttpMessageNotReadableException;
import org.springframework.http.converter.HttpMessageNotWritableException;
import java.io.IOException;
import java.io.OutputStream;
import java.nio.charset.StandardCharsets;
/**
 * @author MYXH
 * @date 2023/9/18
 * @description
 * 自定义的 YAML HTTP 消息转换器
 * 用于将对象转换为 YAML 格式的内容
 */
public class MyYamlHttpMessageConverter extends AbstractHttpMessageConverter

顺序	特性	属性
1	片段包含。	th:insert、th:replace
2	遍历。	th:each
3	判断。	th:if、th:unless、th:switch、th:case
4	定义本地变量。	th:object、th:with
5	通用方式属性修改。	th:attr、th:attrprepend、th:attrappend
6	指定属性修改。	th:value、th:href、th:src、...
7	文本值。	th:text、th:utext
8	片段指定。	th:fragment
9	片段移除。	th:remove

提供方法	核心参数	功能	默认
addFormatters	FormatterRegistry	格式化器：支持属性上 @NumberFormat 和@DatetimeFormat 的数据类型转换。	GenericConversionService
getValidator	无	数据校验：校验 Controller 上使用 @Valid 标注的参数合法性，需要导入 starter-validator。	无
addInterceptors	InterceptorRegistry	拦截器：拦截收到的所有请求。	无
configureContentNegotiation	ContentNegotiationConfigurer	内容协商：支持多种数据格式返回，需要配合支持这种类型的 HttpMessageConverter。	支持 json。
configureMessageConverters	List>	消息转换器：标注 @ResponseBody 的返回值会利用 MessageConverter 直接写出去。	8 个，支持 byte, string, multipart, resource, json。
addViewControllers	ViewControllerRegistry	视图映射：直接将请求路径与物理视图映射，用于无 Java 业务逻辑的直接视图页渲染。
configureViewResolvers	ViewResolverRegistry	视图解析器：逻辑视图转为物理视图。	iewResolverComposite
addResourceHandlers	ResourceHandlerRegistry	静态资源处理：静态资源路径映射、缓存控制。	ResourceHandlerRegistry
configureDefaultServletHandling	DefaultServletHandlerConfigurer	默认 Servlet：可以覆盖 Tomcat 的 DefaultServlet，让 DispatcherServlet 拦截 /。	无
configurePathMatch	PathMatchConfigurer	路径匹配：自定义 URL 路径匹配，可以自动为所有路径加上指定前缀，比如 /api。	无
configureAsyncSupport	AsyncSupportConfigurer	异步支持：	TaskExecutionAutoConfiguration
addCorsMappings	CorsRegistry	跨域：	无
addArgumentResolvers	List	参数解析器：	mvc 默认提供。
addReturnValueHandlers	List	返回值解析器：	mvc 默认提供。
configureHandlerExceptionResolvers	List	异常处理器：	默认 3 个，ExceptionHandlerExceptionResolver、ResponseStatusExceptionResolver、DefaultHandlerExceptionResolver。
getMessageCodesResolver	无	消息码解析器：国际化使用	无

方式	用法	效果
全自动	直接编写控制器逻辑。	全部使用自动配置默认效果。
半自动	注解 @Configuration + 配置 WebMvcConfigurer + 配置 WebMvcRegistrations，不要标注注解 @EnableWebMvc。	保留自动配置效果，手动设置部分功能，定义 MVC 底层组件。
全手动	注解 @Configuration + 配置 WebMvcConfigurer，标注注解 @EnableWebMvc。	禁用自动配置效果，全手动设置。

方法	说明
assertEquals	判断两个对象或两个原始类型是否相等。
assertNotEquals	判断两个对象或两个原始类型是否不相等。
assertSame	判断两个对象引用是否指向同一个对象。
assertNotSame	判断两个对象引用是否指向不同的对象。
assertTrue	判断给定的布尔值是否为 true。
assertFalse	判断给定的布尔值是否为 false。
assertNull	判断给定的对象引用是否为 null。
assertNotNull	判断给定的对象引用是否不为 null。
assertArrayEquals	数组断言。
assertAll	组合断言。
assertThrows	异常断言。
assertTimeout	超时断言。
fail	快速失败。