# springboot-study

**Repository Path**: wanzhenxing/springboot-study

## Basic Information

- **Project Name**: springboot-study
- **Description**: springboot-study...
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 0
- **Created**: 2023-05-09
- **Last Updated**: 2024-01-10

## Categories & Tags

**Categories**: Uncategorized

**Tags**: SpringBoot

## README

# springboot-study

springboot-study...

## 0、SpringBoot 简介
### 0.1 回顾什么是  Spring ？
Spring是一个开源框架，2003 年兴起的一个轻量级的Java 开发框架，作者：Rod Johnson。  
Spring是为了解决企业级应用开发的复杂性而创建的，简化开发。  
官方文档：https://docs.spring.io/spring-boot/docs/2.7.14/reference/html/features.html#features.task-execution-and-scheduling

### 0.2 Spring 是如何简化 Java 开发的
为了降低Java开发的复杂性，Spring采用了以下4种关键策略：  
1、基于POJO的轻量级和最小侵入性编程，所有东西都是bean；  
2、通过IOC，依赖注入（DI）和面向接口实现松耦合；  
3、基于切面（AOP）和惯例进行声明式编程；  
4、通过切面和模版减少样式代码，RedisTemplate，xxxTemplate；

### 0.3 什么是 SpringBoot ？
- 学过 javaweb 就知道，开发一个web应用，从最初开始接触Servlet结合Tomcat, 跑出一个Hello Wolrld程序，是要经历特别多的步骤；后来就用了框架Struts，再后来是SpringMVC，到了现在的SpringBoot，过一两年又会有其他web框架出现；你们有经历过框架不断的演进，然后自己开发项目所有的技术也在不断的变化、改造吗？建议都可以去经历一遍；
- 言归正传，什么是SpringBoot呢，就是一个javaweb的开发框架，和SpringMVC类似，对比其他javaweb框架的好处，官方说是简化开发，约定大于配置，  you can "just run"，能迅速的开发web应用，几行代码开发一个http接口。
- 所有的技术框架的发展似乎都遵循了一条主线规律：从一个复杂应用场景 衍生 一种规范框架，人们只需要进行各种配置而不需要自己去实现它，这时候强大的配置功能成了优点；发展到一定程度之后，人们根据实际生产应用情况，选取其中实用功能和设计精华，重构出一些轻量级的框架；之后为了提高开发效率，嫌弃原先的各类配置过于麻烦，于是开始提倡“约定大于配置”，进而衍生出一些一站式的解决方案。
- 是的这就是 Java 企业级应用 > J2EE > spring > springboot 的过程。
- 随着 Spring 不断的发展，涉及的领域越来越多，项目整合开发需要配合各种各样的文件，慢慢变得不那么易用简单，违背了最初的理念，甚至人称配置地狱。Spring Boot 正是在这样的一个背景下被抽象出来的开发框架，目的为了让大家更容易的使用 Spring 、更容易的集成各种常用的中间件、开源软件；
- Spring Boot 基于 Spring 开发，Spirng Boot 本身并不提供 Spring 框架的核心特性以及扩展功能，只是用于快速、敏捷地开发新一代基于 Spring 框架的应用程序。也就是说，它并不是用来替代 Spring 的解决方案，而是和 Spring 框架紧密结合用于提升 Spring 开发者体验的工具。Spring Boot 以**约定大于配置的核心思想**，默认帮我们进行了很多设置，多数 Spring Boot 应用只需要很少的 Spring 配置。同时它集成了大量常用的第三方库配置（例如 Redis、MongoDB、Jpa、RabbitMQ、Quartz 等等），Spring Boot 应用中这些第三方库几乎可以零配置的开箱即用。
- 简单来说就是SpringBoot其实不是什么新的框架，它默认配置了很多框架的使用方式，就像maven整合了所有的jar包，spring boot整合了所有的框架 。Spring Boot 出生名门，从一开始就站在一个比较高的起点，又经过这几年的发展，生态足够完善，Spring Boot 已经当之无愧成为 Java 领域最热门的技术。

### 0.4 Spring Boot 的主要优点
1、为所有 Spring 开发者更快的入门；  
2、开箱即用，提供各种默认配置来简化项目配置；  
3、内嵌式容器简化 Web 项目；  
4、没有冗余代码生成和 XML 配置的要求。  
快速去体验开发个接口的感觉吧！

## 1、Hello Spring Boot ！（helloworld）
### 1.1 准备工作
我们将学习如何快速的创建一个Spring Boot应用，并且实现一个简单的Http请求处理。通过这个例子对Spring Boot有一个初步的了解，并体验其结构简单、开发快速的特性。  
**配置环境**：JDK     17.0.5 / Maven  3.9.0 / SpringBoot 2.7.8  
**开发工具**：IntelliJ IDEA 2022 3.1

### 1.2 创建基础项目说明
Spring 官方提供了非常方便的工具让我们快速构建应用  
Spring Initializr：https://start.spring.io

**项目创建方式一**：使用Spring Initializr 的 Web页面创建项目  
1、打开  https://start.spring.io；  
2、填写项目信息；  
3、点击”Generate Project“按钮生成项目；下载此项目  
4、解压项目包，并用IDEA以Maven项目导入，一路下一步即可，直到项目导入完毕。  
5、如果是第一次使用，可能速度会比较慢，包比较多、需要耐心等待一切就绪。

**项目创建方式二**：使用 IDEA 直接创建项目  
1、创建一个新项目；  
2、选择spring initalizr ， 可以看到默认就是去官网的快速构建工具那里实现；  
3、填写项目信息；  
4、选择初始化的组件（初学勾选 Web 即可）；  
5、填写项目路径；  
6、等待项目构建成功。

**项目结构分析**：通过上面步骤完成了基础项目的创建。就会自动生成以下文件。  
1、程序的主启动类；  
2、一个 application.properties 配置文件；  
3、一个 测试类；  
4、一个 pom.xml。

### 1.3 pom.xml 分析
打开pom.xml，看看Spring Boot项目的依赖：
```java
<!-- 父项目 依赖 -->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.7.8</version>
    <relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>com.xing</groupId>
<artifactId>helloworld</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>helloworld</name>
<description>helloworld</description>
<properties>
    <java.version>17</java.version>
</properties>
<dependencies>
    <!-- web场景启动器 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <!-- springboot单元测试 -->
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

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

### 1.4 编写一个http接口
1、在主程序的同级目录下，新建一个controller包，一定要在同级目录下，否则识别不到
2、在包中新建一个HelloController类
```java
// 原理 自动装配
@RestController
public class Helloworld {

    // 接口： http://localhost:8080/hello
    @RequestMapping("/hello")
    public String hello(){
        //调用业务，接收前端的参数！
        return "hello world";
    }
}
```

3、编写完毕后，从主程序启动项目，浏览器发起请求，看页面返回；控制台输出了 Tomcat 访问的端口号！
![](D:\2023\Java\SpringBoot\springboot-study\img\01.png)
简单几步，就完成了一个web接口的开发，SpringBoot 就是这么简单。所以我们常用它来建立我们的微服务项目！

### 1.5 将项目打成jar包，并在本地运行测试
**将项目打成jar包**  
1、点击File → Project Structure → Artifacts → + → Add下的JAR下的 → From modules with dependencies...  
2、Create JAR from Modules页面下 → Main Class中添加启动项 → 点击OK  
3、Project Structure页面 → √勾选 在项目构建中包含 → Apply → OK  
4、点击Build下 → Build Artifacts... → Build Artifact下 → Action下 → Build  
5、项目就已经打包到out下 → artifacts下 → *项目名*下 → *项目名*.jar  
**或者使用maven打包，简单快捷**  
**jar包 运行测试**  
C:\Windows\System32>cd /d D:\2023\Java\SpringBoot  
D:\2023\Java\SpringBoot>java -jar helloworld.jar

如果打包成功，则会在target目录下生成一个out 包，打成了out包下的jar包，就可以在任何地方运行了！OK

### 1.6  **彩蛋**
如何更改启动时显示的字符拼成的字母，SpringBoot呢？也就是 banner 图案；  
只需一步：到项目下的 resources 目录下新建一个banner.txt 即可。  
图案可以到：https://www.bootschool.net/ascii 这个网站生成，然后拷贝到文件中即可！
![](D:\2023\Java\SpringBoot\springboot-study\img\02.png)
 SpringBoot这么简单的东西背后一定有故事，我们之后去进行一波源码分析！

### @学不可以已 helloworld 已完结。
helloworld  模块中 （springboot项目创建+打包测试）。
## 2、运行原理探究（springboot-01-helloworld）
springboot-01-helloworld，到底是怎么运行的呢，Maven项目，我们一般从pom.xml文件探究起；pom.xml。

### 2.1 父依赖
其中它主要是依赖一个父项目，主要是管理项目的资源过滤及插件！
```xml
<parent>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-parent</artifactId>
        <version>2.7.8</version>
        <relativePath/> <!-- lookup parent from repository -->
</parent>
```
点进去，发现还有一个父依赖
```xml
<groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-dependencies</artifactId>
  <version>2.7.8</version>
  <packaging>pom</packaging>
  <name>spring-boot-dependencies</name>
```
这里才是真正管理 SpringBoot 应用里面所有依赖版本的地方，SpringBoot的版本控制中心；  
**以后导入依赖默认是不需要写版本；但是如果导入的包没有在依赖中管理着就需要手动配置版本。**
### 2.2 启动器
**启动器 spring-boot-starter**
```xml
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>
```
**springboot-boot-starter-xxx**：就是 spring-boot 的场景启动器  
**spring-boot-starter-web**：帮我们导入了 web 模块正常运行所依赖的组件；  
SpringBoot将所有的功能场景都抽取出来，做成一个个的starter （启动器），只需要在项目中引入这些starter即可，所有相关的依赖都会导入进来，我们要用什么功能就导入什么样的场景启动器即可；我们未来也可以自己自定义 starter；

### 2.3 **主启动类分析**
分析完了 pom.xml 来看看这个启动类
#### 2.3.1 默认的主启动类
```java
// @SpringBootApplication 来标注一个主程序类 说明这是一个Spring Boot应用
@SpringBootApplication
public class Springboot01HelloworldApplication {
    public static void main(String[] args) {
        // 以为是启动了一个方法，没想到启动了一个服务
        SpringApplication.run(Springboot01HelloworldApplication.class, args);
        System.out.println("\n Run successfully!");
    }
}
```
但是**一个简单的启动类并不简单**！我们来分析一下这些注解都干了什么。
#### 2.3.2 @SpringBootApplication
**作用**：标注在某个类上说明这个类是SpringBoot的主配置类，SpringBoot就应该运行这个类的main方法来启动SpringBoot应用；   
**进入这个注解**：可以看到上面还有很多其他注解！
```java
@SpringBootConfiguration
@EnableAutoConfiguration
@ComponentScan(
    excludeFilters = {@Filter(
    type = FilterType.CUSTOM,
    classes = {TypeExcludeFilter.class}
), @Filter(
    type = FilterType.CUSTOM,
    classes = {AutoConfigurationExcludeFilter.class}
)}
)
public @interface SpringBootApplication {
    // ......
}
```
#### 2.3.3 @ComponentScan
这个注解在Spring中很重要 ,它对应XML配置中的元素。  
**作用**：自动扫描并加载符合条件的组件或者bean，将这个bean定义加载到IOC容器中。
#### 2.3.4 @SpringBootConfiguration
**作用**：SpringBoot的配置类，标注在某个类上，表示这是一个SpringBoot的配置类；继续进去这个注解查看。
```java
// 点进去得到下面的 @Component
@Configuration
public @interface SpringBootConfiguration {}

@Component
public @interface Configuration {}
```
这里的 @Configuration，说明这是一个配置类，配置类就是对应Spring的xml 配置文件；  
里面的 @Component 这就说明，启动类本身也是Spring中的一个组件而已，负责启动应用！  
我们回到 SpringBootApplication 注解中继续看。
#### 2.3.5 @EnableAutoConfiguration
**@EnableAutoConfiguration：开启自动配置功能**

以前我们需要自己配置的东西，而现在SpringBoot可以自动帮我们配置 ；@EnableAutoConfiguration告诉SpringBoot开启自动配置功能，这样自动配置才能生效；点进注解接续查看：

**@AutoConfigurationPackage：自动配置包**

```java
@Import({Registrar.class})
public @interface AutoConfigurationPackage {
}
```

**@import** ：Spring底层注解@import ， 给容器中导入一个组件
Registrar.class 作用：将主启动类的所在包及包下面所有子包里面的所有组件扫描到Spring容器 ；
这个分析完了，退到上一步，继续看。

**@Import({AutoConfigurationImportSelector.class}) ：给容器导入组件 ；**

**AutoConfigurationImportSelector** ：自动配置导入选择器，那么它会导入哪些组件的选择器呢？我们点击去这个类看源码：

1、这个类中有一个这样的方法

```java
// 获得候选的配置
protected List<String> getCandidateConfigurations(AnnotationMetadata metadata, AnnotationAttributes attributes) {
    //这里的getSpringFactoriesLoaderFactoryClass（）方法
    //返回的就是我们最开始看的启动自动导入配置文件的注解类；EnableAutoConfiguration
    List<String> configurations = SpringFactoriesLoader.loadFactoryNames(this.getSpringFactoriesLoaderFactoryClass(), this.getBeanClassLoader());
    Assert.notEmpty(configurations, "No auto configuration classes found in META-INF/spring.factories. If you are using a custom packaging, make sure that file is correct.");
    return configurations;
}
```

2、这个方法又调用了  SpringFactoriesLoader 类的静态方法！我们进入SpringFactoriesLoader类loadFactoryNames() 方法

```java
public static List<String> loadFactoryNames(Class<?> factoryClass, @Nullable ClassLoader classLoader) {
    String factoryClassName = factoryClass.getName();
    //这里它又调用了 loadSpringFactories 方法
    return (List)loadSpringFactories(classLoader).getOrDefault(factoryClassName, Collections.emptyList());
}
```

3、我们继续点击查看 loadSpringFactories 方法

```java
private static Map<String, List<String>> loadSpringFactories(@Nullable ClassLoader classLoader) {
    //获得classLoader ， 我们返回可以看到这里得到的就是EnableAutoConfiguration标注的类本身
    MultiValueMap<String, String> result = (MultiValueMap)cache.get(classLoader);
    if (result != null) {
        return result;
    } else {
        try {
            //去获取一个资源 "META-INF/spring.factories"
            Enumeration<URL> urls = classLoader != null ? classLoader.getResources("META-INF/spring.factories") : ClassLoader.getSystemResources("META-INF/spring.factories");
            LinkedMultiValueMap result = new LinkedMultiValueMap();

            //将读取到的资源遍历，封装成为一个Properties
            while(urls.hasMoreElements()) {
                URL url = (URL)urls.nextElement();
                UrlResource resource = new UrlResource(url);
                Properties properties = PropertiesLoaderUtils.loadProperties(resource);
                Iterator var6 = properties.entrySet().iterator();

                while(var6.hasNext()) {
                    Entry<?, ?> entry = (Entry)var6.next();
                    String factoryClassName = ((String)entry.getKey()).trim();
                    String[] var9 = StringUtils.commaDelimitedListToStringArray((String)entry.getValue());
                    int var10 = var9.length;

                    for(int var11 = 0; var11 < var10; ++var11) {
                        String factoryName = var9[var11];
                        result.add(factoryClassName, factoryName.trim());
                    }
                }
            }

            cache.put(classLoader, result);
            return result;
        } catch (IOException var13) {
            throw new IllegalArgumentException("Unable to load factories from location [META-INF/spring.factories]", var13);
        }
    }
}
```

 4、发现一个多次出现的文件：spring.factories，全局搜索它。

#### 2.3.6 spring.factories

我们根据源头打开spring.factories ， 看到了很多自动配置的文件；这就是自动配置根源所在。

**WebMvcAutoConfiguration**

我们在上面的自动配置类随便找一个打开看看，比如 ：WebMvcAutoConfiguration  
可以看到这些一个个的都是JavaConfig配置类，而且都注入了一些Bean，可以找一些自己认识的类，看着熟悉一下！  
所以，自动配置真正实现是从classpath中搜寻所有的META-INF/spring.factories配置文件 ，并将其中对应的 org.springframework.boot.autoconfigure. 包下的配置项，通过反射实例化为对应标注了 @Configuration的JavaConfig形式的IOC容器配置类 ， 然后将这些都汇总成为一个实例并加载到IOC容器中。

**结论：**

1. SpringBoot在启动的时候从类路径下的META-INF/spring.factories中获取EnableAutoConfiguration指定的值；
2. 将这些值作为自动配置类导入容器，自动配置类就生效，帮我们进行自动配置工作；
3. 整个J2EE的整体解决方案和自动配置都在springboot-autoconfigure的jar包中；
4. 它会给容器中导入非常多的自动配置类 （xxxAutoConfiguration）, 就是给容器中导入这个场景需要的所有组件， 并配置好这些组件 ；
5. 有了自动配置类，免去了我们手动编写配置注入功能组件等的工作。

**现在大家应该大概的了解了SpringBoot的运行原理，后面我们还会深化一次！**

#### 2.3.7 **SpringApplication**

不简单的方法。

```java
// 最初以为就是运行了一个main方法，没想到却开启了一个服务；
@SpringBootApplication
public class SpringbootApplication {
    public static void main(String[] args) {
        SpringApplication.run(SpringbootApplication.class, args);
    }
}
```

**SpringApplication.run分析**

分析该方法主要分两部分，一部分是SpringApplication的实例化，二是run方法的执行；

#### 2.3.8 SpringApplication

**这个类主要做了以下四件事情：**

1、推断应用的类型是普通的项目还是Web项目；  
2、查找并加载所有可用初始化器 ， 设置到initializers属性中；  
3、找出所有的应用程序监听器，设置到listeners属性中；  
4、推断并设置main方法的定义类，找到运行的主类。  
查看构造器：

```java
public SpringApplication(ResourceLoader resourceLoader, Class... primarySources) {
    // ......
    this.webApplicationType = WebApplicationType.deduceFromClasspath();
    this.setInitializers(this.getSpringFactoriesInstances();
    this.setListeners(this.getSpringFactoriesInstances(ApplicationListener.class));
    this.mainApplicationClass = this.deduceMainApplicationClass();
}
```

#### 2.3.9 run方法流程分析

![](D:\2023\Java\SpringBoot\springboot-study\img\03.png)

 跟着源码和这幅图就可以一探究竟了！

### @学不可以已 springboot-01-helloworld 已完结。

springboot-01-helloworld  模块中 （IDEA创建springboot项目+测试+启动类分析） 。

## 3、yaml 语法学习（springboot-02-config）

### 3.1 配置文件

SpringBoot使用一个全局的配置文件， 配置文件名称是固定的

**application.properties:** 

- 语法结构：key=value

**application.yaml:** 

- 语法结构：key：空格 value

**配置文件的作用**：修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我们自动配置好了；  

比如我们可以在配置文件中修改Tomcat 默认启动的端口号！测试一下！

```properties
server.port: 8081
```

### 3.2 yaml概述

**中文名**：另一种标记语言  
**外文名**：YAML Ain't Markup Language  
**YAML**（/ˈjæməl/，尾音类似*camel*骆驼）是一个可读性高，用来表达数据序列化的格式。  
**YAML**是 "YAML Ain't a Markup Language" （YAML不是一种标记语言）的递归缩写。在开发的这种语言时，YAML 的意思其实是："Yet Another Markup Language"（仍是一种标记语言），但为了强调这种语言以数据做为中心，而不是以标记语言为重点，而用反向缩略语重命名。

**这种语言以数据作为中心，而不是以标记语言为重点！**  
以前的配置文件，大多数都是使用xml来配置；  
比如一个简单的端口配置，我们来对比下yaml和xml传统xml配置：

```xml
<server><port>8081<port></server>
```

yaml配置：

```yaml
server:
  port: 8081
```

### 3.3 yaml基础语法

**说明**：语法要求严格！  

1、空格不能省略；  
2、以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的；  
3、属性和值的大小写都是十分敏感的。

**字面量：普通的值  [ 数字，布尔值，字符串  ]**

字面量直接写在后面就可以 ， 字符串默认不用加上双引号或者单引号；k: v 。

注意：

- “ ” 双引号，不会转义字符串里面的特殊字符 ， 特殊字符会作为本身想表示的意思；

  比如 ：name: "kuang \n shen"  输出 ：kuang  换行  shen

- '' 单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出

  比如 ：name: ‘kuang \n shen’  输出 ：kuang  \n  shen


**对象、Map（键值对）**

```
#对象、Map格式k:     v1:    v2:
```

在下一行来写对象的属性和值得关系，注意缩进；比如：

```
student:    name: qinjiang    age: 3
```

行内写法

```
student: {name: qinjiang,age: 3}
```

**数组（ List、set ）**

用 - 值表示数组中的一个元素,比如：

```
pets: - cat - dog - pig
```

行内写法

```
pets: [cat,dog,pig]
```

**修改SpringBoot的默认端口号**

配置文件中添加，端口号的参数，就可以切换端口；

```yaml
server.port: 8082
```

注入配置文件，yaml文件更强大的地方在于，他可以给我们的实体类直接注入匹配值！

### 3.4 yaml注入配置文件

**1**、在springboot-02-config项目中的resources目录下新建一个文件 application.yml；

**2**、新建一个实体类 **Dog**；

```java
package com.xing.domain;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component //注册bean到容器中

public class Dog {
//    @Value("旺财")
    private String name;
//    @Value("3")
    private String age;
    //有参无参构造、get、set方法、toString()方法 
}
```

**3**、思考，原来是如何给bean注入属性值的！@Value，给狗类测试一下：

```java
@Value("旺财")
@Value("3")
```

**4**、在SpringBoot的测试类Springboot02ConfigApplicationTests下注入狗输出一下；

```java
package com.xing;
import com.xing.domain.Dog;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class Springboot02ConfigApplicationTests {

    @Autowired
    private Dog dog;

    @Test
    void contextLoads() {
        System.out.println(dog);
    }
}
```

**Test测试结果：Dog(name=旺财, age=3)**

结果成功输出，@Value注入成功。

**5**、我们在编写一个复杂一点的实体类：Person 类

```java
package com.xing.domain;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import java.util.Date;
import java.util.List;
import java.util.Map;

@Data
@AllArgsConstructor
@NoArgsConstructor
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
    //有参无参构造、get、set方法、toString()方法
}
```

**6**、使用yaml配置的方式进行注入，注意区别和优势，编写一个yaml配置！

编写一个： **application.yml**

```yaml
server:
  port: 8081
person:
  name: yasuo
  age: 9
  happy: false
  birth: 2014/01/09
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - boy
    - programming
  dog:
    name: 旺财
    age: 6
```

**7**、刚才已经把person这个对象的所有值都写好了，我们现在来注入到我们的类中！

```java
package com.xing.domain;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
    //有参无参构造、get、set方法、toString()方法
    /**
     * @ConfigurationProperties作用:
     * 将配置文件中配置的每一个属性的值，映射到这个组件中;
     * 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
     * 参数 prefix = "person":将配置文件中的person下面的所有属性——对应
     * 只有这个组件是容器中的组件，才能使用容器提供的@configurationProperties功能
     * 需要再maven导入：spring-boot-configuration-processor 依赖
     */
}
```

**8**、IDEA 提示，springboot配置注解处理器没有找到，让我们看文档，我们可以查看文档，找到这个依赖！

```xml
<!-- 导入配置文件处理器，配置文件进行绑定就会有提示，需要重启 -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-configuration-processor</artifactId>
    <optional>true</optional>
</dependency>
```

**9**、确认以上配置都OK之后，我们去测试类中测试一下：

```java
package com.xing;

import com.xing.domain.Dog;
import com.xing.domain.Person;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class Springboot02ConfigApplicationTests {
    @Autowired
    private Person person; //将person自动注入进来
    @Test
    void contextLoads01() {
        System.out.println("----------");
        System.out.println(person);
    }
}
```

**Test测试结果：Person(name=yasuo, age=9, happy=false, birth=Thu Jan 09 00:00:00 CST 2014, maps={k1=v1, k2=v2}, lists=[code, boy, programming], dog=Dog(name=旺财, age=6))**

结果：所有值全部注入成功！

**yaml配置注入到实体类完全OK！**

自由测试：

1、将配置文件的key 值 和 属性的值设置为不一样，则结果输出为null，注入失败；

2、在配置一个person2，然后将 @ConfigurationProperties(prefix = "person2") 指向person2。

### 3.5 自定义加载指定的配置文件

**@PropertySource** ：加载指定的配置文件；

**@configurationProperties**：默认从全局配置文件中获取值；

**1**、我们去在resources目录下新建一个**xing.properties**文件

编写一个： **xing.properties**

```properties
ys:亚索
```

**2**、然后在我们的代码中指定加载**xing.properties**文件

```java
package com.xing.domain;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

import java.util.Date;
import java.util.List;
import java.util.Map;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component
//@ConfigurationProperties(prefix = "person")
/**
 * javaConfig 绑定配置文件的值，可以采取这些方式
 * 加载指定的配置文件
 */
