关于springBoot yml文件的list读取问题总结(亲测)

springBoot yml文件的list读取问题

折腾了很久，记录下。

配置如下

# 自定义数据上报信息
xx:
  # 机组信息
    machine1s:
      -   name: XXXX
          frequency: null
          frequency-unit: null
          pressure: 0.01
          pressure-unit: Pa
          flow: 0
          flow-unit: NM3/H
          state: 停机
          runtime: 17.5
          runtime-unit: 天
      -   name: XXXX
          frequency: 42.4
          frequency-unit: HZ
          pressure: 0.39
          pressure-unit: Pa
          flow: 4730
          flow-unit: NM3/H
          state: 运行
          runtime: 12.5
          runtime-unit: 天
      -   name: XXXX
          frequency: 46.4
          frequency-unit: HZ
          pressure: 0.00
          pressure-unit: Pa
          flow: 0
          flow-unit: NM3/H
          state: 停机
          runtime: 8.2
          runtime-unit: 天
      -   name: XXXX
          frequency: 41.4
          frequency-unit: HZ
          pressure: 0.39
          pressure-unit: Pa
          flow: 9532
          flow-unit: NM3/H
          state: 运行
          runtime: 3.2
          runtime-unit: 天
      -   name: XXXX
          frequency: null
          frequency-unit: null
          pressure: 0.38
          pressure-unit: Pa
          flow: 4800
          flow-unit: NM3/H
          state: 停机
          runtime: 20.4
          runtime-unit: 天
      -   name: XXXX
          frequency: null
          frequency-unit: null
          pressure: 0.01
          pressure-unit: Pa
          flow: 0
          flow-unit: NM3/H
          state: 停机
          runtime: 7.5
          runtime-unit: 天

1.定义配置类

@ConfigurationProperties(prefix = "xx")
public class TXMachinesProperties { 
    private List<Map<String, String>> machine1s; 
    public List<Map<String, String>> getMachine1s() {
        return machine1s;
    }
 
    public void setMachine1s(List<Map<String, String>> machine1s) {
        this.machine1s = machine1s;
    } 
}

注意：

a.这里prefix写到接收对象的前一级即可；

b.这里的变量名必须要与配置的名称一致，才可自动接收。

2.定义启动的配置类

这里其实可与上面的配置类写在一起，但是一个类就是做一件事情，就做了隔离。

@Configuration
@EnableConfigurationProperties({TXMachinesProperties.class})
public class TXMachinesConfig {
}

3.使用方式

采用下面的方式即可。这里注意，由于使用这个yml的注解是属于SpringBoot的框架内进行的，因此这个属性注入只能在标有Spring的注解的类的范围内使用，不能在普通类使用。

@Autowired
    private TXWorkShopAlarmProperties txWorkShopAlarmProperties;

可以解决了~

读取yml文件里的list配置

YAML 支持以下几种数据类型

对象：键值对的集合，又称为映射（mapping）/ 哈希（hashes） / 字典（dictionary）
数组：一组按次序排列的值，又称为序列（sequence） / 列表（list）
纯量（scalars）：单个的、不可再分的值

这里只介绍list类型的读取

yml里的list配置（以 - 开头的行表示构成一个数组：）：

weixin:
  configs:
   - schId: 111
      appId: 11111
      appSecret: 11111
      templateId: 111111
    - schId: 2222
      appId: 222222
      appSecret: 2222222
      templateId: 2222222

导入jar包

        <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-configuration-processor</artifactId>
            <version>2.2.1.RELEASE</version>
        </dependency>

写一个微信配置的实体类，将配置文件中配置的每一个属性的值，映射到这个实体类中

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

@Component
@Data
@ConfigurationProperties(prefix = "weixin")
public class WxConfig {
    private List<Config> configs;
    @Data
    public static class Config {
        private Integer schId;
        private String appId;
        private String appSecret;
        private String templateId;
    }
}

拿到配置文件里的内容

1.注入该实体类

 @Autowired
    private WxConfig wxConfig;

2.解析，我这里是将其转为学校id为key的map，方便我后面使用，按照自己想要的读取就好了JSON.toJSONString(wxConfig)

    public  Map<Integer,Map> getWeiXinConfig(){
        JSONObject o = JSON.parseObject(JSON.toJSONString(wxConfig));
        JSONArray jsonArray = o.getJSONArray("configs");
        Map<Integer,Map> map = new HashMap<>();
        if (jsonArray.size() != 0) {
            for (int j = 0; j < jsonArray.size(); j++) {
                Map map2 = new HashMap();
                JSONObject o1 = jsonArray.getJSONObject(j);
                String appId = o1.getString("appId");
                String appSecret = o1.getString("appSecret");
                Integer schId = o1.getIntValue("schId");
                String templateId = o1.getString("templateId");
                map2.put("appId", appId);
                map2.put("appSecret", appSecret);
                map2.put("schId", schId);
                map2.put("templateId", templateId);
                map.put(schId,map2);
            }
        }
        return map;
    }

调用方法getWeiXinConfig(),输出map的输出结果：

在这里插入图片描述

频道导航