2. 程式人生 > 其它 >3.配置繫結

3.配置繫結

阿新 • • 發佈：2022-03-06

所謂“配置繫結”就是把配置檔案中的值與 JavaBean 中對應的屬性進行繫結。通常，我們會把一些配置資訊（例如，資料庫配置）放在配置檔案中，然後通過 Java 程式碼去讀取該配置檔案，並且把配置檔案中指定的配置封裝到 JavaBean（實體類） 中。

SpringBoot 提供了以下 2 種方式進行配置繫結：

  • 使用 @ConfigurationProperties 註解
  • 使用 @Value 註解

一、@ConfigurationProperties

通過 Spring Boot 提供的 @ConfigurationProperties 註解，可以將全域性配置檔案中的配置資料繫結到 JavaBean 中。下面我們以 Spring Boot 專案helloworld 為例，演示如何通過@ConfigurationProperties 註解進行配置繫結。



1. 在 helloworld 的全域性配置檔案 application.yml 中新增以下自定義屬性。

person:
lastName: 張三
age: 18
boss: false
birth: 1990/12/12
maps: { k1: v1,k2: 12 }
lists:
‐ lisi
‐ zhaoliu
dog:
name: 迪迪
age: 5


2. 在 helloworld 專案的 net.biancheng.www.bean 中建立一個名為 Person 的實體類，並將配置檔案中的屬性對映到這個實體類上，程式碼如下。

package net.biancheng.www.bean;


import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;


import java.util.Date;
import java.util.List;
import java.util.Map;


/**
* 將配置檔案中配置的每一個屬性的值，對映到這個元件中
*
* @ConfigurationProperties：告訴 SpringBoot 將本類中的所有屬性和配置檔案中相關的配置進行繫結；
* prefix = "person"：配置檔案中哪個下面的所有屬性進行一一對映
*
* 只有這個元件是容器中的元件，才能使用容器提供的@ConfigurationProperties功能；
*/
@Component
@ConfigurationProperties(prefix = "person")
public class Person {
private String lastName;
private Integer age;
private Boolean boss;
private Date birth;
private Map<String, Object> maps;
private List<Object> lists;
private Dog dog;


public Person() {
}


public String getLastName() {
return lastName;
}


public void setLastName(String lastName) {
this.lastName = lastName;
}


public Integer getAge() {
return age;
}


public void setAge(Integer age) {
this.age = age;
}


public Boolean getBoss() {
return boss;
}


public void setBoss(Boolean boss) {
this.boss = boss;
}


public Date getBirth() {
return birth;
}


public void setBirth(Date birth) {
this.birth = birth;
}


public Map<String, Object> getMaps() {
return maps;
}


public void setMaps(Map<String, Object> maps) {
this.maps = maps;
}


public List<Object> getLists() {
return lists;
}


public void setLists(List<Object> lists) {
this.lists = lists;
}


public Dog getDog() {
return dog;
}


public void setDog(Dog dog) {
this.dog = dog;
}


public Person(String lastName, Integer age, Boolean boss, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) {
this.lastName = lastName;
this.age = age;
this.boss = boss;
this.birth = birth;
this.maps = maps;
this.lists = lists;
this.dog = dog;
}


@Override
public String toString() {
return "Person{" +
"lastName='" + lastName + '\'' +
", age=" + age +
", boss=" + boss +
", birth=" + birth +
", maps=" + maps +
", lists=" + lists +
", dog=" + dog +
'}';
}
}


注意：

  • 只有在容器中的元件，才會擁有 SpringBoot 提供的強大功能。如果我們想要使用 @ConfigurationProperties 註解進行配置繫結，那麼首先就要保證該對 JavaBean 物件在 IoC 容器中，所以需要用到 @Component 註解來新增元件到容器中。
  • JavaBean 上使用了註解 @ConfigurationProperties(prefix = "person") ，它表示將這個 JavaBean 中的所有屬性與配置檔案中以“person”為字首的配置進行繫結。


2. 在 net.biancheng.www.bean 中，建立一個名為 Dog 的 JavaBean，程式碼如下。

package net.biancheng.www.bean;


