SpringBoot读取yml配置文件一组对象数据初始化

news2025/1/23 19:45:33

- - 1. yml的短横杠语法
  - 2. yml数组元素读取并初始化
  - 3. 测试结果

1. yml的短横杠语法

- 短横杠加空格，可以表示数组元素，如下配置

表示有名为apps的一组数据，数组的元素对象包含有corpId、corpSecret、appCode三个字段
像server.port没有 - 表示的就是键值，也就是可以通过@Value(“${server.port}”)来获取到键值
但有 - 的数组元素，是无法通过@Value获取的

server:
  port: 8091

wechatwork:
  apps:
    - corpId: corpId111
      corpSecret: corpSecret111
      appCode: appCode111
    - corpId: corpId222
      corpSecret: corpSecret222
      appCode: appCode222

2. yml数组元素读取并初始化

对接过企业微信的，应该有了解；像上述corpId、corpSecret就是用来获取应用accessToken的
不同的应用有不同的密钥信息，有时候我们需要指定应用去推送应用消息，就需要获取对应应用的密钥配置
场景需求就是根据定义的应用编码来获取密钥信息，一般可以这么设计
把应用密钥信息存在一张密钥字典表，每次获取的时候根据编码去查询（当然可以缓存）
还有就是像本栗子这样，在yml文件进行配置，在项目启动的时候进行读取和初始化成本地缓存Map

package com.example.config;

import java.util.List;
import java.util.Map;
import java.util.concurrent.ConcurrentHashMap;

import javax.annotation.PostConstruct;

import org.apache.commons.collections4.CollectionUtils;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

import com.example.common.model.dto.WeChatCorpInfoDTO;

import lombok.Data;
import lombok.extern.slf4j.Slf4j;

@Data
@Slf4j
@Component
@ConfigurationProperties("wechatwork")
public class WeChatWorkCorpProperties {

    private List<AppNotify> apps;

    private Map<String, WeChatCorpInfoDTO> map = new ConcurrentHashMap<>();

    @PostConstruct
    public void initWeChatWorkMap() {
        if (CollectionUtils.isNotEmpty(apps)) {
            for (AppNotify appNotify : apps) {
                WeChatCorpInfoDTO corpInfoDTO = new WeChatCorpInfoDTO(appNotify.getAppCode(), appNotify.getCorpId(), appNotify.getCorpSecret());
                map.putIfAbsent(corpInfoDTO.getAppCode(), corpInfoDTO);
            }
        }
    }

    @Data
    public static class AppNotify {

        /**
         * 应用编码（自定义的）
         */
        private String appCode;

        /**
         * 应用id
         */
        private String corpId;
        /**
         * 应用密钥
         */
        private String corpSecret;

    }
}

使用@ConfigurationProperties(“wechatwork”)来读取配置文件wechatwork层级信息
数组List<AppNotify> apps;对应wechatwork.apps，注意字段名要和键一致
通过@PostConstruct执行Bean的一些初始化方法，这里就去将apps转换封装为map

3. 测试结果

@Slf4j
@RunWith(SpringJUnit4ClassRunner.class)
@SpringBootTest(classes = {MybatisExampleApplication.class})
public class BootTest {

    @Resource
    private WeChatWorkCorpProperties weChatWorkCorpProperties;

    @Test
    public void testWeChatWorkCorpProperties() {
        log.info("weChatWorkCorpProperties map：{}", JSON.toJSONString(weChatWorkCorpProperties.getMap()));
        log.info("weChatWorkCorpProperties key：{}", JSON.toJSONString(weChatWorkCorpProperties.getMap().get("appCode111")));
    }
}