springboot:框架想學好,屬性配置和使用你都明白了嗎?

Spring Boot 屬性配置和使用

簡單的說,Spring Boot 就是允許通過外部配置讓你在不同的環境使用同一應用程序的代碼,或許說就是可以通過配置文件來注入屬性或者修改默認的配置。
Spring Boot 支持多種外部配置方式

這些方式優先級如下:

命令行參數
來自java:comp/env的JNDI屬性
Java系統屬性(System.getProperties())
操作系統環境變量
RandomValuePropertySource配置的random.*屬性值
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指定的默認屬性
命令行參數

通過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 '/'

複製代碼
注意:命令行參數在app.jar的後面!
可以通過SpringApplication.setAddCommandLineProperties(false)禁用命令行配置。
操作系統環境變量

配置過JAVA_HOME的應該都瞭解這一個。
這裏需要注意的地方,有些OS可以不支持使用.這種名字,如server.port,這種情況可以使用SERVER_PORT來配置。
應用配置文件(.properties或.yml)

在配置文件中直接寫: name=Isea533 server.port=8080
.yml格式的配置文件如: name: Isea533 server: port: 8080
當有前綴的情況下,使用.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 defaultMap = new HashMap();
defaultMap.put("name", "Isea-Blog");
//還可以是Properties對象
application.setDefaultProperties(defaultMap);
application.run(args);
複製代碼
應用(使用)屬性

@Value(“${xxx}”)

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

Spring Boot 可以方便的將屬性注入到一個配置對象中。例如:
my.name=Isea533
my.port=8080
my.servers[0]=dev.bar.com
my.servers[1]=foo.bar.com
複製代碼
對應對象:
@ConfigurationProperties(prefix="my")
public class Config {
private String name;
private Integer port;
private List servers = new ArrayList();
public String geName(){
return this.name;
}
public Integer gePort(){
return this.port;
}
public List getServers() {
return this.servers;
}
}
複製代碼
Spring Boot 會自動將prefix="my"前綴爲my的屬性注入進來。
Spring Boot 會自動轉換類型,當使用List的時候需要注意在配置中對List進行初始化!
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對象中。
在@Bean方法上使用@ConfigurationProperties

例如: @ConfigurationProperties(prefix = "foo") @Bean public FooComponent fooComponent() { ... }
Spring Boot 會將foo開頭的屬性按照名字匹配注入到FooComponent對象中。
這種方式比較少見,我們在整合mybatis那章結合Druid的配置來具體演示。
屬性佔位符

例如: app.name=MyApp app.description=${app.name} is a Spring Boot application
可以在配置文件中引用前面配置過的屬性(優先級前面配置過的這裏都能用)。
通過如${app.name:默認名稱}方法還可以設置默認值,當找不到引用的屬性時,會使用默認的屬性。
由於${}方式會被Maven處理。如果你pom繼承的spring-boot-starter-parent,
Spring Boot 已經將maven-resources-plugins默認的${}方式改爲了@ @方式,例如@name@。
如果你是引入的Spring Boot,你可以修改使用其他的分隔符
通過屬性佔位符還能縮短“命令行”參數

例如修改web默認端口需要使用--server.port=9090方式,如果在配置中寫上: server.port=${port:8080}
那麼就可以使用更短的--port=9090,當不提供該參數的時候使用默認值8080。
屬性名匹配規則

例如有如下配置對象:
@Component
@ConfigurationProperties(prefix="person")
public class ConnectionSettings {
private String firstName;
}
複製代碼
firstName可以使用的屬性名如下:
person.firstName,標準的駝峯式命名
person.first-name,虛線(-)分割方式,推薦在.properties和.yml配置文件中使用
PERSON_FIRST_NAME,大寫下劃線形式,建議在系統環境變量中使用
需要java學習路線圖的私信筆者“java”領取哦!另外喜歡這篇文章的可以給筆者點個贊,關注一下,每天都會分享Java相關文章!還有不定時的福利贈送,包括整理的學習資料,面試題,源碼等~~

發表評論
所有評論
還沒有人評論,想成為第一個評論的人麼? 請在上方評論欄輸入並且點擊發布.
相關文章