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

2024-03-31 04:32
文章标签 java 读取 总结 方式 配置文件 properties 八种

本文主要是介绍Java中读取properties配置文件的八种方式总结，希望对大家解决编程问题提供一定的参考价值，需要的开发者们随着小编来一起学习吧！

一、前言

在做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类继承关系图
  • 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配置文件的八种方式总结的文章就介绍到这儿，希望我们推荐的文章对编程师们有所帮助！


http://www.chinasem.cn/article/863401。

相关文章

springboot集成easypoi导出word换行处理过程

springboot集成easypoi导出word换行处理过程

《springboot集成easypoi导出word换行处理过程》SpringBoot集成Easypoi导出Word时,换行符n失效显示为空格,解决方法包括生成段落或替换模板中n为回车,同时需确... 目录项目场景问题描述解决方案第一种：生成段落的方式第二种：替换模板的情况，换行符替换成回车总结项目场景s
阅读更多...
SpringBoot集成redisson实现延时队列教程

SpringBoot集成redisson实现延时队列教程

《SpringBoot集成redisson实现延时队列教程》文章介绍了使用Redisson实现延迟队列的完整步骤,包括依赖导入、Redis配置、工具类封装、业务枚举定义、执行器实现、Bean创建、消费... 目录1、先给项目导入Redisson依赖2、配置redis3、创建 RedissonConfig 配
阅读更多...
SpringBoot中@Value注入静态变量方式

SpringBoot中@Value注入静态变量方式

《SpringBoot中@Value注入静态变量方式》SpringBoot中静态变量无法直接用@Value注入,需通过setter方法,@Value(${})从属性文件获取值,@Value(#{})用... 目录项目场景解决方案注解说明1、@Value("${}")使用示例2、@Value("#{}"php
阅读更多...
SpringBoot分段处理List集合多线程批量插入数据方式

SpringBoot分段处理List集合多线程批量插入数据方式

《SpringBoot分段处理List集合多线程批量插入数据方式》文章介绍如何处理大数据量List批量插入数据库的优化方案：通过拆分List并分配独立线程处理,结合Spring线程池与异步方法提升效率... 目录项目场景解决方案1.实体类2.Mapper3.spring容器注入线程池bejsan对象4.创建
阅读更多...
线上Java OOM问题定位与解决方案超详细解析

线上Java OOM问题定位与解决方案超详细解析

《线上JavaOOM问题定位与解决方案超详细解析》OOM是JVM抛出的错误,表示内存分配失败,：本文主要介绍线上JavaOOM问题定位与解决方案的相关资料,文中通过代码介绍的非常详细,需要的朋... 目录一、OOM问题核心认知1.1 OOM定义与技术定位1.2 OOM常见类型及技术特征二、OOM问题定位工具
阅读更多...
基于 Cursor 开发 Spring Boot 项目详细攻略

基于 Cursor 开发 Spring Boot 项目详细攻略

《基于Cursor开发SpringBoot项目详细攻略》Cursor是集成GPT4、Claude3.5等LLM的VSCode类AI编程工具,支持SpringBoot项目开发全流程,涵盖环境配... 目录cursor是什么？基于 Cursor 开发 Spring Boot 项目完整指南1. 环境准备2. 创建
阅读更多...
Spring Security简介、使用与最佳实践

Spring Security简介、使用与最佳实践

《SpringSecurity简介、使用与最佳实践》SpringSecurity是一个能够为基于Spring的企业应用系统提供声明式的安全访问控制解决方案的安全框架,本文给大家介绍SpringSec... 目录一、如何理解 Spring Security？—— 核心思想二、如何在 Java 项目中使用？——
阅读更多...
SpringBoot+RustFS 实现文件切片极速上传的实例代码

SpringBoot+RustFS 实现文件切片极速上传的实例代码

《SpringBoot+RustFS实现文件切片极速上传的实例代码》本文介绍利用SpringBoot和RustFS构建高性能文件切片上传系统,实现大文件秒传、断点续传和分片上传等功能,具有一定的参考... 目录一、为什么选择 RustFS + SpringBoot？二、环境准备与部署2.1 安装 RustF
阅读更多...
springboot中使用okhttp3的小结

springboot中使用okhttp3的小结

《springboot中使用okhttp3的小结》OkHttp3是一个JavaHTTP客户端,可以处理各种请求类型,比如GET、POST、PUT等,并且支持高效的HTTP连接池、请求和响应缓存、以及异... 在 Spring Boot 项目中使用 OkHttp3 进行 HTTP 请求是一个高效且流行的方式。
阅读更多...
java.sql.SQLTransientConnectionException连接超时异常原因及解决方案

java.sql.SQLTransientConnectionException连接超时异常原因及解决方案

《java.sql.SQLTransientConnectionException连接超时异常原因及解决方案》：本文主要介绍java.sql.SQLTransientConnectionExcep... 目录一、引言二、异常信息分析三、可能的原因3.1 连接池配置不合理3.2 数据库负载过高3.3 连接泄漏
阅读更多...

Copyright China编程 23002807@qq.com

沪ICP备2023033072号-2