springboot读取自定义配置文件实现过程
作者:grootblockchain
本文介绍Spring Boot中配置文件读取方法,包括使用@Value注解读取application.properties和自定义properties文件,以及通过ResourceBundle编写工具类ResourceUtil实现配置获取
前提
Application.java启动类要添加注解支持,如果使用的注解是
@SpringBootApplication
那没问题,如果不是的话,还需要添加如下注解来开启配置文件读取支持
@EnableAutoConfiguration //自动加载配置信息
实现方法
1、如果是读取application.properties文件中的值可以直接用@Value("${属性名}")来读取。
2、如果是想读取自定义的properties配置文件,直接在想要读取配置文件的类上加注解如:
@PropertySource(value="classpath:config.properties")
即可以直接使用@Value来读取
@Value("${netty.tcp.server.host}")
String HOST;如:
package com.gili.CPMasterController.netty.tcp.server;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.context.annotation.PropertySource;
import org.springframework.stereotype.Component;
/**
* description:
* author:groot
* date: 2019-4-10 12:07
**/
@Component
@PropertySource(value="classpath:config.properties")
public class NettyTcpServer {
@Value("${netty.tcp.server.port}")
private Integer port;
}config.properties文件
# 作为客户端请求的服务端地址 netty.tcp.server.host=127.0.0.1 # 作为客户端请求的服务端端口 netty.tcp.server.port=7000 # 作为服务端开放给客户端的端口 netty.tcp.client.port=7000
3、通过ResourceBundle的方式来获取,可以编写工具类。
- ①、编写工具类ResourceUtil
package com.platform.utils;
import java.io.UnsupportedEncodingException;
import java.util.ResourceBundle;
/**
* 名称:ResourceUtil <br>
* 描述:参数工具类<br>
*
* @author groot
* @version 1.0
* @since 1.0.0
*/
public class ResourceUtil {
private static ResourceUtil RESOURCE_UTIL = null;
private static ResourceBundle BUNDLE = java.util.ResourceBundle.getBundle("config");//以config.properties为例
private ResourceUtil() {
}
/**
* 工厂实现配置文件读取
*
* @param properties 参数
* @return ResourceUtil 工具类
*/
public static ResourceUtil getInstance(String properties) {
if (RESOURCE_UTIL == null) {
RESOURCE_UTIL = new ResourceUtil();
}
if (properties != null) {
BUNDLE = java.util.ResourceBundle.getBundle(properties);
}
return RESOURCE_UTIL;
}
/**
* 工厂实现配置文件读取
*
* @return ResourceUtil
*/
public static ResourceUtil getInstance() {
if (RESOURCE_UTIL == null) {
RESOURCE_UTIL = new ResourceUtil();
}
return RESOURCE_UTIL;
}
/**
* 主要功能:获取配置文件参数
* 注意事项:无
*
* @param name 参数名称
* @return 参数名称对应值
*/
public static String getConfigByName(String name) {
String value = "";
try {
value = new String(BUNDLE.getString(name).getBytes("iso8859-1"), "UTF-8");
} catch (UnsupportedEncodingException e) {
e.printStackTrace();
}
return value;
}
/**
* 主要功能:取得分隔符
* 注意事项:无
*
* @return 分隔符
*/
public static String getSeparator() {
return System.getProperty("file.separator");
}
}- ② 使用,例如:
String uri = ResourceUtil.getConfigByName("myproject.base_url");//配置文件中的配置项总结
以上为个人经验,希望能给大家一个参考,也希望大家多多支持脚本之家。
