Spring Boot配置文件和yaml语法

傷城~ 2024-04-21 08:01 11阅读 0赞

> #### ✨Spring Boot配置 ####
> 
>  *  🏖️1.全局配置文件
>  *   *  🌈1.1全局配置文件概述
>      *  🌈1.2配置文件的位置和加载顺序
>  *  🏖️2.多环境配置
>  *   *  🌈 2.1多环境配置文件
>      *  🌈2.2激活某个环境配置
>  *  🏖️3.yaml
>  *   *  🌈3.1yaml概述
>      *  🌈3.2基本语法
>      *  🌈3.3值的写法
>      *   *  ❄️3.3.1字面量
>          *  ❄️3.3.2 日期类型
>          *  ❄️3.3.3对象
>          *  ❄️3.3.4 数组、List、Set
>  *  🏖️4.利用配置文件来给属性赋值
>  *   *  🌈4.1@Value,通过$\{\}直接获得配置文件的配置值注入
>      *  🌈4.2@ConfigurationProperties
>      *  🌈4.3@EnableConfigurationProperties
>      *  🌈4.4@PropertySource
>  *  🏖️5.自定义配置类
>  *   *  🌈5.1@Configuration
>      *  🌈5.2@Bean
>      *  🌈5.3代码演示
>      *  🌈5.4查看启动类的注解
> 
>   
> 📃个人主页: [不断前进的皮卡丘][Link 1]  
> 🌞博客描述: **梦想也许遥不可及，但重要的是追梦的过程，用博客记录自己的成长，记录自己一步一步向上攀登的印记**  
> **🔥网站推荐：千里之行，始于足下。每天坚持刷题，巩固所学知识，也为将来找工作，面试做好准备**\----- [刷题神器][Link 2]

## 🏖️1.全局配置文件 ##

### 🌈1.1全局配置文件概述 ###

> Spring Boot使用一个全局的配置文件，通过配置文件，可以修改Spring Boot自动配置的默认值，配置文件名是固定的，文件名必须是`application`  
> 配置文件格式`properties`或者`yml`,比如`application.properties`或者`application.yml`  
> 比如，我们可以通过修改application.properties来自定义服务器的端口号  
> ![在这里插入图片描述][b83e6bc3d11a4c7abef6710a8065cd6d.png]  
> 我们来新建一个项目  
> ![在这里插入图片描述][5e8e1917c56c49b3902e83eba1f44666.png]  
> ![在这里插入图片描述][bf823c11dbf745c58582040d9dbd36fa.png]  
> ![在这里插入图片描述][99849361f40c4c0890ff6876da00ae1b.png]

### 🌈1.2配置文件的位置和加载顺序 ###

*  /config/:当前项目根目录下的config目录下
 *  /:当前项目的根目录下
 *  /resources/config/:resources目录下的config目录下
 *  /resources/:resources目录下

加载的优先级是从上到下，由高到低  
![在这里插入图片描述][6e9a8ed7e4ae48fca6b4938ef8d0c179.png]

## 🏖️2.多环境配置 ##

> 开发过程中，至少需要三个环境(开发环境dev-测试环境test-生产环境pro),但是每一个环境的配置都不一样，比如数据库等各种配置，Spring Boot提供多环境配置的机制，让开发者灵活根据需求而切换不同的配置环境  
> 比如:我们可以通过在不同环境下面，服务器端口号不同进行测试

### 🌈 2.1多环境配置文件 ###

> 在Spring Boot中多环境配置文件名必须满足:`application-{profile}.properties`的固定格式。  
> 其中，\{profile\}对应的是我们的环境标识，比如:

application-dev.properties:开发环境
    application-test.properties:测试环境
    application-prod.properties:生产环境

### 🌈2.2激活某个环境配置 ###

在application.properties文件中添加配置,`spring.profiles.active={profile}` 来激活  
比如:

spring-profiles.active=test  表示开启测试环境

![在这里插入图片描述][772f744228e7438983514d62f3a9936f.png]  
![在这里插入图片描述][9f9ec75e6b7841669f95d488578316f6.png]

## 🏖️3.yaml ##

### 🌈3.1yaml概述 ###

yaml(YAML A/isn’t Markup Language),后缀名是`.yaml`或者`.yml`。有两层含义

*  YAML是一个标记语言
 *  YAML不是一个标记语言

yaml是以`数据为中心`,比如json\\xml等更适合作为配置文件  
使用`#`添加注释

# 服务器端口
    server:
    	port: 8080

> 当我们创建一个Spring Boot项目的时候，它默认是给的配置文件是`.properties`的形式,我们也可以把它修改成`yaml`的形式  
> ![在这里插入图片描述][5b2063eabca44c428f1184d105ed7f3d.png]  
> ![在这里插入图片描述][db9cee168c774fa8a46b1269ba4544fb.png]  
> ![在这里插入图片描述][6f481b905dd6487ea79d864cccdfb3f6.png]

### 🌈3.2基本语法 ###