public class Dog {
private String name;
private String age;


public Dog() {
}


public Dog(String name, String age) {
this.name = name;
this.age = age;
}


public void setName(String name) {
this.name = name;
}


public void setAge(String age) {
this.age = age;
}


public String getName() {
return name;
}


public String getAge() {
return age;
}
}


3. 修改HelloController 的程式碼，在瀏覽器中展示配置檔案中各個屬性值，程式碼如下。

package net.biancheng.www.controller;


import net.biancheng.www.bean.Person;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;


@Controller
public class HelloController {
@Autowired
private Person person;


@ResponseBody
@RequestMapping("/hello")
public Person hello() {
return person;
}
}


4. 重啟專案，使用瀏覽器訪問 “http://localhost:8081/hello”，結果如下圖。

圖3：Spring Boot 讀取自定義配置

二、@Value

當我們只需要讀取配置檔案中的某一個配置時，可以通過 @Value 註解獲取。

1. 以 Spring Boot 專案 helloworld 為例，修改實體類 Person 中的程式碼，使用 @Value 註解進行配置繫結，程式碼如下。

package net.biancheng.www.bean;


import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;


import java.util.Date;
import java.util.List;
import java.util.Map;


@Component
public class Person {
@Value("${person.lastName}")
private String lastName;
@Value("${person.age}")
private Integer age;
@Value("${person.boss}")
private Boolean boss;
@Value("${person.birth}")
private Date birth;


private Map<String, Object> maps;
private List<Object> lists;
private Dog dog;


public Person() {


}


public String getLastName() {
return lastName;
}


public void setLastName(String lastName) {
this.lastName = lastName;
}


public Integer getAge() {
return age;
}


public void setAge(Integer age) {
this.age = age;
}


public Boolean getBoss() {
return boss;
}


public void setBoss(Boolean boss) {
this.boss = boss;
}


public Date getBirth() {
return birth;
}


public void setBirth(Date birth) {
this.birth = birth;
}


public Map<String, Object> getMaps() {
return maps;
}


public void setMaps(Map<String, Object> maps) {
this.maps = maps;
}


public List<Object> getLists() {
return lists;
}


public void setLists(List<Object> lists) {
this.lists = lists;
}


public Dog getDog() {
return dog;
}


public void setDog(Dog dog) {
this.dog = dog;
}


public Person(String lastName, Integer age, Boolean boss, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) {
this.lastName = lastName;
this.age = age;
this.boss = boss;
this.birth = birth;
this.maps = maps;
this.lists = lists;
this.dog = dog;
}


@Override
public String toString() {
return "Person{" +
"lastName='" + lastName + '\'' +
", age=" + age +
", boss=" + boss +
", birth=" + birth +
", maps=" + maps +
", lists=" + lists +
", dog=" + dog +
'}';
}
}


2. 重啟專案，使用瀏覽器訪問 “http://localhost:8081/hello”，結果如下圖。

圖4：Spring Boot @Value 註解讀取配置檔案值

三、@Value 與 @ConfigurationProperties 對比

@Value 和 @ConfigurationProperties 註解都能讀取配置檔案中的屬性值並繫結到 JavaBean 中，但兩者存在以下不同。

1. 使用位置不同

  • @ConfigurationProperties：標註在 JavaBean 的類名上；
  • @Value：標註在 JavaBean 的屬性上。

2. 功能不同

  • @ConfigurationProperties：用於批量繫結配置檔案中的配置；
  • @Value：只能一個一個的指定需要繫結的配置。

3. 鬆散繫結支援不同

@ConfigurationProperties：支援鬆散繫結（鬆散語法），例如實體類 Person 中有一個屬性為 lastName，那麼配置檔案中的屬性名支援以下寫法：

  • person.firstName
  • person.first-name
  • person.first_name
  • PERSON_FIRST_NAME


@Vaule：不支援鬆散繫結。

4. SpEL 支援不同

  • @ConfigurationProperties：不支援 SpEL 表示式;
  • @Value：支援 SpEL 表示式。

5. 複雜型別封裝

  • @ConfigurationProperties：支援所有型別資料的封裝，例如 Map、List、Set、以及物件等；
  • @Value：只支援基本資料型別的封裝，例如字串、布林值、整數等型別。

