Spring Boot 支持多种外部配置方式

Spring Boot 属性配置和使用

Spring Boot 允许通过外部配置让你在不同的环境使用同一应用程序的代码，简单说就是可以通过配置文件来注入属性或者修改默认的配置。这些方式优先级如下：

1.命令行参数

(1).通过java -jar app.jar –name=”Spring” –server.port=9090方式来传递参数。参数用–xxx=xxx的形式传递。

(2).可以使用的参数可以是我们自己定义的，也可以是Spring Boot中默认的参数。

(3).注意：命令行参数在app.jar的后面！
可以通过SpringApplication.setAddCommandLineProperties(false)禁用命令行配置。

2.来自java:comp/env的JNDI属性

J2EE上下文环境变量前缀,一般有如下几种:
java:/comp/env/jdbc
java:/comp/env/url
java:/comp/env/mail
java:/comp/env/jms
在部署和运行EJB中,容器将在java:/comp/env/处创建一个JNDI上下文环境,在该环境中,可以查找获得
在ejb-jar.xml中定义的变量,通过在程序中用JNDI的lookup()方法查找java:/comp/env/后面的变量名得到的.这些值是只读的,也只供本地J2EE组件使用,而客户机无法获取这些值.

3.Java系统属性（System.getProperties()）

(1).注意Java系统属性位置java -Dname=”demo” -jar app.jar，可以配置的属性都是一样的，优先级不同。

(2).例如java -Dname=”demo” -jar app.jar –name=”Spring!”中name值为Spring!

4.操作系统环境变量

配置过JAVA_HOME的应该都了解这一个。同一样的，如果在统环境变量环境变量这增加PRO_ENV=test的环境变量，则下面的配置会生效，即读取application-{profile}.properties或application-{profile}.yml并且profile为test的配置文件,而不是profile为local的配置文件。

spring:
  profiles: 
    active: ${PRO_ENV,local}

5.RandomValuePropertySource配置的random.*属性值

系统中用到随机数的地方，例如：

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

random.int()支持value参数和max参数，当提供max参数的时候，value就是最小值。

6.jar包外部的application-{profile}.properties或application.yml(带spring.profile)配置文件

(1).在properties配置文件中直接写：

name=demo

server.port=8080

: (2).yml格式的配置文件如：

name: demo
server:
  port: 8080

当有前缀的情况下，使用.yml格式的配置文件更简单。

注意：使用.yml时，属性名的值和冒号中间必须有空格，如name: demo正确，name:demo就是错的。

(3).属性配置文件的位置

spring会从classpath下的/config目录或者classpath的根目录查找application.properties或application.yml。/config优先于classpath根目录

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

SpringApplication application = new SpringApplication(Application.class);
Map<String, Object> defaultMap = new HashMap<String, Object>();
defaultMap.put("spring.profiles.active", "local");
//还可以是Properties对象
application.setDefaultProperties(defaultMap);
application.run(args);

12.spring boot配置属性的使用

(1).@Value(“${xxx}”)

这种方式是最简单的，通过@Value注解可以将属性值注入进来。

(2).@ConfigurationProperties

Spring Boot 可以方便的将属性注入到一个配置对象中。例如：

spring:
  datasource:
    druid:
      driverClassName: com.mysql.jdbc.Driver
      url: jdbc:mysql://localhost:3306/ddemo?useUnicode=true&characterEncoding=utf-8
      username: root
      password: 555222
      filters: stat
      connectionProperties: druid.stat.mergeSql=true;druid.stat.slowSqlMillis=5000

对应对象：

@ConfigurationProperties(prefix = "spring.datasource.druid")
public class DatasourceProperties {

    private String driverClassName;

    private String url;

    private String username;

    private String password;

    private String filters;

    private String connectionProperties;

    // ... getters and setters
}

Spring Boot 会自动将prefix=”spring.datasource.druid”前缀为my的属性注入进来。

Spring Boot 会自动转换类型，当使用List的时候需要注意在配置中对List进行初始化！

:(3).Spring Boot 还支持嵌套属性注入，例如：

name=isea533
jdbc.username=root
jdbc.password=root
...

对应的配置类：

@ConfigurationProperties
public class Config {
    private String name;
    private Jdbc jdbc;
    class Jdbc {
        private String username;
        private String password;
        //getter...
    }

    public Integer gePort(){
        return this.port;
    }
    public Jdbc getJdbc() {
        return this.jdbc;
    }
}

jdbc开头的属性都会注入到Jdbc对象中。

13.属性占位符

例如：

app:
  name: demo
  description: ${app.name} is a Spring Boot application

可以在配置文件中引用前面配置过的属性（优先级前面配置过的这里都能用）。

(1).通过如${app.name:默认名称}方法还可以设置默认值，当找不到引用的属性时，会使用默认的属性。

由于 ${}方式会被Maven处理。如果你pom继承的spring-boot-starter-parent，Spring Boot 已经将maven-resources-plugins默认的${}方式改为了@ @方式，例如@name@。

(2)如果你是引入的Spring Boot，你可以修改使用其他的分隔符

通过属性占位符还能缩短命令参数
例如修改web默认端口需要使用–server.port=9090方式，如果在配置中写上：

server:
  port: ${port:8080}

那么就可以使用更短的–port=9090，当不提供该参数的时候使用默认值8080。

14.属性名匹配规则

例如有如下配置对象：

@Component
@ConfigurationProperties(prefix="person")
public class ConnectionSettings {
    private String firstName;
}

firstName可以使用的属性名如下：

1>.person.firstName，标准的驼峰式命名
2>.person.first-name，虚线（-）分割方式，推荐在.properties和.yml配置文件中使用
3>.PERSON_FIRST_NAME，大写下划线形式，建议在系统环境变量中使用

15.属性验证

可以使用JSR-303注解进行验证，例如：

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {
    @NotNull
    private InetAddress remoteAddress;
    // ... getters and setters
}