在昨天介紹springboot框架之后血崭，大家對(duì)于這個(gè)框架的熱度還是不錯(cuò)卧惜。那么今天Damon繼續(xù)更大家介紹下關(guān)于springboot更深入的東西。希望能夠幫助大家成長(zhǎng)以及進(jìn)步夹纫。如果想要了解昨天的文章咽瓷，可以去github或者翻閱下此前的紀(jì)錄都能夠看到。
Spring Boot 屬性配置和使用
- 簡(jiǎn)單的說舰讹，Spring Boot 就是允許通過外部配置讓你在不同的環(huán)境使用同一應(yīng)用程序的代碼茅姜，或許說就是可以通過配置文件來注入屬性或者修改默認(rèn)的配置。
Spring Boot 支持多種外部配置方式
這些方式優(yōu)先級(jí)如下：
- 命令行參數(shù)
- 來自java:comp/env的JNDI屬性
- Java系統(tǒng)屬性（System.getProperties()）
- 操作系統(tǒng)環(huán)境變量
- RandomValuePropertySource配置的random.*屬性值
- jar包外部的application-{profile}.properties或application.yml(帶spring.profile)配置文件
- jar包內(nèi)部的application-{profile}.properties或application.yml(帶spring.profile)配置文件
- jar包外部的application.properties或application.yml(不帶spring.profile)配置文件
- jar包內(nèi)部的application.properties或application.yml(不帶spring.profile)配置文件
- @Configuration注解類上的@PropertySource
- 通過SpringApplication.setDefaultProperties指定的默認(rèn)屬性
命令行參數(shù)
通過java -jar app.jar --name="Spring" --server.port=9090方式來傳遞參數(shù)月匣。
參數(shù)用--xxx=xxx的形式傳遞钻洒。
-
可以使用的參數(shù)可以是我們自己定義的，也可以是Spring Boot中默認(rèn)的參數(shù)桶错。
-很多人可能會(huì)關(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 '/'
- 注意：命令行參數(shù)在app.jar的后面院刁！
- 可以通過SpringApplication.setAddCommandLineProperties(false)禁用命令行配置糯钙。
操作系統(tǒng)環(huán)境變量
- 配置過JAVA_HOME的應(yīng)該都了解這一個(gè)。
- 這里需要注意的地方，有些OS可以不支持使用.這種名字任岸，如server.port再榄，這種情況可以使用SERVER_PORT來配置。
應(yīng)用配置文件（.properties或.yml）
在配置文件中直接寫：
name=Isea533
server.port=8080.yml格式的配置文件如：
name: Isea533
server:
port: 8080當(dāng)有前綴的情況下享潜，使用.yml格式的配置文件更簡(jiǎn)單困鸥。關(guān)于.yml配置文件用法請(qǐng)看這里
注意：使用.yml時(shí)，屬性名的值和冒號(hào)中間必須有空格剑按，如name: Isea533正確疾就，name:Isea533就是錯(cuò)的。
屬性配置文件的位置
- spring會(huì)從classpath下的/config目錄或者classpath的根目錄查找application.properties或application.yml艺蝴。
- /config優(yōu)先于classpath根目錄
@PropertySource
- 這個(gè)注解可以指定具體的屬性配置文件猬腰，優(yōu)先級(jí)比較低。
SpringApplication.setDefaultProperties
-
例如：
SpringApplication application = new SpringApplication(Application.class); Map<String, Object> defaultMap = new HashMap<String, Object>(); defaultMap.put("name", "Isea-Blog"); //還可以是Properties對(duì)象 application.setDefaultProperties(defaultMap); application.run(args);
應(yīng)用（使用）屬性
@Value(“${xxx}”)
- 這種方式是最簡(jiǎn)單的猜敢，通過@Value注解可以將屬性值注入進(jìn)來姑荷。
@ConfigurationProperties
-
Spring Boot 可以方便的將屬性注入到一個(gè)配置對(duì)象中。例如：
my.name=Isea533 my.port=8080 my.servers[0]=dev.bar.com my.servers[1]=foo.bar.com -
對(duì)應(yīng)對(duì)象：
@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 會(huì)自動(dòng)將prefix="my"前綴為my的屬性注入進(jìn)來缩擂。
Spring Boot 會(huì)自動(dòng)轉(zhuǎn)換類型鼠冕，當(dāng)使用List的時(shí)候需要注意在配置中對(duì)List進(jìn)行初始化！
Spring Boot 還支持嵌套屬性注入胯盯，例如：
name=isea533
jdbc.username=root
jdbc.password=root
...對(duì)應(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開頭的屬性都會(huì)注入到Jdbc對(duì)象中懈费。
在@Bean方法上使用@ConfigurationProperties
- 例如：
@ConfigurationProperties(prefix = "foo")
@Bean
public FooComponent fooComponent() {
...
} - Spring Boot 會(huì)將foo開頭的屬性按照名字匹配注入到FooComponent對(duì)象中。
- 這種方式比較少見陨闹，我們?cè)谡蟤ybatis那章結(jié)合Druid的配置來具體演示楞捂。
屬性占位符
例如：
app.name=MyApp
app.description=${app.name} is a Spring Boot application可以在配置文件中引用前面配置過的屬性（優(yōu)先級(jí)前面配置過的這里都能用）薄坏。
通過如${app.name:默認(rèn)名稱}方法還可以設(shè)置默認(rèn)值趋厉，當(dāng)找不到引用的屬性時(shí)，會(huì)使用默認(rèn)的屬性胶坠。
由于${}方式會(huì)被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ī)則
-
例如有如下配置對(duì)象：
@Component @ConfigurationProperties(prefix="person") public class ConnectionSettings { private String firstName; }
- firstName可以使用的屬性名如下：
- person.firstName罩润，標(biāo)準(zhǔn)的駝峰式命名
- person.first-name玖翅，虛線（-）分割方式，推薦在.properties和.yml配置文件中使用
- 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 }
