Spring Boot 屬性配置和使用

spring Boot 允許通過外部配置讓你在不同的環境使用同一應用程式的程式碼，簡單說就是可以通過配置檔案來注入屬性或者修改預設的配置。

Spring Boot 系列

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

這些方式優先順序如下：

1. 命令列引數
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
    指定的預設屬性

命令列引數

通過Java -jar app.jar --name="Spring" --server.port=9090方式來傳遞引數。

引數用--xxx=xxx的形式傳遞。

可以使用的引數可以是我們自己定義的，也可以是Spring Boot中預設的引數。

很多人可能會關心如web埠如何配置這樣的問題，這些都是Spring Boot中提供的引數，部分可用引數如下：

# 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 '/'

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13

更多常見的應用屬性請瀏覽這裡

注意：命令列引數在app.jar的後面！

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

Java系統屬性

注意Java系統屬性位置java -Dname="isea533" -jar app.jar，可以配置的屬性都是一樣的，優先順序不同。

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

作業系統環境變數

配置過JAVA_HOME的應該都瞭解這一個。

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

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

RandomValuePropertySource

系統中用到隨機數的地方，例如：

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]}

• 1
• 2
• 3
• 4
• 5

• 1
• 2
• 3
• 4
• 5

random.int*支援value引數和,max引數，當提供max引數的時候，value就是最小值。

應用配置檔案（.properties或.yml）

在配置檔案中直接寫：

name=Isea533
server.port=8080

• 1
• 2

• 1
• 2

.yml格式的配置檔案如：

name: Isea533
server:
    port: 8080

• 1
• 2
• 3

• 1
• 2
• 3

當有字首的情況下，使用.yml格式的配置檔案更簡單。關於.yml配置檔案用法請看這裡

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

屬性配置檔案的位置

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

/config優先於classpath根目錄

@PropertySource

這個註解可以指定具體的屬性配置檔案，優先順序比較低。

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);

• 1
• 2
• 3
• 4
• 5
• 6

• 1
• 2
• 3
• 4
• 5
• 6

應用（使用）屬性

@Value(“${xxx}”)

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

@ConfigurationProperties

Spring Boot 可以方便的將屬性注入到一個配置物件中。例如：

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

• 1
• 2
• 3
• 4

• 1
• 2
• 3
• 4

對應物件：

@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;
    }
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17

Spring Boot 會自動將prefix="my"字首為my的屬性注入進來。

Spring Boot 會自動轉換型別，當使用List的時候需要注意在配置中對List進行初始化！

Spring Boot 還支援巢狀屬性注入，例如：

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

• 1
• 2
• 3
• 4

• 1
• 2
• 3
• 4

對應的配置類：

@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;
    }
}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10
• 11
• 12
• 13
• 14
• 15
• 16
• 17

jdbc開頭的屬性都會注入到Jdbc物件中。

在@Bean方法上使用@ConfigurationProperties

例如：

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

• 1
• 2
• 3
• 4
• 5

• 1
• 2
• 3
• 4
• 5

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

屬性佔位符

例如：

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

• 1
• 2

• 1
• 2

可以在配置檔案中引用前面配置過的屬性（優先順序前面配置過的這裡都能用）。

通過如${app.name:預設名稱}方法還可以設定預設值，當找不到引用的屬性時，會使用預設的屬性。

由於${}方式會被Maven處理。如果你pom繼承的spring-boot-starter-parent，Spring Boot 已經將maven-resources-plugins預設的${}方式改為了@ @方式，例如@[email protected]。

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

通過屬性佔位符還能縮短命令引數

例如修改web預設埠需要使用--server.port=9090方式，如果在配置中寫上：

server.port=${port:8080}

• 1

• 1

那麼就可以使用更短的--port=9090，當不提供該引數的時候使用預設值8080。

屬性名匹配規則

例如有如下配置物件：

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

    private String firstName;

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7

• 1
• 2
• 3
• 4
• 5
• 6
• 7

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

1. person.firstName，標準的駝峰式命名
2. person.first-name，虛線（-）分割方式，推薦在.properties和.yml配置檔案中使用
3. PERSON_FIRST_NAME，大寫下劃線形式，建議在系統環境變數中使用

屬性驗證

可以使用JSR-303註解進行驗證，例如：

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

    @NotNull
    private InetAddress remoteAddress;

    // ... getters and setters

}

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10

• 1
• 2
• 3
• 4
• 5
• 6
• 7
• 8
• 9
• 10

最後

關於Spring Boot更多的內容可以繼續關注本部落格。