SpringBoot绑定复杂类型自定义参数（List/Map/Set/自定义对象等）YML

最新推荐文章于 2024-04-18 19:02:05 发布
最新推荐文章于 2024-04-18 19:02:05 发布
阅读量4.1k 收藏 9
点赞数 7
文章标签： spring boot list java yaml
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/daiyi666/article/details/122511997
版权

应用场景

在开发中，我们经常需要把一些随时可能变化的属性配置到配置文件中，这样耦合性低，方便维护。Spring Boot在这方面为我们提供了很大的便捷，我们可以很轻易的将properties、yml、yaml中配置的属性绑定到JAVA实体类上。
在这里插入图片描述

具体实施

注意事项

  • 您需要保证您需要绑定参数的这个类是被Spring IOC容器所管理的
  • 您这个需要绑定参数的类至少需要具有set方法，不然无法绑定（但不会报错，下面演示中使用的lombok提供get、set方法等）
  • 您在使用这个类的时候也应该是遵循Spring 依赖注入的规范

代码解释：请看下面的代码：我创建了一个Configuration类(我使用了Lombok提供get、set方法等)，他有一个静态内部类：Properties，这个内部类我用来作为“配置类出现”，为它绑定属性。所以我用@Component注解将它交给IOC容器管理，又由于我的Configuration类需要注入Properties“配置类”，所以我也将Configuration类交给了IOC容器管理，在Configuration中使用@Resource注解注入了Properties,而print方法作为测试方法，我为它加了@PostConstruct注解（在依注入完成之后自动执行，方便查看测试结果）

package com.scfenzhi.config;

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

import javax.annotation.PostConstruct;
import javax.annotation.Resource;

/**
 * @Author: Yi Dai
 * @Email: 484201132@qq.com
 * @CreateTime: 2022-01-15 15:51
 * @Company: Sichuan Fenzhi International Trade Co., LTD
 * @Description:
 */

@Component
public class Configuration {

    @Resource
    private Properties properties;

    @Data
    @Component
    @ConfigurationProperties(prefix = "configuration.properties")
    private static class Properties {

    }

    @PostConstruct
    public void print() {
        System.out.println(properties);
    }

}

基本数据类型及字符串类型

Java代码

package com.scfenzhi.config;

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

import javax.annotation.PostConstruct;
import javax.annotation.Resource;

/**
 * @Author: DaiYi
 * @Email: 484201132@qq.com
 * @CreateTime: 2022-01-15 15:51
 * @Company: Sichuan Fenzhi International Trade Co., LTD
 * @Description:
 */

@Component
public class Configuration {

    @Resource
    private Properties properties;


    @Data
    @Component
    @ConfigurationProperties(prefix = "configuration.properties")
    private static class Properties {
        private byte byteType;
        private short shortType;
        private int intType;
        private long longType;
        private float floatType;
        private double doubleType;
        private boolean booleanType;
        private char chatType;
        private String str1;
        private String str2;
        private String str3;
    }

    @PostConstruct
    public void print() {
        System.out.println(properties);
    }

}

yaml代码

configuration:
  properties:
    byte-type: 1
    short-type: 1
    int-type: 1
    long-type: 1
    float-type: 1.0F
    double-type: 1.0D
    boolean-type: true
    chat-type: 97
    str1: haha
    str2: 'heihei'
    str3: "xixixi"

输出结果

Configuration.Properties(byteType=1, shortType=1, intType=1, longType=1, floatType=1.0, doubleType=1.0, booleanType=true, chatType=a, str1=haha, str2=heihei, str3=xixixi)

特别注意：

  • 绑定char类型时，您可以选择使用字符表码表中的数值来代替字符(比如我上面的97就表示字母a)，当然，您也可以使用字面量表示，如chat-type: a，值您也可以选择用单引号或者双引号包裹起来。这并不会报错。
  • 绑定String类型时，您可以选择不用引号或者使用单引号，甚至双引号也可以，都不会报错。在有特殊字符的情况下，使用引号可能是个不错的选择。
  • 绑定boolean类型参数时，您不仅可以使用true、false来表示。您还可以用on或者off表示(on=true,off=false)
  • 绑定float类型或者double类型时，您可以选择在值的后面加一个标识符标识类型，如1.0f表示这是float类型，1.0D表示这是double类型，大小写均可。但是比较坑的是，long类型是不能加L或者l标识符的，这会报错：

