微服务 SpringBoot 2.0：配置文件解析

Posted 2021-01-08 Java面试必修

tags:

篇首语：本文由小常识网(cha138.com)小编为大家整理，主要介绍了微服务 SpringBoot 2.0：配置文件解析相关的知识，希望对你有一定的参考价值。

properties我用了好多年，你却让我用yml，这是什么鬼 —— Java面试必修

引言

上一篇介绍了Spring Boot的轻松入门项目构建，对Spring Boot的特性有了初步了解。但如果要想玩得很熟练的话就请看接下来的文章，这样有助于后续我们快速的构建企业级应用，打怪咱得先熟悉地图对吧

配置详解

工具

SpringBoot版本：2.0.4
开发工具：IDEA 2018
Maven：3.3 9
JDK：1.8

配置文件类型

本文主要讲解SpringBoot的配置文件，常用的配置文件类型有如下两种，分为properties、yml，先甭管什么文件，SpringBoot都能正确加载读取里面的参数，配置文件的路径在：src/main/resources下

properties结尾的文件，这种想必大家都比较熟悉了，比如：jdbc.properties，或log4j.properties。
yml结尾的文件，YAML（Yet Another Markup Language）结构化的数据配置文件，谐音(亚妹袄)，ML和XML同音

动手尝试

2种配置均可读取的固定代码，配置请往下看

@RestController
@SpringBootApplication
public class DemoApplication {

    @Value("${com.demo.name}")
    private String name;

    @Value("${com.demo.url}")
    private String url;

    @RequestMapping("/index")
    public String index(){
        return "name：" + name +"，url：" + url ;
    }

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

    }
}

application.properties，先来个简单的配置，代码@Value注解直接绑定

com.demo.name="JAVA面试必修"
com.demo.url="www.itmsbx.com"

结果：成功返回name：“Java面试必修”，url："www.itmsbx.com"

换成 application.yml 则内容如下

#注释
com.demo.name: Java面试必修
com.demo.url: www.itmsbx.com

---- yml上下任选一种即可

com.demo:
  name: Java面试必修
  url: www.itmsbx.com

结果：name：Java面试必修，url：www.itmsbx.com

Spring框架提供两个便利的类用于加载YAML文档，YamlPropertiesFactoryBean会将YAML加载为Properties，YamlMapFactoryBean会将YAML加载为Map，后续讲解

Bean对象绑定

认识了配置文件后，我们发现yml中的数据绑定还挺好用的。但是问题来了，一个个绑定到属性字段上太累，能换成对象，咱们就使用对象对吧，那也是可以的，我们建一个DemoBean.java类。

Bean类中使用注解 @ConfigurationProperties(prefix = “com.demo”)来指明绑定配置文件中哪个变量

@ConfigurationProperties(prefix = "com.demo")
public class DemoBean {

    //省略getter和setter
    private String name;
    private String url;

}

Controller中使用注解@EnableConfigurationProperties({DemoBean.class})来绑定实体类，并使用Autowired在成员变量处注入即可

@RestController
@SpringBootApplication
@EnableConfigurationProperties({DemoBean.class})
public class DemoApplication {

    @Autowired
    DemoBean demoBean;


    @RequestMapping("/index")
    public String index(){
        return "name：" + demoBean.getName() + "，url：" + demoBean.getUrl();
    }

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

    }
}

结果：name：Java面试必修，url：www.itmsbx.com

参数与参数间的引用

# 注释
com.demo:
  name: Java面试必修
  url: www.itmsbx.com
  scope: ${com.demo.name}的网址是${com.demo.url}

这样我们直接使用scope属性就能看到效果了，注：properties和yml除了书写格式上的差异外，使用方式基本类似，所以后续我们的讲解中都建议使用yml文件

随机参数生成

通常是用这些随机数我们得写一段代码生成，现在配置文件中${random} 可以用来生成各种不同类型的随机值，从而简化了代码生成的麻烦，例如生成 int 值、long 值或者 string 字符串

