關於springBoot yml文件的list讀取問題總結(親測)

Posted on by

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的輸出結果：

在這裡插入圖片描述

以上為個人經驗，希望能給大傢一個參考，也希望大傢多多支持WalkonNet。

推薦閱讀：