@PropertySource(value = "classpath:xing.properties")
public class Person {
    /**
     * Spring el 表达式取出配置文件的值
     */
    @Value("${ys}")
    private String name;
    private Integer age;
    private Boolean happy;
    private Date birth;
    private Map<String,Object> maps;
    private List<Object> lists;
    private Dog dog;
    //有参无参构造、get、set方法、toString()方法
    /**
     * @ConfigurationProperties作用:
     * 将配置文件中配置的每一个属性的值，映射到这个组件中;
     * 告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
     * 参数 prefix = "person":将配置文件中的person下面的所有属性——对应
     * 只有这个组件是容器中的组件，才能使用容器提供的@configurationProperties功能
     * 需要再maven导入：spring-boot-configuration-processor 依赖
     */
}

```

测试类不变，启动测试。

**Test测试结果：Person(name=亚索, age=null, happy=null, birth=null, maps=null, lists=null, dog=null)**

**3**、再次输出测试一下：指定配置文件绑定成功！

### 3.6 配置文件占位符

配置文件还可以编写占位符生成随机数

```yaml
person:
  name: yasuo${random.uuid} # 随机uuid
  age: ${random.int}        # 随机int
  happy: false
  birth: 2014/01/09
  maps: {k1: v1,k2: v2}
  hello: 小旺财
  lists:
    - code
    - boy
    - programming
  dog:
    name: ${person.hello:hello}_旺财
    age: 6
```

测试类不变，启动测试。使用@ConfigurationProperties

**Test测试结果：Person(name=yasuo82408b9e-fb11-4f00-8f75-7e2f49697e9a, age=1660117737, happy=false, birth=Thu Jan 09 00:00:00 CST 2014, maps={k1=v1, k2=v2}, lists=[code, boy, programming], dog=Dog(name=小旺财_旺财, age=6))**

### 3.7 回顾properties配置

上面采用的yaml方法都是最简单的方式，开发中最常用的；也是springboot所推荐的！其他的实现方式，道理都是相同的；写还是那样写；配置文件除了yml还有我们之前常用的properties ！

【注意】properties配置文件在写中文的时候，会有乱码 ， 我们需要去IDEA中设置编码格式为UTF-8；

settings-->FileEncodings 中配置；勾选 Transparent native-to-ascii conversion 。

**自由测试步骤：**

**1**、新建一个实体类**User**

```java
package com.xing.domain;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;

@Data
@AllArgsConstructor
@NoArgsConstructor
@Component //注册bean
@PropertySource(value = "classpath:user.properties")
public class User {
    //直接使用@value
//    @Value("${user.name}") //从配置文件中取值
    @Value("${n}")
    private String name;
//    @Value("#{9*2}")  // #{SPEL} Spring表达式
    @Value("${a}")
    private int age;
//    @Value("男")  // 字面量
    @Value("${s}")
    private String sex;
}
```

**2**、编辑配置文件 **user.properties**

```properties
n:亚索
a=18
s=男
```

**3**、我们在User类上使用@Value来进行注入！

```java
@Value("${n}")
@Value("${a}")
@Value("${s}")
```

**4**、Springboot测试

```java
package com.xing;