demo.secret: ${random.value}
demo.number: ${random.int}
demo.bignumber: ${random.long}
demo.uuid: ${random.uuid}
demo.number.less.than.ten: ${random.int(10)}
demo.number.in.range: ${random.int[1024,65536]}

大家仔细思考下，${}很熟悉，我们用自己的变量也是${}包含起来的对不对，那其实这是SpringBoot已经封装好的配置变量啦，类似于jsp中的隐式对象request一样，拿来即用

命令行参数配置

Spring Boot是基于jar包运行的，打成jar包的程序可以直接通过下面命令运行：

java -jar demo-0.0.1-SNAPSHOT.jar

可以使用下命令修改tomcat端口号：

java -jar demo-0.0.1-SNAPSHOT.jar --server.port=9090

等价于在yml中配置server.port: 9090，或properties中配置server.port=9090
java -jar demo-0.0.1-SNAPSHOT.jar

控制台输出

$ java -jar myapp.jar --debug
但前提是你需要在yml或properties中指明 debug=true

设置Spring profiles参数启动

$ java -jar -Dspring.profiles.active=production demo-0.0.1-SNAPSHOT.jar

命令启动参数用 --xxx=xxx 的形式传递。命令行参数在demo.jar的后面，如果你担心命令行有风险，则可以使用SpringApplication.setAddCommandLineProperties(false)禁用它。

运行或系统参数获取

Spring Boot应用程序有多种设置途径，Spring Boot能从多重属性源获得属性，包括如下几种（优先级从高到低排序）：

命令行参数
SPRING_APPLICATION_JSON中的属性(环境变量或系统属性中的内联JSON嵌入)。
ServletConfig初始化参数。
ServletContext初始化参数。
来自java:comp/env的JNDI属性
Java系统属性（System.getProperties()）
操作系统环境变量
RandomValuePropertySource配置的random.*属性值，比如${random.long}
jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件
jar包内部的application-{profile}.properties或application.yml(带spring.profile)配置文件
jar包外部的application.properties或application.yml(不带spring.profile)配置文件
jar包内部的application.properties或application.yml(不带spring.profile)配置文件
@Configuration注解类上的@PropertySource
通过SpringApplication.setDefaultProperties指定的默认属性

任何在高优先级属性源里设置的属性都会覆盖低优先级的相同属性，列如我们上面提到的命令行属性就覆盖了application.properties的属性。

配置文件的优先级

application.properties和application.yml文件可以放在以下四个位置：

外置，在相对于应用程序运行目录的/congfig子目录里。
外置，在应用程序运行的目录里
内置，在config包内
内置，在Classpath根目录

同样，这个列表按照优先级排序，也就是说，src/main/resources/config/application.properties覆盖src/main/resources/application.properties中相同的属性，如图：

配置文件优先级

此外，如果你在相同优先级位置同时有application.properties和application.yml，那么application.properties里的属性里面的属性就会覆盖application.yml

使用自定义的配置文件

对于同时加载多个properties配置文件，SpringBoot有注解@PropertySource支持，而yml多配置文件需要单独用程序读取，官方提供了YamlPropertySourceLoader.java类来支持，所以@PropertySource只能支持properties配置文件，如下：

@Configuration
@ConfigurationProperties(prefix = "com.custom")
@PropertySource("classpath:application-test.properties")
public class CustomBean {

    //省略getter和setter
    private String sex;
    private String age;
    private String desc;
    
}

若对于yml多配置文件，建议写到一个里面，但如果分成多个环境加载不同配置，那接下来我们就讲解下如何通过命令参数调用不同的yml

Profile-多环境配置

普通springmvc项目解决方案

在普通的springmvc的tomcat项目中，我们也可以指定JVM的运行参数，在启动服务的时候通过System.getProperty("JVM配置key")获取到这个参数，然后初始化不同的Properties文件，操作如下：