6. 應用場景不同

@Value 和 @ConfigurationProperties 兩個註解之間，並沒有明顯的優劣之分，它們只是適合的應用場景不同而已。

  • 若只是獲取配置檔案中的某項值，則推薦使用 @Value 註解；
  • 若專門編寫了一個 JavaBean 來和配置檔案進行對映，則建議使用 @ConfigurationProperties 註解。


我們在選用時，根據實際應用場景選擇合適的註解能達到事半功倍的效果。

四、@PropertySource

如果將所有的配置都集中到 application.properties 或 application.yml 中，那麼這個配置檔案會十分的臃腫且難以維護，因此我們通常會將與 Spring Boot 無關的配置（例如自定義配置）提取出來，寫在一個單獨的配置檔案中，並在對應的 JavaBean 上使用 @PropertySource 註解指向該配置檔案。

1. 以 helloworld 為例，將與 person 相關的自定義配置移動到 src/main/resources 下的 person.properties 中（注意，必須把 application.properties 或 application.yml 中的相關配置刪除），如下圖。

圖5：person.properties

person.properties 的配置如下。

person.last-name=李四
person.age=12
person.birth=2000/12/15
person.boss=false
person.maps.k1=v1
person.maps.k2=14
person.lists=a,b,c
person.dog.name=dog
person.dog.age=2


2. 在 Person 使用 @PropertySource 註解指向 person.properties，程式碼如下。

package net.biancheng.www.bean;


import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;


import java.util.Date;
import java.util.List;
import java.util.Map;


@PropertySource(value = "classpath:person.properties")//指向對應的配置檔案
@Component
@ConfigurationProperties(prefix = "person")
public class Person {


private String lastName;


private Integer age;


private Boolean boss;


private Date birth;


private Map<String, Object> maps;


private List<Object> lists;


private Dog dog;


public Person() {


}


public String getLastName() {
return lastName;
}


public void setLastName(String lastName) {
this.lastName = lastName;
}


public Integer getAge() {
return age;
}


public void setAge(Integer age) {
this.age = age;
}


public Boolean getBoss() {
return boss;
}


public void setBoss(Boolean boss) {
this.boss = boss;
}


public Date getBirth() {
return birth;
}


public void setBirth(Date birth) {
this.birth = birth;
}


public Map<String, Object> getMaps() {
return maps;
}


public void setMaps(Map<String, Object> maps) {
this.maps = maps;
}


public List<Object> getLists() {
return lists;
}


public void setLists(List<Object> lists) {
this.lists = lists;
}


public Dog getDog() {
return dog;
}


public void setDog(Dog dog) {
this.dog = dog;
}


public Person(String lastName, Integer age, Boolean boss, Date birth, Map<String, Object> maps, List<Object> lists, Dog dog) {
this.lastName = lastName;
this.age = age;
this.boss = boss;
this.birth = birth;
this.maps = maps;
this.lists = lists;
this.dog = dog;
}


@Override
public String toString() {
return "Person{" +
"lastName='" + lastName + '\'' +
", age=" + age +
", boss=" + boss +
", birth=" + birth +
", maps=" + maps +
", lists=" + lists +
", dog=" + dog +
'}';
}
}

3. 重啟專案，使用瀏覽器訪問 “http://localhost:8081/hello”，結果如下圖。


圖6：Spring Boot 將 person.properties 的屬性注入

相關推薦

3.配置繫結

所謂“配置繫結”就是把配置檔案中的值與 JavaBean 中對應的屬性進行繫結。通常，我們會把一些配置資訊（例如，資料庫配置）放在配置檔案中，然後通過 Java 程式碼去讀取該配置檔案，並且把配置檔案中指定的配置封裝

SpringBoot2.2版本配置繫結是不是有點坑了？

SpringBoot版本升級相容性一直做的不是多麼的美麗，各個大分支之間由於底層使用的Srping版本不同，才導致的這種問題出現，而升級到2.2.1.RELEASE版本之後又遇到一個配置繫結的坑。

YAML配置繫結變數兩種方式

它可以清晰的表達類、成員變數、集合以及他們之間的巢狀關係，這樣一些資料結構。

