2. 程式人生 > >微服務 SpringBoot 2.0（二）：配置檔案解析

微服務 SpringBoot 2.0（二）：配置檔案解析

阿新 • • 發佈：2018-12-11

properties我用了好多年，你卻讓我用yml，這是什麼鬼 —— Java面試必修

引言

上一篇介紹了Spring Boot的輕鬆入門專案構建，對Spring Boot的特性有了初步瞭解。但如果要想玩得很熟練的話就請看接下來的文章，這樣有助於後續我們快速的構建企業級應用，打怪咱得先熟悉地圖對吧

配置詳解

工具

  • SpringBoot版本：2.0.4
  • 開發工具：IDEA 2018
  • Maven：3.3 9
  • JDK：1.8

配置檔案型別

本文主要講解SpringBoot的配置檔案，常用的配置檔案型別有如下兩種，分為properties、yml，先甭管什麼檔案，SpringBoot都能正確載入讀取裡面的引數，配置檔案的路徑在：src/main/resources

下

  1. properties結尾的檔案，這種想必大家都比較熟悉了，比如：jdbc.properties，或log4j.properties。
  2. yml結尾的檔案，YAML（Yet Another Markup Language）結構化的資料配置檔案，諧音(亞妹襖)，ML和XML同音

動手嘗試

  1. 2種配置均可讀取的固定程式碼，配置請往下看
@RestController
@SpringBootApplication
public class DemoApplication {

	@Value("${com.demo.name}")
	private String name;

	@Value(
 
"${com.demo.url}")
	private String url;

	@RequestMapping("/index")
	public String index(){
		return "name：" + name +"，url：" + url ;
	}

	public static void main(String[] args) {
		SpringApplication.run(DemoApplication.class, args);

	}
}
  1. application.properties，先來個簡單的配置，程式碼@Value註解直接繫結
com.demo.name="JAVA面試必修"
com.demo.url="www.itmsbx.com"

 
結果：成功返回name：“Java面試必修”，url："www.itmsbx.com"
  1. 換成 application.yml 則內容如下
#註釋
com.demo.name: Java面試必修
com.demo.url: www.itmsbx.com

---- yml上下任選一種即可

com.demo:
  name: Java面試必修
  url: www.itmsbx.com

結果：name：Java面試必修，url：www.itmsbx.com

Spring框架提供兩個便利的類用於載入YAML文件，YamlPropertiesFactoryBean會將YAML載入為Properties，YamlMapFactoryBean會將YAML載入為Map，後續講解

Bean物件繫結

認識了配置檔案後，我們發現yml中的資料繫結還挺好用的。但是問題來了，一個個繫結到屬性欄位上太累，能換成物件，咱們就使用物件對吧，那也是可以的，我們建一個DemoBean.java類。

  1. Bean類中使用註解 @ConfigurationProperties(prefix = “com.demo”)來指明繫結配置檔案中哪個變數
@ConfigurationProperties(prefix = "com.demo")
public class DemoBean {

    //省略getter和setter
    private String name;
    private String url;

}
  1. Controller中使用註解@EnableConfigurationProperties({DemoBean.class})來繫結實體類，並使用Autowired在成員變數處注入即可
@RestController
@SpringBootApplication
@EnableConfigurationProperties({DemoBean.class})
public class DemoApplication {

	@Autowired
	DemoBean demoBean;


	@RequestMapping("/index")
	public String index(){
		return "name：" + demoBean.getName() + "，url：" + demoBean.getUrl();
	}

	public static void main(String[] args) {
		SpringApplication.run(DemoApplication.class, args);

	}
}

結果：name：Java面試必修，url：www.itmsbx.com

引數與引數間的引用

# 註釋
com.demo:
  name: Java面試必修
  url: www.itmsbx.com
  scope: ${com.demo.name}的網址是${com.demo.url}

這樣我們直接使用scope屬性就能看到效果了，注：properties和yml除了書寫格式上的差異外，使用方式基本類似，所以後續我們的講解中都建議使用yml檔案

隨機引數生成

通常是用這些隨機數我們得寫一段程式碼生成，現在配置檔案中${random} 可以用來生成各種不同型別的隨機值，從而簡化了程式碼生成的麻煩，例如 生成 int 值、long 值或者 string 字串

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

大家仔細思考下，${}很熟悉，我們用自己的變數也是${}包含起來的對不對，那其實這是SpringBoot已經封裝好的配置變數啦，類似於jsp中的隱式物件request一樣，拿來即用

命令列引數配置

Spring Boot是基於jar包執行的，打成jar包的程式可以直接通過下面命令執行：

java -jar demo-0.0.1-SNAPSHOT.jar

可以使用下命令修改tomcat埠號：

