springboot3-快速入门

springboot快速入门

一 简介

1.1 前置知识

● Java17
● Spring、SpringMVC、MyBatis
● Maven、IDEA

1.2 环境要求

1.3 SpringBoot是什么

​ SpringBoot 帮我们简单、快速地创建一个独立的、生产级别的 Spring 应用（说明：SpringBoot底层是Spring）
大多数 SpringBoot 应用只需要编写少量配置即可快速整合 Spring 平台以及第三方技术
特性：

• 快速创建独立 Spring 应用
  SSM：导包、写配置、启动运行

• 直接嵌入Tomcat、Jetty or Undertow（无需部署 war 包）【Servlet容器】
  linux java tomcat mysql： war 放到 tomcat 的 webapps下
  jar： java环境； java -jar

• 重点：提供可选的starter，简化应用整合
  场景启动器（starter）：web、json、邮件、oss（对象存储）、异步、定时任务、缓存…
  导包一堆，控制好版本。
  为每一种场景准备了一个依赖； web-starter。mybatis-starter

• 重点：按需自动配置 Spring 以及 第三方库
  如果这些场景我要使用（生效）。这个场景的所有配置都会自动配置好。

  ​ 约定大于配置：每个场景都有很多默认配置。
  ​ 自定义：配置文件中修改几项就可以

• 提供生产级特性：如 监控指标、健康检查、外部化配置等
  监控指标、健康检查（k8s）、外部化配置

• 无代码生成、无xml

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

二 快速体验

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

2.1 开发流程

2.1.1 创建项目

maven 项目

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

2.1.2 导入场景

场景启动器

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

2.1.3 主程序

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

2.1.4 业务

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

2.1.5 测试

默认启动访问： localhost:8080

2.1.6 打包

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

mvn clean package把项目打成可执行的jar包
java -jar demo.jar启动项目

2.2 Spring Initializr 创建向导

一键创建好整个项目结构

三 应用分析

3.1 依赖管理机制

思考：
1、为什么导入starter-web所有相关依赖都导入进来？

• 开发什么场景，导入什么场景启动器。
• maven依赖传递原则。A-B-C： A就拥有B和C
• 导入 场景启动器。 场景启动器 自动把这个场景的所有核心依赖全部导入进来

2、为什么版本号都不用写？

• 每个boot项目都有一个父项目spring-boot-starter-parent
• parent的父项目是spring-boot-dependencies
• 父项目 版本仲裁中心，把所有常见的jar的依赖版本都声明好了。
• 比如：mysql-connector-j

3、自定义版本号

• 利用maven的就近原则

  • 直接在当前项目properties标签中声明父项目用的版本属性的key

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

4、第三方的jar包

• boot父项目没有管理的需要自行声明好

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

3.2 自动配置机制

3.2.1 初步理解

• 自动配置的 Tomcat、SpringMVC 等

  • 导入场景，容器中就会自动配置好这个场景的核心组件。

  • 以前：DispatcherServlet、ViewResolver、CharacterEncodingFilter…

  • 现在：自动配置好的这些组件

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

    public static void main(String[] args) {
    //java10： 局部变量类型的自动推断
    var ioc = SpringApplication.run(MainApplication.class, args);

    //1、获取容器中所有组件的名字
    String[] names = ioc.getBeanDefinitionNames();
    //2、挨个遍历：
    // dispatcherServlet、beanNameViewResolver、characterEncodingFilter、	multipartResolver
    // SpringBoot把以前配置的核心组件现在都给我们自动配置好了。
    for (String name : names) {
        System.out.println(name);
    }

}

• 默认的包扫描规则

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

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

  • 自定义扫描路径

  ​ @SpringBootApplication(scanBasePackages = “com.zhg”)

  ​ @ComponentScan(“com.zhg”) 直接指定扫描的路径

配置默认值

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

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

• 比如：

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

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

  …参照官方文档：或者参照 绑定的 属性类。

