一、前言

在做Java项目开发过程中，涉及到一些数据库服务连接配置、缓存服务器连接配置等，通常情况下我们会将这些不太变动的配置信息存储在以 .properties 结尾的配置文件中。当对应的服务器地址或者账号密码信息有所变动时，我们只需要修改一下配置文件中的信息即可。同时为了让Java程序可以读取 .properties配置文件中的值，Java的JDK中提供了java.util.Properties类可以实现读取配置文件。

二、Properties类

Properties 类位于 java.util.Properties中，是Java 语言的处理配置文件所使用的类，其中的xxx.Properties类主要用于集中的持久存储Java的配置文件内容，可以读取后缀是.properties和.cfg的配置文件。

Properties继承了Hashtable 类，以Map 的形式进行放置值，put(key,value) 和 get(key)，文本注释信息可以用"#"来注释。

Properties 类表示了一个持久的属性集。Properties 可保存在流中或从流中加载。属性列表中每个键及其对应值都是一个字符串。

Properties 文件内容的格式是：键=值 形式，Key值不能够重复。 例如：

jdbc.driver=com.mysql.jdbc.Driver
  • Properties类的继承关系图：
  • Properties类的源码关系图：
  • 主要方法介绍：

它提供了几个核心的方法：

  • getProperty ( String key)： 用指定的键在此属性列表中搜索属性。也就是通过参数 key ，得到 key 所对应的 value。

  • load ( InputStream inStream)： 从输入流中读取属性列表（键和元素对）。通过对指定的文件（比如说上面的 test.properties 文件）进行装载来获取该文件中的所有键 - 值对。以供 getProperty ( String key) 来搜索。

  • setProperty ( String key, String value) ： 调用 Hashtable 的方法 put 。他通过调用基类的put方法来设置 键 - 值对。

  • store ( OutputStream out, String comments)： 以适合使用 load 方法加载到 Properties 表中的格式，将此 Properties 表中的属性列表（键和元素对）写入输出流。与 load 方法相反，该方法将键 - 值对写入到指定的文件中去。

  • clear ()： 清除所有装载的 键 - 值对。该方法在基类中提供。

三、Properties常用方法实践

Properties类我们从文件的写入和读取来实践其具体用法，下面演示练习将以下数据库配置信息写入到jdbc.properties文件中

jdbc.driver=com.mysql.jdbc.Driver
jdbc.url=jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf8
jdbc.username=root
jdbc.password=123456
  • 项目目录结构如下

四、Java写入Properties

Properties类调用setProperty方法将键值对保存到内存中，此时可以通过getProperty方法读取，propertyNames方法进行遍历，但是并没有将键值对持久化到属性文件中，故需要调用store方法持久化键值对到属性文件中。

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Properties;/*** @desc:  写入Mysql数据库了连接信息到jdbc.properties中* @author: cao_wencao* @date: 2020-12-29 13:41*/
public class PropertiesStoreTest {public static void main(String[] args) {Properties properties = new Properties();OutputStream output = null;try {output = new FileOutputStream("src/main/resources/jdbc.properties");properties.setProperty("jdbc.driver", "com.mysql.jdbc.Driver");properties.setProperty("jdbc.url","jdbc:mysql://localhost:3306/mybatis?characterEncoding=utf8" );properties.setProperty("jdbc.username", "root");properties.setProperty("jdbc.password", "123456");// 保存键值对到文件中properties.store(output, "Thinkingcao modify");} catch (IOException io) {io.printStackTrace();} finally {if (output != null) {try {output.close();} catch (IOException e) {e.printStackTrace();}}}}
}

输出结果，在resources目录下多一个文件jdbc.properties，内容如下：

#Thinkingcao modify
#Tue Dec 29 13:43:48 CST 2020
jdbc.url=jdbc\:mysql\://localhost\:3306/mybatis?characterEncoding\=utf8
jdbc.username=root
jdbc.driver=com.mysql.jdbc.Driver
jdbc.password=123456

五、Java读取Properties

Java读取Properties文件的方法有很多，下面介绍8种方式，分别读取resource目录下的jdbc.properties和resource/config/application.properties。