普通springmvc项目，properties文件

 <!-- 从properties文件加载配置信息 -->
    <bean id="propertyPlaceholderConfigurer" class="com.xx.xx.common.spring.CustomizedPropertyPlaceholderConfigurer">
        <property name="locations">
            <list>
                <!-- 此处配置文件需要在tomcat运行参数中指定[develop|test|product]其中一个，若不指定，默认取develop -->
                <value>classpath*:**/config/config-develop.properties</value>
                <value>classpath*:**/config/config-test.properties</value>
                <value>classpath*:**/config/config-product.properties</value>
            </list>
        </property>
        <property name="configureClasses">
            <list>
                <value>com.xx.xx.common.util.Constants</value>
            </list>
        </property>
    </bean>

    tomcat 中 catalina.bat（.sh中不用“set”） 添加JAVA_OPS。通过设置active选择不同配置文件
    set JAVA_OPTS="-Dspring.profiles.active=test"

上述的CustomizedPropertyPlaceholderConfigurer类实现了PropertyPlaceholderConfigurer，在初始化的时候通过获取JVM的profile进行不同的properties选取

SpringBoot解决方案

对于多环境的配置，各种项目构建工具或是框架的基本思路是一致的，通过配置多份不同环境的配置文件，再通过打包命令指定需要打包的内容之后进行区分打包，Spring Boot也不例外，或者说更加简单。

在Spring Boot中多环境配置文件名需要满足application-{profile}.yml的格式，其中{profile}对应你的环境标识，如下图：

yml结构

至于哪个具体的配置文件会被加载，需要在application.yml文件中通过spring.profiles.active属性来设置，其值对应{profile}值。如：spring.profiles.active=prod就会加载application-prod.yml配置文件内容

application.yml内容如下

spring.profiles.active: dev

application-dev.yml内容如下

server:
  port: 1000

application-prod.yml内容如下

server:
  port: 1001

启动的时候带上参数：java -jar xxx.jar --spring.profiles.active=dev，就会发现启动的端口不一样，说明配置文件生效了

代码使用profile

除了可以用profile的配置文件来分区配置我们的环境变量，在代码里，我们还可以直接用@Profile注解来进行配置，例如数据库配置，这里我们先定义一个接口

public  interface DBConnector { public  void  dbConfig(); }

分别定义俩个实现类来实现它

/**
  * 开发数据库
  */
@Component
@Profile("devdb")
public class DevDBConnector implements DBConnector {
    @Override
    public void dbConfig() {
        System.out.println("devdb");
    }
}
/**
 * 生产数据库
 */
@Component
@Profile("prodb")
public class ProDBConnector implements DBConnector {
    @Override
    public void dbConfig() {
        System.out.println("prodb");
    }
}

通过在配置文件激活具体使用哪个实现类

spring.profiles.active=prodb

然后具体调用如下

@RestController
@RequestMapping("/call")
public class CallController {

    @Autowired DBConnector connector ;

    @RequestMapping(value = {"/",""})
    public String hellYml(){

        connector.dbConfig(); //最终打印prodb
        return "Hello yml";
    }
}

总结

SpringBoot的配置文件给我们带来了极大的便利，properties和yml两者各选一个吧，不过我更倾向于yml，其格式化的配置看起来很舒服，有点类似于json格式，更多的属性及配置后续在使用的过程中慢慢讲解。

作者有话说：喜欢的话就请移步Java面试必修网，请自备水，更多干、干、干货等着你

以上是关于微服务 SpringBoot 2.0：配置文件解析的主要内容，如果未能解决你的问题，请参考以下文章

微服务 SpringBoot 2.0：启动剖析之SpringApplication.run

微服务之springboot 自定义配置Application.properties文件

oauth 2.0、JWT、Spring 安全、微服务

spring-boot 2.0 多模块化项目和EurekaServer的搭建

OAuth 2.0实现分布式认证授权-注册中心Eureaka搭建

SpringBoot微服务框架概述