SpringBoot中yml的數據綁定示例
前言
Spring Boot 提供了強大的配置能力，通過 YAML 文件進行數據綁定是一種常見且便捷的方式。在本示例中，我們將演示如何利用 Spring Boot 的特性，通過 YAML 文件實現數據綁定。借助于 YAML 的簡潔語法和結構化特性，我們能夠輕松地管理應用程序的配置信息，使得配置文件更加清晰易讀。通過本示例，您將了解如何利用 Spring Boot 快速、高效地實現 YAML 數據綁定，為您的應用程序提供靈活且可維護的配置管理。讓我們開始吧，深入探索 Spring Boot 中 YAML 數據綁定的精髓！
一、前期準備
1、新建項目，結構如下
2、導入依賴
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<parent>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-parent</artifactId>
<version>2.7.17</version>
<relativePath/> <!-- lookup parent from repository -->
</parent>
<groupId>edu.nf</groupId>
<artifactId>ch03</artifactId>
<version>0.0.1-SNAPSHOT</version>
<name>ch03</name>
<description>ch03</description>
<properties>
<java.version>11</java.version>
</properties>
<dependencies>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter</artifactId>
</dependency>
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-configuration-processor</artifactId>
<optional>true</optional>
</dependency>
<dependency>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-starter-test</artifactId>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<plugins>
<plugin>
<groupId>org.springframework.boot</groupId>
<artifactId>spring-boot-maven-plugin</artifactId>
<configuration>
<image>
<builder>paketobuildpacks/builder-jammy-base:latest</builder>
</image>
</configuration>
</plugin>
</plugins>
</build>
</project>
這是一個 Maven 的 pom.xml 文件，它描述了一個 Spring Boot 項目的依賴關系和構建方式。
在這個文件中，我們定義了兩個依賴項：
spring-boot-starter：這是一個 Spring Boot 的核心依賴，它包含了 Spring MVC、Spring Data JPA、Spring Security 等常用模塊，并且自動配置了這些模塊所需的環(huán)境。通過引入這個依賴，我們可以快速搭建一個基于 Spring Boot 的 Web 應用程序。
spring-boot-starter-test：這是一個 Spring Boot 的測試依賴，它提供了許多用于測試的工具和框架，例如 JUnit、Mockito、Hamcrest 等。通過引入這個依賴，我們可以輕松地編寫和執(zhí)行單元測試和集成測試。
此外，我們還定義了一個 Maven 插件 spring-boot-maven-plugin，用于將應用程序打包成一個可執(zhí)行的 JAR 文件，以便于部署和運行。在這個插件中，我們還可以配置容器、端口等參數，以滿足不同的應用程序需求。
總之，pom.xml 文件是 Spring Boot 項目的配置文件，它定義了項目的依賴關系和構建方式，并且通過 Maven 插件實現了對應用程序的打包和部署
二、第一種，值綁定
值綁定，使用 @value 注解精確指定節(jié)點的名稱
1、新建一個 Student 類
@Component
@Data
public class Student {
// 使用 @Value 注解和spell表達式將yml的節(jié)點值綁定到類的字段上
@Value("${student.userId}")
private Integer stuId;
@Value("${student.userName}")
private String stuName;
@Value("${student.age}")
private Integer age;
}
這段代碼是一個Spring組件，用于將YAML配置文件中的值映射到Java對象的字段上。
首先，使用了@Data注解，它會自動生成getter和setter方法、equals方法、hashCode方法以及toString方法。
然后，通過@Value注解來綁定YAML配置文件中的各個節(jié)點值到類的字段上。@Value注解中的"${student.userId}"等，是SpEL表達式，它會在運行時從YAML配置文件中讀取對應節(jié)點的值，并將其賦值給類的字段。
例如，如果在YAML配置文件中有以下內容：
student: userId: 1001 userName: qiu age: 18
那么在運行時，Student對象的stuId字段將被賦值為123，stuName字段將被賦值為"tom"，age字段將被賦值為18。
總之，這段代碼可以讓你輕松地將YAML配置文件中的值映射到Java對象的字段上，方便你的代碼使用。
2、測試
@SpringBootTest
@Slf4j
class Ch03ApplicationTests {
@Autowired
private Student student;
@Test
void contextLoads() {
log.info(student.getStuId().toString());
log.info(student.getStuName());
log.info(student.getAge().toString());
}
}
這段代碼是一個Spring Boot的測試類，用于測試應用程序的上下文加載和配置是否正確。
首先，使用了@SpringBootTest注解，它表示這是一個Spring Boot的集成測試類。它會自動加載應用程序的上下文，并進行必要的配置。
然后，使用@Slf4j注解，它是Lombok庫提供的注解，可以自動生成日志變量log。
接下來，通過@Autowired注解將Student對象注入到測試類中的student字段上。這樣就可以在測試方法中使用該對象。
在contextLoads()方法中，通過調用student對象的getter方法，獲取并打印stuId、stuName和age字段的值。這主要用于驗證是否成功將YAML配置文件中的值綁定到Student對象的相應字段上。
通過日志輸出，你可以在測試運行時查看stuId、stuName和age字段的值。
總結起來，這段代碼用于測試Spring Boot應用程序的上下文加載和配置是否正確，并驗證是否成功將YAML配置文件中的值綁定到相應的Java對象字段上。
運行結果：
三、第二種，松散綁定
使用 @ConfigurationProperties 注解，松散綁定只需要綁定指定節(jié)點的前綴即可，子節(jié)點在 yml 中可以依據約定， 使用駝峰模式（如：userName）、“—”線（如：允(user-name）、或者全大寫加下劃線（如：USER_NAME） 進行綁定即可。
1、還是使用 Student 類
@Component
@Data
@ConfigurationProperties(prefix = "student.info")
public class Student {
private Integer stuId;
private String stuName;
private Integer age;
}
?這段代碼定義了一個名為 Student 的 Java 類，使用了 @Component 和 @Data 注解，并且使用了 @ConfigurationProperties 注解對該類進行了配置。
@Component 注解表示這個類是 Spring 中的一個組件，會被 Spring 容器所管理。@Data 注解是 lombok 提供的注解，自動生成一些常用方法，如 getter、setter、toString 等等。
@ConfigurationProperties(prefix = "student.info") 注解指定了該類的屬性值從以 student.info 為前綴的配置項中獲取。例如，配置文件中有如下配置：
# 數據值綁定
student:
info:
stuId: 1001
stu-name: qiu
AGE: 18 則 Student 類中的 stuId 屬性值為 1001，stuName 屬性值為 "qiu"，age 屬性值為 18。
這里指定字段的格式我使用了三種，為的是演示可以這樣去寫，在實際開發(fā)中，大家最好是選擇一種去使用，統(tǒng)一一點。
通過這種方式，我們可以將應用程序的配置信息與業(yè)務邏輯分離，使得配置文件更加清晰易讀，同時也方便進行統(tǒng)一的配置管理。
測試的結果和值綁定到一樣，就不測試了。需要注意的是，實體類的字段名稱和yml配置的名稱要一樣，不能出現不一致的，不然會報錯的。
2、綁定實體
1）新建一個 Card 實體類
@Data
public class Card {
private String cardNum;
}使用 @Data 生成 get、set訪問器就可以了。
2）在 Student 實體類中引入 Card 實體類為字段
@Component
@Data
@ConfigurationProperties(prefix = "student.info")
public class Student {
private Integer stuId;
private String stuName;
private Integer age;
// 實體
private Card card;
} 在原有的 Student 類基礎上，新增了一個名為 card 的屬性，并且類型為 Card。
yml示例：
# 數據值綁定
student:
info:
stuId: 1001
stu-name: qiu
AGE: 18
card:
card-num: 4408812000 則 Student 類中的 stuId 屬性值為 1001，stuName 屬性值為 "qiu"，age 屬性值為 18。Card類中的 cardNum 為 4408812000.
3）測試
@SpringBootTest
@Slf4j
class Ch03ApplicationTests {
@Autowired
private Student student;
@Test
void contextLoads() {
log.info(student.getStuId().toString());
log.info(student.getStuName());
log.info(student.getAge().toString());
log.info(student.getCard().getCardNum());
}
}
在contextLoads()方法中，使用日志記錄器log輸出了student對象的一些屬性信息。通過調用student對象的get方法獲取學生的學號、姓名、年齡以及身份證號碼，并通過log.info()方法將它們輸出到日志中。
運行結果：
3、綁定數組
1）在 student 實體類中新建一個字段
// 數組
private String[] tels;yml中綁定 tels 的值：
# 綁定 array，list，set 集合,多個值使用逗號分隔
tels: # 13223453421,14556766700
- 13223453421
- 14556766700這里呢有兩種寫法，一種是用逗號隔開，一種是使用 “-”線加空格隔開，不加空格的話，輸出的時候會把 “-” 也輸出來。
2）測試
@SpringBootTest
@Slf4j
class Ch03ApplicationTests {
@Autowired
private Student student;
@Test
void contextLoads() {
log.info(student.getStuId().toString());
log.info(student.getStuName());
log.info(student.getAge().toString());
log.info(student.getCard().getCardNum());
for (String tel : student.getTels()) {
log.info(tel);
}
}
}
綁定了一個數組，拿出來只需要循環(huán)就可以啦。
運行結果：
4、綁定 map
1）在 Student 實體類中新建一個字段
// map
private Map<String,Integer> score;yml 綁定 score 的值：
# 綁定 map
score:
chinese: 85
english: 60因為 map 是一以鍵值對保存數據的，所以這里的 Chinese 就是鍵，85 就是這個鍵的值。
2）測試
@SpringBootTest
@Slf4j
class Ch03ApplicationTests {
@Autowired
private Student student;
@Test
void contextLoads() {
log.info(student.getStuId().toString());
log.info(student.getStuName());
log.info(student.getAge().toString());
log.info(student.getCard().getCardNum());
for (String tel : student.getTels()) {
log.info(tel);
}
student.getScore().forEach((k,v) -> log.info(k + " : " + v));
}
}
Map的forEach()方法，遍歷了getScore()返回的Map對象，并通過日志輸出了每個鍵值對的內容。
運行結果：
5、復雜的值綁定
1）新建一個 Teacher 實體類
@Data
public class Teacher {
private String name;
private Integer age;
}
2）在 student 實體類中新加一個字段
// 集合里面有個對象
private List<Teacher> teaches;
yml綁定：
# 綁定復雜類型（集合中包含對象）
teaches:
- name: Mr.qiu
age: 21
- name: Ms.zhi
age: 22這是一個 YAML 配置文件，其中 teaches 是一個復雜類型，包含了兩個對象：Mr.qiu 和 Ms.zhi，它們都擁有 name 和 age 兩個屬性。
3）測試
@SpringBootTest
@Slf4j
class Ch03ApplicationTests {
@Autowired
private Student student;
@Test
void contextLoads() {
log.info(student.getStuId().toString());
log.info(student.getStuName());
log.info(student.getAge().toString());
log.info(student.getCard().getCardNum());
for (String tel : student.getTels()) {
log.info(tel);
}
student.getScore().forEach((k,v) -> log.info(k + " : " + v));
student.getTeaches().forEach( teach -> {
log.info(teach.getName());
log.info(teach.getAge().toString());
});
}
}
運行結果：
四、值綁定和松散綁定到優(yōu)點和缺點
YAML 數據綁定的值綁定和松散綁定有以下優(yōu)點：
- 簡單易讀：YAML 格式的數據配置文件相對于傳統(tǒng)的屬性文件更加簡潔易讀，且支持注釋和多行文本。
- 靈活性：YAML 的靈活性允許我們在配置文件中使用復雜的數據類型，包括數組、對象、嵌套對象等。
- 易于維護：通過將配置文件中的值綁定到 Java 類上，我們可以使用 Java 對象的語法來訪問這些值，使得代碼更加易于維護和閱讀。
- 配置管理：通過
@ConfigurationProperties注解，可以將應用程序的配置信息與業(yè)務邏輯分離，使得配置文件更加清晰易讀，同時也方便進行統(tǒng)一的配置管理。
但是，YAML 數據綁定的值綁定和松散綁定也有以下缺點：
- 學習成本：相比于傳統(tǒng)的屬性文件，使用 YAML 格式的數據配置文件需要學習新的語法和規(guī)則，需要一些時間來適應。
- 錯誤處理：由于 YAML 的松散綁定特性，當配置文件中出現錯誤時，可能會造成不可預知的結果，需要開發(fā)者自己注意檢查和處理。
- 性能問題：相比于傳統(tǒng)的屬性文件，使用 YAML 格式的數據配置文件解析和讀取速度可能會稍慢一些，特別是在處理大量數據時。
綜上所述，在使用 YAML 數據綁定時，需要根據具體情況權衡其優(yōu)缺點，并選擇適合自己的方式來處理配置信息。
到此這篇關于SpringBoot中yml的數據綁定示例的文章就介紹到這了,更多相關SpringBoot yml數據綁定內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家！
相關文章
這篇文章主要介紹了IntelliJ IDEA 的使用界面圖文教程,需要的朋友可以參考下2018-10-10
這篇文章主要介紹了idea 2023.1字體設置及自動調整大小的教程,本文通過圖文并茂的形式給大家介紹的非常詳細，需要的朋友可以參考下2023-07-07
本文主要介紹了Springboot+redis+Vue實現秒殺的項目實踐，文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值，需要的朋友們下面隨著小編來一起學習學習吧2022-08-08
java8新特性之stream流中reduce()求和知識總結
今天帶大家回顧Java8的新特性,文中對stream流中reduce()求和的相關知識作了詳細的介紹,對正在學習java的小伙伴們有很好地幫助,需要的朋友可以參考下2021-05-05
本地啟動RocketMQ未映射主機名產生的超時問題最新解決方案
這篇文章主要介紹了本地啟動RocketMQ未映射主機名產生的超時問題,本文給大家分享最新解決方案，感興趣的朋友跟隨小編一起看看吧2024-02-02
日常開發(fā)中,我們經常會遇到一些重復代碼,最近小編優(yōu)化了一些系統(tǒng)中的重復代碼,用了好幾種的方式,感覺挺有用的,所以本文給大家講講優(yōu)化重復代碼的幾種方式2023-08-08
這篇文章主要介紹了Java獲取網頁數據步驟方法詳解,文中通過示例代碼介紹的非常詳細，對大家的學習或者工作具有一定的參考學習價值,需要的朋友可以參考下2020-03-03
這篇文章主要介紹了Java?@Validated遇到的大坑與處理方式，具有很好的參考價值，希望對大家有所幫助。如有錯誤或未考慮完全的地方，望不吝賜教2021-12-12
這篇文章主要介紹了淺談Java中對類的主動引用和被動引用，分享了相關代碼示例，小編覺得還是挺不錯的，具有一定借鑒價值，需要的朋友可以參考下2018-02-02
利用Spring?Boot和JPA創(chuàng)建GraphQL?API
這篇文章主要介紹了利用Spring?Boot和JPA創(chuàng)建GraphQL?API，GraphQL既是API查詢語言，也是使用當前數據執(zhí)行這些查詢的運行時，下文更多相關內容介紹需要的小伙伴可以參考一下2022-04-04