SpringBoot:ch03 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 等常用模块，并且自动配置了这些模块所需的环境。通过引入这个依赖，我们可以快速搭建一个基于 Spring Boot 的 Web 应用程序。

spring-boot-starter-test：这是一个 Spring Boot 的测试依赖，它提供了许多用于测试的工具和框架，例如 JUnit、Mockito、Hamcrest 等。通过引入这个依赖，我们可以轻松地编写和执行单元测试和集成测试。

此外，我们还定义了一个 Maven 插件 spring-boot-maven-plugin，用于将应用程序打包成一个可执行的 JAR 文件，以便于部署和运行。在这个插件中，我们还可以配置容器、端口等参数，以满足不同的应用程序需求。

总之，pom.xml 文件是 Spring Boot 项目的配置文件，它定义了项目的依赖关系和构建方式，并且通过 Maven 插件实现了对应用程序的打包和部署

 

二、第一种，值绑定

值绑定，使用 @value 注解精确指定节点的名称

1、新建一个 Student 类

@Component
@Data
public class Student {
    // 使用 @Value 注解和spell表达式将yml的节点值绑定到类的字段上
    @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配置文件中的各个节点值到类的字段上。@Value注解中的"${student.userId}"等，是SpEL表达式，它会在运行时从YAML配置文件中读取对应节点的值，并将其赋值给类的字段。

例如，如果在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 注解，松散绑定只需要绑定指定节点的前缀即可，子节点在 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。

这里指定字段的格式我使用了三种，为的是演示可以这样去写，在实际开发中，大家最好是选择一种去使用，统一一点。

通过这种方式，我们可以将应用程序的配置信息与业务逻辑分离，使得配置文件更加清晰易读，同时也方便进行统一的配置管理。

测试的结果和值绑定到一样，就不测试了。需要注意的是，实体类的字段名称和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);
        }
    }

}

绑定了一个数组，拿出来只需要循环就可以啦。

运行结果：

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());
        });
    }

}

 运行结果：

 

四、值绑定和松散绑定到优点和缺点

YAML 数据绑定的值绑定和松散绑定有以下优点：

  1. 简单易读：YAML 格式的数据配置文件相对于传统的属性文件更加简洁易读，且支持注释和多行文本。
  2. 灵活性：YAML 的灵活性允许我们在配置文件中使用复杂的数据类型，包括数组、对象、嵌套对象等。
  3. 易于维护：通过将配置文件中的值绑定到 Java 类上，我们可以使用 Java 对象的语法来访问这些值，使得代码更加易于维护和阅读。
  4. 配置管理：通过 @ConfigurationProperties 注解，可以将应用程序的配置信息与业务逻辑分离，使得配置文件更加清晰易读，同时也方便进行统一的配置管理。

但是，YAML 数据绑定的值绑定和松散绑定也有以下缺点：

  1. 学习成本：相比于传统的属性文件，使用 YAML 格式的数据配置文件需要学习新的语法和规则，需要一些时间来适应。
  2. 错误处理：由于 YAML 的松散绑定特性，当配置文件中出现错误时，可能会造成不可预知的结果，需要开发者自己注意检查和处理。
  3. 性能问题：相比于传统的属性文件，使用 YAML 格式的数据配置文件解析和读取速度可能会稍慢一些，特别是在处理大量数据时。

综上所述，在使用 YAML 数据绑定时，需要根据具体情况权衡其优缺点，并选择适合自己的方式来处理配置信息。

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：/a/175122.html

如若内容造成侵权/违法违规/事实不符，请联系我们进行投诉反馈qq邮箱809451989@qq.com，一经查实，立即删除！

相关文章

vue3-响应式函数

vue3-响应式函数

​&#x1f308;个人主页&#xff1a;前端青山 &#x1f525;系列专栏&#xff1a;Vue篇 &#x1f516;人终将被年少不可得之物困其一生 依旧青山,本期给大家带来vue篇专栏内容:vue3-响应式函数 目录 ref 响应式函数 引言&#xff1a; ref 函数 reactive 函数 Reactive 与…
阅读更多...
详解python淘宝秒杀抢购脚本程序实现

详解python淘宝秒杀抢购脚本程序实现

