[Java] 使用springboot在工具类中读取配置文件(ClassPathResource)

2021-11-17 | 956 人阅读

这篇文章主要介绍了使用springboot在工具类中读取配置文件(ClassPathResource),具有很好的参考价值,希望对大家有所帮助。如有错误或未考虑完全的地方,望不吝赐教
springboot工具类中读取配置文件
1、创建配置文件(application.properties)
  1. spring.activemq.broker-url=tcp://localhost:61616
  2. spring.activemq.user=admin
  3. spring.activemq.password=admin
  4. spring.activemq.in-memory=true
  5. spring.activemq.pool.enabled=false
复制代码
2、创建工具类(PropertiesUtil.java)
  1. package com.jeff.utils;
  2. import java.io.IOException;
  3. import java.util.Properties;
  4. import org.springframework.core.io.ClassPathResource;
  5. import org.springframework.core.io.support.PropertiesLoaderUtils;
  6. public class PropertiesUtil {
  7.     private static String user;
  8.     static {
  9.         System.out.println("application.properties属性文件读取开始");
  10.         ClassPathResource resource = new ClassPathResource("application.properties");
  11.         try {
  12.             Properties properties = PropertiesLoaderUtils.loadProperties(resource);
  13.             user = properties.getProperty("spring.activemq.user");
  14.             System.out.println("user的值:" + user);
  15.         } catch (IOException e) {
  16.             System.out.println("application.properties属性文件读取异常" + e);
  17.         }
  18.         System.out.println("application.properties属性文件读取完成");
  19.     }
  20.     public static String getUser() {
  21.         System.out.println("获取user的值:" + user);
  22.         return user;
  23.     }
  24. }
复制代码
3、创建测试类(MyController.java)
  1. package com.jeff.controller;
  2. import org.springframework.web.bind.annotation.RequestMapping;
  3. import org.springframework.web.bind.annotation.RestController;
  4. import com.jeff.utils.PropertiesUtil;
  5. @RestController
  6. public class MyController {
  7.     @RequestMapping("myTest")
  8.     public String myTest() {
  9.         PropertiesUtil.getUser();
  10.         return "success";
  11.     }
  12. }
复制代码
4、打开浏览器访问 http://localhost:8080/myTest,控制台输出结果
DSC0000.png

DSC0001.png

springboot读取配置文件到静态工具类
通常我们读取配置文件可以用@Value注解和@Configuration,@ConfigurationProperties(prefix = "xxx")等注解,但是这种方式是无法把配置读取到静态变量的,如果我们想在项目初始化时把配置文件加载到一个工具类,然后通过静态变量的方式调用的话我们就不能使用这两种方法。
这时候,我们可以用Environment 来解决
不废话了,直接上代码
  1. import javax.annotation.PostConstruct;
  2. import org.springframework.beans.factory.annotation.Autowired;
  3. import org.springframework.core.env.Environment;
  4. import org.springframework.stereotype.Component;
  5. /**
  6. *
  7. * @Description: 配置常量类——根据不同的spring-profile加载不同的配置
  8. * @author: eric.zhang
  9. * @date: 2018年7月20日 上午10:59:24
  10. */
  11. @Component
  12. public class ConfigConstant {
  13.   @Autowired
  14.   private Environment env;
  15.   
  16.   public static String url;
  17.   public static String param;
  18.   
  19.   @PostConstruct
  20.   public void readConfig() {
  21.     url = env.getProperty("config.url");
  22.     param = env.getProperty("config.param");
  23.   }
  24. }
复制代码
我写完以后发现有些麻烦,下面是改进的方法,不需要每个配置都去get一下,只需要把配置文件的key与工具类的静态变量名写成一样的即可。
  1. import java.io.UnsupportedEncodingException;
  2. import java.lang.reflect.Field;
  3. import javax.annotation.PostConstruct;
  4. import org.springframework.beans.factory.annotation.Autowired;
  5. import org.springframework.core.env.Environment;
  6. import org.springframework.stereotype.Component;
  7. /**
  8. *
  9. * @Description: 配置常量类——根据不同的spring-profile加载不同的配置,变量名要与配置文件里写的名一致
  10. * @author: eric.zhang
  11. * @date: 2018年7月20日 上午10:59:24
  12. */
  13. @Component
  14. public class ConfigConstant {
  15.   @Autowired
  16.   private Environment env;
  17.   
  18.   public static String url;
  19.   public static String name;
  20.   
  21.   
  22.   @PostConstruct
  23.   public void readConfig() throws Exception {
  24.     String prefix = "config.";
  25.     Field[] fields = ConfigConstant.class.getFields();
  26.     for(Field field : fields ){
  27.       field.set(null, getProperty(prefix + field.getName()));
  28.     }
  29.   }
  30.   
  31.   private String getProperty(String key) throws UnsupportedEncodingException {
  32.     return new String(env.getProperty(key).getBytes("ISO-8859-1"), "UTF-8");
  33.   }
  34. }
复制代码
大哥说这样写依赖spring, 单测调代码的时候不方便,所以又写了一个不依赖spring的版本。
  1. import java.io.InputStreamReader;
  2. import java.lang.reflect.Field;
  3. import java.util.Properties;
  4. /**
  5. *
  6. * @Description: 配置常量类——根据不同的spring-profile加载不同的配置
  7. *               变量名把配置文件的key中的"."替换成"_"命名
  8. * @author: eric.zhang
  9. * @date: 2018年7月20日 上午10:59:24
  10. */
  11. public class ConfigConstant {
  12.   public static String CONFIG_URL;
  13.   public static String CONFIG_NAME;
  14.   static {
  15.     try {
  16.       Properties props = new Properties();
  17.       props.load(new InputStreamReader(
  18.           ConfigConstant.class.getClassLoader().getResourceAsStream("application.properties"),
  19.           "UTF-8"));
  20.       String profile = props.getProperty("spring.profiles.active");
  21.       String envFile = "application-" + profile + ".properties";
  22.       Properties envProps = new Properties();
  23.       envProps.load(new InputStreamReader(
  24.           ConfigConstant.class.getClassLoader().getResourceAsStream(envFile), "UTF-8"));
  25.       Field[] fields = ConfigConstant.class.getFields();
  26.       for (Field field : fields) {
  27.         field.set(null, envProps.getProperty(field.getName().replace("_", ".").toLowerCase()));
  28.       }
  29.     } catch (Exception e) {
  30.       e.printStackTrace();
  31.     }
  32.   }
  33. }
复制代码
以上为个人经验,希望能给大家一个参考,也希望大家多多支持OPEN开发家园
原文链接:https://blog.csdn.net/weixin_45739720/article/details/103701627

[occ]文档来源:网络转载 http://www.zzvips.com/article/204373.html[/occ]
关注下面的标签,发现更多相似文章
3393 积分
3390 主题
OPNE在线字典
热门推荐