Failed to bind properties under ‘configuration.properties.long-type’ to long:
Property: configuration.properties.long-type
Value: 1L
Origin: class path resource [application.yml] - 89:16
Reason: failed to convert java.lang.String to long (caused by java.lang.NumberFormatException: For input string: “1L”)

对象类型（自定义对象）

Java代码

package com.scfenzhi.config;

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

import javax.annotation.PostConstruct;
import javax.annotation.Resource;

/**
 * @Author: Yi Dai
 * @Email: 484201132@qq.com
 * @CreateTime: 2022-01-15 15:51
 * @Company: Sichuan Fenzhi International Trade Co., LTD
 * @Description:
 */

@Component
public class Configuration {

    @Resource
    private Properties properties;

    @Data
    @Component
    @ConfigurationProperties(prefix = "configuration.properties")
    private static class Properties {
        private User user;
    }

    @Data
    private static class User {
        private int id;
        private String username;
        private boolean gender;
    }

    @PostConstruct
    public void print() {
        System.out.println(properties);
    }

}

yaml代码(写法一)

configuration:
  properties:
    user: { id: 1001,username: Yi Dai,gender: false }

yaml代码(写法二)

configuration:
  properties:
    user:
      id: 1001
      username: Yi Dai
      gender: on

输出结果

两种写法输出结果一致

Configuration.Properties(user=Configuration.User(id=1001, username=Yi Dai, gender=true))

数组类型

Java代码

package com.scfenzhi.config;

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

import javax.annotation.PostConstruct;
import javax.annotation.Resource;

/**
 * @Author: Yi Dai
 * @Email: 484201132@qq.com
 * @CreateTime: 2022-01-15 15:51
 * @Company: Sichuan Fenzhi International Trade Co., LTD
 * @Description:
 */

@Component
public class Configuration {

    @Resource
    private Properties properties;

    @Data
    @Component
    @ConfigurationProperties(prefix = "configuration.properties")
    private static class Properties {
        private String[] stringArray;
        private User[] userArray;
    }

    @Data
    private static class User {
        private int id;
        private String username;
        private boolean gender;
    }


    @PostConstruct
    public void print() {
        System.out.println(properties);
    }

}

yaml代码（写法一）

configuration:
  properties:
    string-array: [ Yi Dai,Guoxu Li ]
    user-array: [ { id: 1001,username: Yi Dai,password: 123456a,gender: true },{ id: 1002,username: Guoxu Li,password: 123456b,gender: off } ]

yaml代码（写法二）

configuration:
  properties:
    string-array:
      - Yi Dai
      - Guoxu Li
    user-array:
      - id: 1001
        username: Yi Dai
        password: 123456a
        gender: true
      - id: 1002
        username: Guoxu Li
        password: 123456b
        gender: off

输出结果

两种写法输出结果一致

Configuration.Properties(stringArray=[Yi Dai, Guoxu Li], userArray=[Configuration.User(id=1001, username=Yi Dai, gender=true), Configuration.User(id=1002, username=Guoxu Li, gender=false)])

特别注意：

  • 在采用写法二绑定数组时，您应该注意每个元素都要换行，且-标识符后面应该有一个空格

集合类型

Java代码

package com.scfenzhi.config;

import lombok.Data;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.Resource;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * @Author: DaiYi
 * @Email: 484201132@qq.com
 * @CreateTime: 2022-01-15 15:51
 * @Company: Sichuan Fenzhi International Trade Co., LTD
 * @Description:
 */

@ToString
@Component
public class Configuration {

    @Resource
    private Properties properties;


    @Data
    @Component
    @ConfigurationProperties(prefix = "configuration.properties")
    private static class Properties {
        private List<String> stringList;
        private Set<Integer> integerSet;
        private Map<String, Integer> stringIntegerMap;
    }


    @PostConstruct
    public void print() {
        System.out.println(properties);
    }

}

yaml代码（写法一）

configuration:
  properties:
    string-list: [ YiDai,'Guoxu Li',"Yaxin Zhang" ]
    integer-set: [ 1,3,5,7,9 ]
    string-integer-map: { Dai: 18 , "Li": 23,'Zhang': 19 }

yaml代码（写法二）

configuration:
  properties:
    string-list:
      - Yi Dai
      - 'Guoxu Li'
      - "Yaxin Zhang"
    integer-set:
      - 1
      - 3
      - 5
      - 7
      - 9
    string-integer-map:
      Dai: 18
      "Li": 23
      'Zhang': 19

