Spring boot中使用工具类无需注入获取.yml中的值

最新推荐文章于 2024-08-28 09:20:15 发布

转载最新推荐文章于 2024-08-28 09:20:15 发布 · 352 阅读

0 ·

CC 4.0 BY-SA版权

原文链接：https://my.oschina.net/xiaowangqiongyou/blog/1636004

文章标签：

#java

本文介绍如何在Spring Boot项目中使用YML文件进行配置，并通过自定义类实现配置项的读取。文中详细展示了如何定义配置文件、创建映射对象以及利用工具类获取配置信息。

2019独角兽企业重金招聘Python工程师标准>>>

项目中经常需要将路径URL等信息单独提出写到配置文件中，之前使用Spring时一般都是用 .properties文件来存这些公共信息，那么如何在spring boot中优雅的使用.yml文件存取呢、、

首先定义存放公共信息的 .yml 配置文件定义为 application-config.yml 文件如下:

prairieManage:
   mapProps:
    key1: value1
    key2: value2

然后在住配置文件引用新定义的文件：如下：

server:
  port: 8080
  tomcat:
    uri-encoding: UTF-8
spring:
  profiles:
    active: local,config

这里注意：active这个属性支持引入多个配置文件以逗号分隔.具体请查看源码 active是以list接收的:

再顶一个对象用于映射该配置文件的值如下:

@Component
@ConfigurationProperties(prefix = "prairieManage")
@Data
@Getter
@Setter
@EqualsAndHashCode
@ToString
@NoArgsConstructor
public class YmlConfig {
    private Map<String,String> mapProps = new HashMap<>();
}

注意该类中变量要与配置文件的一致如配置文件我们定义了一个以键值类型的 mapProns 那么实体对象中属性名也需要是该名.该对象中一定要有@Component

以及 Getter Setter 由于我们使用的 Lombok 所以这里以注解代替 Getter Setter。

最后我们定义一个 Util 用于获取该map中的值：

public class YmlConfigUtil implements ApplicationContextAware {
    private static ApplicationContext applicationContext = null;

    private static  Map<String,String> propertiesMap =null;

    public YmlConfigUtil() {
    }

    public static String getConfigByKey(String key) throws JsonProcessingException {
        if (propertiesMap ==null){
            YmlConfig ymlConfig = applicationContext.getBean(YmlConfig.class);
            propertiesMap = ymlConfig.getMapProps();
        }
        return propertiesMap.get(key);
    }

    @Override
    public void setApplicationContext(ApplicationContext applicationContext) throws BeansException {
        if(YmlConfigUtil.applicationContext == null){
            YmlConfigUtil.applicationContext  = applicationContext;
        }
    }
}

这里注意该util需要在启动类注入进来：