二、SpringBoot——配置及相关注解

1 SpringBoot配置简述

Spring Boot使用一个全局的配置文件
配置文件放在src/main/resources目录或者类路径/config下
配置文件的作用：修改SpringBoot自动配置的默认值；SpringBoot在底层都给我们自动配置好

SpringBoot的两种配置文件
application.properties
application.yml

2 YAML配置

1）YAML概述
YAML（YAML Ain’t Markup Language）
YAML A Markup Language：是一个标记语言
YAML isn’t Markup Language：不是一个标记语言；

标记语言：以前的配置文件；大多都使用的是 xxxx.xml文件；
YAML：以数据为中心，比json、xml等更适合做配置文件；

例子
server:
port: 8081

2）YAML语法（http://www.yaml.org/ 参考语法规范）

a、YAML基本语法
使用缩进表示层级关系
缩进时不允许使用Tab键，只允许使用空格。
缩进的空格数目不重要，只要相同层级的元素左侧对齐即可
大小写敏感

b、YAML 支持的三种数据结构
I) 对象：键值对的集合

第一种写法
friends:
lastName: zhangsan
age: 20

第二种写法（行内写法注意带单引号）
friends: {‘lastName‘: zhangsan,‘age‘: 18}

在这里插入图片描述

II) 数组：一组按次序排列的值
第一种写法
用- (-空格)值表示数组中的一个元素
pets:
‐ cat
‐ dog
‐ pig

第二种写法（行内写法）pets: [cat,dog,pig]

III) 字面量（数字，字符串，布尔，日期）：单个的、不可再分的值
k: v：字面直接来写；
字符串默认不用加上单引号或者双引号；
“”：双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思
name: “zhangsan \n lisi”：输出；zhangsan 换行 lisi
‘’：单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据
name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi

在这里插入图片描述

在这里插入图片描述
https://nodeca.github.io/js-yaml/ yaml语法校验

IV）复合结构。以上写法的任意组合都是可以

注意：Spring Boot使用 snakeyaml 解析yml文件；
https://bitbucket.org/asomov/snakeyaml/wiki/Documentation#markdown-header-yaml-

3 YAML demo

1)新建springboot工程
new–module–spring initializr
2)引入maven依赖

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

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

	<dependency>
		<groupId>org.springframework.boot</groupId>
		<artifactId>spring-boot-configuration-processor</artifactId>
		<version>2.1.6.RELEASE</version>
		<optional>true</optional>
	</dependency>
	导入配置文件处理器这个依赖包，可以提示YAML配置的编写，在这个过程中maven 依赖unkonw,到maven仓库网站查询依赖信息（https://mvnrepository.com/），拷贝过来就解决了
</dependencies>

3）创建Person和Dog两个class
在这里插入图片描述

@ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；
prefix = “person”：配置文件中哪个下面的所有属性进行一一映射
只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能
所以需要和@Component搭配使用

4)新建并编写yaml配置文件
在这里插入图片描述
在测试过程中发现打印的信息为null,
排查总结
首先：校验yaml是否正确（https://nodeca.github.io/js-yaml/）
其次：对应的属性名称是否一致
再次：get set方法是否齐全，@ConfigurationProperties，@Component注解是否有配置
最后：如果有嵌套的属性如dog中的属性名注意使用单引号
5）测试
在这里插入图片描述
6）注销掉yaml配置，在properties中配置如下，进行测试

7 )解决中文乱码
file–setting–Editor–file Encodings,修改为UTF-8,并选择上转asc码

4 配置文件值注入@Value
1）@Value
@Value是Spring中的注解，作用类似于xml中配置bean

注销掉@ConfigurationProperties 添加@Value查看测试结果
在这里插入图片描述
2）@Value和@ConfigurationProperties为属性注值对比

属性名匹配规则（Relaxed binding松散绑定）
– person.firstName：使用标准方式
– person.first-name：大写用-
– person.first_name：大写用_
– PERSON_FIRST_NAME：
• 推荐系统属性使用这种写法

