【Spring Boot】二、Spring Boot 配置

版权声明：本文为博主原创文章，未经博主允许不得转载。 https://blog.csdn.net/tian330726/article/details/87120104

本文详细描述 Spring Boot 的配置文件

一、配置文件

Spring Boot使用一个全局的配置文件

• application.properties
• application.yml

配置文件放在src/main/resources目录或者类路径 /config 下

**yml **是 YAML（YAML Ain’t Markup Language）语言的文件，以数据为中
心，比 json、xml 等更适合做配置文件

http://www.yaml.org/ 参考语法规范

全局配置文件的可以对一些默认配置值进行修改

YAML ： 配置例子

server:
  port: 8081

XML ：配置例子

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

二、YAML语法

1、基本语法

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

2、YAML 支持的三种数据结构

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

2.1、字面量

• 数字、字符串、布尔、日期
• 字符串
  • 默认不使用引号
  • 可以使用单引号或者双引号，单引号会转义特殊字符，双引号不会转义
  • 字符串可以写成多行，从第二行开始，必须有一个单空格缩进，换行符会被转为空格。

name: “zhangsan \n lisi”：输出；zhangsan 换行 lisi

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

2.2、对象（Map）

• 对象的一组键值对，使用冒号分隔。如：username: admin
• 冒号后面跟空格来分开键值
• {k: v}是行内写法

行内写法：

friends: {name: xiaoming,age: 18}

2.2、数组（List、Set）：

一组连词线（-）开头的行，构成一个数组，[]为行内写法

pets: [cat,dog,pig]

3、配置文件值注入

注入类：

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

    private String name;
    private Integer age;
    private Boolean boss;
    private Date birth;

    private Map<String, Object> maps;
    private List<Object> lists;
    private Animal animal;
    
    getter/setter
}

yaml配置文件：

person:
  name: xiaoming
  age: 18
  boss: true
  birth: 2010/01/01
  maps:
    hello: world
    say: hello
  lists: [dog,cat,pig]
  animal:
    name: xiaohuang
    age: 3

打印：

Person{name='xiaoming', age=18, boss=true, birth=Fri Jan 01 00:00:00 CST 2010, maps={hello=world, say=hello}, lists=[dog, cat, pig], animal=Animal{name='xiaohuang', age=3}}

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

File --> Editor --> File Encodings

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

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

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

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

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

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

@Component
@ConfigurationProperties(prefix = "person")
@Validated
public class Person {

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

//    @Value("${person.name}")
//    @Email
    private String name;
//    @Value("#{11*3}")
    private Integer age;
//    @Value("false")
    private Boolean boss;
//    @Value("2010/01/01")
    private Date birth;

    // 通过@Value的测试：Person{name='小马', age=33, boss=false, birth=Fri Jan 01 00:00:00 CST 2010, maps=null, lists=null, animal=null}

    //    @Value("${person.maps}")---不支持这种写法（IllegalArgumentException）
    private Map<String, Object> maps;
    private List<Object> lists;
    private Animal animal;

3.4、@PropertySource & @ImportResource & @Bean

@PropertySource：加载指定的配置文件；

person.properties

# 配置person的属性
person.name=小李
person.age=15
person.birth=2011/01/01
person.boss=false
person.animal.name=小灰
person.animal.age=1
person.maps.h1=11
person.maps.jj=11
person.lists=1,2,3

Person.java 部分

@PropertySource(value = {"classpath:person.properties"})
@Component
@ConfigurationProperties(prefix = "person")
//@Validated
public class Person {
    ...
}

test测试数据

Person{name='小李', age=15, boss=false, birth=Sat Jan 01 00:00:00 CST 2011, 
maps={h1=11, jj=11}, lists=[1, 2, 3], animal=Animal{name='小灰', age=1}}

@ImportResource：导入Spring的配置文件，让配置文件里面的内容生效；

bean的配置文件：beans.xml

<bean id="helloService" class="com.tyron.springboot.service.HelloService"></bean>

启动类：SpringBoot02ConfigApplication.java

@ImportResource(value = "classpath:beans.xml")
@SpringBootApplication
public class SpringBoot02ConfigApplication {

    public static void main(String[] args) {
        SpringApplication.run(SpringBoot02ConfigApplication.class, args);
    }
}

测试方法：

@Autowired
ApplicationContext ioc;

@Test
public void testService() {
    boolean containsBean = ioc.containsBean("helloService");
    System.out.println("containsBean：" + containsBean);
}

// 输出结果：
containsBean：true

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

配置类 MyAppConfig：

/**
 * @Configuration 指明当前类是配置类，代替之前的xml配置文件
 * 在Spring配置文件中使用<bean></bean>，在配置文件中使用@Bean 注解
 */
@Configuration
public class MyAppConfig {

