Springboot快速入门（一）——yaml配置
2022-09-08 17:10:58 # Springboot # Java

以下笔记来自b站up：遇见狂神说（【狂神说Java】SpringBoot最新教程IDEA版通俗易懂）视频+subeiLY博客

1. pom.xml文件

  • spring-boot-dependencies：核心依赖在父工程中！
  • 在写或者引入一些Springboot依赖的时候，不需要指定版本，就因为有这些版本仓库

2. 启动器

1
2
3
4
<dependency>
     <groupId>org.springframework.boot</groupId>
     <artifactId>spring-boot-starter</artifactId>
</dependency>

  • 启动器：就是springboot的启动场景

  • 比如spring-boot-starter-web，自动导入web环境所有的依赖！

  • springboot会将所有的功能场景，都变成一个个的启动器

  • 需要使用什么功能，就只需要找到对应的启动器就行starter，spring官网有启动器的介绍，找到starter

3. 主程序

  • @ComponentScan：
    • 该注解在Spring中对应XML配置中的元素
    • 作用：自动扫描并加载符合条件的组件或者bean，将这个bean定义加载到IOC容器中
  • @SpringBootConfiguration：spring boot的配置
    • @Configuration：spring配置类，对应Spring的xml 配置文件
    • @Component：说明这是一个Spring组件，负责启动应用
  • @EnableAutoConfiguration：开启自动配置功能
    • @AutoConfigurationPackage：自动配置包
      • @Import({Registrar.class})：自动配置包注册
    • @Import({AutoConfigurationImportSelector.class})：自动导入组件

结论：

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

4. 主启动类如何运行

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

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

  • run方法：

    在这里插入图片描述

5. yaml配置

  • 传统的xml配置：

    <server>
    <port>8081</port>
    </server>

  • yaml配置：

    server: port: 8081

  • 例如：

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    server:
      port: 8080
    # 普通的key-value
    name: chendh

    # 对象
    student:
      name: chendh
      age: 23

    # 行内写法
    student2: {name: chendh,age: 23}

    # 数组 用-值表示数组中的一个元素
    pets:
      - cat
      - dog
      - pig

    pets2: [cat,dog,pig]

  • 基础语法：

    • 空格不能省略

    • 以缩进来控制层级关系，只要是左边对齐的一列数据都是同一个层级的

    • 属性和值的大小写都是十分敏感的

      • 字面量：普通的值 [ 数字，布尔值，字符串 ]
      • 字面量直接写在后面就可以 ， 字符串默认不用加上双引号或者单引号

    • “ ” 双引号，不会转义字符串里面的特殊字符 ， 特殊字符会作为本身想表示的意思； 比如 ： name: “github\n subei” 输出 ： github 换行 subei

    • ‘’ 单引号，会转义特殊字符 ， 特殊字符最终会变成和普通字符一样输出 比如 ： name: ‘github\n subei’ 输出 ： github\n subei

6. 给属性赋值的几种方式——推荐使用yaml配置的方式

6.1 yaml配置的方式

  • 编写一个yaml配置

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    person: 
    name: subeiLY
    age: 18
    happy: true
    birth: 2002/03/04
    maps: {k1: v1,k2: v2}
    lists:
      - code
      - book
      - music
    dog: 
      name: 来福
      age: 2

  • 将person注入到类中

    @ConfigurationProperties(prefix = "person")

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    /*
    @ConfigurationProperties作用：
    将配置文件中配置的每一个属性的值，映射到这个组件中；
    告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定
    参数 prefix = “person” : 将配置文件中的person下面的所有属性一一对应
    */

    /**
     * 注册bean
     */

    @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> list;
        private Dog dog;

        // 有参无参构造、get、set方法、toString()方法
        
    }

  • 导入依赖

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

  • 测试类中测试

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    @SpringBootTest
    class Springboot02ConfigApplicationTests {

        @Autowired  // 将人类自动注入进来
        Person person;

        @Test
        void contextLoads() {
            System.out.println(person);    // 打印一下人物对象
        }

    }

6.2 加载指定的配置文件

  • resources目录下新建一个person.properties文件

    1
    name=chendh

  • 代码中指定加载person.properties文件

    @PropertySource(value = "classpath:person.properties")

    1
    2
    3
    4
    5
    6
    7
    8
    9
    @Component
    //@ConfigurationProperties(prefix = "person")
    // 指定配置文件绑定
    @PropertySource(value = "classpath:person.properties")
    public class Person {
        @Value("${name}")
        private String name;
        ......
    }