  • application.properties文件内容如下
minio.endpoint=http://localhost:9000
minio.accessKey=minioadmin
minio.secretKey=minioadmin
minio.bucketName=demo

1. 从当前的类加载器的getResourcesAsStream来获取

/*** 1. 方式一* 从当前的类加载器的getResourcesAsStream来获取* InputStream inputStream = this.getClass().getResourceAsStream(name)** @throws IOException*/@Testpublic void test1() throws IOException {InputStream inputStream = this.getClass().getResourceAsStream("jdbc.properties");Properties properties = new Properties();properties.load(inputStream);properties.list(System.out);System.out.println("==============================================");String property = properties.getProperty("jdbc.url");System.out.println("property = " + property);}

2. 从当前的类加载器的getClassLoader().getResourcesAsStream来获取

 /*** 2. 方式二* 从当前的类加载器的getResourcesAsStream来获取* InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream(name)** @throws IOException*/@Testpublic void test2() throws IOException {InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream("config/application.properties");Properties properties = new Properties();properties.load(inputStream);properties.list(System.out);System.out.println("==============================================");String property = properties.getProperty("minio.endpoint");System.out.println("property = " + property);}

3. 使用Class类的getSystemResourceAsStream静态方法 和使用当前类的ClassLoader是一样的

 /*** 3. 方式三* 使用Class类的getSystemResourceAsStream方法 和使用当前类的ClassLoader是一样的* InputStream inputStream = ClassLoader.getSystemResourceAsStream(name)** @throws IOException*/@Testpublic void test3() throws IOException {InputStream inputStream = ClassLoader.getSystemResourceAsStream("config/application.properties");Properties properties = new Properties();properties.load(inputStream);properties.list(System.out);System.out.println("==============================================");String property = properties.getProperty("minio.endpoint");System.out.println("property = " + property);}

4. 使用Spring-core包中的ClassPathResource读取

    /*** 4. 方式四* Resource resource = new ClassPathResource(path)** @throws IOException*/@Testpublic void test4() throws IOException {Resource resource = new ClassPathResource("config/application.properties");Properties properties = PropertiesLoaderUtils.loadProperties(resource);properties.list(System.out);System.out.println("==============================================");String property = properties.getProperty("minio.endpoint");System.out.println("property = " + property);}

5. 从文件中读取，new BufferedInputStream(InputStream in)

/*** 5. 方式五* 从文件中获取,使用InputStream字节,主要是需要加上当前配置文件所在的项目src目录地址。路径配置需要精确到绝对地址级别* BufferedInputStream继承自InputStream* InputStream inputStream = new BufferedInputStream(new FileInputStream(name)* 这种方法读取需要完整的路径，优点是可以读取任意路径下的文件，缺点是不太灵活* @throws IOException*/@Testpublic void test5() throws IOException {InputStream inputStream = new BufferedInputStream(new FileInputStream("src/main/resources/config/application.properties"));Properties properties = new Properties();properties.load(inputStream);properties.list(System.out);System.out.println("==============================================");String property = properties.getProperty("minio.endpoint");System.out.println("property = " + property);}

6.从文件中读取，new FileInputStream(String name)

/*** 6. 方式六* 从文件中获取,使用InputStream字节,主要是需要加上当前配置文件所在的项目src目录地址。路径配置需要精确到绝对地址级别* FileInputStream继承自InputStream* InputStream inputStream = new FileInputStream(name)* 这种方法读取需要完整的路径，优点是可以读取任意路径下的文件，缺点是不太灵活* @throws IOException*/@Testpublic void test6() throws IOException {InputStream inputStream = new FileInputStream("src/main/resources/config/application.properties");Properties properties = new Properties();properties.load(inputStream);properties.list(System.out);System.out.println("==============================================");String property = properties.getProperty("minio.endpoint");System.out.println("property = " + property);}

7. 使用PropertyResourceBundle读取InputStream流