    /**
     * @Bean 注解的作用是将方法的返回值添加到容器中；
     * 容器中该组件默认的id就是方法名
     */
    @Bean
    public HelloService helloService02() {
        System.out.println("通过配置类的方式注入Bean");
        return new HelloService();
    }
}

测试方法：

@Test
public void testService() {
    boolean containsBean = ioc.containsBean("helloService02");
    System.out.println("containsBean：" + containsBean);
}

// 输出结果
通过配置类的方式注入Bean
containsBean：true

4、配置文件占位符

4.1 、随机数

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

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

${person.hello:hello}_h1

例子：

# 配置person的属性
person.name=小李${random.uuid}
person.age=${random.int}
person.birth=2011/01/01
person.boss=false
person.animal.name=${person.name}_animal
person.animal.age=${random.int(10)}
person.maps.h1=${person.hello:hello}_h1
person.maps.jj=${random.value}
person.lists=1,2,3

# 打印结果
Person{name='小马33922644-860e-4655-b1cd-0f4da7862169', age=-1366299504, boss=false, birth=Sat Jan 01 00:00:00 CST 2011, maps={h1=hello_h1, jj=f4903021ea950ac7529dbcd9e300fc26}, lists=[1, 2, 3], animal=Animal{name='小马b3c42bef-e6a1-4bbe-98fd-e1a7ed771238_animal', age=7}}

5、Profile

5.1、多Profile

在主配置文件编写的时，文件名可以是 application-{profile}.properties/yml

默认使用 application.properties 的配置；

5.2、yml支持多文档块方式

server:
  port: 8081
spring:
  profiles:
    active: dev
---
server:
  port: 8082
spring:
  profiles: dev

---
server:
  port: 8083
spring:
  profiles: prod

5.3、激活指定profile

• 在配置文件中指定 spring.profiles.active=dev [properties的格式]，yml的激活方式如上；
• 启动参数[Program arguments]：–spring.profiles.active=dev
• 命令行：mvn-package 打成jar包后，java -jar spring-boot-02-config-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
• 虚拟机参数[VM options]：-Dspring.profiles.active=dev

注：properties文件的优先级高于yml文件

6、配置文件加载位置

springboot 启动会扫描以下位置的application.properties或者application.yml文件作为Spring boot的默认配置文件

–file:./config/

–file:./

–classpath:/config/

–classpath:/

注：[-file ：当前项目的文件路径；–classpath：类路径]

优先级由高到底，高优先级的配置会覆盖低优先级的配置；

如图：

SpringBoot会从这四个位置全部加载主配置文件；互补配置；

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

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

java -jar spring-boot-02-config02-0.0.1-SNAPSHOT.jar --spring.config.location=D/application.properties

7、外部配置加载顺序

官方文档地址：https://docs.spring.io/spring-boot/docs/1.5.9.RELEASE/reference/htmlsingle/#boot-features-external-config

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.*属性值

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指定的默认属性

8、自动配置原理

配置文件能配置的属性参照：官方配置文档

自动配置原理解析

1）、SpringBoot启动的时候加载主配置类，开启了自动配置功能 @EnableAutoConfiguration

2）、@EnableAutoConfiguration 作用：

• 利用 EnableAutoConfigurationImportSelector 给容器导入一些组件；
• 可以插入 EnableAutoConfigurationImportSelector 的父类 AutoConfigurationImportSelector 中 selectImports() 方法的内容；
• List configurations = this.getCandidateConfigurations(annotationMetadata, attributes);获取候选的配置
• 通过 SpringFactoriesLoader.loadFactoryNames() 方法扫描所有jar包类路径下的 META-INF/spring.factories 文件，把扫描到的这些文件的内容包装成properties对象从properties中获取到EnableAutoConfiguration.class类（类名）对应的值，然后把他们添加在容器中；
• D:\maven\repository\org\springframework\boot\spring-boot-autoconfigure\1.5.9.RELEASE\spring-boot-autoconfigure-1.5.9.RELEASE.jar!\META-INF\spring.factories 将 类路径下 META-INF/spring.factories 里面配置的所有EnableAutoConfiguration的值加入到了容器中；
• 每一个这样的 xxxAutoConfiguration类都是容器中的一个组件，都加入到容器中来做自动配置；

3）、每一个自动配置类进行自动配置功能；

4）、以**HttpEncodingAutoConfiguration（Http编码自动配置）**为例解释自动配置原理；

@Configuration // 表示这是一个配置类，类似以前的配置文件，给容器中添加组件
@EnableConfigurationProperties({HttpEncodingProperties.class})// 启动指定类ConfigurationProperties功能；将配置文件中对应的值和HttpEncodingProperties绑定起来
@ConditionalOnWebApplication // Spring底层@Conditional注解，根据不同条件，如果满足指定的条件，整个配置类里面的配置就会生效。 判断当前应用是否为web应用，如果是，当前配置类生效
@ConditionalOnClass({CharacterEncodingFilter.class})// 判断当前项目有没有该类   CharacterEncodingFilter 为SpringMVC中解决乱码问题的过滤器；
@ConditionalOnProperty(
    prefix = "spring.http.encoding",
    value = {"enabled"},
    matchIfMissing = true
)// 判断配置文件中是否存在某个配置，如上表示即使我们不配置spring.http.encoding.enabled默认为true
public class HttpEncodingAutoConfiguration {
    // 与SpringBoot的配置文件映射
    private final HttpEncodingProperties properties;