import com.xing.domain.User;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class UserTest {
    @Autowired
    User user;

    @Test
    void contextLoads() {
        System.out.println("---------");
        System.out.println(user);
    }
}
```

**Test测试结果：方法一：User(name=WZX, age=18, sex=男)   方法二：User(name=亚索, age=18, sex=男)**

结果正常输出。

### 3.8 对比小结

@Value这个使用起来并不友好！需要为每个属性单独注解赋值，比较麻烦；功能对比图。![](D:\2023\Java\SpringBoot\springboot-study\img\04.png)

**1**、@ConfigurationProperties只需要写一次即可，@Value则需要每个字段都添加。  
**2**、松散绑定：这个什么意思呢? 比如我的yml中写的last-name，这个和lastName是一样的， -后面跟着的字母默认是大写的。这就是松散绑定。可以测试一下。

```java
//在Dog类把name改为firstName，添加配置属性注解，
@ConfigurationProperties(prefix = "dog")
public class Dog {
    private String firstName;
```

```yaml
//application.yml 添加松散绑定
dog:
    first-name: 狗狗
    age: 4
```

最后测试 测试类不变。

**Test测试结果：Dog(firstName=狗狗, age=4)**

**3**、JSR303数据校验，这个就是我们可以在字段是增加一层过滤器验证，可以保证数据的合法性。  
**4**、复杂类型封装，yml中可以封装对象，使用value就不支持。

**结论：**
配置yml和配置properties都可以获取到值， 强烈推荐 yml；  
如果我们在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value；  
如果说，专门编写了一个JavaBean来和配置文件进行一一映射，就直接@configurationProperties，不要犹豫！

## 4、JSR303数据校验及多环境切换

### 4.1 测试如何使用

Springboot中可以用@validated来校验数据，如果数据异常则会统一抛出异常，方便异常中心统一处理。我们这里来写个注解让我们的name只能支持Email格式；

**1、pom.xml**中引入**spring-boot-starter-validation** jar包；

```
<!-- Springboot整合JSR303校验，只需要引入validation的场景启动器即可 -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-validation</artifactId>
            <version>2.7.14</version>
        </dependency>
```

**2、Person**类中添加数据校验注解，并使用@Email测试；

```java
//添加数据校验注解
@Validated //数据校验
public class Person {
    @Email(message = "邮箱格式不正确！")
    private String email;
```

**3、application.yml** 添加email；

```yaml
 email: 1231333
```

**4**、测试。

```java
//person 测试
    @Autowired
    private Person person; //将person自动注入进来
    @Test
    void contextLoads01() {
        System.out.println("----------");
        System.out.println(person);
    }
```

**Test测试结果：[不是一个合法的电子邮件地址]**，使用正确邮箱测试即可成功。

**使用数据校验，可以保证数据的正确性。**

### 4.2 JSR303校验 常用的注解参数

```java
@NotNull(message="名字不能为空")
private String userName;
@Max(value=120,message="年龄最大不能查过120") 
private int age;
@Email(message="邮箱格式错误")
private String email;
//空检查
@Null       验证对象是否为null    
@NotNull    验证对象是否不为null, 无法查检长度为0的字符串
@NotBlank   验证字符串不为null、空或包含空格、制表符、换行符、不可见字符等空白字符。
@NotEmpty   验证字符串不为null、空或长度为0。
//Booelan检查
@AssertTrue     验证 Boolean 对象是否为 true
@AssertFalse    验证 Boolean 对象是否为 false
//长度检查
@Size(min=1, max=10)  验证字符串的长度是否在1到10个字符之间。描述计算机内存、硬盘空间等的大小。
@Length(min=3, max=5) 验证字符串的长度是否在3到5个字符之间。描述音符的长度，或者一段时间的长度。
//日期检查
@Past       验证 Date 和 Calendar 对象是否在当前时间之前
@Future     验证 Date 和 Calendar 对象是否在当前时间之后
@Pattern    验证 String 对象是否符合正则表达式的规则

.......等等，除此以外，还可以自定义一些数据校验规则。
```

### 4.3 多环境配置及配置文件加载位置

官方外部配置文件说明参考文档，考虑的完整位置集可分为以下四个方式:

1. `optional:classpath:/;optional:classpath:/config/`
2. `optional:file:./;optional:file:./config/;optional:file:./config/*/`
3. `optional:classpath:custom-config/`
4. `optional:file:./custom-config/`

![](D:\2023\Java\SpringBoot\springboot-study\img\05.png)

优先级执行顺序：**①④②③**。  
优先级1：项目路径下的config文件夹配置文件；  
优先级2：项目路径下配置文件；  
优先级3：资源路径下的config文件夹配置文件；  
优先级4：资源路径下配置文件。  
优先级由高到底，高优先级的配置会覆盖低优先级的配置。

**.properties 方法一：**

profile是Spring对不同环境提供不同配置功能的支持，可以通过激活不同的环境版本，实现快速切换环境；  
我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml , 用来指定多个环境版本；  

副配置文件：  
application-test.properties 代表测试环境配置  
application-dev.properties 代表开发环境配置  
但是Springboot并不会直接启动这些配置文件，它**默认使用application.properties主配置文件**；  
我们需要通过一个配置来选择需要激活的环境：

```properties
#主配置文件 application.properties
#springboot的多环境配置，可以选择激活哪一个配置文件
spring.profiles.active=dev #在此切换需要使用的环境
```

**.yaml 方法二：**

和properties配置文件中一样，但是使用yaml去实现不需要创建多个配置文件，更加方便了 !

```yaml
spring:
  profiles:
    active: dev #选择要激活那个环境块
---
server:
  port: 8087
spring:
  config:
    activate:
      on-profile: dev #配置环境的名称
---
server:
  port: 8089
spring:
  config:
    activate:
      on-profile: prod #配置环境的名称
```

**注意：如果yaml和properties同时都配置了端口，并且没有激活其他环境，默认会使用properties配置文件的！**

## 5、自动配置原理

### 5.1 自动配置原理

配置文件到底能写什么？怎么写？

SpringBoot官方文档中有大量的配置，我们无法全部记住。

### 5.2 分析自动配置原理

我们以**HttpEncodingAutoConfiguration（Http编码自动配置）**为例解释自动配置原理；

```java
package org.springframework.boot.autoconfigure.web.servlet;
在此，包略写......
//表示这是一个自动配置类。在Spring Boot启动时，如果该类存在，则会自动扫描并加载其依赖项。
@AutoConfiguration
//表示该类可以接收配置属性，并将其存储到运行时环境中。在Spring Boot启动时，如果该类存在，则会自动扫描并加载其配置属性。
@EnableConfigurationProperties({ServerProperties.class})
//表示该注解只在Web应用程序中生效。如果应用程序不是Web应用程序，则该注解将不会生效。
@ConditionalOnWebApplication(type = Type.SERVLET)
//表示该注解只在特定类存在时生效。如果该类不存在，则该注解将不会生效。
@ConditionalOnClass({CharacterEncodingFilter.class})
//表示该注解只在特定属性的值匹配时生效。如果属性的值不匹配，则该注解将不会生效。在本例中，
//该注解用于检查“server.servlet.encoding.enabled”属性是否为true。如果该属性的值为true，则该注解将生效，否则将不会生效。
@ConditionalOnProperty(prefix = "server.servlet.encoding", value = {"enabled"}, matchIfMissing = true)
public class HttpEncodingAutoConfiguration {
    //他已经和SpringBoot的配置文件映射了
    private final Encoding properties;
    //只有一个有参构造器的情况下，参数的值就会从容器中拿
    public HttpEncodingAutoConfiguration(ServerProperties properties) {
        this.properties = properties.getServlet().getEncoding();
    }
    //给容器中添加一个组件，这个组件的某些值需要从properties中获取
    @Bean
    //在Spring容器中查找指定名称的Bean是否存在，如果不存在则创建一个新的Bean并注入到容器中。该注解可以用于创建和注册Bean的时候，
    //也可以用于其他Bean的依赖注入时，如果被依赖的Bean不存在，则自动创建一个新的Bean并注入。
    @ConditionalOnMissingBean
    public CharacterEncodingFilter characterEncodingFilter() {
        CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
        filter.setEncoding(this.properties.getCharset().name());
        ......
}
```

**一句话总结：根据当前不同的条件判断，决定这个配置类是否生效！**

- 一但这个配置类生效；这个配置类就会给容器中添加各种组件；
- 这些组件的属性是从对应的properties类中获取的，这些类里面的每一个属性又是和配置文件绑定的；
- 所有在配置文件中能配置的属性都是在xxxxProperties类中封装着；
- 配置文件能配置什么就可以参照某个功能对应的这个属性类

```
//从配置文件中获取指定的值和bean的属性进行绑定
@ConfigurationProperties(prefix = "spring.http") 
public class HttpProperties {    // .....}
```

配置文件里面试试前缀，看提示！

```yaml
spring.http.encoding. 。。。
```

**这就是自动装配的原理！**

### 5.3 精髓

1、SpringBoot启动会加载大量的自动配置类

2、我们看我们需要的功能有没有在SpringBoot默认写好的自动配置类当中；

3、我们再来看这个自动配置类中到底配置了哪些组件；（只要我们要用的组件存在在其中，我们就不需要再手动配置了）

4、给容器中自动配置类添加组件的时候，会从properties类中获取某些属性。我们只需要在配置文件中指定这些属性的值即可；

**xxxxAutoConfigurartion：自动配置类**；给容器中添加组件。

**xxxxProperties:封装配置文件中相关属性。**

### 5.4 了解@Conditional

了解完自动装配的原理后，来关注一个细节问题，**自动配置类必须在一定的条件下才能生效；**

**@Conditional派生注解（Spring注解版原生的@Conditional作用）**

作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

![](D:\2023\Java\SpringBoot\springboot-study\img\06.png)

**那么多的自动配置类，必须在一定的条件下才能生效；也就是说加载了这么多的配置类，但不是所有的都生效了。**

我们怎么知道哪些自动配置类生效？

**我们可以通过启用 debug=true属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效；**

```
#开启springboot的调试类
debug: true
#在 Spring Boot 中，"debug:true" 是一个 application.yaml 文件中的配置项，用于开启 Spring Boot 的调试模式。
#在调试模式下，Spring Boot 会输出一些额外的信息，例如应用程序的运行时信息、线程信息、Bean 的创建和注入过程等，以便开发者进行调试和排查问题。
#这个配置项通常会被放在 application.yaml 文件的开头，以便在整个应用程序运行过程中都开启调试模式。
```

**Positive matches:（自动配置类启用的：正匹配）**

**Negative matches:（没有启动，没有匹配成功的自动配置类：负匹配）**

**Unconditional classes: （没有条件的类）**

【演示：查看输出的日志】 掌握吸收理解原理，即可以不变应万变！

### @学不可以已 springboot-02-config 已完结。

springboot-02-config  模块中 （yaml注入+JSR303校验+多环境配置+自动配置原理） 。

## 6、springboot web开发（springboot-03-web）

**新建一个springboot-03-web项目，记得勾选spring web。**

**1**、新建测试类**HelloController**，验证项目是否正常。

```java
package com.xing.controller;

import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
@RequestMapping("/hello")
public class HelloController {
    @GetMapping("/h1")
    public String hello(){
        return "hello,world!";
    }
}
```

**2**、首页测试类**IndexController**，测试首页和图标。

```java
package com.xing.controller;

import org.springframework.stereotype.Controller;

@Controller
public class IndexController {

    public String index() {
        return "index";//写一个对应的index.html进行测试
    }
}
```

### 6.1 Web开发探究

SpringBoot与Web开发，实战部分；其实SpringBoot的东西用起来非常简单，因为SpringBoot最大的特点就是自动装配。

#### 6.1.1 使用SpringBoot的步骤：

1、创建一个SpringBoot应用，选择需要的模块，SpringBoot就会默认将我们的需要的模块自动配置好；

2、手动在配置文件中配置部分配置项目就可以运行起来；

3、专注编写业务代码，不需要考虑以前那样一大堆的配置了。

要熟悉掌握开发，自动配置的原理一定要搞明白！

比如SpringBoot到底帮我们配置了什么？我们能不能修改？我们能修改哪些配置？我们能不能扩展？

- 向容器中自动配置组件 ：*** Autoconfiguration
- 自动配置类，封装配置文件的内容：***Properties

没事就找找类，看看自动装配原理！我们之后来进行一个单体项目的小项目测试，快速上手开发！

#### 6.1.2 静态资源处理

SpringBoot中，SpringMVC的web配置都在 WebMvcAutoConfiguration 这个配置类里面。

可以去看看 WebMvcAutoConfigurationAdapter 中有很多配置方法；

有一个方法：addResourceHandlers 添加资源处理。

总结：在springboot，可以使用以下方式处理静态资源。  
**1、webjars**                                               localhost:8080/webjars/...  
**2、public，static，/xx，resources**    localhost :8080/

**优先级: resources > static(默认) > public**

**什么是webjars ？**

Webjars本质就是以jar包的方式引入我们的静态资源 ， 我们以前要导入一个静态资源文件，直接导入即可。SpringBoot需要使用Webjars，可以去搜索一下：

网站：https://www.webjars.org 

要使用jQuery，我们只要要引入jQuery对应版本的pom依赖即可！导入完毕，查看webjars目录结构，并访问Jquery.js文件！

访问：只要是静态资源，SpringBoot就会去对应的路径寻找资源，访问：http://localhost:8088/webjars/jquery/3.7.0/jquery.js

可以在resources根目录下新建对应的文件夹，都可以存放我们的静态文件；

比如我们访问 http://localhost:8088/1.js , 他就会去这些文件夹中寻找对应的静态资源文件；

自定义静态资源路径：也可以自己通过配置文件来指定一下，哪些文件夹是需要我们放静态资源文件的，在application.properties中配置；

```yaml
spring.resources.static-locations=classpath:/coding/,classpath:/xing/
```

一旦自己定义了静态文件夹的路径，原来的自动配置就都会失效了！

#### 6.1.3首页和图标定制

可以看到一个欢迎页的映射welcomePageHandlerMapping，就是我们的首页，欢迎页，静态资源文件夹下的所有 index.html 页面；被 /** 映射。

比如我访问  http://localhost:8088/ ，就会找静态资源文件夹下的 index.html

新建一个 **index.html** ，在我们上面的3个目录中任意一个；然后访问测试：http://localhost:8088/  看结果！

**关于网站图标说明**：

与其他静态资源一样，Spring Boot在配置的静态内容位置中查找 favicon.ico。如果存在这样的文件，它将自动用作应用程序的favicon。

Spring Boot 2.7.15版本支持**将favicon.ico图标直接放置在`resources`目录下，以替换默认的favicon图标。只需将您的自定义favicon图标命名为   `favicon.ico`**，并将其放置在`src/main/resources`目录下即可。在启动Spring Boot应用程序时，它将自动检测并使用该文件作为默认的favicon图标。如果您想禁用favicon，则可以将`spring.mvc.favicon.path=false` 设置为空字符串。

**1**、关闭SpringBoot默认图标；

**2**、自己放一个图标在静态resources资源目录下，放在 public 目录下；

**3**、清除浏览器缓存！刷新网页，发现图标已经变成自己的图标！

### 6.2 Thymeleaf模板引擎

前端交给我们的页面，是html页面。如果是我们以前开发，我们需要把他们转成jsp页面，jsp好处就是当我们查出一些数据转发到JSP页面以后，我们可以用jsp轻松实现数据的显示及交互等。

jsp支持非常强大的功能，包括能写Java代码，但是呢，我们现在的这种情况，SpringBoot这个项目首先是以jar的方式，不是war，像第二，我们用的还是嵌入式的Tomcat，所以他现在默认是不支持jsp的。不支持jsp，如果我们直接用纯静态页面的方式，那给我们开发会带来非常大的麻烦，那怎么办呢？

**SpringBoot推荐你可以来使用模板引擎：**

模板引擎，我们其实大家听到很多，其实jsp就是一个模板引擎，还有用的比较多的freemarker，包括SpringBoot给我们推荐的Thymeleaf，模板引擎有非常多，但再多的模板引擎，他们的思想都是一样的，什么样一个思想呢我们来看一下这张图：

![](D:\2023\Java\SpringBoot\springboot-study\img\7.png)

模板引擎的作用就是我们来写一个页面模板，比如有些值呢，是动态的，我们写一些表达式。而这些值，从哪来呢，就是我们在后台封装一些数据。然后把这个模板和这个数据交给我们模板引擎，模板引擎按照我们这个数据帮你把这表达式解析、填充到我们指定的位置，然后把这个数据最终生成一个我们想要的内容给我们写出去，这就是我们这个模板引擎，不管是jsp还是其他模板引擎，都是这个思想。只不过呢，就是说不同模板引擎之间，他们可能这个语法有点不一样。其他的我就不介绍了，我主要来介绍一下SpringBoot给我们推荐的Thymeleaf模板引擎，这模板引擎呢，是一个高级语言的模板引擎，他的这个语法更简单。而且呢，功能更强大。

看一下这个模板引擎，那既然要看这个模板引擎。首先，我们来看SpringBoot里边怎么用。

#### 6.2.1 引入Thymeleaf

怎么引入呢，对于springboot来说，什么事情不都是一个start的事情嘛，我们去在项目中引入一下。给大家三个网址：

Thymeleaf 官网：https://www.thymeleaf.org

Thymeleaf 在Github 的主页：https://github.com/thymeleaf/thymeleaf

Spring官方文档：找到我们对应的版本

https://docs.spring.io/spring-boot/docs/2.7.15/reference/htmlsingle/#upgrading

找到对应的pom依赖：可以适当点进源码看下本来的包！

```xml
<dependency>
   <groupId>org.thymeleaf</groupId>
   <artifactId>thymeleaf-spring5</artifactId>
</dependency>
<dependency>
   <groupId>org.thymeleaf.extras</groupId>
   <artifactId>thymeleaf-extras-java8time</artifactId>
</dependency>
```

Maven会自动下载jar包，可以去看下下载的三个jar包；

#### 6.2.2 Thymeleaf分析

前面呢，我们已经引入了Thymeleaf，那这个要怎么使用呢？

我们首先得按照SpringBoot的自动配置原理看一下我们这个Thymeleaf的自动配置规则，在按照那个规则，我们进行使用。

我们去找一下Thymeleaf的自动配置类：ThymeleafProperties

```java
public class ThymeleafProperties {
    private static final Charset DEFAULT_ENCODING;
    public static final String DEFAULT_PREFIX = "classpath:/templates/";
    public static final String DEFAULT_SUFFIX = ".html";
    private boolean checkTemplate = true;
    private boolean checkTemplateLocation = true;
    private String prefix = "classpath:/templates/";
    private String suffix = ".html";
    private String mode = "HTML";
    private Charset encoding;
    //后面源码忽略...
```

我们可以在其中看到默认的前缀和后缀！

只需要把我们的html页面放在类路径下的templates下，thymeleaf就可以帮我们自动渲染了。

使用thymeleaf什么都不需要配置，只需要将他放在指定的文件夹下即可！

**编写一个测试**

**1**、编写一个**TestController**

```java
@Controller
@RequestMapping("/test")
public class TestController {
    @RequestMapping("/t1")
    public String test(){
        return "test";
    }
}
```

**2**、编写一个测试页面  test.html 放在 templates 目录下

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>Test</h1>
</body>
</html>
```

**3**、启动项目请求测试：http://localhost:8088/test/t1

#### 6.2.3 Thymeleaf 语法学习

要学习语法，还是参考官网文档最为准确，我们找到对应的版本看一下；

Thymeleaf 官网：https://www.thymeleaf.org/ ， 简单看一下官网！下载Thymeleaf的官方文档学习！

**我们做个最简单的练习 ：我们需要查出一些数据，在页面中展示**
![](D:\2023\Java\SpringBoot\springboot-study\img\07.png)

**1**、修改测试请求，增加数据传输。

```java
@Controller
@RequestMapping("/test")
public class TestController {

    @RequestMapping("/t1")
    public String test(Model model){
        //存入数据
        model.addAttribute("msg","Hello thymeleaf!");
        //classpath:/templates/test.html
        return "test";
    }
}
```

**2**、我们要使用thymeleaf，需要在html文件中导入命名空间的约束，方便提示。

可以去官方文档的#3中看一下命名空间拿来过来：

```html
xmlns:th="http://www.thymeleaf.org"
```

**3**、我们去编写下前端页面

```html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>Test</h1>
<!-- th:text就是将div中的内容设置为它指定的值，和之前学习的Vue一样 -->
<div th:text="${msg}"></div>
</body>
</html>
```

4、启动测试！http://localhost:8088/test/t1

**OK，入门搞定，我们来认真研习一下Thymeleaf的使用语法！**

**1、我们可以使用任意的 th:attr 来替换Html中原生属性的值！**
![img](D:\2023\Java\SpringBoot\springboot-study\img\08.png)

**2、我们能写哪些表达式呢？**

```java
Simple expressions:（表达式语法）
Variable Expressions: ${...}：获取变量值；OGNL；
    1）、获取对象的属性、调用方法
    2）、使用内置的基本对象：#18
         #ctx : the context object.
         #vars: the context variables.
         #locale : the context locale.
         #request : (only in Web Contexts) the HttpServletRequest object.
         #response : (only in Web Contexts) the HttpServletResponse object.
         #session : (only in Web Contexts) the HttpSession object.
         #servletContext : (only in Web Contexts) the ServletContext object.
    3）、内置的一些工具对象：
　　　　　　#execInfo : information about the template being processed.
　　　　　　#uris : methods for escaping parts of URLs/URIs
　　　　　　#conversions : methods for executing the configured conversion service (if any).
　　　　　　#dates : methods for java.util.Date objects: formatting, component extraction, etc.
　　　　　　#calendars : analogous to #dates , but for java.util.Calendar objects.
　　　　　　#numbers : methods for formatting numeric objects.
　　　　　　#strings : methods for String objects: contains, startsWith, prepending/appending, etc.
　　　　　　#objects : methods for objects in general.
　　　　　　#bools : methods for boolean evaluation.
　　　　　　#arrays : methods for arrays.
　　　　　　#lists : methods for lists.
　　　　　　#sets : methods for sets.
　　　　　　#maps : methods for maps.
　　　　　　#aggregates : methods for creating aggregates on arrays or collections.
==================================================================================
  Selection Variable Expressions: *{...}：选择表达式：和${}在功能上是一样；
  Message Expressions: #{...}：获取国际化内容
  Link URL Expressions: @{...}：定义URL；
  Fragment Expressions: ~{...}：片段引用表达式

Literals（字面量）
      Text literals: 'one text' , 'Another one!' ,…
      Number literals: 0 , 34 , 3.0 , 12.3 ,…
      Boolean literals: true , false
      Null literal: null
      Literal tokens: one , sometext , main ,…
      
Text operations:（文本操作）
    String concatenation: +
    Literal substitutions: |The name is ${name}|
    
Arithmetic operations:（数学运算）
    Binary operators: + , - , * , / , %
    Minus sign (unary operator): -
    
Boolean operations:（布尔运算）
    Binary operators: and , or
    Boolean negation (unary operator): ! , not
    
Comparisons and equality:（比较运算）
    Comparators: > , < , >= , <= ( gt , lt , ge , le )
    Equality operators: == , != ( eq , ne )
    
Conditional operators:条件运算（三元运算符）
    If-then: (if) ? (then)
    If-then-else: (if) ? (then) : (else)
    Default: (value) ?: (defaultvalue)
    
Special tokens:
    No-Operation: _
```

**练习测试：**

**1**、我们编写一个Controller，放一些数据；

```java
@RequestMapping("/t2")
    public String test2(Map<String,Object> map){
        //存入数据
        map.put("users", Arrays.asList("Fizz","Zed","Yasuo"));
        //classpath:/templates/test.html
        return "test";
    }
```

**2**、测试页面取出数据；

```html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>Test1</h1>
<!-- th:text就是将div中的内容设置为它指定的值，和之前学习的Vue一样 -->
<div th:text="${msg}"></div>
<!--不转义-->
<div th:utext="${msg}"></div>

<h1>Test2</h1>
<!--遍历数组，集合-->
<h3 th:each="users:${users}" th:text="${users}"></h3>
<!--行内写法：官网#12-->
<h2><span th:each="users:${users}">[[${users}]]<br></span></h2>
</body>
</html>
```

**3**、启动项目测试！http://localhost:8088/test/t2

**看完语法，有很多样式，即使现在学习，长时间也会忘记，根据官方文档来查询，熟练使用官方文档最重要！**

### 6.3 MVC自动配置原理

#### 6.3.1 官网文档

在进行项目编写前，我们还需要知道一个东西，就是SpringBoot对我们的SpringMVC还做了哪些配置，包括如何扩展，如何定制。

只有把这些都搞清楚了，我们在之后使用才会更加得心应手。途径一：源码分析，途径二：官方文档！

地址 ：https://docs.spring.io/spring-framework/docs/5.3.29/reference/html/web.html#spring-web

```java
Spring MVC Auto-configuration
// Spring Boot为Spring MVC提供了自动配置，它可以很好地与大多数应用程序一起工作。
Spring Boot provides auto-configuration for Spring MVC that works well with most applications.
// 自动配置在Spring默认设置的基础上添加了以下功能：
The auto-configuration adds the following features on top of Spring’s defaults:
// 包含视图解析器
Inclusion of ContentNegotiatingViewResolver and BeanNameViewResolver beans.
// 支持静态资源文件夹的路径，以及webjars
Support for serving static resources, including support for WebJars 
// 自动注册了Converter：
// 转换器，这就是我们网页提交数据到后台自动封装成为对象的东西，比如把"1"字符串自动转换为int类型
// Formatter：【格式化器，比如页面给我们了一个2019-8-10，它会给我们自动格式化为Date对象】
Automatic registration of Converter, GenericConverter, and Formatter beans.
// HttpMessageConverters
// SpringMVC用来转换Http请求和响应的的，比如我们要把一个User对象转换为JSON字符串，可以去看官网文档解释；
Support for HttpMessageConverters (covered later in this document).
// 定义错误代码生成规则的
Automatic registration of MessageCodesResolver (covered later in this document).
// 首页定制
Static index.html support.
// 图标定制
Custom Favicon support (covered later in this document).
// 初始化数据绑定器：帮我们把请求数据绑定到JavaBean中！
Automatic use of a ConfigurableWebBindingInitializer bean (covered later in this document).
/*
如果您希望保留Spring Boot MVC功能，并且希望添加其他MVC配置（拦截器、格式化程序、视图控制器和其他功能），则可以添加自己的@configuration类，类型为webmvcconfiguer，但不添加@EnableWebMvc。如果希望提供
RequestMappingHandlerMapping、RequestMappingHandlerAdapter或ExceptionHandlerExceptionResolver的自定义实例，
则可以声明WebMVCregistrationAdapter实例来提供此类组件。
*/
If you want to keep Spring Boot MVC features and you want to add additional MVC configuration 
(interceptors, formatters, view controllers, and other features), you can add your own 
@Configuration class of type WebMvcConfigurer but without @EnableWebMvc. If you wish to provide 
custom instances of RequestMappingHandlerMapping, RequestMappingHandlerAdapter, or 
ExceptionHandlerExceptionResolver, you can declare a WebMvcRegistrationsAdapter instance to provide such components.
// 如果您想完全控制Spring MVC，可以添加自己的@Configuration，并用@EnableWebMvc进行注释。
If you want to take complete control of Spring MVC, you can add your own @Configuration annotated with @EnableWebMvc.
```

我们来仔细对照，看一下它怎么实现的，它告诉我们SpringBoot已经帮我们自动配置好了SpringMVC，然后自动配置了哪些东西呢？

#### 6.3.2 视图解析器

自动配置了ViewResolver，就是我们之前学习的SpringMVC的视图解析器；

即根据方法的返回值取得视图对象（View），然后由视图对象决定如何渲染（转发，重定向）。

我们去看看这里的源码：我们找到 WebMvcAutoConfiguration ， 然后搜索ContentNegotiatingViewResolver。找到如下方法！

我们可以点进这类看看！找到对应的解析视图的代码；

```java
@Nullable //注解说明 @Nullable 即参数可为null
    public View resolveViewName(String viewName, Locale locale) throws Exception {
        RequestAttributes attrs = RequestContextHolder.getRequestAttributes();
        Assert.state(attrs instanceof ServletRequestAttributes, "No current ServletRequestAttributes");
        List<MediaType> requestedMediaTypes = this.getMediaTypes(((ServletRequestAttributes)attrs).getRequest());
        if (requestedMediaTypes != null) {
        // 获取候选的视图对象
            List<View> candidateViews = this.getCandidateViews(viewName, locale, requestedMediaTypes);
            // 选择一个最适合的视图对象，然后把这个对象返回    
            View bestView = this.getBestView(candidateViews, requestedMediaTypes, attrs);
            if (bestView != null) {
                return bestView;
            }
        }
        ......
```

我们继续点进去看，他是怎么获得候选的视图的呢？

getCandidateViews中看到他是把所有的视图解析器拿来，进行while循环，挨个解析！

```java
Iterator var5 = this.viewResolvers.iterator();
```

所以得出结论：**ContentNegotiatingViewResolver 这个视图解析器就是用来组合所有的视图解析器的** 

我们再去研究下他的组合逻辑，看到有个属性viewResolvers，看看它是在哪里进行赋值的！

```java
protected void initServletContext(ServletContext servletContext) {
// 这里它是从beanFactory工具中获取容器中的所有视图解析器    
// ViewRescolver.class 把所有的视图解析器来组合的    
        Collection<ViewResolver> matchingBeans = BeanFactoryUtils.beansOfTypeIncludingAncestors(this.obtainApplicationContext(), ViewResolver.class).values();
        ViewResolver viewResolver;
        if (this.viewResolvers == null) {
            this.viewResolvers = new ArrayList(matchingBeans.size());
            Iterator var3 = matchingBeans.iterator();

            while(var3.hasNext()) {
                viewResolver = (ViewResolver)var3.next();
                if (this != viewResolver) {
                    this.viewResolvers.add(viewResolver);
                }
            }
            ......
```

既然它是在容器中去找视图解析器，我们是否可以猜想，我们就可以去实现一个视图解析器了呢？

可以自己给容器中去添加一个视图解析器；这个类就会帮我们自动的将它组合进来；

**我们去实现一下**

**1**、我们在我们的主程序中去写一个视图解析器来试试；

```java
//应为类型要求为WebMvcConfigurer，所以我们实现其接口
//如果。你想diy一些定制化的功能，只要写这个组件，然后将它交给springboot，springboot就会帮我们自动装配!
//可以使用自定义类扩展SpringMVC的功能  jar包spring-webmvc下DispatcherServlet类
//protected void doDispatch 打断点，访问http://localhost:8088/测试
@Configuration //标注为配置类
//@EnableWebMvc 不要标注此注解 否则此类全面接管MVC的全部配置
public class MyMvcConfig implements WebMvcConfigurer {
    //ViewResolver实现了视图解析器接口的类，我们就可以把它看做视图解析器
    @Bean //放到bean中
    public ViewResolver myViewResolver(){
        //自动视图解析器交给spring管理
        return new MyViewResolver();
    }

    //自定义了一个自己的视图解析器 写一个静态内部类，视图解析器就需要实现ViewResolver接口
    public static class MyViewResolver implements ViewResolver {
        @Override
        public View resolveViewName(String viewName, Locale locale) throws Exception {
            return null;
        }
    }
}
```

**2**、怎么看我们自己写的视图解析器有没有起作用呢？

我们给 DispatcherServlet 中的 doDispatch方法 加个断点进行调试一下，因为所有的请求都会走到这个方法中

**3**、我们启动我们的项目，然后随便访问http://localhost:8088 页面，进Debug看this信息；

找到this → 找到视图解析器，可以看到我们自己定义的就在里面；

所以说，我们如果想要使用自己定制化的东西，我们只需要给容器中添加这个组件就好了！剩下的事情SpringBoot就会帮我们做了！

#### 6.3.3 转换器和格式化器

**找到格式化转换器**：WebMvcAutoConfiguration → FormattingConversionService → getFormat → getDateFormat

```java
@Bean
public FormattingConversionService mvcConversionService() {
            WebMvcProperties.Format format = this.mvcProperties.getFormat();
            // 拿到配置文件中的格式化规则
            WebConversionService conversionService = new WebConversionService((new DateTimeFormatters()).dateFormat(format.getDate()).timeFormat(format.getTime()).dateTimeFormat(format.getDateTime()));
            this.addFormatters(conversionService);
            return conversionService;
        }
        ......
```

**点击去**：getDateFormat

```java
public Format getFormat() {
        return this.format;
    }
private String date;
# 自定义的配置日期格式化
# spring.mvc.format.date=dd/MM/yyyy
```

可以看到在我们的Properties文件中，我们可以进行自动配置它！

如果配置了自己的格式化方式，就会注册到Bean中生效，我们可以在配置文件中配置日期格式化的规则：自己多研究探讨即可！

#### 6.3.4 修改SpringBoot的默认配置

这么多的自动配置，原理都是一样的，通过这个WebMVC的自动配置原理分析，我们要学会一种学习方式，通过源码探究，得出结论；这个结论一定是属于自己的，而且一通百通。SpringBoot的底层，大量用到了这些设计细节思想，所以，没事需要多阅读源码！得出结论：SpringBoot在自动配置很多组件的时候，先看容器中有没有用户自己配置的（如果用户自己配置@bean），如果有就用用户配置的，如果没有就用自动配置的；如果有些组件可以存在多个，比如我们的视图解析器，就将用户配置的和自己默认的组合起来！

**扩展使用SpringMVC**  官方文档如下：

If you want to keep Spring Boot MVC features and you want to add additional MVC configuration (interceptors, formatters, view controllers, and other features), you can add your own @Configuration class of type WebMvcConfigurer but without @EnableWebMvc. If you wish to provide custom instances of RequestMappingHandlerMapping, RequestMappingHandlerAdapter, or ExceptionHandlerExceptionResolver, you can declare a WebMvcRegistrationsAdapter instance to provide such components.

我们要做的就是编写一个@Configuration注解类，并且类型要为WebMvcConfigurer，还不能标注@EnableWebMvc注解；自己写一个；新建一个包叫config，写一个类MyMvcConfig。

```java
//应为类型要求为WebMvcConfigurer，所以我们实现其接口
//可以使用自定义类扩展MVC的功能
@Configuration
//@EnableWebMvc 不要标注此注解 否则此类全面接管MVC的全部配置
public class MyMvcConfig1 implements WebMvcConfigurer {
    //视图跳转
    @Override
    public void addViewControllers(ViewControllerRegistry registry) {
        //浏览器发送/test，就会跳转到test页面
        registry.addViewController("/tt").setViewName("test");
    }
}
```

我们去浏览器访问一下：http://localhost:8088/tt

**确实也跳转过来了！所以说，我们要扩展SpringMVC，官方就推荐我们这么去使用，既保SpringBoot留所有的自动配置，也能用我们扩展的配置！**

我们可以去分析一下原理：

**1**、WebMvcAutoConfiguration 是SpringMVC的自动配置类，里面有一个类WebMvcAutoConfigurationAdapter

**2**、这个类上有一个注解，在做其他自动配置时会导入：@Import({EnableWebMvcConfiguration.class})，

**3**、点进EnableWebMvcConfiguration这个类看一下它继承了一个父类：DelegatingWebMvcConfiguration

这个父类中有这样一段代码：

```java
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
    private final WebMvcConfigurerComposite configurers = new WebMvcConfigurerComposite();
    public DelegatingWebMvcConfiguration() {
    }
    // 从容器中获取所有的webmvcConfigure
    @Autowired(
        required = false
    )
    public void setConfigurers(List<WebMvcConfigurer> configurers) {
        if (!CollectionUtils.isEmpty(configurers)) {
            this.configurers.addWebMvcConfigurers(configurers);
        }
    }
    ......
```

**4**、我们可以在这个类中去寻找一个我们刚才设置的viewController当做参考，发现它调用了一个

```java
protected void addViewControllers(ViewControllerRegistry registry) {
        this.configurers.addViewControllers(registry);
    }
```

**5**、我们点进去看一下。

```java
public void addViewControllers(ViewControllerRegistry registry) {
        Iterator var2 = this.delegates.iterator();
        while(var2.hasNext()) {
        // 将所有的WebMvcConfigurer相关配置来一起调用！包括我们自己配置的和Spring给我们配置的
            WebMvcConfigurer delegate = (WebMvcConfigurer)var2.next();
            delegate.addViewControllers(registry);
        }
    }
    ......
```

所以得出结论：所有的WebMvcConfiguration都会被作用，不止Spring自己的配置类，我们自己的配置类当然也会被调用。

#### 6.3.5 全面接管SpringMVC

官方文档：If you want to take complete control of Spring MVCyou can add your own @Configuration annotated with @EnableWebMvc.

全面接管即：SpringBoot对SpringMVC的自动配置不需要了，所有都是我们自己去配置！

只需在我们的配置类中要加一个@EnableWebMvc。

我们看下如果我们全面接管了SpringMVC了，我们之前SpringBoot给我们配置的静态资源映射一定会无效，我们可以去测试一下；

不加注解之前，可以正常访问首页：http://localhost:8088/

给配置类加上注解：@EnableWebMvc：访问首页错误http://localhost:8088/  **Whitelabel Error Page**

我们发现所有的SpringMVC自动配置都失效了！回归到了最初的样子。

**当然，我们开发中，不推荐使用全面接管SpringMVC**

思考问题？为什么加了一个注解，自动配置就失效了！我们看下源码：

**1**、这里发现它是导入了一个类，可以继续进去看

```java
@Import({DelegatingWebMvcConfiguration.class})
//点进EnableWebMvcConfiguration
//再进DelegatingWebMvcConfiguration
```

**2**、它继承了一个父类 WebMvcConfigurationSupport

```java
public class DelegatingWebMvcConfiguration extends WebMvcConfigurationSupport {
    ......
    }
```

**3**、回顾一下Webmvc自动配置类

```java
@AutoConfiguration(after = {DispatcherServletAutoConfiguration.class, TaskExecutionAutoConfiguration.class, ValidationAutoConfiguration.class})
@ConditionalOnWebApplication(type = Type.SERVLET)
@ConditionalOnClass({Servlet.class, DispatcherServlet.class, WebMvcConfigurer.class})
//这个注解的意思就是：容器中没有这个组件的时候，这个自动配置类才生效
@ConditionalOnMissingBean({WebMvcConfigurationSupport.class})
@AutoConfigureOrder(-2147483638)
public class WebMvcAutoConfiguration {
    ......
    }
```

总结一句话：@EnableWebMvc将WebMvcConfigurationSupport组件导入进来了；

而导入的WebMvcConfigurationSupport只是SpringMVC最基本的功能！

**在SpringBoot中会有非常多的扩展配置，只要看见了这个，我们就应该多留心注意**

**各个测试地址：**

```java
System.out.println("http://localhost:8088/hello/h1");
System.out.println("http://localhost:8088/webjars/jquery/3.7.0/jquery.js");
System.out.println("http://localhost:8088/1.js");
System.out.println("http://localhost:8088");
System.out.println("http://localhost:8088/test/t1");
System.out.println("http://localhost:8088/test/t2");
System.out.println("http://localhost:8088/tt");
```

### 6.4 员工管理系统

**1**、首页配置：

- 注意点，所有页面的静态资源都需要使用thymeleaf接管; 
- url：@{}

**2**、页面国际化：

- 我们需要配置i18n文件
- 我们如果需要在项目中进行按钮自动切换，我们需要自定义一个组件LocaleReso1ver
- 记得将自己写的组件配置到spring容器 @Bean
- #{}

**3**、登录 + 拦截器

**4**、员工列表展示

①提取公共页面

a、th:fragment="sidebar"  
b、th:rep1ace="~{commons/commons : :topbar}"  
c、如果要传递参数，可以直接使用（）传参，接收判断即可！

②列表循环展示

**5**、添加员工

①按钮提交

②跳转到添加页面

③添加员工成功

④返回首页

**6**、CRUD搞定

**7**、404、注销登录

**8**、所有功能完成！

### @学不可以已 springboot-03-web 已完结。

springboot-03-web  模块中（创建springboot项目+整合Thymeleaf+员工管理系统） 。

## 7、springboot整合JDBC（springboot-04-data）

**SpringData简介**

对于数据访问层，无论是 SQL(关系型数据库) 还是 NOSQL(非关系型数据库)，Spring Boot 底层都是采用 Spring Data 的方式进行统一处理。

Spring Boot 底层都是采用 Spring Data 的方式进行统一处理各种数据库，Spring Data 也是 Spring 中与 Spring Boot、Spring Cloud 等齐名的知名项目。

Sping Data 官网：https://spring.io/projects/spring-data

数据库相关的启动器 ：可以参考官方文档：

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

整合JDBC

### 7.1 创建测试项目测试数据源

**1**、新建一个项目测试：springboot-04-data ; 引入相应的模块！基础模块；勾选 **Spring Web；JDBC API; MYSQL Driver** 依赖。

**2**、项目建好之后，发现自动帮我们导入了如下的启动器；

```xml
<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>mysql</groupId>
            <artifactId>mysql-connector-java</artifactId>
            <version>8.0.33</version>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- web -->
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
</dependencies>
```

**3**、编写yaml配置文件连接数据库；

```yaml
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    # ?serverTimezone=UTC解决时区的报错
    url: jdbc:mysql://localhost:3306/db_mybatis?useSSL=false&useUnicode=true&characterEncoding=utf-8
    username: wan
    password: 101101
server:
  port: 8091
```

**4**、配置完这些东西后,就可以直接去使用了，因为SpringBoot已经默认帮我们进行了自动配置；测试类测试一下。

```java
@SpringBootTest
class Springboot04DataApplicationTests {
    //DI注入数据源 
    @Autowired
    DataSource dataSource;
    @Test
    void contextLoads() throws SQLException {
        //查看一下默认的数据源
        System.out.println(dataSource.getClass());
        //获取数据库连接
        Connection connection = dataSource.getConnection();
        System.out.println(connection);//关闭连接
    }
}
```

结果：可以看到他默认给我们配置的数据源为 : **class com.zaxxer.hikari.HikariDataSource** 我们并没有手动配置。

我们来全局搜索一下，找到数据源的所有自动配置都在 ：**DataSourceAutoConfiguration**文件：

```java
@Import({DataSourceConfiguration.Hikari.class, DataSourceConfiguration.Tomcat.class, DataSourceConfiguration.Dbcp2.class, DataSourceConfiguration.OracleUcp.class, DataSourceConfiguration.Generic.class, DataSourceJmxConfiguration.class})
    protected static class PooledDataSourceConfiguration {
        protected PooledDataSourceConfiguration() {
        }
    }
```

这里导入的类都在 DataSourceConfiguration 配置类下，可以看出 Spring Boot 2.7.15默认使用HikariDataSource 数据源，而以前版本，如 Spring Boot 1.5 默认使用 org.apache.tomcat.jdbc.pool.DataSource 作为数据源；

**HikariDataSource 号称 Java WEB 当前速度最快的数据源，相比于传统的 C3P0 、DBCP、Tomcat jdbc 等连接池更加优秀；**

**可以使用 spring.datasource.type 指定自定义的数据源类型，值为要使用的连接池实现的完全限定名。**

关于数据源我们并不做介绍，有了数据库连接，显然就可以 CRUD 操作数据库了。但是我们需要先了解一个对象 JdbcTemplate

### 7.2 JDBCTemplate

**1**、有了数据源(com.zaxxer.hikari.HikariDataSource)，然后可以拿到数据库连接(java.sql.Connection)，有了连接，就可以使用原生的 JDBC 语句来操作数据库；

**2**、即使不使用第三方第数据库操作框架，如 MyBatis等，Spring 本身也对原生的JDBC 做了轻量级的封装，即JdbcTemplate。

**3**、数据库操作的所有 CRUD 方法都在 JdbcTemplate 中。

**4**、Spring Boot 不仅提供了默认的数据源，同时默认已经配置好了 JdbcTemplate 放在了容器中，程序员只需自己注入即可使用

**5**、JdbcTemplate 的自动配置是依赖 org.springframework.boot.autoconfigure.jdbc 包下的 JdbcTemplateConfiguration 类

**JdbcTemplate主要提供以下几类方法：**

- execute方法：可以用于执行任何SQL语句，一般用于执行DDL语句；
- update方法及batchUpdate方法：update方法用于执行新增、修改、删除等语句；batchUpdate方法用于执行批处理相关语句；
- query方法及queryForXXX方法：用于执行查询相关语句；
- call方法：用于执行存储过程、函数相关语句。

### 7.3 测试CURD

**1**、编写一个**JdbcController** ，注入 jdbcTemplate，编写测试方法进行访问测试；

```java
package com.xing.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.jdbc.core.JdbcTemplate;
import org.springframework.web.bind.annotation.*;
import java.util.List;
import java.util.Map;

@RestController
@RequestMapping("/jdbc")
public class JdbcController {
    /**
     * Spring Boot 默认提供了数据源，默认提供了 org.springframework.jdbc.core.JdbcTemplate
     * JdbcTemplate 中会自己注入数据源，用于简化 JDBC操作
     * 还能避免一些常见的错误,使用起来也不用再自己来关闭数据库连接
     */
    @Autowired
    JdbcTemplate jdbcTemplate;

    //查询user表中所有数据
    //List 中的1个 Map 对应数据库的 1行数据
    //Map 中的 key 对应数据库的字段名，value 对应数据库的字段值
    @GetMapping("/list")
    public List<Map<String, Object>> userList(){
        String sql = "select * from user";
        List<Map<String,Object>> list = jdbcTemplate.queryForList(sql);
        System.out.println(list);
        return list;
    }

    //新增user
    @PostMapping("/add") //浏览器测试使用RequestMapping
    public String addUser(){
        String sql = "INSERT INTO user (id, name, pwd) VALUES (23,'小张','123678')";
        jdbcTemplate.update(sql);
        System.out.println("添加成功！");
        String sql1 = "select * from user";
        List<Map<String,Object>> list = jdbcTemplate.queryForList(sql1);
        System.out.println(list);
        return "addOk";
    }

    //更新user
    @PutMapping("/update/{id}") //浏览器测试使用RequestMapping
    public String updateUser(@PathVariable("id") int id){
        String sql = "update user set name=?,pwd=? where id="+id;
        //数据
        Object[] objects = new Object[2];//参数个数
        objects[0] = "小周";
        objects[1] = "369852";
        jdbcTemplate.update(sql,objects);
        System.out.println("更新成功！");
        return "updateOk";
    }

    //删除user
    @DeleteMapping("/delete/{id}") //浏览器测试使用RequestMapping
    public String deleteUser(@PathVariable("id") int id){
        String sql = "delete from user where id=?";
        System.out.println("删除成功！");
        return "deleteOk";
    }
}
//    DROP TABLE IF EXISTS `user`;
//        CREATE TABLE `user` (
//        `id` int NOT NULL AUTO_INCREMENT,
//        `name` varchar(50) CHARACTER SET utf8mb3 COLLATE utf8mb3_general_ci DEFAULT NULL,
//        `pwd` varchar(50) CHARACTER SET utf8mb3 COLLATE utf8mb3_general_ci DEFAULT NULL,
//        PRIMARY KEY (`id`) USING BTREE
//        ) ENGINE=InnoDB AUTO_INCREMENT=24 DEFAULT CHARSET=utf8mb3 ROW_FORMAT=DYNAMIC;
// INSERT INTO `user` VALUES(1,'小龙','123546'),(2,'aaa','bbb'),(3,'小明','3466'),(4,'小王','888'),(6,'Has','123321'),
// (7,'小王','12'),(9,'小Q','58779'),(10,'小W','5123'),(13,'小丽','12345'),(14,'小W','5123'),(15,'小W','5123'),
// (16,'小丽','12345'),(20,'小龙','123654'),(21,'小龙','123654'),(23,'小张','123678');
```

**2**、测试请求，结果正常。到此，CURD的基本操作，使用 JDBC 就搞定了。

## 8、springboot整合Druid

### 8.1 Druid简介

Java程序很大一部分要操作数据库，为了提高性能操作数据库的时候，又不得不使用数据库连接池。

Druid 是阿里巴巴开源平台上一个数据库连接池实现，结合了 C3P0、DBCP 等 DB 池的优点，同时加入了日志监控。

Druid 可以很好的监控 DB 池连接和 SQL 的执行情况，天生就是针对监控而生的 DB 连接池。

Druid已经在阿里巴巴部署了超过600个应用，经过一年多生产环境大规模部署的严苛考验。

Spring Boot 2.0 以上默认使用 Hikari 数据源，可以说 Hikari 与 Driud 都是当前 Java Web 上最优秀的数据源，我们来重点介绍 Spring Boot 如何集成 Druid 数据源，如何实现数据库监控。

**Github地址**：https://github.com/alibaba/druid

**com.alibaba.druid.pool.DruidDataSource 基本配置参数如下：**

![](D:\2023\Java\SpringBoot\springboot-study\img\09.png)

![](D:\2023\Java\SpringBoot\springboot-study\img\10.png)

### 8.2 配置数据源

**1**、添加上 Druid 数据源依赖；

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

**2**、切换数据源；之前已经说过 Spring Boot 2.0 以上默认使用 com.zaxxer.hikari.HikariDataSource 数据源，但可以 通过 spring.datasource.type 指定数据源；

```yaml
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    # ?serverTimezone=UTC解决时区的报错
    url: jdbc:mysql://localhost:3306/db_mybatis?useSSL=false&useUnicode=true&characterEncoding=utf-8
    username: wan
    password: 101101
    type: com.alibaba.druid.pool.DruidDataSource # 自定义数据源
server:
  port: 8091
```

**3**、数据源切换之后，在测试类中注入 DataSource，然后获取到它，输出一看便知是否成功切换；

```java
package com.xing;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import javax.sql.DataSource;
import java.sql.Connection;
import java.sql.SQLException;
@SpringBootTest
class Springboot04DataApplicationTests {
    //DI注入数据源
    @Autowired
    DataSource dataSource;
    @Test
    void contextLoads() throws SQLException {
        //查看一下默认的数据源
        System.out.println(dataSource.getClass());
        //获取数据库连接
        Connection connection = dataSource.getConnection();
        System.out.println(connection);//关闭连接
    }
}
```

**4**、切换成功！既然切换成功，就可以设置数据源连接初始化大小、最大连接数、等待时间、最小连接数 等设置项；可以查看源码；

```yaml
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    # ?serverTimezone=UTC解决时区的报错
    url: jdbc:mysql://localhost:3306/db_mybatis?useSSL=false&useUnicode=true&characterEncoding=utf-8
    username: wan
    password: 101101
    type: com.alibaba.druid.pool.DruidDataSource # 自定义数据源
    #Spring Boot 默认是不注入这些属性值的，需要自己绑定
    #druid 数据源专有配置
    initialSize: 5
    minIdle: 5
    maxActive: 20
    maxWait: 60000
    timeBetweenEvictionRunsMillis: 60000
    minEvictableIdleTimeMillis: 300000
    validationQuery: SELECT 1 FROM DUAL
    testWhileIdle: true
    testOnBorrow: false
    testOnReturn: false
    poolPreparedStatements: true
    #配置监控统计拦截的filters，stat:监控统计、log4j：日志记录、wall：防御sql注入
    #如果允许时报错 java.lang.ClassNotFoundException: org.apache.log4j.Priority
    #则导入 log4j 依赖即可，Maven 地址：https://mvnrepository.com/artifact/log4j/log4j 
    filters: stat,wall,log4j
    maxPoolPreparedStatementPerConnectionSize: 20
    useGlobalDataSourceStat: true
    connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
server:
  port: 8091
```

**5**、导入Log4j 的依赖；

```xml
<!-- log4j -->
<dependency>
     <groupId>log4j</groupId>
     <artifactId>log4j</artifactId>
     <version>1.2.17</version>
 </dependency>
```

**6**、现在需要程序员自己为 DruidDataSource 绑定全局配置文件中的参数，再添加到容器中，而不再使用 Spring Boot 的自动生成了；我们需要 自己添加 DruidDataSource 组件到容器中，并绑定属性；

```java
package com.xing.config;

import com.alibaba.druid.pool.DruidDataSource;
import com.alibaba.druid.support.http.StatViewServlet;
import com.alibaba.druid.support.http.WebStatFilter;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.boot.web.servlet.FilterRegistrationBean;
import org.springframework.boot.web.servlet.ServletRegistrationBean;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import javax.sql.DataSource;
import java.util.Arrays;
import java.util.HashMap;
import java.util.Map;

@Configuration
public class DruidConfig {
    // 将自定义的 Druid数据源添加到容器中，不再让 Spring Boot 自动创建
    // 绑定全局配置文件中的 druid 数据源属性到 com.alibaba.druid.pool.DruidDataSource从而让它们生效
    // 作用就是将 全局配置文件中前缀为 spring.datasource的属性值注入到 com.alibaba.druid.pool.DruidDataSource 的同名参数中
    @ConfigurationProperties(prefix = "spring.datasource")
    @Bean
    public DataSource druidDateSource(){
        return new DruidDataSource();
    }
    //后台监控
    // 配置 Druid 监控管理后台的Servlet；
    // 内置 Servlet 容器时没有web.xml文件，所以使用SpringBoot的注册Servlet方式
    @Bean
    public ServletRegistrationBean statViewServlet() {
        ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");

        // 这些参数可以在 com.alibaba.druid.support.http.StatViewServlet
        // 的父类 com.alibaba.druid.support.http.ResourceServlet 中找到
        Map<String, String> initParams = new HashMap<>();
        initParams.put("loginUsername", "admin"); //后台管理界面的登录账号
        initParams.put("loginPassword", "123456"); //后台管理界面的登录密码

        //后台允许谁可以访问
        //initParams.put("allow", "localhost")：表示只有本机可以访问
        //initParams.put("allow", "")：为空或者为null时，表示允许所有访问
        initParams.put("allow", "");
        //deny：Druid 后台拒绝谁访问
        initParams.put("wzx", "192.168.3.186"); //表示禁止此ip访问

        //设置初始化参数
        bean.setInitParameters(initParams);
        return bean;
    }

    //配置 Druid 监控 之  web 监控的 filter
    // WebStatFilter：用于配置Web和Druid数据源之间的管理关联监控统计
    @Bean
    public FilterRegistrationBean webStatFilter() {
        FilterRegistrationBean bean = new FilterRegistrationBean();
        bean.setFilter(new WebStatFilter());

        //exclusions：设置哪些请求进行过滤排除掉，从而不进行统计
        Map<String, String> initParams = new HashMap<>();
        //这些东西不进行统计
        initParams.put("exclusions", "*.js,*.css,/druid/*,/jdbc/*");
        bean.setInitParameters(initParams);

        //"/*" 表示过滤所有请求
        bean.setUrlPatterns(Arrays.asList("/*"));
        return bean;
    }
}
```

**7**、去测试类中测试一下；看是否成功！

```java
@SpringBootTest
class Springboot04DataApplicationTests {
    //DI注入数据源
    @Autowired
    DataSource dataSource;
    @Test
    void contextLoads() throws SQLException {
        //查看一下默认的数据源
        System.out.println(dataSource.getClass());
        //获取数据库连接
        Connection connection = dataSource.getConnection();
        System.out.println(connection);//关闭连接
        DruidDataSource druidDataSource = (DruidDataSource) dataSource;
        System.out.println("druidDataSource 数据源最大连接数：" + druidDataSource.getMaxActive());
        System.out.println("druidDataSource 数据源初始化连接数：" + druidDataSource.getInitialSize());
        connection.close();
    }
}
```

**输出结果 ：**

com.alibaba.druid.pool.DruidDataSource  
com.alibaba.druid.proxy.jdbc.ConnectionProxyImpl@260d48f5  
druidDataSource 数据源最大连接数：21  
druidDataSource 数据源初始化连接数：6

可见配置参数已经生效！

### 8.3 配置Druid数据源监控

Druid 数据源具有监控的功能，并提供了一个 web 界面方便用户查看，类似安装 路由器 时，人家也提供了一个默认的 web 页面。

所以第一步需要设置 Druid 的后台管理页面，比如 登录账号、密码 等；配置后台管理；

```java
//后台监控
    // 配置 Druid 监控管理后台的Servlet；
    // 内置 Servlet 容器时没有web.xml文件，所以使用SpringBoot的注册Servlet方式
    @Bean
    public ServletRegistrationBean statViewServlet() {
        ServletRegistrationBean bean = new ServletRegistrationBean(new StatViewServlet(), "/druid/*");

        // 这些参数可以在 com.alibaba.druid.support.http.StatViewServlet
        // 的父类 com.alibaba.druid.support.http.ResourceServlet 中找到
        Map<String, String> initParams = new HashMap<>();
        initParams.put("loginUsername", "admin"); //后台管理界面的登录账号
        initParams.put("loginPassword", "123456"); //后台管理界面的登录密码
        //后台允许谁可以访问
        //initParams.put("allow", "localhost")：表示只有本机可以访问
        //initParams.put("allow", "")：为空或者为null时，表示允许所有访问
        initParams.put("allow", "");
        //deny：Druid 后台拒绝谁访问
        //initParams.put("wzx", "192.168.3.186"); //表示禁止此ip访问

        //设置初始化参数
        bean.setInitParameters(initParams);
        return bean;
    }
```

配置完毕后，我们可以选择访问 ：http://localhost:8080/druid

使用账号密码登录。进入可以查看 **Stat Index 查看JSON API**

**配置 Druid web 监控 filter 过滤器**

```java
//配置 Druid 监控 之  web 监控的 filter
    // WebStatFilter：用于配置Web和Druid数据源之间的管理关联监控统计
    @Bean
    public FilterRegistrationBean webStatFilter() {
        FilterRegistrationBean bean = new FilterRegistrationBean();
        bean.setFilter(new WebStatFilter());

        //exclusions：设置哪些请求进行过滤排除掉，从而不进行统计
        Map<String, String> initParams = new HashMap<>();
        //这些东西不进行统计
        initParams.put("exclusions", "*.js,*.css,/druid/*,/jdbc/*");
        bean.setInitParameters(initParams);

        //"/*" 表示过滤所有请求
        bean.setUrlPatterns(Arrays.asList("/*"));
        return bean;
    }
```

平时在工作中，按需求进行配置即可，主要用作监控！

### @学不可以已 springboot-04-data 已完结。

springboot-04-data  模块中 （IDEA创建springboot项目+整合jdbcCURD+整合druidDruid配置） 。

## 9、springboot整合MyBatis（springboot-05-mybatis）

**整合MyBatis**

官方文档：http://mybatis.org/spring-boot-starter/mybatis-spring-boot-autoconfigure

Maven仓库地址：https://mvnrepository.com/artifact/org.mybatis.spring.boot/mybatis-spring-boot-starter

### 9.1 整合测试

**1**、创建项目springboot-05-mybatis；

**2**、导入相关依赖；

```xml
<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-jdbc</artifactId>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <scope>runtime</scope>
        </dependency>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
        <!-- springboot-mybatis -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.3.1</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/com.alibaba/druid -->
        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>druid</artifactId>
            <version>1.2.18</version>
        </dependency>
        <!-- lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
        </dependency>
    </dependencies>
    <build>
        <plugins>
            <plugin>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-maven-plugin</artifactId>
            </plugin>
        </plugins>
        <!-- maven配置资源过滤问题 -->
        <resources>
            <resource>
                <directory>src/main/java</directory>
                <includes>
                    <include>**/*.xml</include>
                </includes>
                <filtering>true</filtering>
            </resource>
        </resources>
    </build>
```

**3**、配置数据库连接信息

```properties
server.port=8092
spring.datasource.username=wan
spring.datasource.password=101101
spring.datasource.driver-class-name=com.mysql.cj.jdbc.Driver
spring.datasource.url=jdbc:mysql://localhost:3306/db_mybatis?useSSL=false&useUnicode=true&characterEncoding=utf-8
#整合mybatis
#如果没有aliases UserMapper.xml中parameterType="User"会报错
mybatis.type-aliases-package=com.xing.domain
mybatis.mapper-locations=classpath:mapper/*.xml
```

**4**、测试数据源和连接；

```java
@SpringBootTest
class Springboot05MybatisApplicationTests {
    @Autowired
    DataSource dataSource;
    @Test
    void contextLoads() throws SQLException {
        System.out.println(dataSource.getClass());
        System.out.println(dataSource.getConnection());
    }
}
```

**5**、创建 User.java实体类，导入 Lombok；

```java
@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private Integer id;
    private String name;
    private String pwd;
}
```

**6**、创建mapper目录以及对应的 Mapper 接口；

```java
package com.xing.mapper;

import com.xing.domain.User;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

import java.util.List;

@Mapper //@Mapper : 表示本类是一个 MyBatis 的 Mapper
@Repository
public interface UserMapper {
    // 获取所有用户信息
    List<User> queryUserList();
    // 通过id获得用户  
    User queryUserById(int id);

    int addUser(User user);

    int updateUser(User user);

    int deleteUserById(int id);
}
```

**7**、对应的Mapper映射文件；

```xml
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.xing.mapper.UserMapper">
    <select id="queryUserList" resultType="User">
        select * from user;
    </select>
    <select id="queryUserById" resultType="User" parameterType="int">
        select * from user where id = #{id};
    </select>
    <insert id="addUser" parameterType="User">
        insert into user (id,name,pwd) values (#{id},#{name},#{pwd});
    </insert>
    <update id="updateUser" parameterType="User">
        update user set name = #{name},pwd = #{pwd} where id = #{id};
    </update>
    <delete id="deleteUserById" parameterType="User">
        delete from user where id = #{id};
    </delete>
</mapper>
```

**8**、编写**UserController** 进行测试！

```java
package com.xing.controller;

import com.xing.domain.User;
import com.xing.mapper.UserMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.*;

import java.util.List;

@RestController
@RequestMapping("/User")
public class UserController {
    @Autowired
    UserMapper userMapper;
    //查询全部用户
    @GetMapping("/queryList")
    public List<User> queryUser(){
        return userMapper.queryUserList();
    }
    //根据用户id查询用户
    @GetMapping("/queryUserById/{id}")
    public User queryUserById(@PathVariable("id") int id){
        return userMapper.queryUserById(id);
    }
    //添加用户数据
    @PostMapping("/addUser")
    public int addUser(@RequestBody User user){
        return userMapper.addUser(user);
    }
    //修改用户数据
    @PutMapping("/updateUser")
    public int updateUser(@RequestBody User user){
        return userMapper.updateUser(user);
    }
    //删除用户数据
    @DeleteMapping("/deleteUserById/{id}")
    public int deleteUserById(@PathVariable("id") int id){
        return userMapper.deleteUserById(id);
    }
}
```

**启动项目访问进行测试**！http://localhost:8092/User/... 根据具体方法地址修改url进行测试。

**测试结果完成，搞定收工！**

### @学不可以已 springboot-05-mybatis 已完结。

springboot-05-mybatis  模块中 （IDEA创建springboot项目+整合mybatis+CRUD测试） 。

## 10、springboot整合SpringSecurity（springboot-06-security）

### 10.1 安全简介

在 Web 开发中，安全一直是非常重要的一个方面。安全虽然属于应用的非功能性需求，但是应该在应用开发的初期就考虑进来。如果在应用开发的后期才考虑安全的问题，就可能陷入一个两难的境地：一方面，应用存在严重的安全漏洞，无法满足用户的要求，并可能造成用户的隐私数据被攻击者窃取；另一方面，应用的基本架构已经确定，要修复安全漏洞，可能需要对系统的架构做出比较重大的调整，因而需要更多的开发时间，影响应用的发布进程。因此，从应用开发的第一天就应该把安全相关的因素考虑进来，并在整个应用的开发过程中。

市面上存在比较有名的：**Shiro，Spring Security ！**

这里需要阐述一下的是，每一个框架的出现都是为了解决某一问题而产生了，那么Spring Security框架的出现是为了解决什么问题呢？

首先我们看下它的官网介绍：Spring Security官网地址

Spring Security is a powerful and highly customizable authentication and access-control framework. It is the de-facto standard for securing Spring-based applications.

Spring Security is a framework that focuses on providing both authentication and authorization to Java applications. Like all Spring projects, the real power of Spring Security is found in how easily it can be extended to meet custom requirements

Spring Security是一个功能强大且高度可定制的身份验证和访问控制框架。它实际上是保护基于spring的应用程序的标准。

Spring Security是一个框架，侧重于为Java应用程序提供身份验证和授权。与所有Spring项目一样，Spring安全性的真正强大之处在于它可以轻松地扩展以满足定制需求

从官网的介绍中可以知道这是一个权限框架。想我们之前做项目是没有使用框架是怎么控制权限的？对于权限 一般会细分为功能权限，访问权限，和菜单权限。代码会写的非常的繁琐，冗余。

怎么解决之前写权限代码繁琐，冗余的问题，一些主流框架就应运而生而Spring Scecurity就是其中的一种。

Spring 是一个非常流行和成功的 Java 应用开发框架。Spring Security 基于 Spring 框架，提供了一套 Web 应用安全性的完整解决方案。一般来说，Web 应用的安全性包括用户认证（Authentication）和用户授权（Authorization）两个部分。用户认证指的是验证某个用户是否为系统中的合法主体，也就是说用户能否访问该系统。用户认证一般要求用户提供用户名和密码。系统通过校验用户名和密码来完成认证过程。用户授权指的是验证某个用户是否有权限执行某个操作。在一个系统中，不同用户所具有的权限是不同的。比如对一个文件来说，有的用户只能进行读取，而有的用户可以进行修改。一般来说，系统会为不同的用户分配不同的角色，而每个角色则对应一系列的权限。

对于上面提到的两种应用情景，Spring Security 框架都有很好的支持。在用户认证方面，Spring Security 框架支持主流的认证方式，包括 HTTP 基本认证、HTTP 表单验证、HTTP 摘要认证、OpenID 和 LDAP 等。在用户授权方面，Spring Security 提供了基于角色的访问控制和访问控制列表（Access Control List，ACL），可以对应用中的领域对象进行细粒度的控制。

### 10.2 实验环境搭建

**1**、新建一个初始的springboot项目添加web模块，thymeleaf模块；

**2**、导入静态资源；

```java
|views
|level1   1.html 2.html 3.html
|level2   1.html 2.html 3.html
|level3   1.html 2.html 3.html
login.html
index.html
```

**3**、RouterController跳转；

```java
@Controller
public class RouterController {

    @RequestMapping({"/","/index"})
    public String index() {
        return "index";
    }

    @RequestMapping("/toLogin")
    public String toLogin() {
        return "views/login";
    }

    @RequestMapping("/level1/{id}")
    public String level1(@PathVariable("id") int id) {
        return "views/level1/" + id;
    }

    @RequestMapping("/level2/{id}")
    public String level2(@PathVariable("id") int id) {
        return "views/level2/" + id;
    }

    @RequestMapping("/level3/{id}")
    public String level3(@PathVariable("id") int id) {
        return "views/level3/" + id;
    }
}
```

**4**、测试 http://localhost:8080 实验环境是否OK！

### 10.3 整合 SpringSecurity

Spring Security 是针对Spring项目的安全框架，也是Spring Boot底层安全模块默认的技术选型，他可以实现强大的Web安全控制，对于安全控制，我们仅需要引入 spring-boot-starter-security 模块，进行少量的配置，即可实现强大的安全管理！

记住几个类：

- WebSecurityConfigurerAdapter：自定义Security策略
- AuthenticationManagerBuilder：自定义认证策略
- @EnableWebSecurity：开启WebSecurity模式

Spring Security的两个主要目标是 “认证” 和 “授权”（访问控制）。

**“认证”（Authentication）**

身份验证是关于验证您的凭据，如用户名/用户ID和密码，以验证您的身份。

身份验证通常通过用户名和密码完成，有时与身份验证因素结合使用。

 **“授权” （Authorization）**

授权发生在系统成功验证您的身份后，最终会授予您访问资源（如信息，文件，数据库，资金，位置，几乎任何内容）的完全权限。

这个概念是通用的，而不是只在Spring Security 中存在。

### 10.4 认证和授权

目前，我们的测试环境，是谁都可以访问的，我们使用 Spring Security 增加上认证和授权的功能。

**1**、引入 Spring Security 模块；

```xml
<!-- security -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-security</artifactId>
</dependency>
```

**2**、编写 Spring Security 配置类；

参考官网：https://spring.io/projects/spring-security

查看我们自己项目中的版本，找到对应的帮助文档：

https://docs.spring.io/spring-security/site/docs/5.3.0.RELEASE/reference/html5  #servlet-applications 8.16.4

**3**、编写基础配置类；

```java
package com.kuang.config;

import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;

@EnableWebSecurity //开启WebSecurity模式
public class SecurityConfig extends WebSecurityConfigurerAdapter {

   @Override
   protected void configure(HttpSecurity http) throws Exception {
       
  }
}
```

**4**、定制请求的授权规则；

```
@EnableWebSecurity //开启WebSecurity模式
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        // 定制请求的授权规则
        // 首页所有人可以访问
        http.authorizeRequests().antMatchers("/").permitAll()
                .antMatchers("/level1/**").hasRole("vip1")
                .antMatchers("/level2/**").hasRole("vip2")
                .antMatchers("/level3/**").hasRole("vip3");
   }
```

**5**、测试一下：发现除了首页都进不去了！因为我们目前没有登录的角色，因为请求需要登录的角色拥有对应的权限才可以；

**6**、在configure()方法中加入以下配置，开启自动配置的登录功能；

```java
http.formLogin();//内部登录测试
```

**7**、测试一下：http://localhost:8080 发现，没有权限的时候，会跳转到登录的页面；

**8**、查看刚才登录页的注释信息；

我们可以定义认证规则，重写configure(AuthenticationManagerBuilder auth)方法

```java
// 认证通过的用户
@Override
public void configure(AuthenticationManagerBuilder auth) throws Exception {
    // 设置用户名密码
    auth.inMemoryAuthentication().passwordEncoder()
            .withUser("xing").password("123456").roles("vip2","vip3")
            .and()
            .withUser("root").password("123456").roles("vip1")
            .and()
            .withUser("admin").password("123456").roles("vip1","vip2","vip3");
}
```

**9**、测试，我们可以使用这些账号登录进行测试！发现会报错；There is no PasswordEncoder mapped for the id “null”

**10**、原因，我们要将前端传过来的密码进行某种方式加密，否则就无法登录，修改代码；

```java
// 认证通过的用户
@Override
public void configure(AuthenticationManagerBuilder auth) throws Exception {
    // 设置用户名密码
    auth.inMemoryAuthentication().passwordEncoder(new BCryptPasswordEncoder())
            .withUser("xing").password(new BCryptPasswordEncoder().encode("123456")).roles("vip2","vip3")
            .and()
            .withUser("root").password(new BCryptPasswordEncoder().encode("123456")).roles("vip1")
            .and()
            .withUser("admin").password(new BCryptPasswordEncoder().encode("123456")).roles("vip1","vip2","vip3");
}
```

**11**、测试，发现，登录成功，并且每个角色只能访问自己认证下的规则！搞定。

### 10.5 权限控制和注销

**1**、开启自动配置的注销的功能；

```java
//定制请求的授权规则
@Override
protected void configure(HttpSecurity http) throws Exception {
   //....
   //开启自动配置的注销的功能 logout注销请求
   http.logout();
}
```

**2**、我们在前端，增加一个注销的按钮，index.html 导航栏中；

```html
<!-- 注销 -->
<div sec:authorize="isAuthenticated()">
<a class="item" th:href="@{/logout}">
<i class="sign-out icon"></i>注销
</a>
```

**3**、测试一下，登录成功后点击注销，发现注销完毕会跳转到登录页面；

**4**、但是，想让他注销成功后，依旧可以跳转到首页，该怎么处理呢；

```java
// 定制退出登录 注销成功来到首页
http.logout().logoutSuccessUrl("/");
```

**5**、测试，注销完毕后，发现跳转到首页OK；

**6**、我们现在又来一个需求：用户没有登录的时候，导航栏上只显示登录按钮，用户登录之后，导航栏可以显示登录的用户信息及注销按钮！还有就是，比如xing这个用户，它只有 vip2，vip3功能，那么登录则只显示这两个功能，而vip1的功能菜单不显示！这个就是真实的网站情况了！该如何做呢？

我们需要结合thymeleaf中的一些功能sec：authorize="isAuthenticated()":是否认证登录！来显示不同的页面；

Maven依赖：

```xml
<!-- Thymeleaf 整合 Spring Security 组件-->
<dependency>
    <groupId>org.thymeleaf.extras</groupId>
    <artifactId>thymeleaf-extras-springsecurity5</artifactId>
</dependency>
```

**7**、修改我们的 前端页面；

**①**、导入命名空间

**②**、`xmlns:th="http://www.thymeleaf.org" xmlns:sec="http://www.thymeleaf.org/thymeleaf-extras-springsecurity5">`

**③**、修改导航栏，增加认证判断

**④**、index.html

```html
<!--登录/注销-->
<div class="right menu">
    <!-- 内部登录测试 -->
    <div sec:authorize="!isAuthenticated()">
        <a class="item" th:href="@{/login}">
             <i class="address card icon"></i>内部登录
        </a>
    </div>
    <!-- 未登录 显示 -->
   <div sec:authorize="!isAuthenticated()">
   <a class="item" th:href="@{/toLogin}">
        <i class="address card icon"></i>登录
   </a>
   </div>
    <!-- 已登录 显示 -->
    <div sec:authorize="isAuthenticated()">
        <a class="item">
            <i class="add card icon"></i>
            用户名：<span sec:authentication="principal.username"></span>&nbsp
            角色：<span sec:authentication="principal.authorities"></span>
        </a>
    </div>
    <!-- 注销 -->
    <div sec:authorize="isAuthenticated()">
    <a class="item" th:href="@{/logout}">
         <i class="sign-out icon"></i>注销
    </a>
    </div>
```

**8**、重启测试，我们可以登录试试看，登录成功后确实，显示了我们想要的页面；

**9**、如果注销404了，就是因为它默认防止csrf跨站请求伪造，因为会产生安全问题，我们可以将请求改为post表单提交，或者在spring security中关闭csrf功能；我们试试：在 配置中增加 `http.csrf().disable();`

```java
// 关闭csrf功能:跨站请求伪造,默认只能通过post方式提交logout请求
http.csrf().disable();
// 定制退出登录 注销成功来到首页
http.logout().logoutSuccessUrl("/");
```

**10**、我们继续将下面的角色功能块认证完成；

```java
<div class="ui three column stackable grid">
            <!-- sec:authorize="hasRole('vip1')" -->
            <div class="column" sec:authorize="hasRole('vip1')">
                <div class="ui raised segment">
                    <div class="ui">
                        <div class="content">
                            <h5 class="content">Level 1</h5>
                            <hr>
                            <div><a th:href="@{/level1/1}"><i class="bullhorn icon"></i> Level-1-1</a></div>
                            <div><a th:href="@{/level1/2}"><i class="bullhorn icon"></i> Level-1-2</a></div>
                            <div><a th:href="@{/level1/3}"><i class="bullhorn icon"></i> Level-1-3</a></div>
                        </div>
                    </div>
                </div>
            </div>
...                     
<!-- sec:authorize="hasRole('vip2')" -->
<div class="column" sec:authorize="hasRole('vip2')">
...
<!-- sec:authorize="hasRole('vip3')" -->
<div class="column" sec:authorize="hasRole('vip3')">
...
```

**11**、测试一下！http://localhost:8080 权限控制和注销搞定！

### 10.6 记住我

现在的情况，我们只要登录之后，关闭浏览器，再登录，就会让我们重新登录，但是很多网站的情况，就是有一个记住密码的功能，这个该如何实现呢？很简单。

**1**、开启记住我功能；

```java
//定制请求的授权规则
@Override
protected void configure(HttpSecurity http) throws Exception {
//。。。。。。。。。。。
   // 记住我功能，默认保存14天
   http.rememberMe();
}
```

**2**、我们再次启动项目测试一下，发现登录页多了一个记住我功能，我们登录之后关闭 浏览器，然后重新打开浏览器访问，发现用户依旧存在！

思考：如何实现的呢？其实非常简单，我们可以查看浏览器的cookie；

**3**、我们点击注销的时候，可以发现，spring security 帮我们自动删除了这个 cookie；

**4**、结论：登录成功后，将cookie发送给浏览器保存，以后登录带上这个cookie，只要通过检查就可以免登录了。如果点击注销，则会删除这个cookie，具体的原理我们在JavaWeb阶段都讲过了，这里就不在多说了！

### 10.7 定制登录页

现在这个登录页面都是spring security 默认的，怎么样可以使用我们自己写的Login界面呢？

**1**、在刚才的登录页配置后面指定 loginpage；

```java
// 定制登录 没有权限默认会到登录页面,需要开启登录的页面
http.formLogin().loginPage("/toLogin");
```

**2**、然后前端也需要指向我们自己定义的 login请求；

```java
<!-- 未登录 显示 -->
<div sec:authorize="!isAuthenticated()">
<a class="item" th:href="@{/toLogin}">
    <i class="address card icon"></i>登录
 </a>
```

**3**、我们登录，需要将这些信息发送到哪里，我们也需要配置，login.html 配置提交请求及方式，方式必须为post：在 loginPage()源码中的注释上有写明；

```html
<form th:action="@{/login}" method="post">
   <div class="field">
       <label>Username</label>
       <div class="ui left icon input">
           <input type="text" placeholder="Username" name="user"> <!-- user -->
           <i class="user icon"></i>
       </div>
   </div>
<div class="field">
    <label>Password</label>
    <div class="ui left icon input">
        <input type="password" placeholder="Password" name="pwd"> <!-- pwd -->
        <i class="lock icon"></i>
    </div>
   </div>
   <div class="field">
   <input type="checkbox" name="remember"> 记住我!
   </div>
   <input type="submit" class="ui blue submit button"/>
</form>
```

**4**、这个请求提交上来，我们还需要验证处理，怎么做呢？我们可以查看formLogin()方法的源码！我们配置接收登录的用户名和密码的参数；

```java
// 定制登录 没有权限默认会到登录页面,需要开启登录的页面
http.formLogin().loginPage("/toLogin")
        .usernameParameter("user")
        .passwordParameter("pwd")
        .loginProcessingUrl("/login"); //登陆表单提交请求
```

**5**、在登录页增加记住我的多选框 login.html；

```html
<div class="field">
<input type="checkbox" name="remember"> 记住我!
</div>
```

**6**、后端验证处理；

```java
// 记住我功能，自定义接收前端的参数
http.rememberMe().rememberMeParameter("remember");
```

**7**、测试http://localhost:8080 OK！

**SecurityConfig** 完整配置代码。

```java
package com.xing.config;

import org.springframework.security.config.annotation.authentication.builders.AuthenticationManagerBuilder;
import org.springframework.security.config.annotation.web.builders.HttpSecurity;
import org.springframework.security.config.annotation.web.configuration.EnableWebSecurity;
import org.springframework.security.config.annotation.web.configuration.WebSecurityConfigurerAdapter;
import org.springframework.security.crypto.bcrypt.BCryptPasswordEncoder;

@EnableWebSecurity //开启WebSecurity模式
public class SecurityConfig extends WebSecurityConfigurerAdapter {
    @Override
    protected void configure(HttpSecurity http) throws Exception {
        // 定制请求的授权规则
        // 首页所有人可以访问
        http.authorizeRequests().antMatchers("/").permitAll()
                .antMatchers("/level1/**").hasRole("vip1")
                .antMatchers("/level2/**").hasRole("vip2")
                .antMatchers("/level3/**").hasRole("vip3");
        //http.formLogin();//内部登录测试

        // 定制登录 没有权限默认会到登录页面,需要开启登录的页面
        http.formLogin().loginPage("/toLogin")
                .usernameParameter("user")
                .passwordParameter("pwd")
                .loginProcessingUrl("/login"); //登陆表单提交请求

        // 关闭csrf功能:跨站请求伪造,默认只能通过post方式提交logout请求
        http.csrf().disable();
        // 定制退出登录 注销成功来到首页
        http.logout().logoutSuccessUrl("/");
        // 记住我功能，默认保存14天
        //http.rememberMe();
        // 记住我功能，自定义接收前端的参数
        http.rememberMe().rememberMeParameter("remember");
    }
    // 认证通过的用户
    @Override
    public void configure(AuthenticationManagerBuilder auth) throws Exception {
        // 设置用户名密码
        auth.inMemoryAuthentication().passwordEncoder(new BCryptPasswordEncoder())
                .withUser("xing").password(new BCryptPasswordEncoder().encode("123456")).roles("vip2","vip3")
                .and()
                .withUser("root").password(new BCryptPasswordEncoder().encode("123456")).roles("vip1")
                .and()
                .withUser("admin").password(new BCryptPasswordEncoder().encode("123456")).roles("vip1","vip2","vip3");
    }
}
```

### @学不可以已 springboot-06-security 已完结。

springboot-06-security  模块中 （IDEA创建springboot项目+整合security+认证授权+权限控制和注销+记住我+定制登录页） 。

## 11、springboot整合Shiro（springboot-07-shiro）

### 11.1 Shiro简介

#### 11.1.1 Shiro 是什么？

Apache Shiro 是 Java 的一个安全（权限）框架。

Shiro 可以非常容易的开发出足够好的应用，其不仅可以用在 JavaSE 环境，也可以用在 JavaEE 环境。

Shiro 可以完成：认证、授权、加密、会话管理、与Web 集成、缓存等。

**下载地址**：

**官网**：https://swagger.io

**github**：https://github.com/apache/shiro

#### 11.1.2 功能？

![img](D:\2023\Java\SpringBoot\springboot-study\img\11.png)

**Authentication**：身份认证/登录，验证用户是不是拥有相应的身份；

**Authorization**：授权，即权限验证，验证某个已认证的用户是否拥有某个权限；即判断用户是否能进行什么操作，如：验证某个用户是否拥有某个角色。或者细粒度的验证某个用户对某个资源是否具有某个权限；

**Session Management**：会话管理，即用户登录后就是一次会话，在没有退出之前，它的所有信息都在会话中；会话可以是普通JavaSE环境，也可以是Web 环境的；

**Cryptography**：加密，保护数据的安全性，如密码加密存储到数据库，而不是明文存储；

**Web Support**：Web 支持，可以非常容易的集成到Web 环境；

**Caching**：缓存，比如用户登录后，其用户信息、拥有的角色/权限不必每次去查，这样可以提高效率；

**Concurrency**：Shiro支持多线程应用的并发验证，即如在一个线程中开启另一个线程，能把权限自动传播过去；

**Testing**：提供测试支持；

**Run As**：允许一个用户假装为另一个用户（如果他们允许）的身份进行访问；

**Remember Me**：记住我，这个是非常常见的功能，即一次登录后，下次再来的话不用登录了

#### 11.1.3 Shiro架构(外部)

![img](D:\2023\Java\SpringBoot\springboot-study\img\12.png)

从外部来看Shiro，即从应用程序角度的来观察如何使用Shiro完成工作

**Subject**：应用代码直接交互的对象是Subject，也就是说Shiro的对外API 核心就是Subject。Subject 代表了当前“用户”，这个用户不一定是一个具体的人，与当前应用交互的任何东西都是Subject，如网络爬虫，机器人等；与Subject 的所有交互都会委托给SecurityManager；Subject 其实是一个门面，SecurityManager才是实际的执行者

**SecurityManager**：安全管理器；即所有与安全有关的操作都会与SecurityManager交互；且其管理着所有Subject；可以看出它是Shiro的核心，它负责与Shiro的其他组件进行交互，它相当于SpringMVC中DispatcherServlet的角色

Realm：Shiro从Realm 获取安全数据（如用户、角色、权限），就是说SecurityManager要验证用户身份，那么它需要从Realm 获取相应的用户进行比较以确定用户身份是否合法；也需要从Realm 得到用户相应的角色/权限进行验证用户是否能进行操作；可以把Realm 看成DataSource

也就是说对于我们而言，最简单的一个Shiro应用：

应用代码通过Subject来进行认证和授权，而Subject又委托给SecurityManager；

我们需要给Shiro的SecurityManager注入Realm，从而让SecurityManager能得到合法的用户及其权限进行判断。

从以上也可以看出，Shiro不提供维护用户/权限，而是通过Realm让开发人员自己注入

#### 11.1.4 Shiro架构(内部)

![img](D:\2023\Java\SpringBoot\springboot-study\img\13.png)

**Subject**：主体，可以看到主体可以是任何可以与应用交互的“用户”；

**SecurityManager**：相当于SpringMVC中的DispatcherServlet或者Struts2中的FilterDispatcher；是Shiro的心脏；所有具体的交互都通过SecurityManager进行控制；它管理着所有Subject、且负责进行认证和授权、及会话、缓存的管理。

**Authenticator**：认证器，负责主体认证的，这是一个扩展点，如果用户觉得Shiro默认的不好，可以自定义实现；其需要认证策略（Authentication Strategy），即什么情况下算用户认证通过了；

**Authrizer**：授权器，或者访问控制器，用来决定主体是否有权限进行相应的操作；即控制着用户能访问应用中的哪些功能；

**Realm**：可以有1个或多个Realm，可以认为是安全实体数据源，即用于获取安全实体的；可以是JDBC实现，也可以是LDAP实现，或者内存实现等等；由用户提供；注意：Shiro不知道你的用户/权限存储在哪及以何种格式存储；所以我们一般在应用中都需要实现自己的Realm；  
SessionManager：如果写过Servlet就应该知道Session的概念，Session呢需要有人去管理它的生命周期，这个组件就是SessionManager；而Shiro并不仅仅可以用在Web环境，也可以用在如普通的JavaSE环境、EJB等环境；所有呢，Shiro就抽象了一个自己的Session来管理主体与应用之间交互的数据；这样的话，比如我们在Web环境用，刚开始是一台Web服务器；接着又上了台EJB服务器；这时想把两台服务器的会话数据放到一个地方，这个时候就可以实现自己的分布式会话（如把数据放到Memcached服务器）；
**SessionDAO**：DAO大家都用过，数据访问对象，用于会话的CRUD，比如我们想把Session保存到数据库，那么可以实现自己的SessionDAO，通过如JDBC写到数据库；比如想把Session放到Memcached中，可以实现自己的Memcached SessionDAO；另外SessionDAO中可以使用Cache进行缓存，以提高性能；

**CacheManager**：缓存控制器，来管理如用户、角色、权限等的缓存的；因为这些数据基本上很少去改变，放到缓存中后可以提高访问的性能

**Cryptography**：密码模块，Shiro提高了一些常见的加密组件用于如密码加密/解密的

#### 11.1.5 认证流程

用户提交身份信息、凭证信息封装成令牌交由安全管理器认证。

### 11.2 快速入门

#### 11.2.1 拷贝案例

按照官网提示找到快速入门案例GitHub，从GitHub 的文件中可以看出这个快速入门案例是一个 Maven 项目；

新建一个 Maven 工程**hello-shiro**，删除其 src 目录，将其作为父工程；

在父工程中新建一个 Maven 模块；

复制快速入门案例 POM.xml 文件中的依赖 （版本号自选）。

```xml
<dependencies>
        <!-- https://mvnrepository.com/artifact/org.apache.shiro/shiro-core -->
        <dependency>
            <groupId>org.apache.shiro</groupId>
            <artifactId>shiro-core</artifactId>
            <version>1.12.0</version>
        </dependency>
        <!-- configure logging -->
        <!-- https://mvnrepository.com/artifact/org.slf4j/jcl-over-slf4j -->
        <dependency>
            <groupId>org.slf4j</groupId>
            <artifactId>jcl-over-slf4j</artifactId>
            <version>2.0.9</version>
        </dependency>
        <!-- https://mvnrepository.com/artifact/org.apache.logging.log4j/log4j-slf4j2-impl -->
        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-slf4j2-impl</artifactId>
            <version>2.20.0</version>
        </dependency>

        <dependency>
            <groupId>org.apache.logging.log4j</groupId>
            <artifactId>log4j-core</artifactId>
            <version>2.20.0</version>
        </dependency>
```


把快速入门案例中的 resource 下的log4j.properties 复制下来；

复制一下 shiro.ini 文件；

复制一下 Quickstart.java 文件，如果有导包的错误，把那两个错误的包删掉，就会自动导对的包了，快速入门案例中用的方法过时了；

运行 Quickstart.java，得到结果。

#### 11.2.2 分析案例

**1**、通过 SecurityUtils 获取当前执行的用户 Subject；

```java
Subject currentUser = SecurityUtils.getSubject();
```

**2**、通过 当前用户拿到 Session；

```java
Session session = currentUser.getSession();
```

**3**、用 Session 存值取值；

```java
session.setAttribute("someKey", "aValue");
String value = (String) session.getAttribute("someKey");
```

**4**、判断用户是否被认证；

```java
currentUser.isAuthenticated()
```

**5**、执行登录操作；

```java
currentUser.login(token);
```

**6**、打印其标识主体；

```java
currentUser.getPrincipal()
```

**7**、注销；

```java
currentUser.logout();
```

**8**、总览。

```java
package com.xing;

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.*;
import org.apache.shiro.config.IniSecurityManagerFactory;
import org.apache.shiro.mgt.SecurityManager;
import org.apache.shiro.session.Session;
import org.apache.shiro.subject.Subject;
import org.apache.shiro.util.Factory;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

/**
 * Simple Quickstart application showing how to use Shiro's API.
 *
 * @since 0.9 RC2
 */
public class Quickstart {

    private static final transient Logger log = LoggerFactory.getLogger(Quickstart.class);

    public static void main(String[] args) {
        Factory<SecurityManager> factory = new IniSecurityManagerFactory("classpath:shiro.ini");
        SecurityManager securityManager = factory.getInstance();
        SecurityUtils.setSecurityManager(securityManager);

        // get the currently executing user:
        // 获取当前的用户对象Subject
        Subject currentUser = SecurityUtils.getSubject();

        // 通过当前用户拿到session
        Session session = currentUser.getSession();
        session.setAttribute("someKey", "aValue");
        String value = (String) session.getAttribute("someKey");
        if (value.equals("aValue")) {
            log.info("Retrieved the correct value! [" + value + "]");
        }

        // 判断当前的用户是否被认证
        if (!currentUser.isAuthenticated()) {
            //Token 令牌
            UsernamePasswordToken token = new UsernamePasswordToken("lonestarr", "vespa");
            token.setRememberMe(true); //记住我
            try {
                currentUser.login(token);//执行登录操作
            } catch (UnknownAccountException uae) {
                log.info("There is no user with username of " + token.getPrincipal());
            } catch (IncorrectCredentialsException ice) {
                log.info("Password for account " + token.getPrincipal() + " was incorrect!");
            } catch (LockedAccountException lae) {
                log.info("The account for username " + token.getPrincipal() + " is locked.  " +
                        "Please contact your administrator to unlock it.");
            }
            // ... catch more exceptions here (maybe custom ones specific to your application?
            catch (AuthenticationException ae) {
                //unexpected condition?  error?
            }
        }

        //say who they are:
        //print their identifying principal (in this case, a username):
        log.info("User [" + currentUser.getPrincipal() + "] logged in successfully.");

        //test a role:
        if (currentUser.hasRole("schwartz")) {
            log.info("May the Schwartz be with you!");
        } else {
            log.info("Hello, mere mortal.");
        }

        //粗粒度
        //test a typed permission (not instance-level)
        if (currentUser.isPermitted("lightsaber:wield")) {
            log.info("You may use a lightsaber ring.  Use it wisely.");
        } else {
            log.info("Sorry, lightsaber rings are for schwartz masters only.");
        }

        //细粒度
        //a (very powerful) Instance Level permission:
        if (currentUser.isPermitted("winnebago:drive:eagle5")) {
            log.info("You are permitted to 'drive' the winnebago with license plate (id) 'eagle5'.  " +
                    "Here are the keys - have fun!");
        } else {
            log.info("Sorry, you aren't allowed to drive the 'eagle5' winnebago!");
        }

        //注销
        //all done - log out!
        currentUser.logout();

        //结束请求
        System.exit(0);
    }
}
```
### 11.3 环境搭建（shiro-springboot）

#### 11.3.1 编写配置文件config

**1**、在刚刚的父项目中新建一个 shiro-springboot 模块；

**2**、导入 SpringBoot 和 Shiro 整合包的依赖；

```xml
<dependencies>
        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-web</artifactId>
        </dependency>

        <!-- https://mvnrepository.com/artifact/com.github.theborakompanioni/thymeleaf-extras-shiro -->
        <dependency>
            <groupId>com.github.theborakompanioni</groupId>
            <artifactId>thymeleaf-extras-shiro</artifactId>
            <version>2.1.0</version>
        </dependency>
        
        <!-- Subject用广
             SecurityManager 管理所有用户
             Realm 连接数据 -->
        <dependency>
            <groupId>com.mysql</groupId>
            <artifactId>mysql-connector-j</artifactId>
            <version>8.0.33</version>
        </dependency>

        <dependency>
            <groupId>log4j</groupId>
            <artifactId>log4j</artifactId>
            <version>1.2.7</version>
        </dependency>

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

        <!-- https://mvnrepository.com/artifact/org.mybatis.spring.boot/mybatis-spring-boot-starter -->
        <dependency>
            <groupId>org.mybatis.spring.boot</groupId>
            <artifactId>mybatis-spring-boot-starter</artifactId>
            <version>2.3.1</version>
        </dependency>

        <!-- https://mvnrepository.com/artifact/org.projectlombok/lombok -->
        <dependency>
            <groupId>org.projectlombok</groupId>
            <artifactId>lombok</artifactId>
            <version>1.18.28</version>
            <scope>provided</scope>
        </dependency>

        <!-- shiro整合spring的包 -->
        <dependency>
            <groupId>org.apache.shiro</groupId>
            <artifactId>shiro-spring</artifactId>
            <version>1.12.0</version>
        </dependency>

        <!--thymeleaf依赖-->
        <dependency>
            <groupId>org.thymeleaf</groupId>
            <artifactId>thymeleaf-spring5</artifactId>
        </dependency>
        <dependency>
            <groupId>org.thymeleaf.extras</groupId>
            <artifactId>thymeleaf-extras-java8time</artifactId>
        </dependency>

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-test</artifactId>
            <scope>test</scope>
        </dependency>
</dependencies>
```

**3**、编写自定义的 **UserRealm** ，需要继承 AuthorizingRealm

```java
package com.xing.config;

import com.xing.domain.User;
import com.xing.service.UserService;
import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.*;
import org.apache.shiro.authz.AuthorizationInfo;
import org.apache.shiro.authz.SimpleAuthorizationInfo;
import org.apache.shiro.realm.AuthorizingRealm;
import org.apache.shiro.session.Session;
import org.apache.shiro.subject.PrincipalCollection;
import org.apache.shiro.subject.Subject;
import org.springframework.beans.factory.annotation.Autowired;

//自定义的UserRealm
public class UserRealm extends AuthorizingRealm {

    @Autowired
    UserService userService;
    //授权
    @Override
    protected AuthorizationInfo doGetAuthorizationInfo(PrincipalCollection principals) {
        System.out.println("执行了=>授权doGetAuthorizationInfo");
        //授权
        SimpleAuthorizationInfo info = new SimpleAuthorizationInfo();
//        info.addStringPermission("user:add");
        //info.addStringPermission("user:update");
        //拿到当前登录的对象
        Subject subject = SecurityUtils.getSubject();
        User currentUser = (User) subject.getPrincipal();//拿到user对象
        info.addStringPermission(currentUser.getPerms());
        return info;
    }

    @Override
    protected AuthenticationInfo doGetAuthenticationInfo(AuthenticationToken authenticationToken) throws AuthenticationException {
        System.out.println("执行了=>认证doGetAuthorizationInfo");

//        // 测试1
//        //用户名 密码 临时测试数据
//        String name = "admin";
//        String password = "123456";
//
//        UsernamePasswordToken userToken = (UsernamePasswordToken) authenticationToken;
//
//        if (!userToken.getUsername().equals(name)) {
//            return null;//抛出异常 UnknownAccountException
//        }
//        return new SimpleAuthenticationInfo("",password,"");
//    }

        UsernamePasswordToken userToken = (UsernamePasswordToken) authenticationToken;
        //连接真实的数据库
        User user = userService.queryUserByName(userToken.getUsername());
        if (user == null) {
            return null;//没有这个人
        }

        Subject currentSubject = SecurityUtils.getSubject();
        Session session = currentSubject.getSession();
        session.setAttribute("loginUser",user);

        // 可以加密MD5、MD5盐值加密
        // 密码认证，shiro做
        return new SimpleAuthenticationInfo(user,user.getPwd(), "");
    }
}
```

**4**、新建一个 **ShiroConfig** 配置文件；

```java
package com.xing.config;

import at.pollux.thymeleaf.shiro.dialect.ShiroDialect;
import org.apache.shiro.spring.web.ShiroFilterFactoryBean;
import org.apache.shiro.web.mgt.DefaultWebSecurityManager;
import org.apache.shiro.web.session.mgt.DefaultWebSessionManager;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;

import java.util.LinkedHashMap;
import java.util.Map;

@Configuration
public class ShiroConfig {
    /**
     * 下面是编写配置文件
     * Shiro 三大要素：
     * subject -> ShiroFilterFactoryBean
     * securityManager -> DefaultWebSecurityManager
     * realm -> UserRealm
     * 实际操作中对象创建的顺序 ： realm -> securityManager -> subject
     */
    //ShiroFilterFactoryBean：3
    @Bean
    public ShiroFilterFactoryBean getShiroFilterFactoryBean(@Qualifier("securityManager") DefaultWebSecurityManager defaultWebSecurityManager) {
        ShiroFilterFactoryBean bean = new ShiroFilterFactoryBean();
        //设置安全管理器
        bean.setSecurityManager(defaultWebSecurityManager);
        //添加 Shiro 的内置过滤器
        /* anon : 无需认证，就可以访问
           authc : 必须认证，才能访问
           user : 必须拥有 “记住我”功能才能用
           perms : 拥有对某个资源的权限才能访问
           role : 拥有某个角色权限才能访问  */
        // 拦截
        Map<String, String> filterMap = new LinkedHashMap<>();
        filterMap.put("/user/add", "authc");//↓↓
        filterMap.put("/user/update", "authc");//↓↓
        //filterMap.put("/user/*", "authc");//通配符 效果一样↑↑
        //登陆后授权，正常情况下没有授权会跳转到未授权页面
        filterMap.put("/user/add","perms[user:add]");
        filterMap.put("/user/update","perms[user:update]");

        bean.setFilterChainDefinitionMap(filterMap);
        //设置登录请求函数
        bean.setLoginUrl("/toLogin");
        //未授权页面
        bean.setUnauthorizedUrl("/noauth");
        return bean;

    }

    //DefaultWebSecurityManager：2
    @Bean(name = "securityManager")
    public DefaultWebSecurityManager getDefaultWebSecurityManager(@Qualifier("userRealm") UserRealm userRealm) {
        DefaultWebSecurityManager securityManager = new DefaultWebSecurityManager();
        securityManager.setRealm(userRealm);
        return securityManager;
    }

    //创建realm对象，需要自定义类：1
    @Bean //(name = "userRealm") 使用此方法 效果相同看↑↑↑例子
    public UserRealm userRealm() {
        return new UserRealm();
    }

    // 整合ShiroDialect：用来整合shiro-thymeleaf
    @Bean
    public ShiroDialect getShiroDialect() {
        return new ShiroDialect();
    }
}
```

#### 11.3.2 搭建前端页面templates

**1**、新建首页index.html；

```html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org"
      xmlns:shiro="http://www.thymeleaf.org/thymeleaf-extras-shiro">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<h1>首页</h1>
<!-- 从session中判断值！ -->
<div th:if="${session.loginUser==null}">
    <a th:href="@{/toLogin}">登录</a>
</div>

<p th:text="${msg}"></p>
<hr>
<div shiro:hasPermission="user:add">
    <a th:href="@{/user/add}">Add</a>
</div>
<div shiro:hasPermission="user:update">
  <a th:href="@{/user/update}">Update</a>
</div>
<!-- 注销 -->
<br/>
<div>
    <a class="item" th:href="@{/logout}">
        <button onclick="logout()">注销</button>
    </a>
</div>
</body>
</html>
```

**2**、新建登录页面login.html；

```html
<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
  <meta charset="UTF-8">
  <title>登录页面</title>
</head>
<body>
<h1>登录</h1>
<hr>
<p th:text="${msg}" style="color: red;"></p>
<form th:action="@{/login}">
  <p>用户名：<input type="text" name="username"></p>
  <p>密码：<input type="text" name="password"></p>
  <p><input type="submit" value="提交">&nbsp
     <input type="reset">&nbsp
     <input type="button" value="返回" onclick="window.location.href='index'"></p>
</form>
</body>
</html>
```

**3**、新建add页面；

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Add</title>
</head>
<body>
<h1>add</h1>
</body>
</html>
```

**4**、新建update页面；

```html
<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Update</title>
</head>
<body>
<h1>update</h1>
</body>
</html>
```

#### 11.3.3 编写controller

```java
package com.xing.controller;

import org.apache.shiro.SecurityUtils;
import org.apache.shiro.authc.IncorrectCredentialsException;
import org.apache.shiro.authc.UnknownAccountException;
import org.apache.shiro.authc.UsernamePasswordToken;
import org.apache.shiro.subject.Subject;
import org.springframework.stereotype.Controller;
import org.springframework.ui.Model;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class MyController {

    @RequestMapping({"/","index"})
    public String index(Model model) {
        model.addAttribute("msg", "Hello Shiro!");
        return "index";
    }

    @RequestMapping("/user/add")
    public String add() {
        return "user/add";
    }

    @RequestMapping("/user/update")
    public String update() {
        return "user/update";
    }

    @RequestMapping("/toLogin")
    public String toLogin() {
        return "login";
    }

    @RequestMapping("login")
    public String login(String username, String password, Model model) {
        //获取当前的用户
        Subject subject = SecurityUtils.getSubject();
        //封装用户的登录数据
        UsernamePasswordToken token = new UsernamePasswordToken(username, password);
        try {
            subject.login(token);//执行登录的方法，如果没有异常就说明ok了
            return "index";
        } catch (UnknownAccountException e) {//用户名不存在
            model.addAttribute("msg","用户名错误!");
            return "login";
        } catch (IncorrectCredentialsException e) {//密码不存在
            model.addAttribute("msg","密码错误!");
            return "login";
        }
    }

    @RequestMapping("/noauth")
    @ResponseBody
    public String noAuth() {
        return "未经授权，无法访问此页面!";
    }

    //注销登录
    @RequestMapping("/logout")
    public String logout() {
        // 获取当前已登录的Subject
        Subject currentUser = SecurityUtils.getSubject();
        // 执行注销操作
        currentUser.logout();
        // 重定向到登录页面
        return "redirect:toLogin";
    }
}
```

#### 11.3.4 编写domain

```java
package com.xing.domain;

import lombok.AllArgsConstructor;
import lombok.Data;
import lombok.NoArgsConstructor;

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {
    private int id;
    private String name;
    private String pwd;
    private String perms;
}
```

#### 11.3.5 编写mapper

```java
package com.xing.mapper;

import com.xing.domain.User;
import org.apache.ibatis.annotations.Mapper;
import org.springframework.stereotype.Repository;

@Repository
@Mapper
public interface UserMapper {
    public User queryUserByName(String name);
}
```

#### 11.3.6 编写mapper.xml

```java
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper
        PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
        "http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<mapper namespace="com.xing.mapper.UserMapper">
    <select id="queryUserByName" parameterType="String" resultType="User">
        select * from user where name = #{name};
    </select>
</mapper>
```

#### 11.3.7 编写service

```java
package com.xing.service;

import com.xing.domain.User;

public interface UserService {
    public User queryUserByName(String name);
}
```

#### 11.3.8 编写ServiceImpl

```java
package com.xing.service.impl;

import com.xing.domain.User;
import com.xing.mapper.UserMapper;
import com.xing.service.UserService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class UserServiceImpl implements UserService {

    @Autowired
    UserMapper userMapper;

    @Override
    public User queryUserByName(String name) {
        return userMapper.queryUserByName(name);
    }
}
```

#### 11.3.9 编写application.yml配置

```yaml
spring:
  datasource:
    driver-class-name: com.mysql.cj.jdbc.Driver
    # ?serverTimezone=UTC解决时区的报错
    url: jdbc:mysql://localhost:3306/db_mybatis?useSSL=false&useUnicode=true&characterEncoding=utf-8
    username: wan
    password: 101101
    type: com.alibaba.druid.pool.DruidDataSource # 自定义数据源
    #Spring Boot 默认是不注入这些属性值的，需要自己绑定
    #druid 数据源专有配置
    initialSize: 5
    minIdle: 5
    maxActive: 20
    maxWait: 60000
    timeBetweenEvictionRunsMillis: 60000
    minEvictableIdleTimeMillis: 300000
    validationQuery: SELECT 1 FROM DUAL
    testWhileIdle: true
    testOnBorrow: false
    testOnReturn: false
    poolPreparedStatements: true
    #配置监控统计拦截的filters，stat:监控统计、log4j：日志记录、wall：防御sql注入
    #如果允许时报错 java.lang.ClassNotFoundException: org.apache.log4j.Priority
    #则导入 log4j 依赖即可，Maven 地址：https://mvnrepository.com/artifact/log4j/log4j
    filters: stat,wall,log4j
    maxPoolPreparedStatementPerConnectionSize: 20
    useGlobalDataSourceStat: true
    connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=500
mybatis:
  type-aliases-package: com.xing.domain
  mapper-locations: classpath:mapper/*.xml
```

#### 11.3.10 编写测试类

```java
package com.xing;

import com.xing.service.impl.UserServiceImpl;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class ShiroSpringbootApplicationTests {

    @Autowired
    UserServiceImpl userService;

    @Test
    void contextLoads() {
        System.out.println(userService.queryUserByName("aaa"));
    }
}
```

#### 11.3.11 测试

测试地址：http://localhost:8080

### @学不可以已 springboot-07-shiro 已完结。

springboot-07-shiro  模块中 （IDEA创建springboot项目+整合shiro+认证授权+权限控制和注销） 。

## 12、springboot整合Swagger（springboot-08-swagger）

### 12.1 Swagger入门

**前言：**

Swagger 是一套基于 OpenAPI 规范构建的开源工具，使用 RestApi 1.0 规范定义接口文档，用于生成、描述、调用和可视化 RESTful 风格的 Web 服务的接口文档。目前的项目基本都是前后端分离，后端为前端提供接口的同时，还需同时提供接口的说明文档。Swagger 可以让开发者通过简单的注释来定义接口文档，通过 Swagger UI 来可视化展示接口文档，方便开发者调试接口。 Swagger UI 可以让开发者通过简单的界面输入参数，调用接口，实时查看返回结果，大大提高了开发效率。

**前后端分离**  Vue + SpringBoot

**后端时代**：前端只用管理静态页面；html==>后台。模板引擎JSP=>后端是主力

**前后端分离时代:**

- 后端：后端控制层，服务层，数据访问层；

- 前端：前端控制层，视图层[前端团队]；

- 伪造后端数据，json.已经存在了，不需要后端，前端工程依旧能跑起来；

- 前端后台如何交互? ==> API；

- 前后端相对独立，松耦合；

- 前后端甚至可以部署在不同的服务器上；

- **产生一个问题**

- 前后端集成联调，前端人员和后端人员无法做到“即使协商，尽早解决"，最终导致问题集中爆发；

  **解决方案:**

- 首先指定schema[计划的提纲]，实时跟新最新的API，降低集成的风险；

- 早些年：指定Word计划文档；

- 前后端分离：

  - 早些年前端测试接口使用：postman工具
  - 后端提供接口，需要实时更新最新的消息及改动！

**Swagger**

- 号称世界上最流行的Api框架；

- RestFul Api 文档在线自动生成工具=>Api文档与API定义同步更新

- 直接运行，可以在线测试API接口；

- 支持多种语言： java，php，等等

- Swagger官网：https://swagger.io

  **在项目使用Swagger需要两个jar包:**

- swagger2；

- ui(这里是swagger的ui界面的包)；

- Swagger简介...

### 12.2 SpringBoot 集成 Swagger

**1**、创建编写一个SpringBoot的web项目；

**2**、在项目中导入Swagger相关依赖；

SpringBoot集成Swagger => springfox，两个jar包；

Springfox-swagger2 和 swagger-springmvc。

**使用Swagger**

**要求：jdk 1.8 + 否则 swagger2 无法运行**  
**spring.mvc.pathmatch.matching-strategy=ant_path_matcher** springboot2.6以上需要加入这个配置

```xml
<!-- 注意如果你用的是3.0.0版本的可能会有404的bug -->
        <!--  Swagger2jar包 -->
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger2 -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger2</artifactId>
            <version>3.0.0</version>
        </dependency>
        <!--SwaggerUi jar包-->
        <!-- https://mvnrepository.com/artifact/io.springfox/springfox-swagger-ui -->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-swagger-ui</artifactId>
            <version>3.0.0</version>
        </dependency>
        <!--Unable to infer base url.xxx...Please enter the location manually: 解决-->
        <dependency>
            <groupId>io.springfox</groupId>
            <artifactId>springfox-boot-starter</artifactId>
            <version>3.0.0</version>
        </dependency>
```

**3**、编写一个Hello工程；

```java
@RestController
public class HelloController {
    @RequestMapping(value = "/hello")
    public String hello(){
        return "Hello Swagger!";
    }
```

**4**、因为 swagger 是单独的所以需要我们进行配置；

```java
package com.xing.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.Order;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.ArrayList;

@Configuration
public class SwaggerConfig {
    /**
     * 添加资源处理程序
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 解决静态资源无法访问
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
        // 解决swagger无法访问
        registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        // 解决swagger的js文件无法访问
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
    @Bean
    public Docket docketA(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("A同学");
    }
    @Bean
    public Docket docketB(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("B同学");
    }
    @Bean
    public Docket docketC(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C同学");
    }
```

因为Swagger是一个单独的包并没有被整合!

**5**、进行测试访问http://localhost:8080/swagger-ui/index.html 注意端口号！

### 12.3 配置 SwaggerConfig

```java
package com.xing.config;

import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.annotation.Order;
import org.springframework.core.env.Environment;
import org.springframework.core.env.Profiles;
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
import springfox.documentation.builders.RequestHandlerSelectors;
import springfox.documentation.service.ApiInfo;
import springfox.documentation.service.Contact;
import springfox.documentation.spi.DocumentationType;
import springfox.documentation.spring.web.plugins.Docket;

import java.util.ArrayList;

@Configuration
public class SwaggerConfig {
    /**
     * 添加资源处理程序
     * @param registry
     */
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 解决静态资源无法访问
        registry.addResourceHandler("/**").addResourceLocations("classpath:/static/");
        // 解决swagger无法访问
        registry.addResourceHandler("/swagger-ui.html").addResourceLocations("classpath:/META-INF/resources/");
        // 解决swagger的js文件无法访问
        registry.addResourceHandler("/webjars/**").addResourceLocations("classpath:/META-INF/resources/webjars/");
    }
    @Bean
    public Docket docketA(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("A同学");
    }
    @Bean
    public Docket docketB(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("B同学");
    }
    @Bean
    public Docket docketC(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C同学");
    }

    // 配置了Swagger的Docket的bean实例
    @Bean
    public Docket docket(Environment environment) {
        // 设置需要显示的 Swagger 环境
        // Swagger环境这里没有添加 proda 这个环境，那么使用proda配置时下面定义的wzx这个分组名称不会映射到swagger-UI文档上面
        Profiles profiles = Profiles.of("dev","prod","test","deva");
        // 通过 environment.acceptsProfiles(profiles) 判断是否处在自己设定的环境当中 获取项目环境
        boolean b = environment.acceptsProfiles(profiles); //在enable关联测试 使用dev 和 prod 测试
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("wzx") //分组名称 default
                .enable(b) //enable是否启动Swagger，如果为False，则Swagger不能再浏览器中访问 false
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xing.controller"))
                //.paths(PathSelectors.ant("/xing/**")) //过滤
                .build();
              /** RequestHandlerSelectors 配置需要扫描接口的方式
                * basePackage()： 指定需要扫描的包
                * any(): 扫描全部
                * none(): 不扫描
                * withClassAnnotation(例如：RestController.class): 扫描类上的注解，参数是一个注解的反射对象
                * withMethodAnnotation(): 扫描方法上的注解  */
    }
    // 配置Swagger的ApiInfo信息
    private ApiInfo apiInfo() {
        Contact contact = new Contact("我的博客","https://weibo.com/u/5360827707","13629664531@163.com");
        return new ApiInfo(
                "我的API文档",
                "这是系统后端的API文档",
                "1.0",
                "https://weibo.com/u/5360827707",
                contact,
                "My Apache 2.0 Test",
                "http://localhost:8081/hello",
                new ArrayList());
    }
}
```

### 12.4 配置扫描接口与过滤

接口扫描:

- Docket.select()
- **过滤:** paths() 过滤

```java
// 配置了Swagger的Docket的bean实例
    @Bean
    public Docket docket(Environment environment) {
        // 设置需要显示的 Swagger 环境
        Profiles profiles = Profiles.of("dev","prod","test");
        // 通过 environment.acceptsProfiles(profiles) 判断是否处在自己设定的环境当中 获取项目环境
        boolean b = environment.acceptsProfiles(profiles); //在enable关联测试 使用dev 和 prod 测试
        return new Docket(DocumentationType.SWAGGER_2)
                .apiInfo(apiInfo())
                .groupName("wzx") //分组名称 default
                .enable(b) //enable是否启动Swagger，如果为False，则Swagger不能再浏览器中访问 false
                .select()
                .apis(RequestHandlerSelectors.basePackage("com.xing.controller"))
                //.paths(PathSelectors.ant("/xing/**")) //过滤
                .build();
    }
```

**关闭Swagger** enable(false)

```java
.enable(false) //关闭Swagger
```

**小练习：希望在生产环境中使用，不希望在正式环境中使用**

- 判断是不是生产环境；
- 注入enable()；
- 通过 environment.acceptsProfiles(profiles) 判断是否处在自己设定的环境当中 获取项目环境。

**Swagger** 分组测试

```java
    @Bean
    public Docket docketA(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("A同学");
    }
    @Bean
    public Docket docketB(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("B同学");
    }
    @Bean
    public Docket docketC(){
        return new Docket(DocumentationType.SWAGGER_2).groupName("C同学");
    }
```

### 12.5 实体配置 Swagger 注释

**1**、新建一个 User 实体类；

```java
// @Api（用户实体类注释）
@ApiModel("用户实体类")
public class User {
    @ApiModelProperty("用户名")
    public String username;
    @ApiModelProperty("密码")
    public String password;
}
```

**2**、只要这个实体在请求接口的返回值上（即使是泛型），都能映射到实体项中：

**3**、重启测试 查看 swagger 中 Models

注：并不是因为[@ApiModel](https://github.com/ApiModel)这个注解让实体显示在这里了，而是只要出现在接口方法的返回值上的实体都会显示在这里，而[@ApiModel](https://github.com/ApiModel)和[@ApiModelProperty](https://github.com/ApiModelProperty)这两个注解只是为实体添加注释的。

[@ApiModel ](https://github.com/ApiModel)为类添加注释

[@ApiModelProperty](https://github.com/ApiModelProperty) 为类属性添加注释

### 12.6 配置 yaml

**application.yml、application-dev.yml和application-prod.yml** 也可以分开写，外层使用**8081和8082** 测试。

```java
# application.yml
spring:
  mvc:
    pathmatch:
      matching-strategy: ant_path_matcher
  profiles:
    active: dev #选择要激活那个环境块
---
# application-dev.yml
server:
  port: 8083
# 关闭swagger
springfox:
  documentation:
    swagger-ui:
      enabled: true # false 关闭
spring:
  config:
    activate:
      on-profile: deva #配置环境的名称
---
# application-prod.yml
server:
  port: 8084
spring:
  config:
    activate:
      on-profile: proda #配置环境的名称

```

### 12.7 编写控制器类HelloController

```java
package com.xing.controller;

import com.xing.domain.User;
import io.swagger.annotations.ApiOperation;
import io.swagger.annotations.ApiParam;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

@RestController
public class HelloController {
    @RequestMapping(value = "/hello")
    public String hello(){
        return "Hello Swagger!";
    }

    // 只要接口 的返回值中存在实体类，就会被扫描到swagger中
    @PostMapping(value = "/user")
    public User helloA(){
        return new User();
    }

    // Operation接口 不是放在类上 是方法上
    @ApiOperation("Hello控制类")
    @GetMapping(value = "/helloT")
    public String helloC(@ApiParam("用户名") String username){
        return "hello"+username;
    }

    // Operation接口 不是放在类上 是方法上
    @ApiOperation("Post测试类")
    @PostMapping(value = "/helloTest")
    public String helloD(@ApiParam("用户名") User user){
        int i = 5/0;
        return "hello"+user;
    }
}
```

### 12.8 进行测试

**1**、controller可用性测试地址：http://localhost:8081/hello

**2**、swagger测试地址：http://localhost:8081/swagger-ui/index.html

![](D:\2023\Java\SpringBoot\springboot-study\img\14.png)

**注意**：如果接口请求方法为@RequestMapping，没有指定为Get、Post、Put或Delete，swagger文档就会默认生成GET、HEAD、POST、PUT、DELETE、OPTIONS、PATCH这七个接口文档。

### 12.9 常用注解

Swagger的所有注解定义在io.swagger.annotations包下：

下面列一些经常用到的，未列举出来的可以另行查阅说明：
[@Api](https://github.com/Api)(tags = “xxx模块说明”) 作用在模块类上
[@ApiOperation](https://github.com/ApiOperation)(“xxx接口说明”) 作用在接口方法上
[@ApiModel](https://github.com/ApiModel)(“xxxPOJO说明”) 作用在模型类上：如VO、BO
[@ApiModelProperty](https://github.com/ApiModelProperty)(value = “xxx属性说明”，hidden = true) 作用在类方法和属性上，hidden设置为true可以隐藏该属性
[@ApiParam](https://github.com/ApiParam)(“xxx参数说明”) 作用在参数、方法和字段上，类似[@ApiModelProperty](https://github.com/ApiModelProperty)

```Java
// Operation接口 不是放在类上 是方法上
@ApiOperation("HelloT接口")
@GetMapping(value = "/helloT")
public String helloC(@ApiParam("这个用户名会被返回") String username){
    return "hello"+username;
}
```

这样的话，可以给一些比较难理解的属性或者接口，增加一些配置信息，让人更容易阅读！

相较于传统的Postman或Curl方式测试接口，使用swagger简直就是傻瓜式操作，不需要额外说明文档(写得好本身就是文档)而且更不容易出错，只需要录入数据然后点击Execute，如果再配合自动化框架，可以说基本就不需要人为操作了。

Swagger是个优秀的工具，现在国内已经有很多的中小型互联网公司都在使用它，相较于传统的要先出Word接口文档再测试的方式，显然这样也更符合现在的快速迭代开发行情。

### 12.10 Swagger总结

**1**、我们可以通过Swagger给一些比较难理解的属性或者接口增加注释信息；
**2**、接口文档实时更新；
**3**、 可以在线测试；
**4**、Swagger是一个优秀的工具，几乎所有大公司都有使用它，缺点：RAM占用高 ;

Swagger 的一个最大的优点是能实时同步 API 与文档。在项目开发过程中，发生过多次：修改代码但是没有更新文档，前端还是按照老旧的文档进行开发……

关闭Swagger方法：

```yaml
# 在指定使用的数据源环境下false关闭
# 关闭swagger
springfox:
  documentation:
    swagger-ui:
      enabled: true # false 关闭
```

【注意点】在正式发布的时候，关闭Swagger! ! ! 出于安全考虑。而且节省运行的内存。

### @学不可以已 springboot-08-swagger 已完结。

springboot-08-swagger  模块中 （IDEA创建springboot项目+集成swagger+测试使用） 。

## 13、springboot异步、定时、邮件任务（springboot-09-async）

**前言：**

在我们的工作中，常常会用到异步处理任务，比如我们在网站上发送邮件，后台会去发送邮件，此时前台会造成响应不动，直到邮件发送完毕，响应才会成功，所以我们一般会采用多线程的方式去处理这些任务。还有一些定时任务，比如需要在每天凌晨的时候，分析一次前一天的日志信息。还有就是邮件的发送，微信的前身也是邮件服务呢？这些东西都是怎么实现的呢？其实SpringBoot都给我们提供了对应的支持，我们上手使用十分的简单，只需要开启一些注解支持，配置一些配置文件即可！

### 13.1 异步任务

**1**、创建一个Service包；创建一个类AsyncService；

异步处理还是非常常用的，比如我们在网站上发送邮件，后台会去发送邮件，此时前台会造成响应不动，直到邮件发送完毕，响应才会成功，所以我们一般会采用多线程的方式去处理这些任务。

编写方法，假装正在处理数据，使用线程设置一些延时，模拟同步等待的情况；

```java
@Service
public class AsyncService {
    public void hello() {
        try {
            Thread.sleep(3000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println("数据正在处理...");
    }
}
```

**2**、编写controller包；编写AsyncController类；写一个Controller测试一下

```java
@RestController
public class AsyncController {
    @Autowired
    AsyncService asyncService;

    @RequestMapping("/hello")
    public String hello() {
        asyncService.hello(); // 停止3秒
        return "Hello Async！";
    }
}
```

**3**、访问http://localhost:8080/hello 进行测试；

发现它转了3秒后...浏览器才收到“Hello Async！”；

控制台也是3秒后...才出现“数据正在处理...”；

这是同步等待的情况。

**问题**：我们如果想让用户直接得到消息，就在后台使用多线程的方式进行处理即可，但是每次都需要自己手动去编写多线程的实现的话，太麻烦了，我们只需要用一个简单的办法，在我们的方法上加一个简单的注解即可，如下；

**4**、给hello方法添加@Async注解；

```java
@Service
public class AsyncService {
    //告诉Spring这个一个异步的方法
    @Async
    public void hello() {
        try {
            Thread.sleep(3000);
        } catch (InterruptedException e) {
            e.printStackTrace();
        }
        System.out.println("数据正在处理...");
    }
}
```

**5**、SpringBoot就会自己开一个线程池，进行调用！但是要让这个注解生效，我们还需要在主程序上添加一个注解@EnableAsync ，开启异步注解功能；

```java
@EnableAsync    //开启异步注解功能
@SpringBootApplication
public class Springboot09AsyncApplication {

    public static void main(String[] args) {
        SpringApplication.run(Springboot09AsyncApplication.class, args);
        System.out.println("http://localhost:8080/hello");
    }
}
```

**6**、访问http://localhost:8080/hello 进行测试；

发现浏览器瞬间响应收到“Hello Async！”；

后台代码依旧执行，控制台是3秒后...才出现“数据正在处理...”；

这是异步等待的情况。

### 13.2 定时任务

项目开发中经常需要执行一些定时任务，比如需要在每天凌晨的时候，分析一次前一天的日志信息，Spring为我们提供了异步执行任务调度的方式，提供了两个接口。

- TaskExecutor接口
- TaskScheduler接口

两个注解：

- @Scheduled
- @EnableScheduling

**测试步骤：**

**1**、创建一个ScheduledService类；

我们里面存在一个hello方法和一个helloA方法，他需要定时执行，怎么处理呢？

```java
@Service
public class ScheduledService {
    //在@Scheduled 一个特定的时间执行这个方法 Timer
    //cron 表述式
    //秒 分 时 日 月 天 多一位就是后面的一位
    
    //0点 31分 56秒 执行
    @Scheduled(cron = "56 31 0 * * ?")
    public void hello(){
        System.out.println("hello，你被执行了~");
    }

    //表示每2秒 执行任务
    @Scheduled(cron = "0/2 * * * * ?")
    public void helloA(){
        System.out.println("每两秒，执行一次~");
    }
}
```

**2**、这里写完定时任务之后，我们需要在主程序上增加@EnableScheduling 开启定时任务功能；

```java
@EnableScheduling //开启定时功能的注解
@SpringBootApplication
public class Springboot09AsyncApplication {

    public static void main(String[] args) {
        SpringApplication.run(Springboot09AsyncApplication.class, args);
        System.out.println("http://localhost:8080/hello");
    }
}
```

**3**、启动程序进行测试，查看控制台；

后台代码到每天0点31分56秒 **执行hello(）方法** 任务 “hello，你被执行了~”；

后台代码每2秒 **执行helloA(）方法** 任务 “每两秒，执行一次~”；

**这就是定时任务。**

**4、cron表达式：**

可以到BEJSON查看学习：https://www.bejson.com/othertools/cron

```java
# 功能介绍
# 常用的表达式例子
（1）0/2 * * * * ?   表示每2秒 执行任务
（1）0 0/2 * * * ?   表示每2分钟 执行任务
（1）0 0 2 1 * ?     表示在每月的1日的凌晨2点调整任务
（2）0 15 10 ? *     MON-FRI 表示周一到周五每天上午10:15执行作业
（3）0 15 10 ? 6L 2002-2006   表示2002-2006年的每个月的最后一个星期五上午10:15执行作
（4）0 0 10,14,16 * * ?  每天上午10点，下午2点，4点
（5）0 0/30 9-17 * * ?   朝九晚五工作时间内每半小时
（6）0 0 12 ? * WED      表示每个星期三中午12点
（7）0 0 12 * * ?        每天中午12点触发
（8）0 15 10 ? * *       每天上午10:15触发
（9）0 15 10 * * ?       每天上午10:15触发
（10）0 15 10 * * ?      每天上午10:15触发
（11）0 15 10 * * ? 2005 2005年的每天上午10:15触发
（12）0 * 14 * * ?       在每天下午2点到下午2:59期间的每1分钟触发
（13）0 0/5 14 * * ?     在每天下午2点到下午2:55期间的每5分钟触发
（14）0 0/5 14,18 * * ?  在每天下午2点到2:55期间和下午6点到6:55期间的每5分钟触发
（15）0 0-5 14 * * ?     在每天下午2点到下午2:05期间的每1分钟触发
（16）0 10,44 14 ? 3     WED 每年三月的星期三的下午2:10和2:44触发
（17）0 15 10 ? *     MON-FRI 周一至周五的上午10:15触发
（18）0 15 10 15 * ?  每月15日上午10:15触发
（19）0 15 10 L * ?   每月最后一日的上午10:15触发
（20）0 15 10 ? * 6L  每月的最后一个星期五上午10:15触发
（21）0 15 10 ? * 6L 2002-2005 2002年至2005年的每月的最后一个星期五上午10:15触发
（22）0 15 10 ? * 6#3 每月的第三个星期五上午10:15触发
```

### 13.3 邮件任务

邮件发送，在我们的日常开发中，也非常的多，Springboot也帮我们做了支持。

- 邮件发送需要引入spring-boot-start-mail；
- SpringBoot 自动配置MailSenderAutoConfiguration；
- 定义MailProperties内容，配置在application.yml中；
- 自动装配JavaMailSender；
- 测试邮件发送。

**测试：**

**1**、引入pom依赖；

```xml
<!-- mail -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-mail</artifactId>
</dependency>
```

看它引入的依赖，可以看到 jakarta.mail jar包；

`org.eclipse.angus:jakarta.mail:1.0.0`

**2**、查看自动配置类：MailSenderAutoConfiguration；

MailSenderAutoConfiguration.class 这个类中没有注册bean，看一下它导入的其他类；

JavaMailSenderImpl 这个类中存在bean；

然后我们去看下配置文件 MailProperties；

```java
@ConfigurationProperties(
    prefix = "spring.mail"
)
public class MailProperties {
    private static final Charset DEFAULT_CHARSET;
    private String host;
    private Integer port;
    private String username;
    private String password;
    private String protocol = "smtp";
    private Charset defaultEncoding;
    private final Map<String, String> properties;
    private String jndiName;
    ...
```

**3**、配置文件：application.yml；

```yaml
spring:
  mail:
    username: 1911722961@qq.com
    password: vtrpsjwuuvrtihia #授权码
    host: smtp.qq.com
    # qq需要配置ssl
    properties:
      mail:
        smtp:
          ssl:
            enable: true
```

**获取授权码**：在QQ邮箱中的设置->账户->开启pop3和smtp服务 开启和关闭。

**4**、Spring单元测试。

```java
@SpringBootTest
class Springboot09AsyncApplicationTests {

    @Autowired
    JavaMailSenderImpl mailSender;

    @Test
    void contextLoads() {
        //一个简单的邮件
        SimpleMailMessage mailMessage = new SimpleMailMessage();
        mailMessage.setSubject("通知-今晚大家吃饭!");
        mailMessage.setText("地址在瓦罗兰大陆!");
        mailMessage.setTo("13629664531@163.com");
        mailMessage.setFrom("1911722961@qq.com");
        mailSender.send(mailMessage);
    }

    @Test
    void contextLoads2() throws MessagingException {
        //一个复杂的邮件
        MimeMessage mimeMessage = mailSender.createMimeMessage();
        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage,true);
        //正文
        helper.setSubject("通知-下班别走!");
        //组装
        helper.setText("<p style='color:red'>大家集齐开会！</p>",true);
        //附件
        helper.addAttachment("1.jpg",new File("C:\\Users\\Asus\\Desktop\\1.jpg"));

        helper.setTo("13629664531@163.com");
        helper.setFrom("1911722961@qq.com");
        mailSender.send(mimeMessage);
    }

//    //封装为方法
//    public void sendComplexMail(Boolean html,String to, String from, String subject, String text, File attachment) throws MessagingException {
//        //一个复杂的邮件
//        MimeMessage mimeMessage = mailSender.createMimeMessage();
//        //组装
//        MimeMessageHelper helper = new MimeMessageHelper(mimeMessage,html);
//        //正文
//        helper.setSubject(subject);
//        helper.setText(text, true);
//        //附件
//        helper.addAttachment("1.jpg", attachment);
//
//        helper.setTo(to);
//        helper.setFrom(from);
//        mailSender.send(mimeMessage);
//    }

}
```

启动测试程序，查看邮箱，邮件接收成功！

只需要使用Thymeleaf或Vue进行前后端结合即可开发自己网站邮件收发功能了！

### @学不可以已 springboot-09-async 已完结。

springboot-09-async  模块中 （IDEA创建springboot项目+异步任务+定时任务+邮件任务） 。

## 14、springboot整合Redis（springboot-10-redis）

### 14.1 Redis概述

Redis是一种开源的、支持网络的、可基于内存亦可持久化的日志型、Key-Value数据库。它使用ANSI C语言编写，提供多种语言的API，可以用于存储和检索数据，以及实现缓存和队列等功能。 

Redis的数据存储在内存中，因此存取速度非常快。同时，Redis还支持持久化操作，可以将数据保存到磁盘上，以防止断电等意外情况导致数据丢失。 

Redis支持多种数据类型，包括字符串、哈希表、列表、集合和有序集合等。它还支持事务、Lua脚本、发布/订阅机制等高级功能。 

Redis广泛应用于各种场景，如缓存、队列、分布式计算、实时数据处理等。它可以与其他数据库系统（如MySQL）结合使用，以提高系统的性能和可靠性。

#### 14.1.1 SpringData

SpringBoot操作数据：spring-data jpa jdbc mongodb redis ! 

SpringData也是和SpringBoot齐名的项目!  

SpringBoot 操作数据都是使用 ——SpringData，以下是 Spring 官网中描述的 SpringData 可以整合的数据源

**官网地址**：https://spring.io/projects/spring-data

可以看到 Spring Data Redis。

#### 14.1.2 lettuce

在 SpringBoot 2.X 之后，原来的 Jedis 被替换为了 lettuce

可点击pom中spring-boot-starter-data-redis查看到 lettuce-core。

**Jedis 和 lettuce 区别**：

**Jedis** ：采用的是直连的服务，如果有多个线程操作的话是不安全的，就需要使用 Jedis Pool 连接池取解决。问题就会比较多。

**lettuce** ：底层采用 Netty ，实例可以在多个线程中共享，不存在线程不安全的情况。可以减少线程数据了，性能更高。

**源码分析**：RedisAutoConfiguration

```java
 @Bean
    @ConditionalOnMissingBean(name = {"redisTemplate"}) //我们可以自定义一个redisTemplate来替换这个默认的！
    @ConditionalOnSingleCandidate(RedisConnectionFactory.class)
    public RedisTemplate<Object, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) {
        //默认的RedisTemplate没有过多的设置，redis对象都是需要序列化!
        //两个泛型都是 object，object的类型，我们后使用需要强制转换<String,Object>
        RedisTemplate<Object, Object> template = new RedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        return template;
    }

    @Bean
    @ConditionalOnMissingBean  //由于String是redis中最常使用的类型，所以说单独提出来了一个bean！
    @ConditionalOnSingleCandidate(RedisConnectionFactory.class)
    public StringRedisTemplate stringRedisTemplate(RedisConnectionFactory redisConnectionFactory) {
        return new StringRedisTemplate(redisConnectionFactory);
    }
```

### 14.2 查看源码

#### 2.1 自动配置

**1**、点进 RedisAutoConfiguration；

可以得出配置 Redis，只需要配置 RedisAutoConfiguration 即可

@EnableConfigurationProperties({RedisProperties.class})

**2**、在 RedisAutoConfiguration点进 RedisProperties；

![](D:\2023\Java\SpringBoot\springboot-study\img\15.png)

**3**、回到 RedisAutoConfiguration，观察它做了什么

![](D:\2023\Java\SpringBoot\springboot-study\img\16.png)

#### 2.2 Jedis.pool 不生效

**1**、在 RedisAutoConfiguration 类中的 RedisTemplate 方法需要传递一个 点进RedisConnectionFactory 参数。点进这个参数，这是一个结构，查看实现类

**2**、查看 Jedis 的实现类，下载源码
JedisConnectionFactory，会发现 ，这个类中很多没有实现的地方。所以 Jedis Pool 不可用。

**3**、查看 Lettuce 的实现类
LettuceConnectionFactory类，没有问题。

- 这也说明 SpringBoot 更推荐使用 Lettuce。

### 14.3 测试使用

#### 14.3.1 新建项目

新建一个 SpringBoot 项目，勾选上以下

![](D:\2023\Java\SpringBoot\springboot-study\img\17.png)

#### 14.3.2 引入依赖

```xml
<!-- 操作redis -->
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
```

#### 14.3.3 配置连接application.yml

```yaml
# SpringBoot所有的配置类，都有一个自动配置类 RedisAutoConfiguration
# 自动配置类都会绑定一个properties 配置文件  RedisProperties
# Redis配置 配置 Redis
spring:
  data:
    redis:
      host: 127.0.0.1  #官方推荐localhost
      port: 6379
```

#### 14.3.4 测试类

```java
@SpringBootTest
class Springboot10RedisApplicationTests {

    // 这就是之前 RedisAutoConfiguration 源码中的 Bean
    @Autowired
    @Qualifier("redisTemplate")
    private RedisTemplate redisTemplate;

    @Autowired
    private RedisUtil redisUtil;

    //3测
    @Test
    public void test3() {
        // 使用 RedisUtil 工具类
        redisUtil.set("mykey", "小李");
        System.out.println(redisUtil.get("mykey"));
    }

    //1测
    @Test
    void contextLoads() {
        /** 在企业开发中，我们80%的情况下，都不会使用这个原生的方式去编写代码！ 自己编写：RedisUtils 工具类
         * redisTemplate 操作不同的数据类型，API 和 Redis 中的是一样的
         * opsForValue 类似于 Redis 中的 String
         * opsForList 类似于 Redis 中的 List
         * opsForSet 类似于 Redis 中的 Set
         * opsForHash 类似于 Redis 中的 Hash
         * opsForZSet 类似于 Redis 中的 ZSet
         * opsForGeo 类似于 Redis 中的 Geospatial
         * opsForHyperLogLog 类似于 Redis 中的 HyperLogLog
         */
        // 除了基本的操作，常用的命令都可以直接通过redisTemplate操作，比如事务……
        // 和数据库相关的操作都需要通过连接操作，获取redis的连接对象
        //RedisConnection connection = redisTemplate.getConnectionFactory().getConnection();
        //connection.flushDb();
        redisTemplate.opsForValue().set("mykey","\n小明");
        System.out.println(redisTemplate.opsForValue().get("mykey"));
    }

    //2测
    @Test
    public void test2() throws JsonProcessingException {
        // 真实的开发一般都使用json来传递对象
        User user = new User("亚索", "18");
        // 使用 JSON 序列化
        //String jsonUser = new ObjectMapper().writeValueAsString(user);
        // 这里直接传入一个对象
        redisTemplate.opsForValue().set("key",user); //jsonUser
        System.out.println(redisTemplate.opsForValue().get("user"));
    }
}
```

### 14.4 Serializable  序列化

为什么要序列化。

#### 14.4.1 新建一个User实体类

```java
@Component
@Data
@NoArgsConstructor
@AllArgsConstructor
// 实体类序列化在后面加上 implements Serializable
public class User {
    private String name;
    private String age;
}
```

#### 14.4.2 编写测试类，先不序列化

```java
    //2测
    @Test
    public void test2() throws JsonProcessingException {
        // 真实的开发一般都使用json来传递对象
        User user = new User("亚索", "18");
        // 使用 JSON 序列化
        //String jsonUser = new ObjectMapper().writeValueAsString(user);
        // 这里直接传入一个对象
        redisTemplate.opsForValue().set("user",user); //jsonUser
        System.out.println(redisTemplate.opsForValue().get("user"));
    }
```

#### 14.4.3 执行结果

org.springframework.data.redis.serializer.SerializationException: Cannot serialize...  
DefaultSerializer requires a Serializable payload but received an object of type [com.xing.domain.User]  
实体类没有实现 Serializable ，自然会报序列化的错误。  
如果序列化就不会报错，所以一般实体类都要序列化。

#### 14.4.4  为什么要自定义序列化

使用测试类，向数据库中插入了一个中文字符串，虽然在 Java 端可以看到返回了中文，但是在 Redis 中查看是一串乱码。  
C:\Program Files\Redis redis-cli.exe #管理员身份运行  
keys *  # 查看  
flushdb # 清除当前数据库  
![](D:\2023\Java\SpringBoot\springboot-study\img\18.png)
解决这个问题就需要修改默认的序列化规则。  
实体类实现 Serializable 或 使用 JSON 序列化。
![](D:\2023\Java\SpringBoot\springboot-study\img\19.png)

#### 14.4.5 使用自定义配置类

JSON 序列化，需要自定义一个配置类。RedisConfig 模板；

```java
@Configuration
public class RedisConfig {
    //编写我们自己的redisTemplate,这是一个比较固定的模板
    @Bean
    @SuppressWarnings("all")
    public RedisTemplate<String, Object> redisTemplate(RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
        // 为了开发方便，直接使用<String, Object>
        RedisTemplate<String, Object> template = new RedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);

        // Json 配置序列化
        // 使用 jackson 解析任意的对象
        Jackson2JsonRedisSerializer<Object> jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
        // 使用 objectMapper 进行转义
        ObjectMapper objectMapper = new ObjectMapper();
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        objectMapper.activateDefaultTyping(LaissezFaireSubTypeValidator.instance, ObjectMapper.DefaultTyping.NON_FINAL);
        jackson2JsonRedisSerializer.setObjectMapper(objectMapper);
        // String 的序列化
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();

        // key 采用 String 的序列化方式
        template.setKeySerializer(stringRedisSerializer);
        // Hash 的 key 采用 String 的序列化方式
        template.setHashKeySerializer(stringRedisSerializer);
        // value 采用 jackson 的序列化方式
        template.setValueSerializer(jackson2JsonRedisSerializer);
        // Hash 的 value 采用 jackson 的序列化方式
        template.setHashValueSerializer(jackson2JsonRedisSerializer);
        // 把所有的配置 set 进 template
        template.afterPropertiesSet();

        return template;
    }
}
```

清空一下数据库，再次执行之前那个插入 User 对象的测试；  
发现执行成功，没有报错，并且在 Redis 中也没有转义字符了。  
C:\Program Files\Redis redis-cli.exe：运行 get key 再 get user

#### 14.4.6 工具类

```java
package com.xing.utils;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Component;
import org.springframework.util.CollectionUtils;
import java.util.Collection;
import java.util.List;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;

//在我们真实的公司工作中，一般都可以看到一个公司自己封装：RedisUtils 工具类
@Component
public final class RedisUtil {
    @Autowired
    private RedisTemplate<String, Object> redisTemplate;

    // =============================common============================
    /**
     * 指定缓存失效时间
     * @param key  键
     * @param time 时间(秒)
     */
    public boolean expire(String key, long time) {
        try {
            if (time > 0) {
                redisTemplate.expire(key, time, TimeUnit.SECONDS);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 根据key 获取过期时间
     * @param key 键 不能为null
     * @return 时间(秒) 返回0代表为永久有效
     */
    public long getExpire(String key) {
        return redisTemplate.getExpire(key, TimeUnit.SECONDS);
    }

    /**
     * 判断key是否存在
     * @param key 键
     * @return true 存在 false不存在
     */
    public boolean hasKey(String key) {
        try {
            return redisTemplate.hasKey(key);
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 删除缓存
     * @param key 可以传一个值 或多个
     */
    @SuppressWarnings("unchecked")
    public void del(String... key) {
        if (key != null && key.length > 0) {
            if (key.length == 1) {
                redisTemplate.delete(key[0]);
            } else {
                redisTemplate.delete((Collection<String>) CollectionUtils.arrayToList(key));
            }
        }
    }

    // ============================String=============================
    /**
     * 普通缓存获取
     * @param key 键
     * @return 值
     */
    public Object get(String key) {
        return key == null ? null : redisTemplate.opsForValue().get(key);
    }

    /**
     * 普通缓存放入
     * @param key   键
     * @param value 值
     * @return true成功 false失败
     */

    public boolean set(String key, Object value) {
        try {
            redisTemplate.opsForValue().set(key, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 普通缓存放入并设置时间
     * @param key   键
     * @param value 值
     * @param time  时间(秒) time要大于0 如果time小于等于0 将设置无限期
     * @return true成功 false 失败
     */

    public boolean set(String key, Object value, long time) {
        try {
            if (time > 0) {
                redisTemplate.opsForValue().set(key, value, time, TimeUnit.SECONDS);
            } else {
                set(key, value);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 递增
     * @param key   键
     * @param delta 要增加几(大于0)
     */
    public long incr(String key, long delta) {
        if (delta < 0) {
            throw new RuntimeException("递增因子必须大于0");
        }
        return redisTemplate.opsForValue().increment(key, delta);
    }

    /**
     * 递减
     * @param key   键
     * @param delta 要减少几(小于0)
     */
    public long decr(String key, long delta) {
        if (delta < 0) {
            throw new RuntimeException("递减因子必须大于0");
        }
        return redisTemplate.opsForValue().increment(key, -delta);
    }

    // ================================Map=================================
    /**
     * HashGet
     * @param key  键 不能为null
     * @param item 项 不能为null
     */
    public Object hget(String key, String item) {
        return redisTemplate.opsForHash().get(key, item);
    }

    /**
     * 获取hashKey对应的所有键值
     * @param key 键
     * @return 对应的多个键值
     */
    public Map<Object, Object> hmget(String key) {
        return redisTemplate.opsForHash().entries(key);
    }

    /**
     * HashSet
     * @param key 键
     * @param map 对应多个键值
     */
    public boolean hmset(String key, Map<String, Object> map) {
        try {
            redisTemplate.opsForHash().putAll(key, map);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * HashSet 并设置时间
     * @param key  键
     * @param map  对应多个键值
     * @param time 时间(秒)
     * @return true成功 false失败
     */
    public boolean hmset(String key, Map<String, Object> map, long time) {
        try {
            redisTemplate.opsForHash().putAll(key, map);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 向一张hash表中放入数据,如果不存在将创建
     *
     * @param key   键
     * @param item  项
     * @param value 值
     * @return true 成功 false失败
     */
    public boolean hset(String key, String item, Object value) {
        try {
            redisTemplate.opsForHash().put(key, item, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 向一张hash表中放入数据,如果不存在将创建
     *
     * @param key   键
     * @param item  项
     * @param value 值
     * @param time  时间(秒) 注意:如果已存在的hash表有时间,这里将会替换原有的时间
     * @return true 成功 false失败
     */
    public boolean hset(String key, String item, Object value, long time) {
        try {
            redisTemplate.opsForHash().put(key, item, value);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 删除hash表中的值
     *
     * @param key  键 不能为null
     * @param item 项 可以使多个 不能为null
     */
    public void hdel(String key, Object... item) {
        redisTemplate.opsForHash().delete(key, item);
    }

    /**
     * 判断hash表中是否有该项的值
     *
     * @param key  键 不能为null
     * @param item 项 不能为null
     * @return true 存在 false不存在
     */
    public boolean hHasKey(String key, String item) {
        return redisTemplate.opsForHash().hasKey(key, item);
    }

    /**
     * hash递增 如果不存在,就会创建一个 并把新增后的值返回
     *
     * @param key  键
     * @param item 项
     * @param by   要增加几(大于0)
     */
    public double hincr(String key, String item, double by) {
        return redisTemplate.opsForHash().increment(key, item, by);
    }

    /**
     * hash递减
     *
     * @param key  键
     * @param item 项
     * @param by   要减少记(小于0)
     */
    public double hdecr(String key, String item, double by) {
        return redisTemplate.opsForHash().increment(key, item, -by);
    }

    // ============================set=============================
    /**
     * 根据key获取Set中的所有值
     * @param key 键
     */
    public Set<Object> sGet(String key) {
        try {
            return redisTemplate.opsForSet().members(key);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }

    /**
     * 根据value从一个set中查询,是否存在
     *
     * @param key   键
     * @param value 值
     * @return true 存在 false不存在
     */
    public boolean sHasKey(String key, Object value) {
        try {
            return redisTemplate.opsForSet().isMember(key, value);
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将数据放入set缓存
     *
     * @param key    键
     * @param values 值 可以是多个
     * @return 成功个数
     */
    public long sSet(String key, Object... values) {
        try {
            return redisTemplate.opsForSet().add(key, values);
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 将set数据放入缓存
     *
     * @param key    键
     * @param time   时间(秒)
     * @param values 值 可以是多个
     * @return 成功个数
     */
    public long sSetAndTime(String key, long time, Object... values) {
        try {
            Long count = redisTemplate.opsForSet().add(key, values);
            if (time > 0) {
                expire(key, time);
            }
            return count;
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 获取set缓存的长度
     *
     * @param key 键
     */
    public long sGetSetSize(String key) {
        try {
            return redisTemplate.opsForSet().size(key);
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 移除值为value的
     *
     * @param key    键
     * @param values 值 可以是多个
     * @return 移除的个数
     */

    public long setRemove(String key, Object... values) {
        try {
            Long count = redisTemplate.opsForSet().remove(key, values);
            return count;
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    // ===============================list=================================
    /**
     * 获取list缓存的内容
     *
     * @param key   键
     * @param start 开始
     * @param end   结束 0 到 -1代表所有值
     */
    public List<Object> lGet(String key, long start, long end) {
        try {
            return redisTemplate.opsForList().range(key, start, end);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }

    /**
     * 获取list缓存的长度
     *
     * @param key 键
     */
    public long lGetListSize(String key) {
        try {
            return redisTemplate.opsForList().size(key);
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }
    }

    /**
     * 通过索引 获取list中的值
     *
     * @param key   键
     * @param index 索引 index>=0时， 0 表头，1 第二个元素，依次类推；index<0时，-1，表尾，-2倒数第二个元素，依次类推
     */
    public Object lGetIndex(String key, long index) {
        try {
            return redisTemplate.opsForList().index(key, index);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     */
    public boolean lSet(String key, Object value) {
        try {
            redisTemplate.opsForList().rightPush(key, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 将list放入缓存
     * @param key   键
     * @param value 值
     * @param time  时间(秒)
     */
    public boolean lSet(String key, Object value, long time) {
        try {
            redisTemplate.opsForList().rightPush(key, value);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }

    }

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @return
     */
    public boolean lSet(String key, List<Object> value) {
        try {
            redisTemplate.opsForList().rightPushAll(key, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }

    }

    /**
     * 将list放入缓存
     *
     * @param key   键
     * @param value 值
     * @param time  时间(秒)
     * @return
     */
    public boolean lSet(String key, List<Object> value, long time) {
        try {
            redisTemplate.opsForList().rightPushAll(key, value);
            if (time > 0) {
                expire(key, time);
            }
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 根据索引修改list中的某条数据
     *
     * @param key   键
     * @param index 索引
     * @param value 值
     * @return
     */

    public boolean lUpdateIndex(String key, long index, Object value) {
        try {
            redisTemplate.opsForList().set(key, index, value);
            return true;
        } catch (Exception e) {
            e.printStackTrace();
            return false;
        }
    }

    /**
     * 移除N个值为value
     *
     * @param key   键
     * @param count 移除多少个
     * @param value 值
     * @return 移除的个数
     */

    public long lRemove(String key, long count, Object value) {
        try {
            Long remove = redisTemplate.opsForList().remove(key, count, value);
            return remove;
        } catch (Exception e) {
            e.printStackTrace();
            return 0;
        }

    }
}
```
#### 14.4.7 工具类测试
```java
    //3测
    @Test
    public void test3() {
        // 使用 RedisUtil 工具类
        redisUtil.set("mykey", "小李");
        System.out.println(redisUtil.get("mykey"));
    }
```
发现工具类可正常使用。
![](D:\2023\Java\SpringBoot\springboot-study\img\20.png)
### @学不可以已 springboot-10-redis 已完结。
springboot-10-redis  模块中 （IDEA创建springboot项目+Redis源码+自定义测试+序列化+工具类） 。

## 15、springboot集成Dubbo和Zookeeper（ springboot-11-dubbozookeeper）

### 15.1 分布式理论

**什么是分布式系统？ **
在《分布式系统原理与范型》一书中有如下定义：“分布式系统是若干独立计算机的集合，这些计算机对于用户来说就像单个系统”；分布式系统是由一组通过网络进行通信、为了完成共同的任务而协调工作的计算机节点组成的系统。分布式系统的出现是为了用廉价的、普通的机器完成单个计算机无法完成的计算、存储任务。其目的是**利用更多的机器，处理更多的数据**。  
分布式系统（distributed system）是建立在网络之上的软件系统。正是因为软件的特性，所以分布式系统具有高度的内聚性和透明性。因此，网络和分布式系统之间的区别更多的在于高层软件（特别是操作系统），而不是硬件。  
首先需要明确的是，只有当**单个节点的处理能力无法满足日益增长的计算、存储任务的时候，且硬件的提升（加内存、加磁盘、使用更好的CPU）高昂到得不偿失的时候**，应用程序也不能进一步优化的时候，我们**才需要考虑分布式系统**。因为，分布式系统要解决的问题本身就是和单机系统一样的，而由于分布式系统多节点、通过网络通信的拓扑结构，会引入很多单机系统没有的问题，为了解决这些问题又会引入更多的机制、协议，带来更多的问题。

### 15.2 什么是RPC

RPC【Remote Procedure Call】是指**远程过程调用**，是一种进程间通信方式，他是一种技术的思想，而不是规范。它允许程序调用另一个地址空间（通常是共享网络的另一台机器上）的过程或函数，而不用程序员显式编码这个远程调用的细节。即程序员无论是调用本地的还是远程的函数，本质上编写的调用代码基本相同。也就是说两台服务器A，B，一个应用部署在A服务器上，想要调用B服务器上应用提供的函数/方法，由于不在一个内存空间，不能直接调用，需要通过网络来表达调用的语义和传达调用的数据。为什么要用RPC呢？就是无法在一个进程内，甚至一个计算机内通过本地调用的方式完成的需求，比如不同的系统间的通讯，甚至不同的组织间的通讯，由于计算能力需要横向扩展，需要在多台机器组成的集群上部署应用。RPC就是要像调用本地的函数一样去调远程函数。  
推荐阅读文章：https://www.jianshu.com/p/2accc2840a1b

**RPC基本原理**
![](D:\2023\Java\SpringBoot\springboot-study\img\21.png)

**步骤解析：**
![](D:\2023\Java\SpringBoot\springboot-study\img\22.png)

**RPC两个核心模块**：通讯，序列化。

**如何实现一个RPC？**

实际情况下，RPC很少用到http协议来进行数据传输，毕竟我只是想传输一下数据而已，何必动用到一个文本传输的应用层协议呢，我为什么不直接使用**二进制传输**？比如直接用Java的Socket协议进行传输？不管你用何种协议进行数据传输，**一个完整的RPC过程，都可以用下面这张图来描述**：![](D:\2023\Java\SpringBoot\springboot-study\img\23.png)

以左边的Client端为例，Application就是rpc的调用方，Client Stub就是我们上面说到的代理对象，也就是那个看起来像是Calculator的实现类，其实内部是通过rpc方式来进行远程调用的代理对象，至于Client Run-time Library，则是实现远程调用的工具包，比如jdk的Socket，最后通过底层网络实现实现数据的传输。  
这个过程中最重要的就是**序列化**和**反序列化**了，因为数据传输的数据包必须是二进制的，你直接丢一个Java对象过去，人家可不认识，你必须把Java对象序列化为二进制格式，传给Server端，Server端接收到之后，再反序列化为Java对象。

**RPC要解决的两个问题：**  
**1**、解决分布式系统中，服务之间的调用问题。  
**2**、远程调用时，要能够像本地调用一样方便，让调用者感知不到远程调用的逻辑。

### 15.3 Dubbo入门

**开源分布式服务框架**

Dubbo(读音[ˈdʌbəʊ])是[阿里巴巴公司]开源的一个高性能优秀的[服务框架]，使得应用可通过高性能的 [RPC]实现服务的输出和输入功能，可以和[Spring]框架无缝集成。

Dubbo是一款高性能、轻量级的开源[Java]RPC框架，它提供了三大[核心能力]：面向接口的[远程方法调用]，智能容错和[负载均衡]，以及服务自动注册和发现。

随着互联网的发展，网站应用的规模不断扩大，常规的垂直应用架构已无法应对，分布式服务架构以及流动计算架构势在必行，急需**一个治理系统**确保架构有条不紊的演进。

在Dubbo的官网文档有这样一张图
![](D:\2023\Java\SpringBoot\springboot-study\img\24.png)

**单一应用架构**

当网站流量很小时，只需一个应用，将所有功能都部署在一起，以减少部署节点和成本。此时，用于简化增删改查工作量的数据访问框架(ORM)是关键。
![](D:\2023\Java\SpringBoot\springboot-study\img\25.png)

适用于小型网站，小型管理系统，将所有功能都部署到一个功能里，简单易用。

**缺点：**  
**1**、性能扩展比较难；   
**2**、协同开发问题；  
**3**、不利于升级维护。

**垂直应用架构** 

当访问量逐渐增大，单一应用增加机器带来的加速度越来越小，将应用拆成互不相干的几个应用，以提升效率。此时，用于加速前端页面开发的Web框架(MVC)是关键。
![](D:\2023\Java\SpringBoot\springboot-study\img\26.png)

通过切分业务来实现各个模块独立部署，降低了维护和部署的难度，团队各司其职更易管理，性能扩展也更方便，更有针对性。
缺点：公用模块无法重复利用，开发性的浪费

**分布式服务架构**

当垂直应用越来越多，应用之间交互不可避免，将核心业务抽取出来，作为独立的服务，逐渐形成稳定的服务中心，使前端应用能更快速的响应多变的市场需求。此时，用于提高业务复用及整合的**分布式服务框架(RPC)**是关键。
![](D:\2023\Java\SpringBoot\springboot-study\img\27.png)

**流动计算架构**

当服务越来越多，容量的评估，小服务资源的浪费等问题逐渐显现，此时需增加一个调度中心基于访问压力实时管理集群容量，提高集群利用率。此时，用于**提高机器利用率的资源调度和治理中心**(SOA)[ Service Oriented Architecture]是关键。
![](D:\2023\Java\SpringBoot\springboot-study\img\28.png)

**Dubbo服务治理**
![](D:\2023\Java\SpringBoot\springboot-study\img\29.png)

在大规模服务化之前，应用可能只是通过RMI或Hessian等工具，简单的暴露和引用远程服务，通过配置服务的URL地址进行调用，通过F5等硬件进行负载均衡。

dubbo官网 https://cn.dubbo.apache.org/zh-cn/index.html

**1**、了解Dubbo的特性
**2**、查看官方文档

**dubbo基本概念**
![](D:\2023\Java\SpringBoot\springboot-study\img\30.png)
![](D:\2023\Java\SpringBoot\springboot-study\img\31.png)

**服务提供者**（Provider）：暴露服务的服务提供方，服务提供者在启动时，向注册中心注册自己提供的服务；  
**服务消费者**（Consumer）：调用远程服务的服务消费方，服务消费者在启动时，向注册中心订阅自己所需的服务，服务消费者，从提供者地址列表中，基于软负载均衡算法，选一台提供者进行调用，如果调用失败，再选另一台调用；  
**注册中心**（Registry）：注册中心返回服务提供者地址列表给消费者，如果有变更，注册中心将基于长连接推送变更数据给消费者；  
**监控中心**（Monitor）：服务消费者和提供者，在内存中累计调用次数和调用时间，定时每分钟发送一次统计数据到监控中心。

**调用关系说明**

-  服务容器负责启动，加载，运行服务提供者；
- 服务提供者在启动时，向注册中心注册自己提供的服务；
- 服务消费者在启动时，向注册中心订阅自己所需的服务；
- 注册中心返回服务提供者地址列表给消费者，如果有变更，注册中心将基于长连接推送变更数据给消费者；
- 服务消费者，从提供者地址列表中，基于软负载均衡算法，选一台提供者进行调用，如果调用失败，再选另一台调用；
- 服务消费者和提供者，在内存中累计调用次数和调用时间，定时每分钟发送一次统计数据到监控中心。

### 15.4 zookeeper/Dubbo下载/测试

**zookeeper 分布式应用程序协调服务软件**  
ZooKeeper是一个分布式的，[开放源码]的[分布式应用程序]协调服务，是[Google]的Chubby一个开源的实现，是[Hadoop]和[Hbase]的重要组件。它是一个为[分布式应用]提供一致性服务的软件，提供的功能包括：配置维护、[域名服务]、分布式同步、组服务等。  
ZooKeeper的目标就是封装好复杂易出错的关键服务，将简单易用的接口和性能高效、功能稳定的系统提供给用户。  
ZooKeeper包含一个简单的原语集，提供[Java]和C的接口。  
ZooKeeper代码版本中，提供了分布式独享锁、选举、队列的接口，代码在$zookeeper_home\src\recipes。其中分布锁和队列有[Java](https://baike.baidu.com/item/Java/85979?fromModule=lemma_inlink)和C两个版本，选举只有Java版本。

**Window下载安装zookeeper。**  
zookeeper官网：https://zookeeper.apache.org  
我的安转位置D:\Users\Asus\apache-zookeeper-3.8.2-bin  
**1**、下载zookeeper ：下载Apache ZooKeeper 3.8.2 (latest stable release)，当前最新LTS！解压zookeeper；  
**2**、运行/bin/zkServer.cmd ，初次运行会报错，没有zoo.cfg配置文件。  
`cmd：C:\Users\Asus>cd /d D:\Users\Asus\apache-zookeeper-3.8.2-bin\bin`  
`cmd：C:\Users\Asus>zkServer.cmd`  
可能遇到问题：闪退 !  
解决方案：编辑zkServer.cmd文件末尾添加pause 。这样运行出错就不会退出，会提示错误信息，方便找到原因。endlocal上加pause。  
**3**、修改zoo.cfg配置文件  
将conf文件夹下面的zoo_sample.cfg复制一份改名为zoo.cfg即可。  
注意几个重要位置：  
dataDir=./  临时数据存储的目录（可写相对路径）；  
clientPort=2181  zookeeper的端口号；  
修改完成后再次启动zookeeper。
**5**、zkServer.cmd测试

```cmd
服务端
C:\Windows\System32>call "C:\......
2023-09-21 12:49:23,385 [myid:] - INFO  [main:o.a.z.ZookeeperBanner@42] -
2023-09-21 12:49:23,386 [myid:] - INFO  [main:o.a.z.ZookeeperBanner@42] -   ______                  _
2023-09-21 12:49:23,387 [myid:] - INFO  [main:o.a.z.ZookeeperBanner@42] -  |___  /                 | |
2023-09-21 12:49:23,389 [myid:] - INFO  [main:o.a.z.ZookeeperBanner@42] -     / /    ___     ___   | | __   ___    ___   _ __     ___   _ __
2023-09-21 12:49:23,390 [myid:] - INFO  [main:o.a.z.ZookeeperBanner@42] -    / /    / _ \   / _ \  | |/ /  / _ \  / _ \ | '_ \   / _ \ | '__|
2023-09-21 12:49:23,391 [myid:] - INFO  [main:o.a.z.ZookeeperBanner@42] -   / /__  | (_) | | (_) | |   <  |  __/ |  __/ | |_) | |  __/ | |
2023-09-21 12:49:23,391 [myid:] - INFO  [main:o.a.z.ZookeeperBanner@42] -  /_____|  \___/   \___/  |_|\_\  \___|  \___| | .__/   \___| |_|
2023-09-21 12:49:23,392 [myid:] - INFO  [main:o.a.z.ZookeeperBanner@42] -                                               | |
2023-09-21 12:49:23,395 [myid:] - INFO  [main:o.a.z.ZookeeperBanner@42] -                                               |_|
......
2023-09-21 12:50:41,772 [myid:] - INFO  [SyncThread:0:o.a.z.a.Slf4jAuditLogger@35] - session=0x1000c30c6dc0000  user=127.0.0.1  ip=127.0.0.1    operation=create        znode=/xing     znode_type=ephemeral    result=success
```

**4**、使用zkCli.cmd测试

```cmd
客户端
Welcome to ZooKeeper!
......
WATCHER::
WatchedEvent state:SyncConnected type:None path:null
[zk: localhost:2181(CONNECTED) 0] ls /
[zookeeper]
[zk: localhost:2181(CONNECTED) 1] create -e /xing 123
Created /xing
[zk: localhost:2181(CONNECTED) 2] ls /
[xing, zookeeper]
[zk: localhost:2181(CONNECTED) 3] get /xing
123
[zk: localhost:2181(CONNECTED) 4]
```

### 15.5  window下载安装 dubbo-admin 

dubbo本身并不是一个服务软件。它其实就是一个jar包，能够帮你的java程序连接到zookeeper，并利用zookeeper消费、提供服务。  
但是为了让用户更好的管理监控众多的dubbo服务，官方提供了一个可视化的监控程序dubbo-admin，不过这个监控即使不装也不影响使用。  
**Dubbo源码安装测试**   
dubbo官网：https://cn.dubbo.apache.org/zh-cn/overview/mannual/java-sdk/reference-manual/registry  
点进dubbo官方文档，推荐我们使用Zookeeper 注册中心；  
**1**、修改配置  
修改 dubbo-admin\src\main\resources \application.properties 指定zookeeper地址  
**2**、在项目目录下打包dubbo-admin  
`mvn clean package -Dmaven.test.skip=true`  
**3**、第一次打包的过程有点慢，需要3分钟左右，耐心等待！直到成功！  
**4**、执行 dubbo-admin\target 下的dubbo-admin-0.0.1-SNAPSHOT.jar  
**跳转磁盘运行：**  
`C:\Users\Asus>cd /d D:\2023\Java\SpringBoot\dubbo-admin\dubbo-admin-distribution\target`  
`D:\2023\Java\SpringBoot\dubbo-admin\dubbo-admin-distribution\target>java -jar dubbo-admin-0.7.0-SNAPSHOT.jar`     
【注意：zookeeper的服务一定要打开！】  
执行完毕，我们去访问一下 http://localhost:38080/ ， 这时候我们需要输入登录账户和密码，我们都是默认的root-root；  
登录成功后，查看界面，安装完成！

### 15.6 SpringBoot集成Dubbo + Zookeeper

框架搭建

**1**. 启动zookeeper；

**2**. IDEA创建一个空项目；

**3**.创建一个模块，实现服务提供者：**provider-server** ， 选择web依赖即可；

**4**.项目创建完毕，我们写一个服务，比如卖票的服务。

编写接口

```java
package com.xing.service;

public interface TicketService {
    public String getTicket();
}
```

编写实现类

```java
package com.xing.service;

import org.apache.dubbo.config.annotation.DubboService;
import org.springframework.stereotype.Component;

@DubboService //将此类以服务的展示 可以扫描到，在项目一启动就自动注册到注册中心
@Component //将此类以组件的展示 使用了Dubbo后尽量不要用@Service注解
public class TicketServiveImpl implements TicketService {
    @Override
    public String getTicket() {
        return "Hello Ticket!";
    }
}
```

**5**.创建一个模块，实现服务消费者：**consumer-server **， 选择web依赖即可；

**6**.项目创建完毕，我们写一个服务，比如用户的服务；

编写service

```java
package com.xing.service;

import org.apache.dubbo.config.annotation.DubboReference;
import org.springframework.stereotype.Service;

@Service//注入到容器中--spring的@Service才能引用TicketService接口
public class UserService {

    @DubboReference //远程引用指定的服务，他会按照全类名进行匹配，看谁给注册中心注册了这个全类名(接口名:com.kuang.service.TicketService)
    TicketService ticketService;//引用, Pom坐标,可以定义路径相同的接口名

    public void bugTicket(){
        String ticket = ticketService.getTicket();
        System.out.println("在注册中心拿到"+ticket);
    }

}
```

需求：现在我们的用户想使用买票的服务，这要怎么弄呢 ？

**服务提供者**

**1**、将服务提供者注册到注册中心，我们需要整合Dubbo和zookeeper，所以需要导包，从dubbo官网进入github，看下方的帮助文档，找到dubbo-springboot，找到依赖包；

```xml
<!-- 导入依赖dubbo 和 zookeeper -->
        <dependency>
            <groupId>org.apache.dubbo</groupId>
            <artifactId>dubbo-spring-boot-starter</artifactId>
            <version>3.1.11</version>
        </dependency>
        <dependency>
            <groupId>com.101tec</groupId>
            <artifactId>zkclient</artifactId>
            <version>0.11</version>
        </dependency>
        <!-- 导入相关依赖 -->
        <!-- https://mvnrepository.com/artifact/org.apache.curator/curator-framework -->
        <dependency>
            <groupId>org.apache.curator</groupId>
            <artifactId>curator-framework</artifactId>
            <version>5.5.0</version>
        </dependency>
        <dependency>
            <groupId>org.apache.curator</groupId>
            <artifactId>curator-recipes</artifactId>
            <version>5.5.0</version>
        </dependency>
        <!--排除这个slf4j-log4j12-->
        <dependency>
            <groupId>org.apache.zookeeper</groupId>
            <artifactId>zookeeper</artifactId>
            <version>3.8.2</version>
            <exclusions>
                <exclusion>
                    <groupId>org.slf4j</groupId>
                    <artifactId>slf4j-log4j12</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
```

zookeeper的包我们去maven仓库下载，zkclient； ↑↑

【新版的坑】zookeeper及其依赖包，解决日志冲突，还需要剔除日志依赖；↑↑

**2**、在springboot配置文件中配置dubbo相关属性！**provider-server 中 application.yml**

```yaml
server:
  port: 8001
dubbo:
  application:
    # 当前应用名称
    name: provider-server
  registry:
    # 注册中心地址，可以在任何电脑上
    address: zookeeper://127.0.0.1:2181
  scan:
    base-packages: com.xing.service
```

**3**、在service的实现类中配置服务注解，发布服务！注意导包问题

```java
package com.xing.service;

import org.apache.dubbo.config.annotation.DubboService;
import org.springframework.stereotype.Component;

@DubboService //将此类以服务的展示 可以扫描到，在项目一启动就自动注册到注册中心
@Component //将此类以组件的展示 使用了Dubbo后尽量不要用@Service注解
public class TicketServiveImpl implements TicketService {
    @Override
    public String getTicket() {
        return "Hello Ticket!";
    }
}
```

逻辑理解 ：应用启动起来，dubbo就会扫描指定的包下带有@component注解的服务，将它发布在指定的注册中心中！

**服务消费者**

**1**、导入依赖，和之前的**provider-server 中 application.yml**依赖一样；↑↑

**2**、配置参数 **consumer-server 中 application.yml**

```yaml
server:
  port: 8002
# 消费者去哪里拿服务，需要暴露自己的名字
dubbo:
  application:
    name: consumer-server
  registry:
    # 注册中心的地址，可以在任何电脑上 或 服务器
    address: zookeeper://127.0.0.1:2181
```

**3**、本来正常步骤是需要将服务提供者的接口打包，然后用pom文件导入，我们这里使用简单的方式，直接将服务的接口拿过来，路径必须保证正确，即和服务提供者相同；

**4**、完善消费者的服务类

```java
package com.xing.service;

import org.apache.dubbo.config.annotation.DubboReference;
import org.springframework.stereotype.Service;

@Service//注入到容器中--spring的@Service才能引用TicketService接口
public class UserService {

    @DubboReference //远程引用指定的服务，他会按照全类名进行匹配，看谁给注册中心注册了这个全类名(接口名:com.kuang.service.TicketService)
    TicketService ticketService;//引用, Pom坐标,可以定义路径相同的接口名

    public void bugTicket(){
        String ticket = ticketService.getTicket();
        System.out.println("在注册中心拿到"+ticket);
    }

}
```

**6**、复制服务提供者接口**TicketService**到消费者接口 ↑↑

**7**、测试类编写。

```java
package com.xing;

import com.xing.service.UserService;
import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;

@SpringBootTest
class ConsumerServerApplicationTests {

    @Autowired
    UserService userService;

    @Test
    void contextLoads() {
        userService.bugTicket();
    }

}
```

**启动测试**

**1**、开启zookeeper；

**2**、打开dubbo-admin jar实现监控【可以不用】；

**3**、开启服务者；

**4**. 消费者消费测试，结果：**在注册中心拿到Hello Ticket!**

也可以上监控中心查看服务注册发现。http://localhost:38080

**ok , 这就是SpingBoot + dubbo + zookeeper实现分布式开发的应用，其实就是一个服务拆分的思想；**

步骤:  
前提:zookeeper服务已开启! 提供者提供服务  
1.导入依赖  
2.配置注册中心的地址，以及服务发现名，和要扫描的包~  
3.在想要被注册的服务上面~增加一个注解@Service2.消费者如何消费  

1.导入依赖  
2.配置注册中心的地址，配置自己的服务名~  
3.从远程注入服务~@Reference

### @学不可以已 springboot-11-dubbozookeeper 已完结。

springboot-11-dubbozookeeper  模块中 （IDEA创建springboot项目+分布式+Dubbo+zookeeper+整合测试） 。

## SpringBoot的现在与未来

```tex
SpringBoot聊聊现在与未来
开发框架(架构的目的就是解耦)
一. Spring
​ IOC AOP
​ IOC:控制反转
​ 原来都是我们自己一步步操作，现在交给容器了！我们需要什么就去拿就可以了
​ AOP：切面(本质：动态代理)
​ 为了解决什么？不影响业务本来的情况下，实现动态增加功能，大量应用在日志，事务…等方面
​ Spring是一个轻量级的控制反转的和面向切面编程的框架，容器
​ 目的：解决企业开发的复杂性问题
​ Spring是春天，觉得他是春天，也十分复杂，配置文件！

二. SpringBoot
SpringBoot并不是新东西，就是SpringBoot的升级版！
新一代JavaEE的开发标准，开箱即用!–>拿过来就可以使用!
它自动帮我们配置了非常多的东西，我们拿来即用！
特性：约定大于配置
随着公司体系越来越大，用户越来越多！
微服务架构—>新架构
模块化，功能化！
用户，支付，签到，娱乐，…；
人多余多：一台服务器解决不了，再增加服务器！

横向
​ 假设A服务器占用98%资源，B服务器只占用了10% —负载均衡；
​ 将原来的整体项目，分成模块化，用户就是一个单独的项目，项目和项目之间需要通信，如何通信？
​ 用户非常多，而签到十分少！–给用户多点服务器，给签到少点服务器！这就是引入了分布式！

三. 微服务架构问题？
​ 分布式架构会遇到的四个核心问题？
1. 这么多服务，客户端该如何去访问？入口在哪里？
2. 这么多服务，服务之间如何进行通信？
3. 这么多服务，如何治理呢？
4. 服务挂了，怎么办？

四. 解决方案
SpringCloud是一套生态，就是来解决以上分布式架构的4个问题
想使用SpringCloud，必须要掌握SpringBoot，因为SpringCloud是基于SpringBoot
SpringCloud NetFlix，出来了一套解决方案！一站式解决方案，我们都可以直接去这里拿？
​ API网关，zuu1组件
​ Feign–>基于HttpClient—>HTTP的通信方式，同步并阻塞
​ 服务注册与发现，Eureka
​ 熔断机制，Hystirx
​ 2018年年底，NetFlix宣布无限期停止维护。生态不再维护，就会脱节。

Apache Dubbo zookeeper，第二套解决系统
​ API：没有！要么找第三方组件，要么自己实现
​ Dubbo是一个高性能的基于Java实现的RPC通信框架！
​ 服务注册与发现，zookeeper：动物园管理者(Hadoop,Hive)
​ 没有：借助了Hystirx
​ 不完善,Dubbo

SpringCloud Alibaba -一站式解决方案!
五. 万变不离其宗，一通百通！
1. API网关，服务路由
2. HTTP，RPC框架，异步调用
3. 服务注册与发现，高可用！
4. 熔断机制，服务降级

六. 本质问题：网络是不可靠的

七. 目前，又提出了一种方案：服务网格:下一代微服务标准，Server Mesh，代表解决方案: istio (未来可能需要掌握! )
```

YYDS：https://www.bilibili.com/video/BV1PE411i7CV