 /*** 7. 方式七* 使用InputStream流来进行操作ResourceBundle，获取流的方式由以上几种。* ResourceBundle resourceBundle = new PropertyResourceBundle(inputStream);* @throws IOException*/@Testpublic void test7() throws IOException {InputStream inputStream = ClassLoader.getSystemResourceAsStream("config/application.properties");ResourceBundle resourceBundle = new PropertyResourceBundle(inputStream);Enumeration<String> keys = resourceBundle.getKeys();while (keys.hasMoreElements()) {String s = keys.nextElement();System.out.println(s + " = " + resourceBundle.getString(s));}}

8. 使用ResourceBundle.getBundle读取

 /*** 8. 方式八* ResourceBundle.getBundle的路径访问和 Class.getClassLoader.getResourceAsStream类似，默认从根目录下读取，也可以读取resources目录下的文件* ResourceBundle rb = ResourceBundle.getBundle("b") //不需要指定文件名的后缀,只需要写文件名前缀即可*/@Testpublic void test8(){//ResourceBundle rb = ResourceBundle.getBundle("jdbc"); //读取resources目录下的jdbc.propertiesResourceBundle rb2 = ResourceBundle.getBundle("config/application");//读取resources/config目录下的application.propertiesfor(String key : rb2.keySet()){String value = rb2.getString(key);System.out.println(key + ":" + value);}}

输出结果：

minio.endpoint:http://localhost:9000
minio.bucketName:demo
minio.secretKey:minioadmin
minio.accessKey:minioadmin

六、Properties配合Spring框架使用

  • 加载.properties方式一
<!-- 1.加载 jdbc.properties 配置文件 -->
<context:property-placeholder location="classpath:jdbc.properties" system-properties-mode="NEVER"/>

除了上面这种方式之外，还有下面这种List集合的方式

  • 加载.properties方式二
 <!-- 4.引入外部配置文件 由于后期可能会引入多个配置文件 所以采用list的形式 --><bean id="propertyPlaceholder"class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer"><property name="locations"><list><value>classpath:/config/jdbc.properties</value><value>classpath:/config/application.properties</value></list></property></bean>

七、完整代码

import org.junit.Test;
import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource;
import org.springframework.core.io.support.PropertiesLoaderUtils;
import java.io.BufferedInputStream;
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.*;/*** @desc: Properties读取配置文件属性值的方式* @author: cao_wencao* @date: 2020-12-29 10:08*/
public class PropertiesTest {/*** 1. 方式一* 从当前的类加载器的getResourcesAsStream来获取* InputStream inputStream = this.getClass().getResourceAsStream(name)** @throws IOException*/@Testpublic void test1() throws IOException {InputStream inputStream = this.getClass().getResourceAsStream("jdbc.properties");Properties properties = new Properties();properties.load(inputStream);properties.list(System.out);System.out.println("==============================================");String property = properties.getProperty("jdbc.url");System.out.println("property = " + property);}/*** 2. 方式二* 从当前的类加载器的getResourcesAsStream来获取* InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream(name)** @throws IOException*/@Testpublic void test5() throws IOException {InputStream inputStream = this.getClass().getClassLoader().getResourceAsStream("config/application.properties");Properties properties = new Properties();properties.load(inputStream);properties.list(System.out);System.out.println("==============================================");String property = properties.getProperty("minio.endpoint");System.out.println("property = " + property);}/*** 3. 方式三* 使用Class类的getSystemResourceAsStream方法 和使用当前类的ClassLoader是一样的* InputStream inputStream = ClassLoader.getSystemResourceAsStream(name)** @throws IOException*/@Testpublic void test4() throws IOException {InputStream inputStream = ClassLoader.getSystemResourceAsStream("config/application.properties");Properties properties = new Properties();properties.load(inputStream);properties.list(System.out);System.out.println("==============================================");String property = properties.getProperty("minio.endpoint");System.out.println("property = " + property);}/*** 4. 方式四* Resource resource = new ClassPathResource(path)** @throws IOException*/@Testpublic void test2() throws IOException {Resource resource = new ClassPathResource("config/application.properties");Properties properties = PropertiesLoaderUtils.loadProperties(resource);properties.list(System.out);System.out.println("==============================================");String property = properties.getProperty("minio.endpoint");System.out.println("property = " + property);}/*** 5. 方式五* 从文件中获取,使用InputStream字节,主要是需要加上当前配置文件所在的项目src目录地址。路径配置需要精确到绝对地址级别* BufferedInputStream继承自InputStream* InputStream inputStream = new BufferedInputStream(new FileInputStream(name)* 这种方法读取需要完整的路径，优点是可以读取任意路径下的文件，缺点是不太灵活* @throws IOException*/@Testpublic void test3() throws IOException {InputStream inputStream = new BufferedInputStream(new FileInputStream("src/main/resources/config/application.properties"));Properties properties = new Properties();properties.load(inputStream);properties.list(System.out);System.out.println("==============================================");String property = properties.getProperty("minio.endpoint");System.out.println("property = " + property);}/*** 6. 方式六* 从文件中获取,使用InputStream字节,主要是需要加上当前配置文件所在的项目src目录地址。路径配置需要精确到绝对地址级别* FileInputStream继承自InputStream* InputStream inputStream = new FileInputStream(name)* 这种方法读取需要完整的路径，优点是可以读取任意路径下的文件，缺点是不太灵活* @throws IOException*/@Testpublic void test6() throws IOException {InputStream inputStream = new FileInputStream("src/main/resources/config/application.properties");Properties properties = new Properties();properties.load(inputStream);properties.list(System.out);System.out.println("==============================================");String property = properties.getProperty("minio.endpoint");System.out.println("property = " + property);}/*** 7. 方式七* 使用InputStream流来进行操作ResourceBundle，获取流的方式由以上几种。* ResourceBundle resourceBundle = new PropertyResourceBundle(inputStream);* @throws IOException*/@Testpublic void test7() throws IOException {InputStream inputStream = ClassLoader.getSystemResourceAsStream("config/application.properties");ResourceBundle resourceBundle = new PropertyResourceBundle(inputStream);Enumeration<String> keys = resourceBundle.getKeys();while (keys.hasMoreElements()) {String s = keys.nextElement();System.out.println(s + " = " + resourceBundle.getString(s));}}/*** 8. 方式八* ResourceBundle.getBundle的路径访问和 Class.getClassLoader.getResourceAsStream类似，默认从根目录下读取，也可以读取resources目录下的文件* ResourceBundle rb = ResourceBundle.getBundle("b") //不需要指定文件名的后缀,只需要写文件名前缀即可*/@Testpublic void test8(){//ResourceBundle rb = ResourceBundle.getBundle("jdbc"); //读取resources目录下的jdbc.propertiesResourceBundle rb2 = ResourceBundle.getBundle("config/application");//读取resources/config目录下的application.propertiesfor(String key : rb2.keySet()){String value = rb2.getString(key);System.out.println(key + ":" + value);}}/*** 单独抽取的方法，用户检测能否正确操纵Properties** @param inputStream* @throws IOException*/private void printKeyValue(InputStream inputStream) throws IOException {Properties properties = new Properties();properties.load(inputStream);Set<Object> keys = properties.keySet();for (Object key : keys) {System.out.println(key + " = " + properties.get(key));}}
}

Java中读取properties配置文件的八种方式总结相关推荐

  1. java中读取properties文件内容五种方式

    一.背景 最近,在项目开发的过程中,遇到需要在properties文件中定义一些自定义的变量,以供java程序动态的读取,修改变量,不再需要修改代码的问题.就借此机会把Spring+SpringMVC ...

  2. Java 读取 .properties 配置文件的几种方式

    Java 开发中,需要将一些易变的配置参数放置再 XML 配置文件或者 properties 配置文件中.然而 XML 配置文件需要通过 DOM 或 SAX 方式解析,而读取 properties 配 ...

  3. Spring-boot中读取config配置文件的两种方式

    了解过spring-Boot这个技术的,应该知道Spring-Boot的核心配置文件application.properties,当然也可以通过注解自定义配置文件的信息. Spring-Boot读取配 ...

  4. java配置文件实现方式_java相关：详解Spring加载Properties配置文件的四种方式

    java相关:详解Spring加载Properties配置文件的四种方式 发布于 2020-4-29| 复制链接 摘记: 一.通过 context:property-placeholder 标签实现配 ...

  5. 如何在spring中读取properties配置文件里面的信息

    如何在spring中读取properties配置文件里面的信息 <!-- 正文开始 --> 一般来说.我们会将一些配置的信息放在.properties文件中. 然后使用${}将配置文件中的 ...

  6. python读取图像数据流_浅谈TensorFlow中读取图像数据的三种方式

    本文面对三种常常遇到的情况,总结三种读取数据的方式,分别用于处理单张图片.大量图片,和TFRecorder读取方式.并且还补充了功能相近的tf函数. 1.处理单张图片 我们训练完模型之后,常常要用图片 ...

  7. Java中线程的创建有两种方式

    Java中继承thread类与实现Runnable接口的区别 Java中线程的创建有两种方式: 1．  通过继承Thread类,重写Thread的run()方法,将线程运行的逻辑放在其中 2．  通过 ...

  8. Java中遍历Map集合的5种方式总结

    这篇文章主要给大家介绍了关于Java中遍历Map集合的5种方式,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值. 方式一 通过Map.keySet使用iterator遍历 ...

  9. java 判断数组已经存满_详解Java中数组判断元素存在几种方式比较

    1. 通过将数组转换成List,然后使用List中的contains进行判断其是否存在 public static boolean useList(String[] arr,String contai ...

最新文章

  1. postgresql高可用_Postgresql高可用实现方案
  2. 关于I2C协议和SPI协议学习之中的补充修改
  3. 实现一个域名对应多个IP地址和DNS优缺点详解！
  4. 深入浅出mfc随笔——MFc程序的生死因果
  5. MVC,MVP与MVVM
  6. 调整/home和/root空间容量
  7. leetcode:Sort List(一个链表的归并排序)
  8. 怎么用latex写ppt呢？
  9. 请简单解释一下ARP协议和ARP攻击
  10. android 如何使用Parcelable接口
  11. 边缘计算容器化是否有必要？
  12. 事务不在活跃oracle,MYSQL性能优化笔记_2
  13. 50-00-040-配置-Flink Configuration简介
  14. C++socket编程（八）8.3：UDP广播
  15. 神经网络基础模型--Logistic Regression的理论和实践
  16. 关于html中table表格tr,td的高度和宽度
  17. 呼叫中心几种常见质检方式的对比
  18. linux使用触摸屏驱动程序,Linux触摸屏驱动
  19. 笔记_python库jpype安装和使用，及如何打包java程序供Python调用
  20. 简析Apache Ignite

热门文章

  1. 电脑全屏闪回桌面问题
  2. AndroidStudio Unresolved reference
  3. 【Android M】平台方实现三指左右滑动任何应用界面截屏
  4. 主动学习与半监督算法结合在支付宝风控的应用
  5. pyecharts-动态可视化（2） 柱状图 时间轴/折线/堆叠/水印/瀑布图
  6. 软件设计原则-开闭原则
  7. windows下tftp服务器
  8. 利用zookeeper模拟实现HA高可用
  9. 【甲骨云】 vps重装一键系统脚本（一键DD脚本）
  10. 【调剂】211云南大学2020年硕士研究生招生调剂通知