• 按需加载自动配置

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

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

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

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

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

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

3.2.2 完整流程

思考：
1、SpringBoot怎么实现导一个starter、写一些简单配置，应用就能跑起来，我们无需关心整合
2、为什么Tomcat的端口号可以配置在application.properties中，并且Tomcat能启动成功？
3、导入场景后哪些自动配置能生效？

自动配置流程细节梳理：
1、导入starter-web：导入了web开发场景

• 1、场景启动器导入了相关场景的所有依赖：starter-json、starter-tomcat、springmvc
• 2、每个场景启动器都引入了一个spring-boot-starter，核心场景启动器。
• 3、核心场景启动器引入了spring-boot-autoconfigure包。
• 4、spring-boot-autoconfigure里面囊括了所有场景的所有配置。
• 5、只要这个包下的所有类都能生效，那么相当于SpringBoot官方写好的整合功能就生效了。
• 6、SpringBoot默认却扫描不到 spring-boot-autoconfigure下写好的所有配置类。（这些配置类给我们做了整合操作），默认只扫描主程序所在的包。

2、主程序：@SpringBootApplication

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

• 2、SpringBoot默认只能扫描自己主程序所在的包及其下面的子包，扫描不到 spring-boot-autoconfigure包中官方写好的配置类

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

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

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

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

  • 项目启动的时候利用 @Import 批量导入组件机制把 autoconfigure 包下的142 xxxxAutoConfiguration类导入进来（自动配置类）

  • 虽然导入了142个自动配置类

• 4、按需生效：

  • 并不是这142个自动配置类都能生效

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

3、xxxxAutoConfiguration自动配置类

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

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

核心流程总结：
1、导入starter，就会导入autoconfigure包。
2、autoconfigure 包里面 有一个文件 META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports,里面指定的所有启动要加载的自动配置类
3、@EnableAutoConfiguration 会自动的把上面文件里面写的所有自动配置类都导入进来。xxxAutoConfiguration 是有条件注解进行按需加载
4、xxxAutoConfiguration给容器中导入一堆组件，组件都是从 xxxProperties中提取属性值
5、xxxProperties又是和配置文件进行了绑定

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

3.2.3 如何学好SpringBoot

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

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

理解自动配置原理
a. 导入starter --> 生效xxxxAutoConfiguration --> 组件 --> xxxProperties --> 配置文件
理解其他框架底层
a. 拦截器
可以随时定制化任何组件
a. 配置文件
b. 自定义组件
普通开发：导入starter，Controller、Service、Mapper、偶尔修改配置文件
高级开发：自定义组件、自定义配置、自定义starter
核心：

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

最佳实战：

• 选场景，导入到项目

  • 官方：starter

  • 第三方：去仓库搜

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

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

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

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

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

    • 定制化

      • 改配置

      • 自定义组件

整合redis：

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

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

• 写配置：

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

  • @EnableConfigurationProperties(RedisProperties.class)

  • 修改redis相关的配置

• 分析组件：

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

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

• 定制化

  • 修改配置文件

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

四 核心技能

4.1 常用注解

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

4.1.1 组件注册

@Configuration、@SpringBootConfiguration
@Bean、@Scope
@Controller、 @Service、@Repository、@Component
@Import
@ComponentScan

步骤：
1、@Configuration 编写一个配置类
2、在配置类中，自定义方法给容器中注册组件。配合@Bean
3、或使用@Import 导入第三方的组件

4.1.2 条件注解

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

@ConditionalOnXxx @ConditionalOnClass：如果类路径中存在这个类，则触发指定行为 @ConditionalOnMissingClass：如果类路径中不存在这个类，则触发指定行为 @ConditionalOnBean：如果容器中存在这个Bean（组件），则触发指定行为 @ConditionalOnMissingBean：如果容器中不存在这个Bean（组件），则触发指定行为