输出结果

Configuration.Properties(stringList=[YiDai, Guoxu Li, Yaxin Zhang], integerSet=[1, 3, 5, 7, 9], stringIntegerMap={Dai=18, Li=23, Zhang=19})

特别注意：

  • 在采用第二种写法绑定map时，您应该注意，此时不是数组了，不能在每一项前面加-标识符，如果您加了，这会导致结果的前面多了索引值和一个.，如：0.Dai=18。
  • 绑定map时（无论何种写法），如果您的key是String类型的，那么存在一个问题，就是您多个字符之间的空格会被自动去除（加引号也不好使），但value不会。如果你的key是中文，那么这个键值对将会被忽略
  • List集合默认创建java.util.ArrayList
  • Set集合默认创建java.util.LinkedHashSet
  • Map集合默认创建java.util.LinkedHashMap

复杂类型

Java代码

package com.scfenzhi.config;

import lombok.Data;
import lombok.ToString;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import javax.annotation.PostConstruct;
import javax.annotation.Resource;
import java.util.List;
import java.util.Map;
import java.util.Set;

/**
 * @Author: DaiYi
 * @Email: 484201132@qq.com
 * @CreateTime: 2022-01-15 15:51
 * @Company: Sichuan Fenzhi International Trade Co., LTD
 * @Description:
 */

@ToString
@Component
public class Configuration {

    @Resource
    private Properties properties;


    @Data
    @Component
    @ConfigurationProperties(prefix = "configuration.properties")
    private static class Properties {

        private User user;

        private List<User> userList;

        private Set<User> userSet;

        private Map<Integer, User> userMap;
    }


    @Data
    private static class User {
        private Integer id;
        private String username;
        private Boolean gender;
        private Car car;
    }

    @Data
    private static class Car {
        private Double price;
        private String brand;
    }


    @PostConstruct
    public void print() {
        System.out.println(properties);
    }

}

yaml代码（写法一）

configuration:
  properties:
    user: { id: 1001,  username: Yi Dai,gender: true,car: { price: 1,brand: '宝驴' } }
    user-list: [ { id: 1001,  username: Yi Dai,gender: true,car: { price: 1,brand: '宝驴' } },{ id: 1002,  username: Yaxin Zhang,gender: false,car: { price: 2,brand: '玛莎拉驴' } } ]
    user-set: [ { id: 1001,  username: Yi Dai,gender: true,car: { price: 1,brand: '宝驴' } },{ id: 1002,  username: Yaxin Zhang,gender: false,car: { price: 2,brand: '玛莎拉驴' } } ]
    user-map: { 1001: { id: 1001,  username: Yi Dai,gender: true,car: { price: 1,brand: '宝驴' } },1002: { id: 1002,  username: Yaxin Zhang,gender: false,car: { price: 2,brand: '玛莎拉驴' } } }

yaml代码（写法二）

configuration:
  properties:
    user:
      id: 1001
      username: Yi Dai
      gender: true
      car:
        price: 1
        brand: 宝驴
    user-list:
      - id: 1001
        username: Yi Dai
        gender: true
        car:
          price: 1
          brand: 宝驴
      - id: 1002
        username: Yaxin Zhang
        gender: false
        car:
          price: 1
          brand: 玛莎拉驴
    user-set:
      - id: 1001
        username: Yi Dai
        gender: true
        car:
          price: 1
          brand: 宝驴
      - id: 1002
        username: Yaxin Zhang
        gender: false
        car:
          price: 1
          brand: 玛莎拉驴
    user-map:
      1001:
        id: 1001
        username: Yi Dai
        gender: true
        car:
          price: 1
          brand: 宝驴
      1002:
        id: 1002
        username: Yaxin Zhang
        gender: false
        car:
          price: 1
          brand: 玛莎拉驴

输出结果

两种方式都能正常绑定