java -jar demo-0.0.1-SNAPSHOT.jar --server.port=9090

等價於在yml中配置server.port: 9090，或properties中配置server.port=9090
java -jar demo-0.0.1-SNAPSHOT.jar

控制檯輸出

$ java -jar myapp.jar --debug
但前提是你需要在yml或properties中指明 debug=true

設定Spring profiles引數啟動

$ java -jar -Dspring.profiles.active=production demo-0.0.1-SNAPSHOT.jar

命令啟動引數用 --xxx=xxx 的形式傳遞。命令列引數在demo.jar的後面，如果你擔心命令列有風險，則可以使用SpringApplication.setAddCommandLineProperties(false)禁用它。

執行或系統引數獲取

Spring Boot應用程式有多種設定途徑，Spring Boot能從多重屬性源獲得屬性，包括如下幾種（優先順序從高到低排序）：

  • 命令列引數
  • SPRING_APPLICATION_JSON中的屬性(環境變數或系統屬性中的內聯JSON嵌入)。
  • ServletConfig初始化引數。
  • ServletContext初始化引數。
  • 來自java:comp/env的JNDI屬性
  • Java系統屬性（System.getProperties()）
  • 作業系統環境變數
  • RandomValuePropertySource配置的random.*屬性值，比如${random.long}
  • 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指定的預設屬性

任何在高優先順序屬性源裡設定的屬性都會覆蓋低優先順序的相同屬性，列如我們上面提到的命令列屬性就覆蓋了application.properties的屬性。

配置檔案的優先順序

application.properties和application.yml檔案可以放在以下四個位置：

  • 外接，在相對於應用程式執行目錄的/congfig子目錄裡。
  • 外接，在應用程式執行的目錄裡
  • 內建，在config包內
  • 內建，在Classpath根目錄

同樣，這個列表按照優先順序排序，也就是說，src/main/resources/config/application.properties覆蓋src/main/resources/application.properties中相同的屬性，如圖：
配置檔案優先順序

此外，如果你在相同優先順序位置同時有application.properties和application.yml，那麼application.properties裡的屬性裡面的屬性就會覆蓋application.yml

使用自定義的配置檔案

對於同時載入多個properties配置檔案，SpringBoot有註解@PropertySource支援，而yml多配置檔案需要單獨用程式讀取，官方提供了YamlPropertySourceLoader.java類來支援，所以**@PropertySource只能支援properties配置檔案**，如下：

@Configuration
@ConfigurationProperties(prefix = "com.custom")
@PropertySource("classpath:application-test.properties")
public class CustomBean {

    //省略getter和setter
    private String sex;
    private String age;
    private String desc;
    
}

若對於yml多配置檔案，建議寫到一個裡面，但如果分成多個環境載入不同配置，那接下來我們就講解下如何通過命令引數呼叫不同的yml

Profile-多環境配置

普通springmvc專案解決方案

在普通的springmvc的tomcat專案中，我們也可以指定JVM的執行引數，在啟動服務的時候通過System.getProperty(“JVM配置key”)獲取到這個引數，然後初始化不同的Properties檔案，操作如下：
普通springmvc專案，properties檔案

	<!-- 從properties檔案載入配置資訊 -->
	<bean id="propertyPlaceholderConfigurer" class="com.xx.xx.common.spring.CustomizedPropertyPlaceholderConfigurer">
		<property name="locations">
			<list>
				<!-- 此處配置檔案需要在tomcat執行引數中指定[develop|test|product]其中一個，若不指定，預設取develop -->
				<value>classpath*:**/config/config-develop.properties</value>
				<value>classpath*:**/config/config-test.properties</value>
				<value>classpath*:**/config/config-product.properties</value>
			</list>
		</property>
		<property name="configureClasses">
			<list>
				<value>com.xx.xx.common.util.Constants</value>
			</list>
		</property>
	</bean>

    tomcat 中 catalina.bat（.sh中不用“set”） 新增JAVA_OPS。通過設定active選擇不同配置檔案
    set JAVA_OPTS="-Dspring.profiles.active=test"

上述的CustomizedPropertyPlaceholderConfigurer類實現了PropertyPlaceholderConfigurer，在初始化的時候通過獲取JVM的profile進行不同的properties選取

SpringBoot解決方案

對於多環境的配置，各種專案構建工具或是框架的基本思路是一致的，通過配置多份不同環境的配置檔案，再通過打包命令指定需要打包的內容之後進行區分打包，Spring Boot也不例外，或者說更加簡單。

在Spring Boot中多環境配置檔名需要滿足application-{profile}.yml的格式，其中{profile}對應你的環境標識，如下圖：

yml結構

