SpringBoot的配置文件的使用

1、配置文件

SpringBoot使用一个全局的配置文件，配置文件名是固定的；
1）、application.properties
2）、application.yml
配置文件的作用：修改SpringBoot自动配置的默认值，SpringBoot在底层都给我们配置好了；

YAML（YAML Ain’t Markup Language）
​ YAML A Markup Language：是一个标记语言
​ YAML isn’t Markup Language：不是一个标记语言
标记语言：
以前的配置文件，大多是是使用的xml形式，
YAML：以数据为中心，比json、xml等更适合做配置文件
YAML的配置例子

server:port: 8081

XML:

8081

2、YAML的语法：

1、基本语法

k(空格)v：表示一对多键值对(空格必须有)；
以空格的缩紧来控制层级关系，只要是左对齐的一列数据，都是同一个层级的

server:port: 8081path: /hello

属性和值也是大小写敏感的

3、 值的写法

k v：字面两直接写
字符串默认不加上单引号和双引号
”“双引号：不回转义字符串里面的特殊字符，特殊字符会作为本身项表达的意思
name：“zhangsna/nlisi”：输出：zhangsan 换行 lisi

对象、Map(属性和值)(键值对)：
k: v：在下一行也写对象的属性和关系；注意缩紧
对象的属性还是k: v的方式

friends:lastName: zhangsanage: 20

行内的写法：

friends: {lastName: zhangsan,age: 18}

数组（List、Set）：
用 - 值表示数组中的一个元素

pets:- cat- dog- pig

行内的写法

pets: [cat,dog,pig]

3、 配置文件值的注入

配置文件

person:lastName: helloage: 18boss: falsebirth: 2017/12/12maps: {k1: v1,k2: 12}lists:- lisi- zhaoliudog:name: 小狗age: 12

对应的javabean