6.3 配置文件占位符

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
person:
  name: subeiLY${random.uuid} # 随机uuid
  age: ${random.int}  # 随机int
  happy: true
  birth: 2002/03/04
  maps: {k1: v1,k2: v2}
  lists:
    - code
    - book
    - music
  dog:
    # 引用person.hello 的值，如果不存在就用 ：后面的值，即 other，然后拼接上_来福
    name: ${person.hello:other}_来福
    age: 2

结论：

  • 配置yml和配置properties都可以获取到值 ，推荐yaml配置
  • 若在某个业务中，只需要获取配置文件中的某个值，可以使用一下 @value
  • 若专门编写了一个JavaBean来和配置文件进行一一映射，就直接**@configurationProperties**，不要犹豫！

7. JSR303数据校验

  • 在pom.xml文件中添加

    1
    2
    3
    4
    5
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
        <version>2.5.6</version>
    </dependency>

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

    1
    2
    3
    4
    5
    6
    7
    8
    9
    @Component
    @ConfigurationProperties(prefix = "person")
    @Validated  // 数据校验
    public class Person {
        // name必须是邮箱格式
        @Email(message="邮箱格式错误")
        private String name;
        ......
    }

  • 运行结果：default message [name]，邮箱格式不对

  • 使用数据校验可以保证数据的正确性，以下是常用的：

    在这里插入图片描述

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    20
    21
    22
    23
    24
    25
    26
    27
    28
    @NotNull(message="名字不能为空")
    private String userName;
    @Max(value=120,message="年龄最大不能查过120")
    private int age;
    @Email(message="邮箱格式错误")

    // 空检查
    @Null 验证对象是否为null
    @NotNull 验证对象是否不为null, 无法查检长度为0的字符串
    @NotBlank 检查约束字符串是不是Null还有被Trim的长度是否大于0,只对字符串,且会去掉前后空格.
    @NotEmpty 检查约束元素是否为NULL或者是EMPTY.

    // Booelan检查
    @AssertTrue 验证 Boolean 对象是否为 true
    @AssertFalse 验证 Boolean 对象是否为 false

    // 长度检查
    @Size(min=, max=) 验证对象（Array,Collection,Map,String）长度是否在给定的范围之内
    @Length(min=, max=) string is between min and max included.

    // 日期检查
    @Past 验证 Date 和 Calendar 对象是否在当前时间之前
    @Future 验证 Date 和 Calendar 对象是否在当前时间之后
    @Pattern 验证 String 对象是否符合正则表达式的规则


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

8. 多环境配置及配置文件位置

profile是Spring对不同环境提供不同配置功能的支持，可以通过激活不同的环境版本，实现快速切换环境

8.1 多配置文件

  • application-{profile}.properties/yaml用来指定多个环境版本

    比如：

    • application-test.properties 代表测试环境配置
    • application-dev.properties 代表开发环境配置

  • 但是Springboot并不会直接启动这些配置文件，它默认使用application.properties主配置文件； 需要通过一个配置来选择需要激活的环境：

    1
    2
    3
    # 比如在配置文件中指定使用dev环境，我们可以通过设置不同的端口号进行测试；
    # 我们启动SpringBoot，就可以看到已经切换到dev下的配置了；
    spring.profiles.active=dev

8.2 yaml多文档块

  • yaml不需要创建多个配置文件，更加方便！

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    19
    server:
      port: 8081

    # 选择要激活那个环境块
    spring:
      profiles:
        active: dev

    ---
    server:
      port: 8082
    spring:
      profiles: dev # 配置环境的名称

    ---
    server:
      port: 8083
    spring:
      profiles: test # 配置环境的名称

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

8.3 配置文件的优先级

  • 优先级1：项目路径下的config文件夹配置文件
    优先级2：项目路径下配置文件
    优先级3：资源路径下的config文件夹配置文件
    优先级4：资源路径下配置文件

    在这里插入图片描述

  • 可以通过spring.config.location来改变默认的配置文件位置

  • 项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；这种情况，一般是后期运维做的多，相同配置，外部指定的配置文件优先级最高，比如：

    java -jar spring-boot-config.jar --
    spring.config.location=F:/application.properties

上一页
2022-09-08 17:10:58 # Springboot # Java
下一页