    // 有参构造函数，参数的值就从容器中拿
	public HttpEncodingAutoConfiguration(HttpEncodingProperties properties) {
		this.properties = properties;
	}
    
    @Bean // 给容器中添加一个组件，且该组件的某些属性需从properties中获取
	@ConditionalOnMissingBean(CharacterEncodingFilter.class)
	public CharacterEncodingFilter characterEncodingFilter() {
		CharacterEncodingFilter filter = new OrderedCharacterEncodingFilter();
		filter.setEncoding(this.properties.getCharset().name());
		filter.setForceRequestEncoding(this.properties.shouldForce(Type.REQUEST));
		filter.setForceResponseEncoding(this.properties.shouldForce(Type.RESPONSE));
		return filter;
	}
    
	...
}

根据当前不同的条件判断配置类是否生效。

5）、所有在配置文件中能配置的属性都在xxxxProperties类中封装；

@ConfigurationProperties(prefix = "spring.http.encoding")// 从配置文件中获取指定的值和bean的属性进行绑定
public class HttpEncodingProperties {
    public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");
    	...
}

精髓

1）、SpringBoot启动时会加载大量的自动配置类；

2）、开发功能前查看SpringBoot是否已配置好默认的自动配置类；

3）、根据配置类对应的properties类中属性，指定属性值。

xxxxAutoConfigurartion：自动配置类；给容器中添加组件

xxxxProperties:封装配置文件中相关属性；

9、@Conditional注解

作用：必须是@Conditional指定的条件成立，才给容器中添加组件，配置配里面的所有内容才生效；

@Conditional扩展注解	作用（判断是否满足当前指定条件）
@ConditionalOnJava	系统的java版本是否符合要求
@ConditionalOnBean	容器中存在指定Bean；
@ConditionalOnMissingBean	容器中不存在指定Bean；
@ConditionalOnExpression	满足SpEL表达式指定
@ConditionalOnClass	系统中有指定的类
@ConditionalOnMissingClass	系统中没有指定的类
@ConditionalOnSingleCandidate	容器中只有一个指定的Bean，或者这个Bean是首选Bean
@ConditionalOnProperty	系统中指定的属性是否有指定的值
@ConditionalOnResource	类路径下是否存在指定资源文件
@ConditionalOnWebApplication	当前是web环境
@ConditionalOnNotWebApplication	当前不是web环境
@ConditionalOnJndi	JNDI存在指定项

自动配置类必须在一定的条件下才能生效；

我们可以通过启用 debug=true 属性；来让控制台打印自动配置报告，这样我们就可以很方便的知道哪些自动配置类生效；

=========================
AUTO-CONFIGURATION REPORT
=========================


Positive matches:
-----------------

   DispatcherServletAutoConfiguration matched:
      - @ConditionalOnClass found required class 'org.springframework.web.servlet.DispatcherServlet'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
      - @ConditionalOnWebApplication (required) found StandardServletEnvironment (OnWebApplicationCondition)

   DispatcherServletAutoConfiguration.DispatcherServletConfiguration matched:
      - @ConditionalOnClass found required class 'javax.servlet.ServletRegistration'; @ConditionalOnMissingClass did not find unwanted class (OnClassCondition)
      - Default DispatcherServlet did not find dispatcher servlet beans (DispatcherServletAutoConfiguration.DefaultDispatcherServletCondition)
          
Negative matches:
-----------------

   ActiveMQAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required classes 'javax.jms.ConnectionFactory', 'org.apache.activemq.ActiveMQConnectionFactory' (OnClassCondition)

   AopAutoConfiguration:
      Did not match:
         - @ConditionalOnClass did not find required classes 'org.aspectj.lang.annotation.Aspect', 'org.aspectj.lang.reflect.Advice' (OnClassCondition)