@ConfigurationProperties
– 与@Bean结合为属性赋值
– 与@PropertySource（只能用于properties文件）结合读取指定文件
• @ConfigurationProperties Validation
– 支持JSR303进行配置文件值校验；

在这里插入图片描述
3）如何选择@ConfigurationProperties @Value
如果说我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；
如果说我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties；

5 @PropertySource 加载指定的配置文件
配置都写在application.yml或者application.properties文件中会导致全局配置文件过大，不便管理。因此新建一个person.yml专门配置Person属性，
在这里插入图片描述
6 @ImportResource导入Spring的配置文件
导入Spring的配置文件，让配置文件里面的内容生效
Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；想让Spring的配置文件生效，加载进来；@ImportResource标注在一个配置类上
在这里插入图片描述

推荐用下面的方式

SpringBoot推荐给容器中添加组件的方式；推荐使用全注解的方式
1）、配置类@Configuration------>Spring配置文件相当于spring 的xml配置文件
指明当前类是一个配置类；就是来替代之前的Spring配置文件
2）、使用@Bean给容器中添加组件；相当于xml中的标签
将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
在这里插入图片描述

7 配置文件占位符

1）配置文件中可以使用随机数
${random.value}、$ {random.int}、${random.long}
${random.int(10)}、$ {random.int[1024,65536]}

2）属性配置占位符
![在这里插入图片描述](https://img-blog.csdnimg.cn/20190620132848384.png
可以在配置文件中引用前面配置过的属性（优先级前面配置过的这里都能用）。
${app.name:默认值}来指定找不到属性时的默认值

在这里插入图片描述

8 Profile
Profile是Spring对不同环境提供不同配置功能的支持，可以通过激活、
指定参数等方式快速切换环境
1）多profile文件形式：
格式：application-{profile}.properties/yml：
application-dev.properties、application-prod.properties

2）yml多profile文档块模式：
在这里插入图片描述
3)激活方式：
命令行java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev可以直接在测试的时候，配置传入命令行参数
–spring.profiles.active=dev
配置文件 spring.profiles.active=dev
jvm参数 –Dspring.profiles.active=dev

9 配置文件加载位置

spring boot 启动会扫描以下位置的application.properties或者
application.yml文件作为Spring boot的默认配置文件
– file:./config/ 当前工程的config目录下
– file:./
– classpath:/config/ 类路径下的config目录下
– classpath:/
– 以上是按照优先级从高到低的顺序，所有位置的文件都会被加载，高优先级配置内容会覆盖低优先级配置内容。
SpringBoot会从这四个位置全部加载主配置文件；互补配置；
– 我们也可以通过配置spring.config.location来改变默认配置
项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默认加载的这些配置文件共同起作用形成互补配置；
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --spring.config.location=G:/application.properties
不用改原来的配置，直接使用新配置有利于运维

10 外部配置加载顺序
Spring Boot 支持多种外部配置方式
这些方式优先级如下：（https://docs.spring.io/spring-boot/docs/current-
SNAPSHOT/reference/htmlsingle/#boot-features-external-config）
SpringBoot也可以从以下位置加载配置；优先级从高到低；高优先级的配置覆盖低优先级的配置，所有的配置会形成互补配置
1）.命令行参数
所有的配置都可以在命令行上进行指定
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc 多个配置用空格分开； --配置项=值
2.）来自java:comp/env的JNDI属性
3.）Java系统属性（System.getProperties()）
4）操作系统环境变量
5.）RandomValuePropertySource配置的random.*属性值

由jar包外向jar包内进行寻找；优先加载带profile；再来加载不带profile
6） jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
7） jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
8）jar包外部的application.properties或application.yml(不带spring.profile)配置文件
9） jar包内部的application.properties或application.yml(不带spring.profile)配置文件
10） @Configuration注解类上的@PropertySource
11）通过SpringApplication.setDefaultProperties指定的默认属性

二、SpringBoot——配置及相关注解

猜你喜欢