/*** 将配置文件中配置的每一个属性的值，映射到这个组件中* @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和配置文件中相关的配置进行绑定；*      prefix = "person"：配置文件中哪个下面的所有属性进行一一映射** 只有这个组件是容器中的组件，才能容器提供的@ConfigurationProperties功能；**/
@Component
@ConfigurationProperties(prefix = "person")
public class Person {private String lastName;private Integer age;private Boolean boss;private Date birth;private Map<String,Object> maps;private List<Object> lists;private Dog dog;

此时我们导入配置文件处理器，以后编写代码就有提示了

<dependency><groupId>org.springframework.bootgroupId><artifactId>spring-boot-configuration-processorartifactId><optional>trueoptional>dependency>

注意：properties配置文件在idea中默认UTF-8可能会出现乱码 file-setting-File Encodings-

2、@Value获取值和@ConfigurationProperties获取值比较

配置文件yml还是properties他们都能获取到值；
如果说，我们只是子啊某个业务逻辑层中需要获取一下配置文件中的某项值，使用@Value;
如果说我们专门编写了一个javabean来和配置文件进行映射，我们直接使用@ConfigurationProperties；
###1、配置文件进注入值数据校验

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {/*** *      * *///lastName必须是邮箱格式@Email//@Value("${person.last-name}")private String lastName;//@Value("#{11*2}")private Integer age;//@Value("true")private Boolean boss;private Date birth;private Map<String,Object> maps;private List<Object> lists;private Dog dog;

3、配置文件注入值数据校验

我们只需要在需要校验的类上加上@Validated注解，就可以在指定的属性上使用jsr303数据校验

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {/*** *      * *///lastName必须是邮箱格式@Email//@Value("${person.last-name}")private String lastName;//@Value("#{11*2}")private Integer age;//@Value("true")private Boolean boss;private Date birth;private Map<String,Object> maps;private List<Object> lists;private Dog dog;

4、@PropertySource@ImportResource&@Bean

@PropertySource：加载指定的配置文件；
如果我们将所有bean类的属性的值都配置到主配置文件中，主配置文件就会有大量的配置。我们可以使用@PropertySource注解，指定需要配置的类的属性对应的配置文件的位置，就可以实现配置

//value中写上配置文件的类路径即可
@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {/*** <bean class="Person">*      <property name="lastName" value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>* <bean/>*///lastName必须是邮箱格式// @Email//@Value("${person.last-name}")private String lastName;//@Value("#{11*2}")private Integer age;//@Value("true")private Boolean boss;

@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效；
Spring Boot里面没有Spring的配置文件，我们自己编写的配置文件，也不能自动识别；想让Spring配置文件生效，加载进来，我们就需要使用@ImportResource标注在一个配置类

@ImportResource(locations = {"classpath:beans.xml"})
导入Spring的配置文件让其生效

<beans xmlns="http://www.springframework.org/schema/beans"xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"xsi:schemaLocation="http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans.xsd"><bean id="helloService" class="com.atguigu.springboot.service.HelloService">bean>
beans>

这样就把一个自己编写的Spring配置文件加载到ioc容器中了
但是我们SpringBoot不推荐使用这样方式 我们推荐使用全注解的方式
1）、配置类@Configuration–》Spring配置文件
2）、在方法中使用**@Bean**给容器中添加组件

/*** @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件** 在配置文件中用<bean><bean/>标签添加组件**/
@Configuration
public class MyAppConfig {//将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名@Beanpublic HelloService helloService02(){System.out.println("配置类@Bean给容器中添加组件了...");return new HelloService();

5、配置文件占位符

5、1、随机数

${random.value}、${random.int}、${random.long}
${random.int(10)}、${random.int[1024,65536]}

5、2、占位符获取之前配置的值，如果没有可以是用:指定默认值

person.last-name=张三${random.uuid}
person.age=${random.int}
person.birth=2017/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=${person.hello:hello}_dog
person.dog.age=15

6、Profile

我们在工作中，常常需要在多环境下运行一个项目，我们可以同过一个配置，简单的实现在不同环境下运行一个项目

6、1、多Profile文件

我们在主配置文件编写的时候，文件名可以是 application-{profile}.properties/yml ，默认使用application.properties的配置，我们可以在默认配置文件中使用spring.profiles.active=dev/prod

spring.profiles.active=dev

的方式，更换不同环境配置

6、2 yml支持多文档块的方式

active: prod  指定默认使用的环境

server:port: 8081
spring:profiles:active: prod---
server:port: 8083
spring:profiles: dev---server:port: 8084
spring:profiles: prod  #指定属于哪个环境

6、3 激活指定的profile

1）、在配置文件中指定spring.profiles.active=dev
2）、命令行
java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev；
spring-boot-02-config-0.0.1-SNAPSHOT.jar是打包的jar包名
3）、虚拟机参数
-Dspring.profiles.active=dev

7、配置文件的加载位置

SpringBoot启动会扫描以下位置的application.properties或者application.yml文件，作为Spring Boot的默认配置文件
-file:…/config/
-file:…/
-classpath:/config/
-classpath:/
优先级由高到低，高优先级的配置会覆盖低优先级的配置；
SpringBoot会从这四个位置全部加载主配置文件，互补配置

我们还可以铜鼓哟spring,config.location来改变默认配置文件的位置

项目打包好以后，我们可以使用命令行参数的形式，启动项目的时候来指定配置文件的新位置；指定配置文件和默认加载的这些配置文件共同起作用，形成互补配置；

8、外部配置的加载顺序

SpringBoot也可以从以下位置加载配置：优先级从高到低；高优先级的配置覆盖低优先级的配置，所有的配置会形成互补配置
1、命令行参数
所有的配置都可以在命令行上进行指定
java -jar spring-boot-02-config-02-0.0.1-SNAPSHOT.jar --server.port=8087 --server.context-path=/abc
多个配置用空格分开；–配置项=值

2、来自java.comp/enc的NDI属性
3、java系统属性（System.getPreperties()）
4、操作系统的环境变量
5.RandomValuePropertySource配置的random.*属性值
由jar包外向jar包内进行寻找；

优先加载带profile
** 6、jar包外部的application-{profile}.properties或application.yml（带spring.profile）配置文件**
7、jar包内部的application-{profile}.properties或application.yml（带spring.profile）配置文件

再来加载不带profile
8、jar包外部的applcation.properties或application.yml(不带spring.profile)配置文件
9、jar包内部的application.properties或application.yml（不带spring.profile）配置文件
10.@Configuration注解类上的@PropertySource

11.通过SpringApplication.setDefaultProperties指定的默认属性

所有支持的配置加载来源；
参考官方文档

本文来自互联网用户投稿，文章观点仅代表作者本人，不代表本站立场，不承担相关法律责任。如若转载，请注明出处。 如若内容造成侵权/违法违规/事实不符，请点击【内容举报】进行投诉反馈！