Java中Properties類和properties文件示例詳解
前言
Java開發(fā)中配置文件是存儲程序參數的常用方式,而properties文件因其簡潔的鍵值對格式,成為最常用的配置文件類型之一,與之配套的java.util.Properties類,則是操作properties文件的核心工具。
一、properties配置文件基礎
1.1 什么是properties文件?
properties文件是一種以.properties為后綴的文本文件,采用鍵值對(key=value) 格式存儲數據,主要用于存儲配置信息(如數據庫連接參數、系統參數等)。
示例:db.properties(數據庫配置)
# 數據庫連接配置(#為注釋) jdbc.driver=com.mysql.cj.jdbc.Driver jdbc.url=jdbc:mysql://localhost:3306/test?useSSL=false jdbc.username=root jdbc.password=123456 # 連接池參數 jdbc.maxActive=20 jdbc.minIdle=5
1.2 properties文件的語法規(guī)則
- 鍵值對格式:
key=value(等號前后可空格,如key = value); - 注釋:以
#或!開頭的行(如# 這是注釋、! 這也是注釋); - 換行規(guī)則:一行一個鍵值對,若值過長需換行,可在末尾加
\(如key=value1\+換行+value2); - 編碼:Java默認以ISO-8859-1編碼讀取,若包含中文需特殊處理(后續(xù)講解);
- 大小寫敏感:
key和value區(qū)分大小寫(如Name和name是不同的key)。
1.3 properties文件的優(yōu)勢
- 簡潔直觀:鍵值對格式易于讀寫和維護;
- 跨平臺:文本文件,可在不同系統中使用;
- 與Java無縫集成:
Properties類原生支持,無需額外依賴; - 動態(tài)配置:無需修改代碼,通過修改配置文件即可調整程序行為。
二、Properties類詳解
java.util.Properties是Java提供的操作properties文件的工具類,繼承自Hashtable<Object, Object>,核心功能是讀取和寫入鍵值對配置。
2.1 Properties類的核心方法
| 方法名 | 作用 | 示例 |
|---|---|---|
load(InputStream in) | 從輸入流讀取properties文件內容 | props.load(new FileInputStream("db.properties")) |
store(OutputStream out, String comments) | 將鍵值對寫入輸出流(生成properties文件) | props.store(new FileOutputStream("out.properties"), "注釋") |
getProperty(String key) | 根據key獲取value(返回String) | String driver = props.getProperty("jdbc.driver") |
getProperty(String key, String defaultValue) | 獲取value,若key不存在則返回默認值 | String port = props.getProperty("jdbc.port", "3306") |
setProperty(String key, String value) | 設置鍵值對(添加或修改) | props.setProperty("jdbc.timeout", "30") |
stringPropertyNames() | 獲取所有key的集合(返回Set) | Set<String> keys = props.stringPropertyNames() |
2.2 Properties類的使用流程
使用Properties類操作配置文件的通用流程:
- 創(chuàng)建
Properties對象; - 通過
load()方法讀取properties文件; - 通過
getProperty()獲取配置值; - (可選)通過
setProperty()修改配置; - (可選)通過
store()寫入新的properties文件。
三、Properties類操作properties文件
3.1 讀取properties文件
3.1.1 讀取類路徑下的properties文件
在Maven項目中,properties文件通常放在src/main/resources目錄下(編譯后位于類路徑),讀取方式:
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
import java.util.Set;
public class PropertiesReadDemo {
public static void main(String[] args) {
// 1. 創(chuàng)建Properties對象
Properties props = new Properties();
try (
// 2. 獲取類路徑下的文件輸入流(自動關閉流)
InputStream in = PropertiesReadDemo.class.getClassLoader().getResourceAsStream("db.properties")
) {
if (in == null) {
throw new RuntimeException("未找到db.properties文件");
}
// 3. 加載文件內容
props.load(in);
// 4. 讀取配置(方式1:指定key)
String driver = props.getProperty("jdbc.driver");
String url = props.getProperty("jdbc.url");
System.out.println("數據庫驅動:" + driver);
System.out.println("連接URL:" + url);
// 4. 讀取配置(方式2:遍歷所有key)
Set<String> keys = props.stringPropertyNames();
System.out.println("\n所有配置:");
for (String key : keys) {
String value = props.getProperty(key);
System.out.println(key + " = " + value);
}
// 4. 讀取配置(方式3:帶默認值)
String port = props.getProperty("jdbc.port", "3306"); // 不存在則返回3306
System.out.println("\n數據庫端口:" + port);
} catch (IOException e) {
e.printStackTrace();
}
}
}
關鍵說明:
getClassLoader().getResourceAsStream("db.properties"):從類路徑讀取文件,無需關心具體路徑;- 使用try-with-resources語法自動關閉輸入流,避免資源泄露;
getProperty支持默認值,適合處理可選配置。
3.1.2 讀取絕對路徑的properties文件
若文件不在類路徑下(如D:/config/db.properties),需通過絕對路徑讀?。?/p>
import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;
public class PropertiesAbsolutePathDemo {
public static void main(String[] args) {
Properties props = new Properties();
// 絕對路徑
String filePath = "D:/config/db.properties";
try (InputStream in = new FileInputStream(filePath)) {
props.load(in);
System.out.println("用戶名:" + props.getProperty("jdbc.username"));
} catch (IOException e) {
e.printStackTrace();
}
}
}
3.2 寫入properties文件
通過store()方法可將Properties對象中的鍵值對寫入文件,常用于生成配置或保存修改。
import java.io.FileOutputStream;
import java.io.IOException;
import java.io.OutputStream;
import java.util.Properties;
public class PropertiesWriteDemo {
public static void main(String[] args) {
// 1. 創(chuàng)建Properties對象并添加配置
Properties props = new Properties();
props.setProperty("app.name", "MyApplication");
props.setProperty("app.version", "1.0.0");
props.setProperty("app.author", "JavaDeveloper");
// 2. 寫入文件
String filePath = "src/main/resources/app.properties";
try (OutputStream out = new FileOutputStream(filePath)) {
// store(輸出流, 注釋):注釋會被添加到文件開頭
props.store(out, "Application Configuration");
System.out.println("配置文件寫入成功:" + filePath);
} catch (IOException e) {
e.printStackTrace();
}
}
}
生成的app.properties內容:
#Application Configuration #Mon Jul 29 15:30:00 CST 2024 app.author=JavaDeveloper app.name=MyApplication app.version=1.0.0
注意:store()會自動添加時間戳注釋,且鍵值對按ASCII排序輸出。
3.3 處理包含中文的properties文件
properties文件默認以ISO-8859-1編碼存儲,直接寫入中文會導致亂碼。解決方式有兩種:
方式1:手動轉義中文(不推薦)
將中文轉為Unicode編碼(如中文→\u4E2D\u6587),可通過Java工具類實現:
public class ChineseEscapeDemo {
public static void main(String[] args) {
String chinese = "數據庫配置";
// 轉為Unicode
String unicode = new String(escapeChinese(chinese).getBytes());
System.out.println(unicode); // 輸出:\u6570\u636E\u5E93\u914D\u7F6E
}
// 中文轉Unicode工具方法
private static String escapeChinese(String str) {
StringBuilder sb = new StringBuilder();
for (char c : str.toCharArray()) {
if (c > 127) {
sb.append("\\u").append(Integer.toHexString(c));
} else {
sb.append(c);
}
}
return sb.toString();
}
}
缺點:可讀性差,維護困難,僅適合少量中文場景。
方式2:使用UTF-8編碼讀寫(推薦)
通過InputStreamReader和OutputStreamWriter指定UTF-8編碼,直接讀寫中文。
import java.io.*;
import java.nio.charset.StandardCharsets;
import java.util.Properties;
public class PropertiesUtf8Demo {
public static void main(String[] args) {
// 1. 寫入UTF-8編碼的properties文件(含中文)
Properties props = new Properties();
props.setProperty("app.name", "我的應用");
props.setProperty("app.desc", "這是一個測試應用");
try (
OutputStream out = new FileOutputStream("src/main/resources/app_utf8.properties");
// 指定UTF-8編碼寫入
Writer writer = new OutputStreamWriter(out, StandardCharsets.UTF_8)
) {
props.store(writer, "UTF-8編碼的配置文件(含中文)");
} catch (IOException e) {
e.printStackTrace();
}
// 2. 讀取UTF-8編碼的properties文件
try (
InputStream in = new FileInputStream("src/main/resources/app_utf8.properties");
// 指定UTF-8編碼讀取
Reader reader = new InputStreamReader(in, StandardCharsets.UTF_8)
) {
Properties readProps = new Properties();
readProps.load(reader);
System.out.println("應用名稱:" + readProps.getProperty("app.name")); // 輸出:我的應用
System.out.println("應用描述:" + readProps.getProperty("app.desc")); // 輸出:這是一個測試應用
} catch (IOException e) {
e.printStackTrace();
}
}
}
關鍵:讀寫時均通過InputStreamReader和OutputStreamWriter指定UTF_8編碼,確保中文正常顯示。
四、properties文件在框架中的應用
properties文件是Java框架的標配配置方式,以Spring和MyBatis為例:
4.1 Spring框架中的properties文件
Spring通過<context:property-placeholder>加載properties文件,實現配置注入:
1. 配置文件(db.properties)
jdbc.driver=com.mysql.cj.jdbc.Driver jdbc.url=jdbc:mysql://localhost:3306/test
2. Spring配置文件(spring.xml)
<!-- 加載properties文件 -->
<context:property-placeholder location="classpath:db.properties"/>
<!-- 注入配置到Bean -->
<bean id="dataSource" class="com.zaxxer.hikari.HikariConfig">
<property name="driverClassName" value="${jdbc.driver}"/>
<property name="jdbcUrl" value="${jdbc.url}"/>
</bean>
4.2 MyBatis中的properties文件
MyBatis通過<properties>標簽加載配置,用于動態(tài)替換SQL中的參數:
1. 配置文件(mybatis.properties)
db.username=root db.password=123456
2. MyBatis配置文件(mybatis-config.xml)
<configuration>
<!-- 加載properties文件 -->
<properties resource="mybatis.properties"/>
<!-- 在數據源中引用 -->
<environments default="development">
<environment id="development">
<dataSource type="POOLED">
<property name="username" value="${db.username}"/>
<property name="password" value="${db.password}"/>
</dataSource>
</environment>
</environments>
</configuration>
五、常見問題與避坑指南
5.1 讀取文件時出現NullPointerException
錯誤:InputStream in = ...返回null,導致props.load(in)報錯。
原因:
- 文件路徑錯誤(如類路徑下不存在該文件);
- 使用
Class.getResourceAsStream()時,路徑前缺少/(相對路徑問題)。
解決方案:
- 確認文件位置:Maven項目中,
src/main/resources下的文件編譯后位于類路徑根目錄; - 正確獲取流:
// 類路徑根目錄下的文件 InputStream in = PropertiesDemo.class.getClassLoader().getResourceAsStream("db.properties"); // 若文件在包下(如com/example/config/db.properties) InputStream in = PropertiesDemo.class.getResourceAsStream("/com/example/config/db.properties");
5.2 中文亂碼問題
錯誤:讀取properties文件中的中文顯示為???或亂碼。
原因:
- 未指定UTF-8編碼讀寫(默認ISO-8859-1);
- 文件實際編碼與讀寫編碼不一致(如文件是GBK,卻用UTF-8讀?。?。
解決方案:
- 統一使用UTF-8編碼讀寫(通過
InputStreamReader和OutputStreamWriter); - 檢查文件實際編碼(右鍵文件→查看/修改編碼格式)。
5.3 配置覆蓋問題
問題:setProperty后未調用store,修改未保存到文件。
原因:Properties是內存中的對象,setProperty僅修改內存數據,需調用store才能寫入文件。
解決方案:
- 修改后必須調用
store方法,否則修改不會持久化:
props.setProperty("jdbc.url", "新URL");
// 必須調用store才能保存到文件
props.store(new FileOutputStream("db.properties"), "更新URL");
總結
properties文件和Properties類是Java中輕量級配置解決方案:
- 簡單易用:鍵值對格式和
Properties類的API都非常直觀,學習成本低; - 靈活通用:適用于各種場景(數據庫配置、系統參數、框架配置等);
- 無縫集成:與Java及主流框架(Spring、MyBatis)完美兼容;
- 便于維護:配置與代碼分離,修改配置無需重新編譯程序。
在實際開發(fā)中,需注意編碼問題(尤其是中文)和路徑問題(確保文件能被正確讀?。?,對于復雜配置(如嵌套結構),可考慮JSON或XML,但properties文件仍是簡單配置的首選。
到此這篇關于Java中Properties類和properties文件的文章就介紹到這了,更多相關Java Properties類和properties文件內容請搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關文章希望大家以后多多支持腳本之家!
相關文章
idea上提交項目到gitee 最后出現 Push rejected的問題處理方法
這篇文章主要介紹了idea上面提交項目到gitee 最后出現 Push rejected的問題處理方法,本文給大家介紹的非常詳細,對大家的學習或工作具有一定參考借鑒價值,需要的朋友可以參考下2020-09-09
Spring中的之啟動過程obtainFreshBeanFactory詳解
這篇文章主要介紹了Spring中的之啟動過程obtainFreshBeanFactory詳解,在refresh時,prepareRefresh后,馬上就調用了obtainFreshBeanFactory創(chuàng)建beanFactory以及掃描bean信息(beanDefinition),并通過BeanDefinitionRegistry注冊到容器中,需要的朋友可以參考下2024-02-02