*  k:(空格)v,表示一对键值对，`空格一定要有`
 *  用缩进来控制层级关系，只要是左对齐的一列数据，都是同一个层级的
 *  属性和值是区分大小写的
 *  缩进的空格数不重要，但同级元素必须左侧对齐。

例如:

spring:
      profiles: dev
      
      datasource:
        url: jdbc:mysql://127.0.01/banchengbang_springboot
        username: root
        password: root
        driver-class-name: com.mysql.jdbc.Driver

### 🌈3.3值的写法 ###

YAML 支持以下三种数据结构：

*  对象：键值对的集合
 *  数组：一组按次序排列的值
 *  字面量：单个的、不可拆分的值

#### ❄️3.3.1字面量 ####

*  字面量:普通的值(数字，字符串，布尔)
    
     *  字符串默认不需要加上单引号或者双引号
     *  字符串如果加上双引号，那么转义字符有效
     *  字符串如果加上单引号，那么转义字符只是一个普通的字符串数据
     *  `字面量是指单个的，不可拆分的值，例如：数字、字符串、布尔值、以及日期等`

name: "zhangsan \n lisi"
    # 输出的结果是
    zhangsan
    lisi

name: 'zhangsan \n lisi'
    # 输出的结果是
    zhangsan \n lisi

#### ❄️3.3.2 日期类型 ####

*  日期类型
    
     *  日期格式必须是 :“yyyy/MM/dd”

birth: 1980/6/15

*  对象(属性和值)、Map(键值对)

#### ❄️3.3.3对象 ####

对象写法方式一:换行缩进

person: 
      lastName: zhangsan
      age: 20
      book:
        price: 222

对象写法方式二:行内写法

book: {
        name: java,price: 2000}

#### ❄️3.3.4 数组、List、Set ####

缩进的写法:用\-表示数组中的一个元素

pets:
      - cat
      - dog
      - pig

行内写法，外部使用\[\]表示

pets: [cat,dog,pig]

## 🏖️4.利用配置文件来给属性赋值 ##

### 🌈4.1@Value,通过$\{\}直接获得配置文件的配置值注入 ###

> ![在这里插入图片描述][56378f6a3c7e46ec9230f488cfb9f940.png]  
> 测试  
> ![在这里插入图片描述][b3fed4391e3147e99b2c7a940188193d.png]

### 🌈4.2@ConfigurationProperties ###

可以让属性和配置文件中的配置自动绑定,需要指明一个prefix(前缀)

> 先把文件编码方式改成UTF-8![>][7b6cbf9214d64202a7e876f14670aa74.png]  
> 还是以刚刚的Book类为例子,我们可以先在pom.xml文件中添加依赖  
> ![在这里插入图片描述][1a1ad648f1ff4a24b2b14894942293cd.png]  
> 加入这个依赖的作用其实是为了便于我们写代码，我们在配置文件中可以看到提示  
> ![在这里插入图片描述][ec57033f7b844ba8a78c0848993c1259.png]  
> ![在这里插入图片描述][2ec0f78b0b8145dd9bfbdd1f9011ee81.png]  
> 测试一下  
> ![在这里插入图片描述][d943cf886ca544d28449096048477a2e.png]

### 🌈4.3@EnableConfigurationProperties ###

*  方法一:通过@Component注解可以把指定类注入到Spring容器中
 *  方法二:在Spring Boot启动类上，添加@EnableConfigurationProperties,把指定的类注入到Spring容器中，推荐这个方法，便于统一管理  
    ![在这里插入图片描述][72b5c3daea2c463fb65d02ec6bb89544.png]  
    我们点进这个注解去看看(大家对源码感兴趣的可以自己去深入了解)  
    ![在这里插入图片描述][2f4f82b9f937456cb764d761a21b886c.png]

### 🌈4.4@PropertySource ###

可以指定加载一个独立的配置文件信息  
用法:

*  加载指定的属性文件（\*.properties）到 Spring 的 Environment 中。可以配合 @Value 和@ConfigurationProperties 使用。
 *  @PropertySource 和 @Value  
    组合使用，可以将自定义属性文件中的属性变量值注入到当前类的使用@Value注解的成员变量中。
 *  @PropertySource 和 @ConfigurationProperties  
    组合使用，可以将属性文件与一个Java类绑定，将属性文件中的变量值注入到该Java类的成员变量中。

> 比如说，我们本来是在全局配置文件中指定那些属性的信息，但是可能有很多需要配置，这个时候，我们可以把这些抽取出来，成为一个个小的配置文件，但是要注意的是，这个时候，这些配置文件只能是properties形式的，不能是yaml形式的  
> ![在这里插入图片描述][7ba1389fd0c748b7922e0f0ed4ef3394.png]  
> ![在这里插入图片描述][65bdf657ac3c48ee81c12dd7c1e69cc9.png]  
> 有一个地方需要注意，这里的话，我们得使用@Component注解，如果使用@EnableConfigurationProperties进行注入的话，其实我们在测试的时候，会发现属性是null

## 🏖️5.自定义配置类 ##