文章目录 前言一、官网下载火狐浏览器二、下载geckodriver&#xff0c;并解压到火狐浏览器文件夹根目录三、添加火狐浏览器根目录到系统环境变量四、下载并安装python及pycharm开发工具五、进入淘宝六、使用Pycharm运行脚本&#xff0c;新建python文件&#xff0c;将代码复制到…
阅读更多...
英语六级范文模板

英语六级范文模板

目录 现象解释 观点选择 问题解决 六级只考议论文&#xff0c;我们将从现象解释&#xff0c;观点选择&#xff0c;问题解决三个角度给出范文&#xff1a; 多次使用的句子&#xff0c;就可以作为模板记下来~~ 现象解释 In the contemporary world, the ability to meet cha…
阅读更多...
单链表OJ题--9.环形链表

单链表OJ题--9.环形链表

9.环形链表 141. 环形链表 - 力扣&#xff08;LeetCode&#xff09; /* 解题思路&#xff1a; 定义快慢指针fast,slow, 如果链表确实有环&#xff0c;fast指针一定会在环内追上slow指针。 */typedef struct ListNode Node; bool hasCycle(struct ListNode *head) {Node* slow …
阅读更多...
程序员指南六：数据平面开发套件

程序员指南六：数据平面开发套件

PORT HOTPLUG FRAMEWORK 端口热插拔框架为DPDK应用程序提供在运行时附加和分离端口的能力。由于该框架依赖于PMD实现&#xff0c;PMD无法处理的端口超出了该框架的范围。此外&#xff0c;在从DPDK应用程序分离端口后&#xff0c;该框架不提供从系统中移除设备的方法。对于由物…
阅读更多...
【代码随想录】刷题笔记Day32

【代码随想录】刷题笔记Day32

前言 实在不想做项目&#xff0c;周末和npy聊了就业的焦虑&#xff0c;今天多花点时间刷题&#xff01;刷刷刷刷&#xff01; 93. 复原 IP 地址 - 力扣&#xff08;LeetCode&#xff09; 分割startindex类似上一题&#xff0c;难点在于&#xff1a;判断子串合法性(0~255)、&…
阅读更多...
锯木棍

锯木棍

题目描述 有一根粗细均匀长度为 L 的木棍&#xff0c;先用红颜色刻度线将它 m 等分&#xff0c;再用蓝色刻度线将 其 n 等分&#xff08; m>n &#xff09;&#xff0c;然后按所有刻度线将该木棍锯成小段&#xff0c;计算并输出长度最长的木棍的长度和根数。 输入格式…
阅读更多...
移动机器人，开启智能柔性制造新篇章

移动机器人，开启智能柔性制造新篇章

智能制造是当今工业发展的必然趋势&#xff0c;而柔性制造则是智能制造的重要组成部分。在这个快速变革的时代&#xff0c;如何提高生产效率、降低成本、增强灵活性成为了制造业的关键挑战。富唯智能移动机器人应运而生&#xff0c;为柔性制造注入了新的活力。 基于富唯智能AI-…
阅读更多...
泛型边界的问题

泛型边界的问题

作者简介&#xff1a;大家好&#xff0c;我是smart哥&#xff0c;前中兴通讯、美团架构师&#xff0c;现某互联网公司CTO 联系qq&#xff1a;184480602&#xff0c;加我进群&#xff0c;大家一起学习&#xff0c;一起进步&#xff0c;一起对抗互联网寒冬 我们花了两篇文章讲述了…
阅读更多...
40、Flink 的Apache Kafka connector（kafka source的介绍及使用示例）-1

40、Flink 的Apache Kafka connector（kafka source的介绍及使用示例）-1

Flink 系列文章 1、Flink 部署、概念介绍、source、transformation、sink使用示例、四大基石介绍和示例等系列综合文章链接 13、Flink 的table api与sql的基本概念、通用api介绍及入门示例 14、Flink 的table api与sql之数据类型: 内置数据类型以及它们的属性 15、Flink 的ta…
阅读更多...
【开源】基于Vue和SpringBoot的智能教学资源库系统

【开源】基于Vue和SpringBoot的智能教学资源库系统

项目编号&#xff1a; S 050 &#xff0c;文末获取源码。 \color{red}{项目编号&#xff1a;S050&#xff0c;文末获取源码。} 项目编号&#xff1a;S050&#xff0c;文末获取源码。 目录 一、摘要1.1 项目介绍1.2 项目录屏 二、功能模块2.1 数据中心模块2.2 课程档案模块2.3 课…
阅读更多...
Rockchip平台rk3588源码下载编译(基于Android13)