Configuration.Properties(user=Configuration.User(id=1001, username=Yi Dai, gender=true, car=Configuration.Car(price=1.0, brand=宝驴)), userList=[Configuration.User(id=1001, username=Yi Dai, gender=true, car=Configuration.Car(price=1.0, brand=宝驴)), Configuration.User(id=1002, username=Yaxin Zhang, gender=false, car=Configuration.Car(price=2.0, brand=玛莎拉驴))], userSet=[Configuration.User(id=1001, username=Yi Dai, gender=true, car=Configuration.Car(price=1.0, brand=宝驴)), Configuration.User(id=1002, username=Yaxin Zhang, gender=false, car=Configuration.Car(price=2.0, brand=玛莎拉驴))], userMap={1001=Configuration.User(id=1001, username=Yi Dai, gender=true, car=Configuration.Car(price=1.0, brand=宝驴)), 1002=Configuration.User(id=1002, username=Yaxin Zhang, gender=false, car=Configuration.Car(price=2.0, brand=玛莎拉驴))})

其他细节

  • 由于是松散绑定，所以您可以选择将属性名之间的多个单词的分割符改为下划线(_)
june-Dai Yi
关注
  • 7
    点赞
  • 踩
  • 9
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
springboot2.0 读取yml 配置 array，list，map，单值，及其组合
m0_67403076的博客
08-24 2369
注意，使用这种方式，必须得在配置文件中配置该 key 及其 value。我在网上找了许多资料，都没找到利用 EL 表达式支持不配置 key/value 的写法。如果key中存在特殊字符如：/、.、*等，我们可以使用"[]"进行转义。(1) 自定义解析方法。
springboot接口参数为List
热门推荐
xue317378914的专栏
06-09 1万+
简单接口参数 springboot接口访问，如果是走http请求，那么参数会默认转换成键值对格式，或者是json字符串形式的。 今天就遇到一个场景，我需要一个list结构的参数，list里面又是对象，那我们该怎么传参呢？ 我们不能再浏览器上直接拼接参数发请求了，例如： 这样的格式是不被允许的，请求会报错。 那么我们转换思路，既然是json格式的参数，那我们就传json格式 设置headers Content-type 的值为application/json 组织传值参数list数据 在body中，传值
Spring Boot中接收各种各样的参数
最新发布
仰望星空，脚踏实地！安全感是自己给的，努力才是一辈子的安全感。
04-18 1207
【代码】Spring Boot中接收各种各样的参数。
Spring Boot之yaml配置注入基本使用
兮动人
01-31 1133
文章目录1. 配置文件2. yaml概述1. yaml基础语法2. 对象、Map（键值对）3. 数组（ List、set ）注入配置文件yaml注入配置文件 1. 配置文件 SpringBoot使用一个全局的配置文件 ， 配置文件名称是固定的 application.properties 语法结构 ：key=value application.yml 语法结构 ：key：空格 value 配置文件的作用 ：修改SpringBoot自动配置的默认值，因为SpringBoot在底层都给我
Spring关于数组、集合和Properties的注入
qq_45349018的博客
02-28 2295
在某个类中需要依赖其它类时，通常是new一个依赖类再调用类实例的方法，这种开发存在的问题是new的类实例不好统一管理。Spring提出了依赖注入的思想，即依赖类不由程序员实例化，而是通过Spring容器帮我们new指定实例并且将实例注入到需要该对象的类中，今天就来总结一下Spring对于数组、集合及Properties的注入。 （1）创建数组、集合及Properties的类 public clas...
yml配置文件简单语法及小坑
Maggie~~的博客
07-13 3810
yml配置文件使用
SpringBoot快速入门
Axin的博客
10-07 2276
参考链接 SpringBoot01：Hello,World！ SpringBoot02：运行原理初探 SpringBoot03：yaml配置注入 SpringBoot04：JSR303数据校验及多环境切换 SpringBoot05：自动配置原理 SpringBoot06：自定义starter SpringBoot07：整合JDBC SpringBoot08：整合Druid SpringBoot09：整合MyBatis SpringBoot10：Web开发静态资源处理 SpringBoot11：Thymele
SpringBoot yml配置文件注入List和Map
12-20
首先，我们需要在`application.yml`或`application.yaml`配置文件中定义List和Map。List的定义如下： ```yaml myprops: list: - 首页 - 主业务类型页面 - 人脸页面 - 子业务类型页面 - 产权证号录入页面 # ....
springboot实现yml里的自定义配置方法
08-26
"springboot实现yml里的自定义配置方法" Spring Boot框架中提供了多种方式来实现自定义配置，今天我们将主要介绍如何在yml文件中实现自定义配置，并将其与Java代码集成。在yml文件中，我们可以使用三种方式来实现...
在SpringBoot 中从application.yml中获取自定义常量方式
08-19
在SpringBoot中从application.yml中获取自定义常量方式 在SpringBoot框架中，我们经常需要在application.yml文件中配置一些自定义的常量，以便在项目中使用。在本文中，我们将详细介绍如何在SpringBoot中从...
Springboot2.0处理自定义异常并返回json
10-15
在`handleException`方法中，我们创建了一个Map对象，将错误代码（code）和错误消息（message）放入其中，并以JSON格式返回。 然后，为了确保Spring Boot能够正确地处理异常并将其包含在响应中，我们需要在`...
在SpringBoot中怎么注入各种类型（String,List,Map,Object）配置？
12-22
在SpringBoot中怎么注入各种类型（String,List,Map,Object）配置？背景String类型配置注入List类型配置注入Map类型配置注入Object类型配置注入结语 背景 在开发过程中，绝大多数场景都是要使用一些配置项的。至于配置项如何注入到应用程序中，一直没有过多的关注过。今天抽了点时间实际试了下，这里做个简单的记录，便于需要的朋友了解下。 在下面的讲述中，我们针对下面的一组配置来进行说明，分别演示读取字符串String、列表List、哈希表Map和对象Object进行说明。开发框架为Springboot。 config: str: 123456 list:
Spring MVC不能直接接收list类型参数的问题
11-05
前端使用jquery向后台传递数组类型的参数，Java后台直接通过List类型接收，会发现无法取到参数。
springboot如何读取自定义配置项
08-27
Spring Boot 如何读取自定义配置项 Spring Boot framework 提供了多种方式来读取自定义配置项，以下是其中的一些方法： 1. 使用 `@ConfigurationProperties` 注解 在 Spring Boot 项目中，我们可以使用 `@...
spring boot装载自定义yml文件
08-30
在Spring Boot 1.5及更高版本中，`@ConfigurationProperties`注解不再接受`location`参数，这意味着不能直接通过该注解指定YAML配置文件的位置。然而，我们可以通过其他方式实现这个功能。 以下是一个示例，展示了...
SpringBoot从yml配置文件中读常用参数值实例方法
08-25
SpringBoot从yml配置文件中读常用参数值实例方法 SpringBoot是一款流行的Java框架，提供了许多便捷的配置方式，其中之一便是使用yml配置文件来存储项目中的配置信息。yml文件中的配置信息可以通过SpringBoot的@...
SpringBoot yml配置文件为变量赋值
pengweismile的专栏
07-14 7699
1. 创建person类和Car类，并在person类上加注释@ConfigurationProperties(prefix = "person")，表明这个类的成员变量的值从配置类注入。注意这里的person类的成员变量需要有get/set方法。 import org.springframework.boot.context.properties.ConfigurationProp...
springBoot自动装配集合(Map、List)以及动态刷新环境配置
燕少江湖
10-13 7861
springboot2.0从apollo读取配置 针对一些需要经常更新的配置，有多种方案： 1、将配置记录在数据库，启动项目的时候读取配置，然后缓存在集合中，这种方案很头疼的地方，每次更新配置之后，需要重新启动项目或者预留接口刷新缓存； 2、将配置记录在数据库，然后缓存在redis（注意缓存过期时间以及更新配置之后刷新缓存）； 3、将配置记录在配置中心或者注册中心，比如：Apollo、zo......
springboot读取XXX.properties自定义配置文件中的map和list类型配置参数
peter_ou的博客
05-21 1万+
springboot读取XXX.properties自定义配置文件中的map和list1. maven的pom.xml文件中添加如下依赖2. 配置文件 XXX.properties添加如下参数3.写一个DataConfig类，用来读取配置信息测试类测试如何改变文本的样式插入链接与图片如何插入一段漂亮的代码片生成一个适合你的列表创建一个表格设定内容居中、居左、居右SmartyPants创建一个自定义...
springboot yml自定义属性
10-10
在Spring Boot中，我们可以使用application.yml文件来配置项目的属性。如果需要自定义属性，可以使用如下方式： 1. 在application.yml文件中添加自定义属性的键值对，例如： ``` my: custom: property: value ``` 2. 在代码中使用@Value注解或者@ConfigurationProperties注解来注入该属性，例如： ``` @Value("${my.custom.property}") private String myCustomProperty; // 或者 @ConfigurationProperties(prefix = "my.custom") public class MyCustomProperties { private String property; public String getProperty() { return property; } public void setProperty(String property) { this.property = property; } } ```

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值