> 从Spring3.0，@Configuration用于定义配置类，可以替换xml配置文件，被注解的类内部包含有一个或多个被@Bean注解的方法，这些方法的返回值会被创建实例，托管给Spring容器

### 🌈5.1@Configuration ###

> @Configuration标注在类上面，相当于把这个类作为Spring的xml配置文件中的`<bean>`，作用是配置spring容器(应用上下文)  
> @Configuration注解的配置类有下面的几个要求:  
> 1️⃣不可以是final类型  
> 2️⃣不可以是匿名类  
> 3️⃣嵌套的configuration必须是静态类

### 🌈5.2@Bean ###

> @Bean标注在方法上(返回某个实例的方法),等价于spring的xml配置文件中的<bean>,作用是注册bean对象

### 🌈5.3代码演示 ###

> 我们先写一个实体类Stu  
> ![在这里插入图片描述][36f9a90960274e56bba0b4db2c52ad40.png]  
> 然后写一个自定义的配置类  
> ![在这里插入图片描述][a0c8bd22024e4f49ad43ba62396644b0.png]  
> 测试  
> ![在这里插入图片描述][d476b7e8e015495998913e02b632076a.png]

### 🌈5.4查看启动类的注解 ###

> ![在这里插入图片描述][d09e8347dc114ed3bfdaf016e83134df.png]  
> 点进去@SpringBootApplication注解  
> ![在这里插入图片描述][77ed66d4041048a7ac45bd35f9abea1c.png]  
> 我们可以看到里面有@ComponentScan(包扫描)和@SpringBootConfiguration(继承于@Configuration),这样子就会把扫描到的包下面的类注入到spring容器中

[Link 1]: https://blog.csdn.net/qq_52797170?spm=1010.2135.3001.5343
[Link 2]: https://www.nowcoder.com/link/pc_csdncpt_pkq_sf
[b83e6bc3d11a4c7abef6710a8065cd6d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/1b0fa9293c7942fb8e56094034747ff5.png
[5e8e1917c56c49b3902e83eba1f44666.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/d92f4ac99d1b4c7a942ce7ed6123b238.png
[bf823c11dbf745c58582040d9dbd36fa.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/4dcf78bcaf734ca99beb008d1fff633f.png
[99849361f40c4c0890ff6876da00ae1b.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/920afa2b8ac44499bbd183c58cc2c818.png
[6e9a8ed7e4ae48fca6b4938ef8d0c179.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/ae0a95555fd2497caf63b2292a23268a.png
[772f744228e7438983514d62f3a9936f.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/afcba54e566d411288bd3a0a73dcf510.png
[9f9ec75e6b7841669f95d488578316f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/8dd4692f9e8e451f9794ac47842f0017.png
[5b2063eabca44c428f1184d105ed7f3d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/8b88c7d4078b495d8a85d3799c63d3f9.png
[db9cee168c774fa8a46b1269ba4544fb.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/cff932232fe243a1b55708840a21ec36.png
[6f481b905dd6487ea79d864cccdfb3f6.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/a57f72b3c5724fa5bad7054717fc347c.png
[56378f6a3c7e46ec9230f488cfb9f940.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/eb5f1947ca394073afb314354c66a546.png
[b3fed4391e3147e99b2c7a940188193d.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/8105b2e4f79a444782af36331e7b21c6.png
[7b6cbf9214d64202a7e876f14670aa74.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/882c374e59754f43a46b5be28ecb5299.png
[1a1ad648f1ff4a24b2b14894942293cd.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/32d4796e9d2c41cc84872270af49500a.png
[ec57033f7b844ba8a78c0848993c1259.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/0a0b4a40e30f473d889a9a600a41fec9.png
[2ec0f78b0b8145dd9bfbdd1f9011ee81.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/f36adc4996b14e558214d5686b450fcf.png
[d943cf886ca544d28449096048477a2e.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/037ff0c1e44a42b0bc94e906afe061a2.png
[72b5c3daea2c463fb65d02ec6bb89544.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/8446c4fb5f50413ca48bb256f6b2d907.png
[2f4f82b9f937456cb764d761a21b886c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/c799db2128584d4993cfb1e9f7fe420e.png
[7ba1389fd0c748b7922e0f0ed4ef3394.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/39330eb54e45406da3baa69d074ab731.png
[65bdf657ac3c48ee81c12dd7c1e69cc9.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/f6a517270d40429c9089cc13629a04aa.png
[36f9a90960274e56bba0b4db2c52ad40.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/e73ddc35974644808a5baa61f3679d4e.png
[a0c8bd22024e4f49ad43ba62396644b0.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/c3fdbb1b56504ae490a7193a98cde876.png
[d476b7e8e015495998913e02b632076a.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/0a76c0fd18684008896b8850b17a2c7d.png
[d09e8347dc114ed3bfdaf016e83134df.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/fe5c8f3ed6664ef496af8a32f78a4f42.png
[77ed66d4041048a7ac45bd35f9abea1c.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/21/2afbaddcd0884cd8813fde237995597b.png