spring Boot 允許通過外部配置讓你在不同的環(huán)境使用同一應(yīng)用程序的代碼，簡單說就是可以通過配置文件來注入屬性或者修改默認(rèn)的配置。

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

這些方式優(yōu)先級如下：

1. 命令行參數(shù)
2. 來自java:comp/env的JNDI屬性
3. Java系統(tǒng)屬性（System.getProperties()）
4. 操作系統(tǒng)環(huán)境變量
5. RandomValuePropertySource配置的random.*屬性值
6. jar包外部的application-{profile}.properties或application.yml(帶spring.profile)配置文件
7. jar包內(nèi)部的application-{profile}.properties或application.yml(帶spring.profile)配置文件
8. jar包外部的application.properties或application.yml(不帶spring.profile)配置文件
9. jar包內(nèi)部的application.properties或application.yml(不帶spring.profile)配置文件
10. @Configuration注解類上的@PropertySource
11. 通過SpringApplication.setDefaultProperties指定的默認(rèn)屬性
    

命令行參數(shù)

通過Java -jar app.jar --name="Spring" --server.port=9090方式來傳遞參數(shù)。

參數(shù)用--xxx=xxx的形式傳遞。

可以使用的參數(shù)可以是我們自己定義的，也可以是Spring Boot中默認(rèn)的參數(shù)。

很多人可能會關(guān)心如web端口如何配置這樣的問題，這些都是Spring Boot中提供的參數(shù)，部分可用參數(shù)如下：

# LOGGING
logging.path=/var/logs
logging.file=myapp.log
logging.config= # location of config file (default classpath:logback.xml for logback)
logging.level.*= # levels for loggers, e.g. "logging.level.org.springframework=DEBUG" (TRACE, DEBUG, INFO, WARN, ERROR, FATAL, OFF)

# EMBEDDED SERVER CONFIGURATION (ServerProperties)
server.port=8080
server.address= # bind to a specific NIC
server.session-timeout= # session timeout in seconds
server.context-parameters.*= # Servlet context init parameters, e.g. server.context-parameters.a=alpha
server.context-path= # the context path, defaults to '/'
server.servlet-path= # the servlet path, defaults to '/'

更多常見的應(yīng)用屬性請瀏覽這里

注意：命令行參數(shù)在app.jar的后面！

可以通過SpringApplication.setAddCommandLineProperties(false)禁用命令行配置。

Java系統(tǒng)屬性

注意Java系統(tǒng)屬性位置java -Dname="isea533" -jar app.jar，可以配置的屬性都是一樣的，優(yōu)先級不同。

例如java -Dname="isea533" -jar app.jar --name="Spring!"中name值為Spring!

操作系統(tǒng)環(huán)境變量

配置過JAVA_HOME的應(yīng)該都了解這一個(gè)。

這里需要注意的地方，有些OS可以不支持使用.這種名字，如server.port，這種情況可以使用SERVER_PORT來配置。

具體名字如何匹配，看本文后面。

RandomValuePropertySource

系統(tǒng)中用到隨機(jī)數(shù)的地方，例如：

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

random.int*支持value參數(shù)和,max參數(shù)，當(dāng)提供max參數(shù)的時(shí)候，value就是最小值。

應(yīng)用配置文件（.properties或.yml）

在配置文件中直接寫：

name=Isea533
server.port=8080

.yml格式的配置文件如：

name: Isea533
server:
  port: 8080

當(dāng)有前綴的情況下，使用.yml格式的配置文件更簡單。關(guān)于.yml配置文件用法請看這里

注意：使用.yml時(shí)，屬性名的值和冒號中間必須有空格，如name: Isea533正確，name:Isea533就是錯(cuò)的。

屬性配置文件的位置

spring會從classpath下的/config目錄或者classpath的根目錄查找application.properties或application.yml。

/config優(yōu)先于classpath根目錄

@PropertySource

這個(gè)注解可以指定具體的屬性配置文件，優(yōu)先級比較低。

SpringApplication.setDefaultProperties

例如：

SpringApplication application = new SpringApplication(Application.class);
Map<String, Object> defaultMap = new HashMap<String, Object>();
defaultMap.put("name", "Isea-Blog");
//還可以是Properties對象
application.setDefaultProperties(defaultMap);
application.run(args);

應(yīng)用（使用）屬性

@Value(“${xxx}”)

這種方式是最簡單的，通過@Value注解可以將屬性值注入進(jìn)來。

@ConfigurationProperties

Spring Boot 可以方便的將屬性注入到一個(gè)配置對象中。例如：

my.name=Isea533
my.port=8080
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com

對應(yīng)對象：

@ConfigurationProperties(prefix="my")
public class Config {
  private String name;
  private Integer port;
  private List<String> servers = new ArrayList<String>();

  public String geName(){
    return this.name;
  }

  public Integer gePort(){
    return this.port;
  }
  public List<String> getServers() {
    return this.servers;
  }
}

Spring Boot 會自動將prefix="my"前綴為my的屬性注入進(jìn)來。

Spring Boot 會自動轉(zhuǎn)換類型，當(dāng)使用List的時(shí)候需要注意在配置中對List進(jìn)行初始化！

Spring Boot 還支持嵌套屬性注入，例如：

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

對應(yīng)的配置類：

@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對象中。

在@Bean方法上使用@ConfigurationProperties

例如：

@ConfigurationProperties(prefix = "foo")
@Bean
public FooComponent fooComponent() {
  ...
}

Spring Boot 會將foo開頭的屬性按照名字匹配注入到FooComponent對象中。

屬性占位符

例如：

app.name=MyApp
app.description=${app.name} is a Spring Boot application

可以在配置文件中引用前面配置過的屬性（優(yōu)先級前面配置過的這里都能用）。

通過如${app.name:默認(rèn)名稱}方法還可以設(shè)置默認(rèn)值，當(dāng)找不到引用的屬性時(shí)，會使用默認(rèn)的屬性。

由于${}方式會被Maven處理。如果你pom繼承的spring-boot-starter-parent，Spring Boot 已經(jīng)將maven-resources-plugins默認(rèn)的${}方式改為了@ @方式，例如@name@。

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

通過屬性占位符還能縮短命令參數(shù)

例如修改web默認(rèn)端口需要使用--server.port=9090方式，如果在配置中寫上：

server.port=${port:8080}

那么就可以使用更短的--port=9090，當(dāng)不提供該參數(shù)的時(shí)候使用默認(rèn)值8080。

屬性名匹配規(guī)則

例如有如下配置對象：

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

  private String firstName;

}

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

1. person.firstName，標(biāo)準(zhǔn)的駝峰式命名
2. person.first-name，虛線（-）分割方式，推薦在.properties和.yml配置文件中使用
3. PERSON_FIRST_NAME，大寫下劃線形式，建議在系統(tǒng)環(huán)境變量中使用

屬性驗(yàn)證

可以使用JSR-303注解進(jìn)行驗(yàn)證，例如：

@Component
@ConfigurationProperties(prefix="connection")
public class ConnectionSettings {

  @NotNull
  private InetAddress remoteAddress;

  // ... getters and setters

}

最后

以上是Spring Boot 屬性配置和使用的內(nèi)容，有些不全面的地方或者讀者有更多疑問，可以查看Spring Boot完整文檔 或 Externalized Configuration。希望對大家的學(xué)習(xí)有所幫助，也希望大家多多支持腳本之家。

最新評論