【串线篇】spring boot配置文件大全【上】

一、配置文件

SpringBoot使用一个全局的配置文件，配置文件名是固定的；

• • application.properties
• • application.yml

配置文件的作用：修改SpringBoot自动配置的默认值；（因为默认SpringBoot在底层都给我们自动配置好；）

YAML（YAML Ain't Markup Language） YAML A Markup Language：是一个标记语言

YAML isn't Markup Language：不是一个标记语言； 标记语言：

以前的配置文件；大多都使用的xxxx.xml文件；

YAML：以数据为中心，比json、xml等更适合做配置文件；

YAML：配置例子

server:
    port: 8081

XML：配置例子

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

二、YAML语法

2.1、基本语法

k:(空格)v：表示一对键值对（空格必须有）；

如果需要层级关系以空格的缩进来控制层级关系；只要是左对齐的一列数据，都是同一个层级的

server:
    port: 8081
    path: /hello

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

2.2、值的写法

字面量：普通的值（数字，字符串，布尔,日期）

k: v：字面直接来写；

字符串默认不用加上单引号或者双引号；

双引号；不会转义字符串里面的特殊字符；特殊字符会作为本身想表示的意思

name:         "zhangsan         \n         lisi"： 输 出 ；zhangsan         换 行       lisi''

单引号；会转义特殊字符，特殊字符最终只是一个普通的字符串数据

name: ‘zhangsan \n lisi’：输出；zhangsan \n lisi

对象、Map（属性和值）（键值对）：

k: v：在下一行来写对象的属性和值的关系；注意缩进对象还是k: v的方式

friends:
    lastName:  zhangsan
    age: 20

行内写法：

friends:  {lastName:  zhangsan,age:  18}

数组（List、Set）：

用- 值表示数组中的一个元素

pets:
    ‐ cat
    ‐ dog
    ‐ pig

行内写法

pets: [cat,dog,pig]

三、配置文件值注入

配置文件yml

person:
    lastName:  hello
    age: 18
    boss: false
    birth: 2017/12/12
    maps:  {k1:  v1,k2:  12}
    lists:
      ‐ lisi
      ‐ zhaoliu
    dog:
      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.boot</groupId><artifactId>spring‐boot‐configuration‐processor</artifactId><optional>true</optional></dependency>

3.1、properties配置文件在idea中默认utf-8可能会乱码

调整

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

	@ConfigurationProperties	@Value
功能	批量注入配置文件中的属性	一个个指定
松散绑定（松散语法）	支持	不支持
SpEL(#{})	不支持	支持
JSR303数据校验	支持	不支持
复杂类型封装(比如map)	支持	不支持

配置文件yml还是properties他们都能获取到值；

如果说，我们只是在某个业务逻辑中需要获取一下配置文件中的某项值，使用@Value；

如果说，我们专门编写了一个javaBean来和配置文件进行映射，我们就直接使用@ConfigurationProperties；√

配置文件注入值数据校验（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;

/**

* <bean class="Person">

*<property  name="lastName"  value="字面量/${key}从环境变量、配置文件中获取值/#{SpEL}"></property>

* <bean/>

*/

private Date birth;

private  Map<String,Object>  maps; 

private  List<Object>  lists; 

private Dog dog;

3.3、@PropertySource&@ImportResource&@Bean

@PropertySource：加载指定的配置文件比如person.properties；（之前只能默认从全局配置文件中获取值；）

/**
*    将配置文件中配置的每一个属性的值，映射到这个组件中
*    @ConfigurationProperties：告诉SpringBoot将本类中的所有属性和
*配置文件中相关的配置进行绑定；
*prefix = "person"：配置文件中哪个下面的所有属性进行一一映射
*    只有这个组件是容器中的组件，才能容器提供的*@ConfigurationProperties功能；
*    @ConfigurationProperties(prefix  =  "person")默认从全局配置文件*中获取值；
*/

@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的配置文件，如果我们自己编写的配置文件bean.xml，将不能自动识别； 想让Spring的配置文件生效，加载进来；

@ImportResource标注在一个配置

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

类上（可以就是那个主程序类上，那就是主配置类SpringBootConfigApplication.java）

不来编写Spring的配置文件（因为不推荐）

<?xml  version="1.0"  encoding="UTF‐8"?>
<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>

SpringBoot推荐给容器中添加组件的方式；推荐使用全注解的方式

1、我们也可以自己写配置类，配置类@Configuration------>替代bean.xml Spring配置文件

2、使用@Bean给容器中添加组件

/**
    *  @Configuration：指明当前类是一个配置类；就是来替代之前的Spring配置文件

    *
        * 在配置文件中用<bean><bean/>标签添加组件
        *
*/ 
@Configuration
public  class  MyAppConfig  {

//将方法的返回值添加到容器中；容器中这个组件默认的id就是方法名
@Bean
public  HelloService  helloService02(){
System.out.println("配置类@Bean给容器中添加组件了..."); 
return  new  HelloService();
　　}
}