配置繫結和自定義配置資料來源

使用強型別物件承載配置資料 元件包：Microsoft.Extensions.Configuration.Binder 要點 支援將配置值繫結到已有物件

WPF MVVM模式開發簡明實現教程 3 事件繫結

事件繫結有至少兩種方法 這裡只會講這兩種，其他方法請自行研究 CallMethodAction

spinbox 上下箭頭事件_[React] 3 - 自動繫結 (事件繫結)

技術標籤：spinbox 上下箭頭事件 1. 自動繫結 (事件繫結) 繫結this: React為什麼要這麼做?

SpringBoot 配置繫結

技術標籤：SpringBoot 一、如何使用Java讀取到properties檔案中的內容，並且把它封裝到JavaBean中，以供隨時使用

Angular10教程--2.3 雙向繫結

技術標籤：angular教程angulartypescript Angular10教程--2.3 雙向繫結 雙向繫結大致可以分成兩種型別：一、普通元件的雙向繫結二、表單中的雙向繫結[(ngModel)]單獨使用表單元素在標籤中使用

SpringBoot配置繫結

技術標籤：SpringBootspring boot 環境： 配置實體類 public class User { private String name; private Integer age;

06-SpringBoot配置繫結

1.5註解@ConfigurationProperties進行元件屬性和資源配置檔案中的值進行繫結 註解@ConfigurationProperties+@Component的方式將application.properties檔案中的值繫結到某個元件的屬性上。注意現在預設只能是繫結核

@ConfigurationProperties實現自定義配置繫結

目錄@ConfigurationProperties使用@ConfigurationProperties特點寬鬆繫結支援複雜屬性型別啟用@ConfigurationProperties通過@EnableConfigurationProperties通過@ConfigurationPropertiesScan@ConfigurationPropert

SpringBoot2-配置繫結

當我們使用傳統java進行讀取到properties檔案中的內容，並且把它封裝到JavaBean中，以供隨時使用

Spring Boot 2.0 新特性（一）：配置繫結 2.0 全解析

在Spring Boot 2.0中推出了Relaxed Binding 2.0，對原有的屬性繫結功能做了非常多的改進以幫助我們更容易的在Spring應用中載入和讀取配置資訊。下面本文就來說說Spring Boot 2.0中對配置的改進。

8.配置繫結(如何將properties配置檔案中的內容，封裝到javabean中)

如何將properties檔案中的內容，封裝到javabean中 示例： 在springboot的配置檔案中(application.properties檔案中)有以下兩個配置

.Net 配置繫結 IOptions

準備   首先準備下appsettins.json以及目標類   appsettins.json \"StudentSettings\": { \"Id\": 1023,

SpringBoot使用@ConstructorBinding註解進行配置屬性繫結

SpringBoot2.2版本發行後一些新的功能也漸漸的浮出了水面，在之前版本SpringBoot的配置檔案與類之間的屬性繫結(@ConfigurationProperties)是通過Setter方法來進行繫結對應的配置值，而從2.2版本開始支援了建構函式的

Android Studio 3.6中使用檢視繫結替代 findViewById的方法

從 Android Studio 3.6 開始，檢視繫結能夠通過生成繫結物件來替代 findViewById，從而可以幫您簡化程式碼、移除 bug，並且從 findViewById 的模版程式碼中解脫出來。

Android Studio 3.6中新的檢視繫結工具ViewBinding 用法詳解

前言 我們在Android開發的過程中總是需要獲取XML佈局中的ViewId，以便給其賦值進行顯示，早期我們只能使用 findViewById 這個API，會導致很多的模版程式碼出現。2013年左右Android界大神 Jake Wharton開源了Butter K

win2012R2配置雙網絡卡繫結

Windows2012 R2已自帶網絡卡繫結功能 但在系統裡叫做NIC組合 預設是已禁用，點選可進行相關配置 新建組就是建立新的埠繫結

android studio 3.6.0 繫結檢視新特性的方法

Android studio 3.6.0 繫結檢視使用方法 1.確保你的 build gradle 最低為3.6.0 dependencies {classpath \'com.android.tools.build:gradle:3.6.0\'