Rockchip平台rk3588源码下载编译(基于Android13)

Rockchip平台rk3588源码下载编译(基于Android13) 源码下载 下载地址 repo init --repo-url https://gerrit.rock-chips.com:8443/repo-release/tools/repo -u https://gerrit.rock-chips.com:8443/Android_T/manifests.git -m Android13.xml服务器镜像下载 repo init --rep…
阅读更多...
PCS7中如何实现DB块变量的自动上传

PCS7中如何实现DB块变量的自动上传

问题：如何实现PCS7中DB块中变量的自动上传？ 解答：PCS7下，所有CFC中的变量都通过编译的方式自动上传的OS项目中，针对自定义的DB块同样也可以通过设置相关属性自动上传的OS中，具体操作如下： 插入一个全局数据块。 注意：数据块号必须符合要求，可以参考PCS7中定义的预留DB…
阅读更多...
5-2计算pi

5-2计算pi

#include<stdio.h> #include<math.h>int main(){int sign1;//数值的符号int count0;//累计计算循环的次数double pi0.0;double n1;//分母double term1.0;//当前项的数while(fabs(term)>1e-6){//fabs(trem)|term|pipiterm;nn2;sign-sign;termsign/n;count;}pipi*…
阅读更多...
vue3的单组件的编写(二)--通过对比vue2来讲解

vue3的单组件的编写(二)--通过对比vue2来讲解

&#x1f42f; 单组件的编写(二) 主要讲了 &#x1f308; 响应式数据的变化 响应式数据是MVVM数据变驱动编程的特色&#xff0c; VUE的设计也是受 MVVM模型的启发&#xff0c;大部分开发者选择MVVM框架都是因为数据驱动编程比传统的事件驱动编程来的方便。而选择vue&#xff…
阅读更多...
“index“ should always be multi-word

“index“ should always be multi-word

vue报错&#xff1a;Component name “index” should always be multi-word 分析&#xff1a;组件名要以驼峰格式命名&#xff0c;自定义的要以loginIndex.vue等这种方式命名&#xff0c;防止和html标签冲突&#xff0c;所以命名index.vue 会报错 解决&#xff1a;在.eslint…
阅读更多...
PG数据中DBeaver上传csv文件作为数据表

PG数据中DBeaver上传csv文件作为数据表

DBeaver 是一个开源的数据库工具&#xff0c;还是蛮好用的&#xff0c;有时候需要我们上传数据做表&#xff0c;数据为CSV格式的&#xff0c;DBeaver本身自带有功能实现的。 可打开连着的数据库&#xff0c;找到模式&#xff0c;点到下面的表里&#xff0c;选择一个表直接导入…
阅读更多...
已完结7个，再启动1个新项目，嘎嘎强！

已完结7个，再启动1个新项目，嘎嘎强！

作者&#xff1a;小傅哥 博客&#xff1a;https://bugstack.cn 沉淀、分享、成长&#xff0c;让自己和他人都能有所收获&#xff01;&#x1f604; 大家好&#xff0c;我是技术UP主小傅哥。 &#x1f490;又到了启动新项目的时候&#xff0c;死鬼开心嘛。小傅哥的星球&#xf…
阅读更多...
Rust可空类型Option

Rust可空类型Option

文章目录 Option基础模式匹配unwrap Rust基础教程&#xff1a;初步⚙所有权⚙结构体和枚举类⚙函数进阶⚙泛型和特征⚙并发和线程通信⚙cargo包管理 Rust进阶教程&#xff1a;用宏实现参数可变的函数⚙类函数宏 Option基础 在一些编程语言中&#xff0c;允许存在空值&#xf…
阅读更多...
Linux环境下安装部署单机RabbitMQ（离线）

Linux环境下安装部署单机RabbitMQ（离线）

摘要 本文档适用于在Linux系统下部署单体RabbitMQ&#xff0c;是在无网的情况下部署的。涉及的任何操作都是通过手动下载安装包然后上传到服务器上进行安装&#xff0c;因此也遇到一些问题&#xff0c;并在此文档中记录。 实际操作环境&#xff1a;Kylin V10&#xff0c;实际…
阅读更多...
最新文章

Copyright @ 2022~2023