Spring Boot 系列(三)屬性配置&自定義屬性配置
阿新 • • 發佈:2019-02-20
在使用spring boot過程中,可以發現專案中只需要極少的配置就能完成相應的功能,這歸功於spring boot中的模組化配置,在pom.xml中依賴的每個Starter都有預設配置,而這些預設配置足以滿足正常的功能開發。
如果需要修改自定義修改預設配置,spring boot 提供了很簡便的方法,只需要在application.properties 中新增修改相應的配置。(spring boot啟動的時候會讀取application.properties這份預設配置)
一、修改預設配置
例1、spring boot 開發web應用的時候,預設tomcat的啟動埠為8080,如果需要修改預設的埠,則需要在application.properties 新增以下記錄:
server.port=8888
重啟專案,啟動日誌可以看到:Tomcat started on port(s): 8888 (http) 啟動埠為8888,瀏覽器中訪問 http://localhost:8888 能正常訪問。
例2、spring boot 開發中的資料庫連線資訊配置(這裡使用com.alibaba 的 druid), 在application.properties 新增以下記錄:
druid.url=jdbc:mysql://192.168.0.20:3306/test
druid.driver-class=com.mysql.jdbc.Driver
druid.username =root
druid.password=123456
druid.initial-size=1
druid.min-idle=1
druid.max-active=20
druid.test-on-borrow=true
以上兩個例子,說明了如需修改starter模組中的預設配置,只需要在在application.properties 新增需要修改的配置即可。
附: application.properties 全部配置項,點選檢視Spring Boot 所有配置說明
二、自定義屬性配置
在application.properties中除了可以修改預設配置,我們還可以在這配置自定義的屬性,並在實體bean中加載出來。
1、在application.properties中新增自定義屬性配置
com.sam.name=sam
com.sam.age=11
com.sam.desc=magical sam
2、編寫Bean類,載入屬性
Sam類需要新增@Component註解,讓spring在啟動的時候掃描到該類,並新增到spring容器中。
第一種:使用spring支援的@Value()載入
package com.sam.demo.conf;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;
/**
* @author sam
* @since 2017/7/15
*/
@Component
public class Sam {
//獲取application.properties的屬性
@Value("${com.sam.name}")
private String name;
@Value("${com.sam.age}")
private int age;
@Value("${com.sam.desc}")
private String desc;
//getter & setter
}
第二種:使用@ConfigurationProperties(prefix=”“) 設定字首,屬性上不需要添加註解。
package com.sam.demo.conf;
import org.springframework.stereotype.Component;
/**
* @author sam
* @since 2017/7/15
*/
@Component
@ConfigurationProperties(prefix = "com.sam")
public class Sam {
private String name;
private int age;
private String desc;
//getter & setter
}
3、在controller中注入並使用Sam這個Bean。
package com.sam.demo.controller;
import com.sam.demo.conf.Sam;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
/**
* @author sam
* @since 2017/7/14
*/
@RestController
public class IndexController {
@Autowired
private Sam sam;
@RequestMapping("/index")
public String index() {
System.out.println(sam.getName() + " " + sam.getAge() + " " + sam.getDesc());
return "index";
}
}
三、application.properties 屬性配置詳解
1、引數引用與random隨機數方法的使用
在application.properties內可以直接通過${}引用其他屬性的值,如下:
com.sam.name=sam
com.sam.age=11
com.sam.desc=${name} is ${age} years old.
在application.properties中如果需要獲取隨機數,可以通過${random},如下:
#獲取隨機字串
com.sam.randomValue=${random.value}
#獲取隨機字串:${random.value}
#獲取隨機int:${random.int}
#獲取10以內的隨機數:${random.int(10)}
#獲取10-20的隨機數:${random.int[10,20]}
#獲取隨機long:${random.long}
#獲取隨機uuid:${random.uuid}
2、多環境配置
實際開發中可能會有不同的環境,有開發環境、測試環境、生成環境。對於每個環境相關配置都可能有所不同,如:資料庫資訊、埠配置、本地路徑配置等。
如果每次切換不同環境都需要修改application.properties,那麼操作是十分繁瑣的。在spring boot中提供了多環境配置,使得我們切換環境變得簡便。
在application.properties同目錄下新建一下三個檔案:
application-dev.properties //開發環境的配置檔案
application-test.properties //測試環境的配置檔案
application-prod.properties //生產環境的配置檔案
上面三個檔案分別對應了 開發、測試、生產 的配置內容,接下來就是應該怎麼選擇性引用這些配置了。
在application.properties新增:
spring.profiles.active=dev
#引用測試的配置檔案
#spring.profiles.active=test
#引用生產的配置檔案
#spring.profiles.active=prod
新增spring.profiles.active=dev後啟動應用,會發現引用了dev的這份配置資訊。
可以看出上面三個配置檔案符合 application-{profile}.properties 格式,而在application.properties新增的 spring.profiles.active=dev 中的dev正是上面配置檔案中的 profile。根據具體環境進行切換即刻。
用命令執行jar包啟動應用的時候,可以指定相應的配置.
java -jar demo-0.0.1-SNAPSHOT.jar --spring.profiles.active=dev
附:配置方式和優先順序
這些方式優先順序如下:
a. 命令列引數
b. 來自java:comp/env的JNDI屬性
c. Java系統屬性(System.getProperties())
d. 作業系統環境變數
e. RandomValuePropertySource配置的random.*屬性值
f. jar外部的application-{profile}.properties或application.yml(帶spring.profile)配置檔案
g. jar內部的application-{profile}.properties或application.yml(帶spring.profile)配置檔案
h. jar外部的application.properties或application.yml(不帶spring.profile)配置檔案
i. jar內部的application.properties或application.yml(不帶spring.profile)配置檔案
j. @Configuration註解類上的@PropertySource
k. 通過SpringApplication.setDefaultProperties指定的預設屬性
注:命令列引數這種jar包指定引數啟動應用的方式,可能是不安全的,我們可以設定禁止這種方式啟動應用,如下:
springApplication.setAddCommandLineProperties(false);
package com.sam.demo;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
@SpringBootApplication
public class DemoApplication {
public static void main(String[] args) {
// SpringApplication.run(DemoApplication.class, args);
SpringApplication springApplication = new SpringApplication(DemoApplication.class);
//禁止命令列設定引數
springApplication.setAddCommandLineProperties(false);
springApplication.run(args);
}
}
補充:
在spring boot 中配置除了支援 application.properties,還支援application.yml的配置方式,如下:
新建application.yml代替application.properties
server:
port: 9999
com:
sam:
name: sam
age: 11
desc: magical sam