Springboot--外部化配置(一)

2019-01-19 本文已影响0人 NealLemon

Springboot--外部化配置(一)

笔记是学习了小马哥在慕课网的课程的《Spring Boot 2.0深度实践之核心技术篇》的内容结合自己的需要和理解做的笔记。

基本介绍

SpringBoot允许将配置进行外部化（externalize），这样你就能够在不同的环境下使用相同的代码。你可以使用properties文件，yaml文件，环境变量和命令行参数来外部化配置。使用@Value注解，可以直接将属性值注入到beans中，然后通过Spring的Environment抽象或通过@ConfigurationProperties绑定到结构化对象来访问。

SpringBoot设计了一个非常特别的加载指定属性文件的顺序(@PropertySource)，以允许对属性值进行合理的覆盖，属性会以如下的顺序进行设值：

home目录下的devtools全局设置属性（~/.spring-boot-devtools.properties，如果devtools激活）。
测试用例上的@TestPropertySource注解。
测试用例上的@SpringBootTest#properties注解。
命令行参数.
来自SPRING_APPLICATION_JSON的属性（环境变量或系统属性中内嵌的内联JSON）。
ServletConfig初始化参数。
ServletContext初始化参数。
来自于java:comp/env的JNDI属性。
Java系统属性（System.getProperties()）。
操作系统环境变量。
RandomValuePropertySource，只包含random.*中的属性。
没有打进jar包的Profile-specific应用属性（application-{profile}.properties和YAML变量）。
打进jar包中的Profile-specific应用属性（application-{profile}.properties和YAML变量）。
没有打进jar包的应用配置（application.properties和YAML变量）。
打进jar包中的应用配置（application.properties和YAML变量）。
@Configuration类上的@PropertySource注解。
默认属性（使用SpringApplication.setDefaultProperties指定）。

<u>以上需要重点关注的就是读取外部化配置的优先级顺序。</u>

主要应用方式

Spring/Springboot
- XML Bean 定义的属性占位符
- @Value 注入
  - @Value 字段注入（Field Injection）
  - @Value 构造器注入（Constructor Injection）
  - @Value 方法注入（Method Injection）
- Environment 读取
Springboot
- @ConfigurationProperties Bean 绑定
- @ConditionalOnProperty 判断

这次我们先介绍 XML Bean 定义的属性占位符 和 @Value 注入。

基础环境

pom.xml

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-validation</artifactId>
    </dependency>

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

XML Bean 定义的属性占位符

相信使用Spring XML配置的小伙伴对这个不配置方式不陌生。

相关代码

外部化要配置的bean

  /**
   * @ClassName SpringXmlCar
   * @Description XML配置的外部化配置
   * @Author Neal
   * @Date 2019/1/19 9:59
   * @Version 1.0
   */
  public class SpringXmlCar {
  
      private String name;
  
      private String color;
  
      private String producer;
  
      public String getName() {
          return name;
      }
  
      public void setName(String name) {
          this.name = name;
      }
  
      public String getColor() {
          return color;
      }
  
      public void setColor(String color) {
          this.color = color;
      }
  
      public String getProducer() {
          return producer;
      }
  
      public void setProducer(String producer) {
          this.producer = producer;
      }
  
      @Override
      public String toString() {
          return "Car{" +
                  "name='" + name + '\'' +
                  ", color='" + color + '\'' +
                  ", producer='" + producer + '\'' +
                  '}';
      }
  }

Spring相关配置XML

resources/META-INF/spring/spring-context.xml 上下文配置使用PropertyPlaceholderConfigurer 读取 properties文件

<?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 class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <!-- Properties 文件 classpath 路径 -->
        <property name="location" value="classpath:/META-INF/default.properties"/>
        <!-- 文件字符编码 -->
        <property name="fileEncoding" value="UTF-8"/>
    </bean>

</beans>

resources/META-INF/spring/car-context.xml 针对SpringXmlCar 使用占位符赋值

<?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">

    <!-- User Bean -->
    <bean id="springXmlCar" class="neal.externalized.domain.SpringXmlCar">
        <property name="name" value="${car.name}"/>
        <property name="color" value="${car.color}"/>
        <property name="producer" value="${car.producer}"/>
    </bean>

</beans>

resources/-INF/default.properties 外部化配置

car.name=Lexus
car.color=sliver
car.producer=Japan

启动类

完全Spring方式 SpringXmlConfigPlaceholderBootstrap

public class SpringXmlConfigPlaceholderBootstrap {

    public static void main(String[] args) {

        String[] locations = {"META-INF/spring/spring-context.xml", "META-INF/spring/car-context.xml"};
        ClassPathXmlApplicationContext applicationContext = new
                ClassPathXmlApplicationContext(locations);
        SpringXmlCar springXmlCar = applicationContext.getBean("springXmlCar", SpringXmlCar.class);
        System.out.println("获取汽车信息 : " + springXmlCar);
        // 关闭上下文
        applicationContext.close();
    }
}

springboot自动装配方式

@ImportResource("META-INF/spring/car-context.xml") // 加载 Spring 上下文 XML 文件
@PropertySource("META-INF/default.properties")   //加载配置文件
@EnableAutoConfiguration
public class XmlPlaceholderExternalizedConfigurationBootstrap {

    public static void main(String[] args) {

        ConfigurableApplicationContext context =
                new SpringApplicationBuilder(XmlPlaceholderExternalizedConfigurationBootstrap.class)
                        .web(WebApplicationType.NONE) // 非 Web 应用
                        .run(args);

        SpringXmlCar springXmlCar = context.getBean("springXmlCar", SpringXmlCar.class);
        System.out.println("获取汽车信息 : " + springXmlCar);
        // 关闭上下文
        context.close();
    }
}