至於哪個具體的配置檔案會被載入，需要在application.yml檔案中通過spring.profiles.active屬性來設定，其值對應{profile}值。如：spring.profiles.active=prod就會載入application-prod.yml配置檔案內容

application.yml內容如下

spring.profiles.active: dev

application-dev.yml內容如下

server:
  port: 1000

application-prod.yml內容如下

server:
  port: 1001

啟動的時候帶上引數：java -jar xxx.jar --spring.profiles.active=dev，就會發現啟動的埠不一樣，說明配置檔案生效了

程式碼使用profile

除了可以用profile的配置檔案來分割槽配置我們的環境變數，在程式碼裡，我們還可以直接用@Profile註解來進行配置，例如資料庫配置，這裡我們先定義一個介面

public  interface DBConnector { public  void  dbConfig(); }

分別定義倆個實現類來實現它

/**
  * 開發資料庫
  */
@Component
@Profile("devdb")
public class DevDBConnector implements DBConnector {
    @Override
    public void dbConfig() {
        System.out.println("devdb");
    }
}
/**
 * 生產資料庫
 */
@Component
@Profile("prodb")
public class ProDBConnector implements DBConnector {
    @Override
    public void dbConfig() {
        System.out.println("prodb");
    }
}

通過在配置檔案啟用具體使用哪個實現類

spring.profiles.active=prodb

然後具體呼叫如下

@RestController
@RequestMapping("/call")
public class CallController {

    @Autowired DBConnector connector ;

    @RequestMapping(value = {"/",""})
    public String hellYml(){

        connector.dbConfig(); //最終列印prodb
        return "Hello yml";
    }
}

總結

SpringBoot的配置檔案給我們帶來了極大的便利，properties和yml兩者各選一個吧，不過我更傾向於yml，其格式化的配置看起來很舒服，有點類似於json格式，更多的屬性及配置後續在使用的過程中慢慢講解。

作者有話說：喜歡的話就請移步Java面試必修網，請自備水，更多幹、幹、乾貨等著你

相關推薦

微服務 SpringBoot 2.0（二）：配置檔案解析

properties我用了好多年，你卻讓我用yml，這是什麼鬼 —— Java面試必修 引言 上一篇介紹了Spring Boot的輕鬆入門專案構建，對Spring Boot的特性有了初步瞭解。但如果要想玩得很熟練的話就請看接下來的文章，這樣有助於後續我們快速

微服務 SpringBoot 2.0（二）：配置文件解析

@override 書寫 string 接下來 code java interface sse als properties我用了好多年，你卻讓我用yml，這是什麽鬼 —— Java面試必修 引言 上一篇介紹了Spring Boot的輕松入門項目構建，對Spring B

微服務 SpringBoot 2.0（六）：常用配置(properties、yml)

版本號 ria enable 序列化 資源 selector reference 一個 templates 約定優於配置，但配置不能為0 —— Java面試必修 引言 在前面的章節中，我們已經知道，SpringBoot的配置文件分為properties和yml，而我個人

微服務 SpringBoot 2.0（一）：簡單入門構建

我做好了從入門到放棄的準備，你卻告訴我炒雞簡單 —— Java面試必修 引言 SpringBoot是由Pivotal團隊提供的全新框架，從最根本上來講，Spring Boot就是簡化開發人員從0構建專案的繁瑣步驟，巧妙的封裝了很多外掛模組，讓開發人員不再擔心

微服務 SpringBoot 2.0（三）：啟動剖析之@SpringBootApplication

我原以為就一個註解，背後竟然還有3個 —— Java面試必修 引言 前面兩章我們先後認識了SpringBoot和它的極簡配置，為新手入門的學習降低了門檻，會基本的使用後，接下來我們將進一步認識SpringBoot，它為何能做到服務秒開，就來跟隨我一起分析SpringBoot執行啟動的原理吧。 啟動原理分2

微服務 SpringBoot 2.0（七）：使用JdbcTemplates訪問Mysql

一切沒有與資料庫互動的網站都是假網站 —— Java面試必修 引言 在web開發服務中，開發人員要做的事情就是將資料庫中的資料返回至前端頁面，在第五章我們已經整合了頁面，今天我們再結合資料庫做一個完整的增刪改查功能，馬上要進入資料互動了，緊不緊張 在接下來

微服務 SpringBoot 2.0（九）：整合Mybatis

我是SQL小白，我選Mybatis —— Java面試必修 引言 在第五章我們已經整合了Thymeleaf頁面框架，第七章也整合了JdbcTemplate，那今天我們再結合資料庫整合Mybatis框架 在接下來的文章中，我會用一個開源的部落格原始碼來做講解

微服務 SpringBoot 2.0（八）：靜態資源和攔截器處理

