Java SpringBoot 加载 yml 配置文件中字典项

科技资讯 投稿 13200 0 评论

Java SpringBoot 加载 yml 配置文件中字典项

Spring Boot 中 yml 配置、引用其它 yml 中的配置。# 在配置文件目录(如:resources)下新建application-xxx

项目结构文件

server:
  port: 8088
  application:
    name: VipSoft Env Demo


spring:
  profiles:
    include:
      dic      # 在配置文件目录(如:resources)下新建application-xxx 开头的yml文件,多个文件用 "," 号分隔,不能换行

#性别字典
user-gender:
  0: 未知
  1: 男
  2: 女

application-dic.yml
将字典独立到单独的yml文件中

#支付方式
pay-type:
  1: 微信支付
  2: 货到付款

resources 目录下,创建META-INF目录,创建 spring.factories文件,
Spring Factories是一种类似于Java SPI的机制,它在META-INF/spring.factories文件中配置接口的实现类名称,然后在程序中读取这些配置文件并实例化。
内容如下:

# Environment Post Processor
org.springframework.boot.env.EnvironmentPostProcessor=com.vipsoft.web.utils.ConfigUtil

ConfigUtil

package com.vipsoft.web.utils;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.context.properties.bind.BindResult;
import org.springframework.boot.context.properties.bind.Binder;
import org.springframework.boot.env.EnvironmentPostProcessor;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.PropertySource;
import org.springframework.util.Assert;

public class ConfigUtil implements EnvironmentPostProcessor {

    private static Binder binder;

    private static ConfigurableEnvironment environment;

    public static String getString(String key {
        Assert.notNull(environment, "environment 还未初始化!";
        return environment.getProperty(key, String.class, "";
    }

    public static <T> T bindProperties(String prefix, Class<T> clazz {
        Assert.notNull(prefix, "prefix 不能为空";
        Assert.notNull(clazz, "class 不能为空";
        BindResult<T> result = ConfigUtil.binder.bind(prefix, clazz;
        return result.isBound( ? result.get( : null;
    }

    /**
    * 通过 META-INF/spring.factories,触发该方法的执行,进行环境变量的加载
    */
    @Override
    public void postProcessEnvironment(ConfigurableEnvironment environment, SpringApplication application {
        for (PropertySource<?> propertySource : environment.getPropertySources( {
            if (propertySource.getName(.equals("refreshArgs" {
                return;
            }
        }
        ConfigUtil.environment = environment;
        ConfigUtil.binder = Binder.get(environment;
    }
}

DictVo

package com.vipsoft.web.vo;


public class DictVO implements java.io.Serializable {
    private static final long serialVersionUID = 379963436836338904L;
    /**
     * 字典类型
     */
    private String type;
    /**
     * 字典编码
     */
    private String code;
    /**
     * 字典值
     */
    private String value;

    public DictVO(String code, String value {
        this.code = code;
        this.value = value;
    }

    public String getType( {
        return type;
    }

    public void setType(String type {
        this.type = type;
    }

    public String getCode( {
        return code;
    }

    public void setCode(String code {
        this.code = code;
    }

    public String getValue( {
        return value;
    }

    public void setValue(String value {
        this.value = value;
    }
}

DefaultController

package com.vipsoft.web.controller;

import com.vipsoft.web.utils.ConfigUtil;
import com.vipsoft.web.vo.DictVO;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RestController;

import java.util.ArrayList;
import java.util.LinkedHashMap;
import java.util.List;


@RestController
public class DefaultController {
    @GetMapping(value = "/"
    public String login( {
        return "VipSoft Demo !!!";
    }

    @GetMapping("/list/{type}"
    public List<DictVO> listDic(@PathVariable("type" String type {
        LinkedHashMap dict = ConfigUtil.bindProperties(type.replaceAll("_", "-", LinkedHashMap.class;
        List<DictVO> list = new ArrayList<>(;
        if (dict == null || dict.isEmpty( {
            return list;
        }
        dict.forEach((key, value -> list.add(new DictVO(key.toString(, value.toString(;
        return list;
    }
}

运行效果

编程笔记 » Java SpringBoot 加载 yml 配置文件中字典项

赞同 (70) or 分享 (0)
游客 发表我的评论   换个身份
取消评论

表情
(0)个小伙伴在吐槽