场景：

如果存在FastsqlException这个类，给容器中放一个Cat组件，名cat01，
否则，就给容器中放一个Dog组件，名dog01
如果系统中有dog01这个组件，就给容器中放一个 User组件，名zhangsan
否则，就放一个User，名叫lisi

@ConditionalOnBean（value=组件类型，name=组件名字）：判断容器中是否有这个类型的组件，并且名字是指定的值
@ConditionalOnRepositoryType (org.springframework.boot.autoconfigure.data)
@ConditionalOnDefaultWebSecurity (org.springframework.boot.autoconfigure.security)
@ConditionalOnSingleCandidate (org.springframework.boot.autoconfigure.condition)
@ConditionalOnWebApplication (org.springframework.boot.autoconfigure.condition)
@ConditionalOnWarDeployment (org.springframework.boot.autoconfigure.condition)
@ConditionalOnJndi (org.springframework.boot.autoconfigure.condition)
@ConditionalOnResource (org.springframework.boot.autoconfigure.condition)
@ConditionalOnExpression (org.springframework.boot.autoconfigure.condition)
@ConditionalOnClass (org.springframework.boot.autoconfigure.condition)
@ConditionalOnEnabledResourceChain (org.springframework.boot.autoconfigure.web)
@ConditionalOnMissingClass (org.springframework.boot.autoconfigure.condition)
@ConditionalOnNotWebApplication (org.springframework.boot.autoconfigure.condition)
@ConditionalOnProperty (org.springframework.boot.autoconfigure.condition)
@ConditionalOnCloudPlatform (org.springframework.boot.autoconfigure.condition)
@ConditionalOnBean (org.springframework.boot.autoconfigure.condition)
@ConditionalOnMissingBean (org.springframework.boot.autoconfigure.condition)
@ConditionalOnMissingFilterBean (org.springframework.boot.autoconfigure.web.servlet)
@Profile (org.springframework.context.annotation)
@ConditionalOnInitializedRestarter (org.springframework.boot.devtools.restart)
@ConditionalOnGraphQlSchema (org.springframework.boot.autoconfigure.graphql)
@ConditionalOnJava (org.springframework.boot.autoconfigure.condition)

4.1.3 属性绑定

@ConfigurationProperties： 声明组件的属性和配置文件哪些前缀开始项进行绑定
@EnableConfigurationProperties：快速注册注解：

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

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

1、给容器中注册组件（@Component、@Bean）
2、使用@ConfigurationProperties 声明组件和配置文件的哪些配置项进行绑定

4.2 YAML配置文件

痛点：SpringBoot 集中化管理配置，application.properties
问题：配置多以后难阅读和修改，层级结构辨识度不高

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

• 设计目标，就是方便人类读写
• 层次分明，更适合做配置文件
• 使用.yaml或 .yml作为文件后缀

4.2.1 基本语法

• 大小写敏感
• 使用缩进表示层级关系，k: v，使用空格分割k,v
• 缩进时不允许使用Tab键，只允许使用空格。换行
• 缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
• #表示注释，从这个字符一直到行尾，都会被解析器忽略。

支持的写法：

• 对象：键值对的集合，如：映射（map）/ 哈希（hash） / 字典（dictionary）
• 数组：一组按次序排列的值，如：序列（sequence） / 列表（list）
• 纯量：单个的、不可再分的值，如：字符串、数字、bool、日期

4.2.2 示例

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

@Data
public class Dog {
    private String name;
    private Integer age;
}

@Data
public class Child {
    private String name;
    private Integer age;
    private Date birthDay;
    private List<String> text; //数组
}

@Data
public class Cat {
    private String name;
    private Integer age;
}

properties表示法

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

yaml表示法

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

4.2.3 细节

• birthDay 推荐写为 birth-day

• 文本：

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

• 大文本

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

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

4.2.4 小技巧：lombok

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

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

使用@Data等注解