一文搞清楚靜態資源和攔截器 —— Java面試必修 引言 接觸一個web專案，首先要確認的就是入口，所以靜態資源和攔截器在專案中是架構級的，在第五章我們整合了Thymeleaf模組，初次認識了SpringBoot對靜態資源的預設支援。今天我們來繼續學習Sp

微服務架構實戰篇（二）：Spring boot2.0 + Swagger2 讓你的API視覺化

簡介 該專案主要利用Spring boot2.0 +Swagger2 方便進行測試後臺的restful形式的介面，實現動態的更新，當我們在後臺的介面修改了後，swagger可以實現自動的更新，而不需要認為的維護這個介面進行測試。 原始碼地址 GitHub：https:

微服務架構之路（二）：父專案及服務註冊與發現中心（Eureka）搭建

1、建立spring boot父專案 （1.1）file---new----project: （1.2）選擇spring initializr，選擇自己本地安裝的jdk。點選next （1.3）填寫自己的專案資訊，next： （1.4）選擇core-devtools

一個簡單的BitTorrent客戶端實現（二）：種子檔案解析及資訊儲存

關於種子檔案 BT的種子檔案一般是以.torrent作為字尾的。關於種子檔案的編碼，這裡不再做任何介紹。本程式採用的測試種子檔案為ubuntu-14.04.3-desktop-i386.torrent，各位可以到http://mirrors.163.com/u

微服務架構學習筆記（一）：gRPC Spring Boot Starter 2.2.0 釋出，及使用步驟

簡介 gRPC Spring Boot Starter 專案是一個 gRPC 的 Spring Boot 模組。通過在 Spring Boot 中內嵌一個 gRPC Server 對外提供服務，並支援 Spring Cloud 的服務發現、註冊、鏈路跟蹤等等。 更新內容 在 2.

SpringCloud 2.0（二）——Eureka客戶端搭建

上一篇：SpringCloud 2.0（一）——註冊中心Eureka搭建 這一節，我們基於SpringBoot搭建一個服務的提供方，然後註冊到上一節中我們搭建的Eureka註冊中心。還是跟上一篇一樣，去Spring的官網搜尋對應的Eureka Discovery依賴，如下圖：因

微服務架構實戰篇（三）：Spring boot2.0 + Mybatis + PageHelper實現增刪改查和分頁查詢功能

簡介 該專案主要利用Spring boot2.0 +Mybatis + PageHelper實現增刪改查和分頁查詢功能，快速搭建一套和資料庫互動的專案。 小工具一枚，歡迎使用和Star支援，如使用過程中碰到問題，可以提出Issue，我會盡力完善該Starter 版本基礎

淺探微服務—springboot（3）：配置檔案application.properties

先附上springboot官方文件：springboot官方指南，內容很廣泛，全英文，可以翻譯網頁檢視，慢慢看。。。 預設建立spring-boot專案後，會在resources目錄下生成一個空的application.properties配置檔案，springboot啟動

微服務架構實戰篇（四）：Spring boot2.0 + Mybatis +Druid監控資料庫訪問效能

簡介 該專案主要利用Spring boot2.0 + Mybatis +Druid 實現監控資料庫訪問效能。 Druid是一個非常優秀的資料庫連線池。在功能、效能、擴充套件性方面，都超過其他資料庫連線池，包括DBCP、C3P0、BoneCP、Proxool、JBoss DataSour

微服務架構實戰篇（一）：使用start.spring.io 構建SpringBoot2.0專案

簡介 該專案主要利用Spring 官方提供的線上專案腳手架來搭建SpringBoot 2.0的專案。 原始碼地址 GitHub：https://github.com/yundianzixun/spring-boot-starter 聯盟公眾號：IT實戰

Android Retrofit 2.0（二）使用教程OkHttp3 + Gson + RxJava

系列文章推薦：相關資料新增依賴compile 'com.squareup.okhttp3:okhttp:3.3.1' compile 'com.squareup.retrofit2:retrofit:2.1.0'別忘在Manifest裡新增許可權<uses-permis

乾貨實操：微服務Spring Cloud 系列（二） Eureka服務發現與服務註冊(strand alone)

此篇主要實操Eureka 服務端的服務註冊，以及服務發現，並需要認證才能訪問控制中心。 分五個部分說明： 一.  認識 Eureka  二.  Eureka  服務端開發 三.  Eureka 客戶端開發 四.  多客戶端情況檢視 五.  下節預告（多個服務提供後，怎麼

Spring Boot實現OAuth 2.0（二）-- 自定義許可權驗證

自定義攔截器進行許可權驗證 涉及到的姿勢： 自定義註解 攔截器 Spring Boot新增攔截器 文章目錄： 自定義註解 @Target(ElementType.METHOD)//作用在方法 @Retention(RetentionP