关于properties文件的读取(Java/spring/springmvc/springboot)
一.Java读取properties文件
1、基于ClassLoder读取配置文件
注意:该方式只能读取类路径下的配置文件,有局限但是如果配置文件在类路径下比较方便。
1 Properties properties = new Properties(); 2 // 使用ClassLoader加载properties配置文件生成对应的输入流 3 InputStream in = PropertiesMain.class.getClassLoader().getResourceAsStream("config/config.properties"); 4 // 使用properties对象加载输入流 5 properties.load(in); 6 //获取key对应的value值 7 properties.getProperty(String key);
2、基于 InputStream 读取配置文件
注意:该方式的优点在于可以读取任意路径下的配置文件
1 Properties properties = new Properties(); 2 3 // 使用InPutStream流读取properties文件 4 5 BufferedReader bufferedReader = new BufferedReader(new FileReader("E:/config.properties")); 6 7 properties.load(bufferedReader); 8 9 // 获取key对应的value值properties.getProperty(String key);
3、通过 java.util.ResourceBundle 类来读取,这种方式比使用 Properties 要方便一些
1>通过 ResourceBundle.getBundle() 静态方法来获取(ResourceBundle是一个抽象类),这种方式来获取properties属性文件不需要加.properties后缀名,只需要文件名即可
1 properties.getProperty(String key); 2 //config为属性文件名,放在包com.test.config下,如果是放在src下,直接用config即可 3 ResourceBundle resource = ResourceBundle.getBundle("com/test/config/config"); 4 String key = resource.getString("keyWord");
2>从 InputStream 中读取,获取 InputStream 的方法和上面一样,不再赘述
1 ResourceBundle resource = new PropertyResourceBundle(inStream);
注意:在使用中遇到的最大的问题可能是配置文件的路径问题,如果配置文件入在当前类所在的包下,那么需要使用包名限定,如:config.properties入在com.test.config包下,则要使用com/test/config/config.properties(通过Properties来获取)或com/test/config/config(通过ResourceBundle来获取);属性文件在src根目录下,则直接使用config.properties或config即可。
以下是几种方式的代码参考:
![](https://images.cnblogs.com/OutliningIndicators/ContractedBlock.gif)
1 package com.test.properties; 2 3 import java.io.BufferedInputStream; 4 import java.io.File; 5 import java.io.FileInputStream; 6 import java.io.IOException; 7 import java.io.InputStream; 8 import java.util.Enumeration; 9 import java.util.Properties; 10 11 import org.springframework.core.io.support.PropertiesLoaderUtils; 12 13 /** 14 * 15 * @ClassName: TestProperties 16 * @Description: 获取配置文件信息 17 * @date: 2017年11月25日 上午10:56:00 18 * @version: 1.0.0 19 */ 20 public class TestProperties { 21 22 23 /** 24 * 25 * @Title: printAllProperty 26 * @Description: 输出所有配置信息 27 * @param props 28 * @return void 29 * @throws 30 */ 31 private static void printAllProperty(Properties props) 32 { 33 @SuppressWarnings("rawtypes") 34 Enumeration en = props.propertyNames(); 35 while (en.hasMoreElements()) 36 { 37 String key = (String) en.nextElement(); 38 String value = props.getProperty(key); 39 System.out.println(key + " : " + value); 40 } 41 } 42 43 /** 44 * 根据key读取value 45 * 46 * @Title: getProperties_1 47 * @Description: 第一种方式:根据文件名使用spring中的工具类进行解析 48 * filePath是相对路劲,文件需在classpath目录下 49 * 比如:config.properties在包com.test.config下, 50 * 路径就是com/test/config/config.properties 51 * 52 * @param filePath 53 * @param keyWord 54 * @return 55 * @return String 56 * @throws 57 */ 58 public static String getProperties_1(String filePath, String keyWord){ 59 Properties prop = null; 60 String value = null; 61 try { 62 // 通过Spring中的PropertiesLoaderUtils工具类进行获取 63 prop = PropertiesLoaderUtils.loadAllProperties(filePath); 64 // 根据关键字查询相应的值 65 value = prop.getProperty(keyWord); 66 } catch (IOException e) { 67 e.printStackTrace(); 68 } 69 return value; 70 } 71 72 /** 73 * 读取配置文件所有信息 74 * 75 * @Title: getProperties_1 76 * @Description: 第一种方式:根据文件名使用Spring中的工具类进行解析 77 * filePath是相对路劲,文件需在classpath目录下 78 * 比如:config.properties在包com.test.config下, 79 * 路径就是com/test/config/config.properties 80 * 81 * @param filePath 82 * @return void 83 * @throws 84 */ 85 public static void getProperties_1(String filePath){ 86 Properties prop = null; 87 try { 88 // 通过Spring中的PropertiesLoaderUtils工具类进行获取 89 prop = PropertiesLoaderUtils.loadAllProperties(filePath); 90 printAllProperty(prop); 91 } catch (IOException e) { 92 e.printStackTrace(); 93 } 94 } 95 96 /** 97 * 根据key读取value 98 * 99 * @Title: getProperties_2 100 * @Description: 第二种方式:使用缓冲输入流读取配置文件,然后将其加载,再按需操作 101 * 绝对路径或相对路径, 如果是相对路径,则从当前项目下的目录开始计算, 102 * 如:当前项目路径/config/config.properties, 103 * 相对路径就是config/config.properties 104 * 105 * @param filePath 106 * @param keyWord 107 * @return 108 * @return String 109 * @throws 110 */ 111 public static String getProperties_2(String filePath, String keyWord){ 112 Properties prop = new Properties(); 113 String value = null; 114 try { 115 // 通过输入缓冲流进行读取配置文件 116 InputStream InputStream = new BufferedInputStream(new FileInputStream(new File(filePath))); 117 // 加载输入流 118 prop.load(InputStream); 119 // 根据关键字获取value值 120 value = prop.getProperty(keyWord); 121 } catch (Exception e) { 122 e.printStackTrace(); 123 } 124 return value; 125 } 126 127 /** 128 * 读取配置文件所有信息 129 * 130 * @Title: getProperties_2 131 * @Description: 第二种方式:使用缓冲输入流读取配置文件,然后将其加载,再按需操作 132 * 绝对路径或相对路径, 如果是相对路径,则从当前项目下的目录开始计算, 133 * 如:当前项目路径/config/config.properties, 134 * 相对路径就是config/config.properties 135 * 136 * @param filePath 137 * @return void 138 * @throws 139 */ 140 public static void getProperties_2(String filePath){ 141 Properties prop = new Properties(); 142 try { 143 // 通过输入缓冲流进行读取配置文件 144 InputStream InputStream = new BufferedInputStream(new FileInputStream(new File(filePath))); 145 // 加载输入流 146 prop.load(InputStream); 147 printAllProperty(prop); 148 } catch (Exception e) { 149 e.printStackTrace(); 150 } 151 } 152 153 /** 154 * 根据key读取value 155 * 156 * @Title: getProperties_3 157 * @Description: 第三种方式: 158 * 相对路径, properties文件需在classpath目录下, 159 * 比如:config.properties在包com.test.config下, 160 * 路径就是/com/test/config/config.properties 161 * @param filePath 162 * @param keyWord 163 * @return 164 * @return String 165 * @throws 166 */ 167 public static String getProperties_3(String filePath, String keyWord){ 168 Properties prop = new Properties(); 169 String value = null; 170 try { 171 InputStream inputStream = TestProperties.class.getResourceAsStream(filePath); 172 prop.load(inputStream); 173 value = prop.getProperty(keyWord); 174 } catch (IOException e) { 175 e.printStackTrace(); 176 } 177 return value; 178 } 179 180 /** 181 * 读取配置文件所有信息 182 * 183 * @Title: getProperties_3 184 * @Description: 第三种方式: 185 * 相对路径, properties文件需在classpath目录下, 186 * 比如:config.properties在包com.test.config下, 187 * 路径就是/com/test/config/config.properties 188 * @param filePath 189 * @return 190 * @throws 191 */ 192 public static void getProperties_3(String filePath){ 193 Properties prop = new Properties(); 194 try { 195 InputStream inputStream = TestProperties.class.getResourceAsStream(filePath); 196 prop.load(inputStream); 197 printAllProperty(prop); 198 } catch (IOException e) { 199 e.printStackTrace(); 200 } 201 } 202 203 204 public static void main(String[] args) { 205 // 注意路径问题 206 String properties_1 = getProperties_1("com/test/config/config.properties", "wechat_appid"); 207 System.out.println("wechat_appid = " + properties_1); 208 getProperties_1("com/test/config/config.properties"); 209 System.out.println("*********************************************"); 210 // 注意路径问题 211 String properties_2 = getProperties_2("configure/configure.properties", "jdbc.url"); 212 System.out.println("jdbc.url = " + properties_2); 213 getProperties_2("configure/configure.properties"); 214 System.out.println("*********************************************"); 215 // 注意路径问题 216 String properties_3 = getProperties_3("/com/test/config/config.properties", "wechat_appid"); 217 System.out.println("wechat_appid = " + properties_3); 218 getProperties_3("/com/test/config/config.properties"); 219 } 220 }
参考链接:https://www.cnblogs.com/sebastian-tyd/p/7895182.html
二.SpringMVC读取properties文件
<bean id="propertyPlaceHolderConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
<property name="systemPropertiesModeName" value="SYSTEM_PROPERTIES_MODE_OVERRIDE" />
<property name="ignoreResourceNotFound" value="true" />
<property name="locations">
<list>
<!-- 把需要配置的properties文件配置在这里,可以有多个 -->
<value>classpath:config.properties</value>
</list>
</property>
</bean>
2、config.properties文件
## 这里配置自己的值 config.attr1=123456 config.attr2=adjfl12313
3、java代码,使用@value注解
// config.attr1是properties文件配置的键值 @Value("${config.attr1}") private String attr1; @Value("${config.attr2}") private String attr2;
三.spring读取properties文件
1.通过PropertyPlaceholderConfigurer来加载
<?xml version="1.0" encoding="UTF-8"?> <!DOCTYPE beans PUBLIC "-//SPRING//DTD BEAN//EN" "http://www.springframework.org/dtd/spring-beans.dtd"> <beans> <bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"> <property name="location"> <value>src/jdbc.properties</value> </property> </bean> <bean id="datasource" class="org.springframework.jdbc.datasource.DriverManagerDataSource"> <property name="driverClassName"> <value>${driverClassName}</value> </property> <property name="url"> <value>${url}</value> </property> <property name="username"> <value>${username}</value> </property> <property name="password"> <value>${password}</value> </property> </bean> <bean id="dao" class="com.zh.model.DataDAO"> <property name="datasource"> <ref local="datasource"/> </property> </bean> </beans>
2.通过 context:property-placeholder 标签实现配置文件加载
(1)、在spring.xml配置文件中添加标签
<context:property-placeholder ignore-unresolvable="true" location="classpath:redis-key.properties"/>
(2)、在 spring.xml 中使用 配置文件属性:$
<!-- 基本属性 url、user、password --> <property name="url" value="${jdbc.url}" /> <property name="username" value="${jdbc.username}" /> <property name="password" value="${jdbc.password}" /
(3)、在java文件中使用:
@Value("${jdbc.url}") private String jdbcUrl; // 注意:这里变量不能定义成static
*注意点:踩过的坑
在Spring中的xml中使用<context:property-placeholderlocation>标签导入配置文件时,想要导入多个properties配置文件,如下:
<context:property-placeholderlocation="classpath:db.properties " />
<context:property-placeholderlocation="classpath:zxg.properties " />
结果发现不行,第二个配置文件始终读取不到,Spring容器是采用反射扫描的发现机制,通过标签的命名空间实例化实例,当Spring探测到容器中有一个org.springframework.beans.factory.config.PropertyPlaceholderConfigurer的Bean就会停止对剩余PropertyPlaceholderConfigurer的扫描,即只能存在一个实例
如果有多个配置文件可以使用 “,” 分隔
<context:property-placeholderlocation="classpath:db.properties,classpath:monitor.properties" />
可以使用通配符 *
<context:property-placeholderlocation="classpath:*.properties" />
属性用法
ignore-resource-not-found //如果属性文件找不到,是否忽略,默认false,即不忽略,找不到文件并不会抛出异常。 ignore-unresolvable //是否忽略解析不到的属性,如果不忽略,找不到将抛出异常。但它设置为true的主要原因是:
3.通过 util:properties 标签实现配置文件加载
(1)、用法示例: 在spring.xml配置文件中添加标签
<?xml version="1.0" encoding="UTF-8"?>
xmlns:util="http://www.springframework.org/schema/util"
xsi:schemaLocation="
http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util.xsd">
<!-- 加载配置文件 -->
<util:properties id="jdbc" local-override="true" location="classpath:properties/jdbc.properties"/>
(2)、在spring.xml 中使用配置文件属性:#
<!-- dataSource --> <bean id="dataSource" class="com.mchange.v2.c3p0.ComboPooledDataSource"> <property name="driverClass" value="#{jdbc.driverClass}" /> <property name="jdbcUrl" value="#{jdbc.jdbcUrl}" /> <property name="user" value="#{jdbc.user}" /> <property name="password" value="#{jdbc.password}" /> </bean>
(3)、java文件,让Spring注入从资源文件中读取到的属性的值,,为了简便,把几种注入的方式直接写入到一个文件中进行展示:
@Component public class SysConf { @Value("#{jdbc.url}") private String url;
@Value("#{jdbc}") public void setJdbcConf(Properties jdbc){ url= sys.getProperty("url"); } }
注意:这里的#{jdbc} 是与第1步的id="jdbc" 相对应的
4、通过 @PropertySource 注解实现配置文件加载
使用和 context:property-placeholder 差不多
(1)、用法示例:在java类文件中使用 PropertySource 注解
@PropertySource(value={"classpath:mail.properties"}) public class ReadProperties { @Value(value="${mail.username}") private String USER_NAME; }
四、springboot读取properties文件
1.默认读取application.properties文件
@Value("${demo.name}")
private String name;
@Value("${demo.age}")
private String age;
或者
需要一个spring-boot启动类
@SpringBootApplication
@EnableConfigurationProperties({PropsConfig.class,YmlConfig.class})
public class ReadApplication {
public static void main(String[] args) {
SpringApplication.run(ReadApplication.class, args);
}
}
没错,@EnableConfigurationProperties注解里指出的PropsConfig.class,YmlConfig.class分别就是读取props和yml配置文件的类。接下来,我们分别进行读取properties和yml配置文件的具体实现。
在类路径下放置一个application.properties文件。
读取props配置的类,很简单,基本就是一个pojo/vo类,在类上加载@ConfigurationProperties注解即可。
@ConfigurationProperties(prefix = "master.ds",locations = "classpath:application.properties")
2.通过PropertiesLoaderUtils
ClassPathResource resource = new ClassPathResource(APPLICATION_PROPERTIES);
Properties properties = PropertiesLoaderUtils.loadProperties(resource);
String property = properties.getProperty(SPRING_BOOT_HELLO, UNDEFINED);
System.out.println("4. 通过PropertiesLoaderUtils获取: " + property);
3.@ConfigurationProperties和@PropertySource
作用在类上用于注入Bean属性,
然后再通过当前Bean获取注入值:
@SpringBootApplication public class AttributeApplication { private static final String APPLICATION_YML = "application.yml"; private static final String SPRING_BOOT_PREFIX = "spring-boot"; @Data @Component @PropertySource("classpath:" + APPLICATION_YML) @ConfigurationProperties(prefix = SPRING_BOOT_PREFIX) class Attribute { private String hello; private String world; }
1.8版本及以上,若引入多个properties文件:
@Configuration
@PropertySource("classpath:1.properties")
@PropertySource("classpath:2.properties")
@PropertySource("...")
public class XConfiguration{}
1.8版本以下,若引入多个properties文件:
@Configuration
@PropertySources({
@PropertySource("classpath:1.properties")
@PropertySource("classpath:2.properties")
})
public class XConfiguration{}