詳談Java中Properties配置類怎麼用

来源:https://www.cnblogs.com/qian-fen/archive/2023/05/29/17440173.html
-Advertisement-
Play Games

本文將為大家詳細講解Java中Properties配置類怎麼用，這是我們進行開發時經常用到的知識點，也是大家在學習Java中很重要的一個知識點，更是我們在面試時有可能會問到的問題！文章較長，乾貨滿滿，建議大家收藏慢慢學習。文末有本文重點總結，主頁有全系列文章分享。技術類問題，歡迎大家和我們一起交流討... ...


本文將為大家詳細講解Java中Properties配置類怎麼用，這是我們進行開發時經常用到的知識點，也是大家在學習Java中很重要的一個知識點，更是我們在面試時有可能會問到的問題！

文章較長，乾貨滿滿，建議大家收藏慢慢學習。文末有本文重點總結，主頁有全系列文章分享。技術類問題，歡迎大家和我們一起交流討論！

前言

在前面的幾篇文章中，給大家講解了Java里的List、Set和Map等集合。

所以現在我們知道，Map集合作為一個雙列集合，有key和value兩個值，這兩個值共同組成了key-value鍵值對的映射關係。而正是這種映射關係，使得Map集合可以解決我們在開發時遇到的配置文件問題。

所謂的配置文件問題，是指我們在開發時，經常需要讀取和修改一些配置信息，比如資料庫、消息隊列、Nginx、Web伺服器等的配置。這些配置信息在測試環境、開發環境和線上環境里的值是不同的，我們經常需要在幾種環境中反覆地修改配置信息。為了便於修改這些信息，我們可以採用Map集合來對這些信息進行封裝和操作，尤其是給我們提供了一個Properties配置類，更是方便了我們的操作。那麼今天，就給大家講一下Properties配置類是怎麼回事，以及怎麼使用。

全文大約【3600】 字，不說廢話，只講可以讓你學到技術、明白原理的純乾貨！本文帶有豐富的案例及配圖視頻，讓你更好地理解和運用文中的技術概念，並可以給你帶來具有足夠啟迪的思考...

一. Properties簡介

1. 概述

在Java開發中，我們經常需要讀取和寫入配置文件，用來存儲程式中的一些配置信息，例如資料庫的連接信息、郵件和Web伺服器的信息、消息隊列的信息等等。配置文件一般都是key-value形式，且它的key-value一般都是String-String類型的，因此我們完全可以用Map<String, String>來表示它。

但因為配置文件特別常用，所以Java集合庫給我們提供了一個Properties類來表示一組“配置”，專門用來處理key－value形式的配置信息。Properties類可以表示一個持久的屬性集，每個鍵及其對應的值都是字元串類型，它可以把配置信息保存在一個IO流中，或是從一個IO流中載入配置信息，因此很適合用來處理配置文件。

Properties的內部本質上是一個Hashtable，該類從Hashtable中繼承了get()和put()方法，這些方法的參數簽名是Object。但由於歷史遺留原因，Properties的設計實際上是有問題的，不過為了保持相容性，現在已經沒法修改了。所以我們在使用Properties時，不要去調用這些從Hashtable繼承來的方法，而應該使用Properties自身關於讀寫配置的方法，比如getProperty()和setProperty()等方法。

2. 配置文件

既然今天我們想利用Properties類來對配置文件進行讀取，所以首先我們得認識一下什麼是配置文件。在Java中，配置文件其實有多種格式，可以是 .txt、.xml、.properties、.yml、.json等格式，今天要給大家介紹的就是基於.properties格式的配置文件。

在Java中，其實預設的配置文件就是以.properties為擴展名的，該文件中的每行信息都是以key=value表示的，並用#進行註釋。以下是一個典型的配置文件：

# db.properties

\#資料庫的url
jdbc.url=jdbc:mysql://localhost:3306/mydb
\#用戶名
jdbc.username=root
\#密碼
jdbc.password=root

我們可以在eclipse等IDE工具中直接創建.properties文件，然後把上面的這些配置信息複製進去即可。

3. 常用方法

我們在使用Properties類讀寫配置文件時，常常會用到以下方法：

public synchronized void load(InputStream inStream) throws IOException
    
public synchronized void store(OutputStream out, String comments) throws IOException

其中，load()方法用於從指定的輸入流中讀取屬性列表(鍵和元素對)，store()方法用於將Properties中的鍵值對存儲到指定的輸出流中。

4. 讀取步驟

在Java中利用Properties類讀取配置文件的信息，一般要經歷如下三步：

  1. 創建 Properties 實例；
  2. 調用 load()方法 讀取配置文件；
  3. 調用 getProperty()方法 獲取具體的配置信息。

瞭解了以上這些內容之後，接下來，會通過幾個例子來給大家詳細地介紹Properties的使用方法。

二. 讀寫Properties配置文件

首先我們通過一個案例，來學習如何讀取Properties配置文件里的信息。

1. 創建Properties文件

為了方便測試，我們可以先在項目中創建一個.properties的配置文件。這裡就把該配置文件命名為db.properties了，如下圖所示：

image.png

大家要註意，在早期的JDK中， .properties配置 文件採用了ASCII編碼，具體來說是ISO8859-1編碼。在這種編碼中，如果文件中存在中文，這些中文必須使用user name=\u4e2d\u6587的形式來表示，非常彆扭。而從JDK 9開始， .properties配置 文件就可以使用UTF-8編碼了。

由於load(InputStream)方法預設總是以ASCII編碼來讀取位元組流，所以會導致讀取信息時產生亂碼，我們可以使用另一個load(Reader)重載方法來讀取：

Properties props = new Properties();
props.load(new FileReader("db.properties", StandardCharsets.UTF_8));

InputStream是位元組流，Reader是字元流，因為字元流在記憶體中已經以char類型表示了，所以不涉及到編碼問題。這樣通過以上代碼，我們就可以正常讀取包含中文的配置信息了。

2. 讀取Properties文件

2.1 載入配置文件

接下來我們可以使用Properties類的load()方法，來讀取上面創建的配置文件，例如：

import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Properties;

public class Demo23 {
	public static void main(String[] args) {
		//創建Properties對象
		Properties properties = new Properties();
		try {
			//設置db.properties配置文件，利用位元組流來載入文件
			
			//尋找.properties文件路徑方式一
			//從當前項目的根目錄下尋找db.properties文件
			URL url = Demo23.class.getResource("/db.properties");
			String path = url.getPath();
			System.out.println("path="+path);
			InputStream inputStream = new FileInputStream(path);
			
			//尋找.properties文件路徑方式二
			//InputStream inputStream = Demo23.class.getResourceAsStream("/db.properties");
			
			//載入位元組流
		    properties.load(inputStream);
		    System.out.println("properties="+properties);
		} catch (IOException e) {
		    e.printStackTrace();
		}
	}
}

在一個普通的Java項目中，如果我們想讀取.properties配置文件，可以有兩種方式：

  1. 類名.class.getResource("配置文件路徑及名稱") ：該方式會得到一個URL對象，它代表了配置文件的路徑；
  2. 類名.class.getResourceAsStream("配置文件路徑及名稱") ：該方式會直接得到InputStream對象。

在上面的代碼中，我們讀取到了名為db.properties的配置文件，並將其存儲在一個Properties對象中。

2.2 讀取配置信息

在上面的代碼中，我們從配置文件中讀取了三個鍵值對，分別是jdbc.url、jdbc.username和jdbc.password。在讀取配置文件後，接下來我們就可以通過getProperty()方法來獲取配置信息了。如果配置文件中不存在這些鍵，getProperty()方法將會返回null。

import java.io.FileInputStream;
import java.io.IOException;
import java.io.InputStream;
import java.net.URL;
import java.util.Properties;

public class Demo23 {
	public static void main(String[] args) {
		//創建Properties對象
		Properties properties = new Properties();
		try {
			//設置db.properties配置文件，利用位元組流來載入文件
			
			//尋找.properties文件路徑方式一
			//從當前項目的根目錄下尋找db.properties文件
			URL dbUrl = Demo23.class.getResource("/db.properties");
			String path = dbUrl.getPath();
			System.out.println("path="+path);
			InputStream inputStream = new FileInputStream(path);
			
			//尋找.properties文件路徑方式二
			//InputStream inputStream = Demo23.class.getResourceAsStream("/db.properties");
			
			//載入位元組流
		    properties.load(inputStream);
		    System.out.println("properties="+properties);
		    
		    //從配置文件中根據指定的key來讀取配置信息
		    String url = properties.getProperty("jdbc.url");
		    String username = properties.getProperty("jdbc.username");
		    String password = properties.getProperty("jdbc.password");
		    System.out.println("[url]="+url+" ,[username]="+username+" ,[password]="+password);
		} catch (IOException e) {
		    e.printStackTrace();
		}
	}
}

要註意，我們在調用 getProperty()方法 獲取配置信息時，如果指定的key不存在，會返回 null 。但我們可以提供一個預設值，這樣當key不存在時會返回一個預設值。 並且如果有多個.properties文件，可以反覆調用load()讀取，後讀取的key-value會覆蓋已讀取的key-value。

2.3 使用預設值讀取信息

在讀取配置文件時，如果某個鍵不存在，getProperty()方法將返回null。為了避免出現NullPointerException，我們可以為getProperty()方法指定一個預設值，例如：

String url = properties.getProperty("jdbc.url", "jdbc:mysql://localhost:3306/mydb");
String username = properties.getProperty("jdbc.username", "root");
String password = properties.getProperty("jdbc.password", "root");

在以上代碼中，如果配置文件中不存在jdbc.url這個鍵，getProperty方法會返回我們設置的預設值"jdbc:mysql://localhost:3306/mydb"。

3. 寫入Properties文件

接下來我們再通過一個案例，來學習如何把配置信息寫入到Properties文件里。

3.1 寫入配置文件

我們可以使用Properties類的store方法來寫入配置文件，例如：

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URL;
import java.util.Properties;

public class Demo24 {
	public static void main(String[] args) {
		//設置配置信息
		Properties properties = new Properties();
		properties.setProperty("jdbc.url", "jdbc:mysql://localhost:3306/mydb2");
		properties.setProperty("jdbc.username", "root");
		properties.setProperty("jdbc.password", "syc");

		try {
			URL dbUrl = Demo24.class.getResource("/db.properties");
			String path = dbUrl.getPath();
			System.out.println("path="+path);
			OutputStream outputStream = new FileOutputStream(path);
			//寫入配置信息
			properties.store(outputStream, "Database connection properties");

			// 尋找.properties文件路徑方式二
			InputStream inputStream = Demo24.class.getResourceAsStream("/db.properties");
			// 載入位元組流
			properties.load(inputStream);
			System.out.println("properties=" + properties);
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
}

以上代碼中，將三個鍵值對寫入到了名為db.properties的配置文件中，並添加了一行註釋“Database connection properties”。

3.2 使用預設值寫入信息

另外在Properties類中，其實本身就有一個預設的Properties對象，可以用來設置一些預設屬性值。我們可以使用Properties類的getDefaultProperties()方法來獲取預設的Properties對象，然後使用setProperty()方法來設置預設屬性值，例如：

Properties defaultProperties = Properties.getDefaultProperties();
defaultProperties.setProperty("jdbc.url", "jdbc:mysql://localhost:3306/mydb");
defaultProperties.setProperty("jdbc.username", "root");
defaultProperties.setProperty("jdbc.password", "root");

Properties properties = new Properties(defaultProperties);

以上代碼中，我們先獲取了預設的Properties對象，然後設置了jdbc.url、jdbc.username和jdbc.password三個預設屬性值。接著，我們創建了一個新的Properties對象，並將預設的Properties對象傳遞給它。這樣，在讀取配置文件時，如果某個鍵不存在，getProperty方法就會先在當前Properties對象中查找，如果找不到，就會在預設Properties對象中查找。

四. 讀寫XML配置文件

其實Properties類不僅可以操作.properties配置文件，也可以操作.xml格式的文件，接下來再給大家講一下如何操作xml文件。

1. 創建XML文件

首先我們來創建一個xml格式的配置文件，如下所示：

<?xml version="1.0" encoding="UTF-8"?>
<!-- 聲明一個properties屬性節點 -->
<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">
<properties>
  <entry key="jdbc.url">jdbc:mysql://localhost:3306/mydb</entry>
  <entry key="jdbc.username">root</entry>
  <entry key="jdbc.password">root</entry>
</properties>

大家要註意，這裡我們要使用<!DOCTYPE properties SYSTEM "http://java.sun.com/dtd/properties.dtd">語句來聲明一個properties根結點，大家可以根據自己的需要定義自己的節點名稱。

2. 讀取XML配置文件

要想讀取XML格式的配置文件，可以使用loadFromXML()方法從XML文件中讀取配置信息，例如：

import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;

public class Demo25 {
	public static void main(String[] args) {
		// 創建Properties對象
		Properties properties = new Properties();
		try {
			// 從當前項目的根目錄下尋找db.properties文件
			InputStream inputStream = Demo25.class.getResourceAsStream("/config.xml");
			// 載入位元組流,從XML文件中讀取配置信息
			properties.loadFromXML(inputStream);

			// 從配置文件中根據指定的key來讀取配置信息

			// 讀取信息時設置預設值
			 String url = properties.getProperty("jdbc.url","jdbc:mysql://localhost:3306/mydb2");
			 String username = properties.getProperty("jdbc.username", "syc");
			 String password = properties.getProperty("jdbc.password", "syc");
			 System.out.println("[url]="+url+" ,[username]="+username+" ,[password]="+password);
		} catch (IOException e) {
			e.printStackTrace();
		}
	}
}

以上代碼讀取了名為config.xml的XML配置文件，並將其存儲在一個Properties對象中。在讀取XML格式的配置文件後，我們就可以通過getProperty方法來獲取配置信息了。

3. 寫入XML配置文件

同時，我們也可以使用storeToXML()方法，將Properties中的鍵值對信息存儲到XML格式的輸出流中，例如：

import java.io.FileOutputStream;
import java.io.IOException;
import java.io.InputStream;
import java.io.OutputStream;
import java.net.URL;
import java.util.Properties;

public class Demo26 {
	public static void main(String[] args) {
		// 設置配置信息
		Properties properties = new Properties();
		properties.setProperty("jdbc.url", "jdbc:mysql://localhost:3306/mydb2");
		properties.setProperty("jdbc.username", "root");
		properties.setProperty("jdbc.password", "syc");

		try {
			URL dbUrl = Demo26.class.getResource("/config.xml");
			String path = dbUrl.getPath();
			OutputStream outputStream = new FileOutputStream(path);
			// 寫入配置信息
			properties.storeToXML(outputStream, "Database connection properties");

			// 尋找.properties文件路徑方式二
			InputStream inputStream = Demo26.class.getResourceAsStream("/config.xml");
			// 載入位元組流
			properties.loadFromXML(inputStream);
			System.out.println("xml=" + properties);

		} catch (IOException e) {
			e.printStackTrace();
		}
	}
}

在以上代碼中，我們將三個鍵值對寫入了一個名為config.xml的XML配置文件中，並添加了一行註釋“Database connection properties”。

五. 結語

在本文中，為大家詳細介紹了Java中的Properties配置類，它是用來處理配置文件的一個實用工具類，該類可以從文件系統、classpath或其他任何地方讀取.properties文件。我們在讀寫Properties時，註意僅使用getProperty()和setProperty()方法，不要調用繼承而來的get()和put()等方法。

通過本文的介紹，相信大家已經掌握了Properties類的基本用法，包括讀寫配置文件、設置預設值、讀寫XML格式的配置文件等等。在實際開發中，我們可以結合Properties類來實現程式的配置功能，提高程式的靈活性和可維護性。

六、配套視頻

視頻教程：戳這裡


您的分享是我們最大的動力!

-Advertisement-
Play Games
更多相關文章
  • Redis+分散式+秒殺
    ## 聊一下MySQL 關於mysql關係型資料庫的一些分析： 1、從性能上：如果我們碰到需要執行耗時特別久，並且執行結果不是很頻繁變動的SQL語句，我們就沒有必要每次都去查詢資料庫，因為每次操作資料庫都很耗時。 2、從併發上：在大併發的情況下（比如618秒殺活動，你敢讓千萬級的請求直接打到資料庫上 ...
  • < Python全景系列-8 > Python超薄感知，超強保護：異常處理的絕佳實踐
    歡迎來到系列第八篇，異常處理的深入探討。本文將分五部分展開。首先，我們將學習Python異常處理的基礎知識，理解`try/except`語句的用法。然後，我們將瞭解Python的常見異常類型並通過實例理解它們的作用。第三部分，我們將更深入地解析`try-except`塊，理解其工作原理及更加複雜的用... ...
  • Pandas 載入數據的方法和技巧
    哈嘍大家好，我是鹹魚 相信小伙伴們在學習 python 數據分析的過程中或多或少都會聽說或者使用過 pandas pandas 是 python 的一個拓展庫，常用於數據分析 今天鹹魚將介紹幾個關於 pandas 導入數據的方法和技巧 ## 從 URL 獲取 csv 數據 關於 pandas 導入 ...
  • Angular Highcharts教程_編程入門自學教程_菜鳥教程-免費教程分享
    ## 教程簡介 Angular Highcharts是一個基於Angular的開源組件，可在Angular應用程式中提供優雅且功能豐富的高圖表可視化，並可與Angular組件無縫配合使用。 [Angular Highcharts入門教程](https://www.itbaoku.cn/tutoria ...
  • Apache Flume教程_編程入門自學教程_菜鳥教程-免費教程分享
    ## 教程簡介 Flume是Apache下麵的一個分散式組件，它提供高效，可靠的收集，整合，傳輸日誌數據的服務。Flume可以理解成一個管道，它連接數據的生產者和消費者，它從數據的生產者(Source)獲取數據，保存在自己的緩存(Channel)中，然後通過Sink發送到消費者。它不對數據做保存和復 ...
  • 面試官：MySQL 自增主鍵一定是連續的嗎？大部分人都會答錯！
    ## 測試環境： > MySQL版本：8.0 資料庫表：T （主鍵id，唯一索引c，普通欄位d） ![](http://img.javastack.cn/1685072039483867.png) 如果你的業務設計依賴於自增主鍵的連續性，這個設計假設自增主鍵是連續的。但實際上，這樣的假設是錯的，因為 ...
  • VST實例（5）節點（NODE） 二、節點的遍歷
    編碼如下：#include <stdio.h> void swap(int* x,int* y ){ int tmp; tmp=*x; *x=*y; *y=tmp ; }; int main(){ int a=4; int b=5; printf("befer\n"); printf("a=%d\n ...
  • Python日期帶時區轉換工具類總結
    @[TOC] # 1.背景 最近項目是國際項目，所以需要經常需要用到UTC時間和local時間的轉換。 所以整理了一下時間戳工具類，方便使用。 這裡主要用到的包就是datatime、time、pytz。 # 2. 遇到的坑 直接看測試案例 ```python tzinfo=pytz.timezone ...
一周排行
    -Advertisement-
    Play Games
  • .NET 6 Entity Framework Core Db First（1） 創建模型
    .Net8.0 Blazor Hybird 桌面端 (WPF/Winform) 實測可以完整運行在 win7sp1/win10/win11. 如果用其他工具打包,還可以運行在mac/linux下, 傳送門BlazorHybrid 發佈為無依賴包方式 安裝 WebView2Runtime 1.57 M ...
  • 資料庫升級PostgreSql+Garnet
    目錄前言PostgreSql安裝測試額外Nuget安裝Person.cs模擬運行Navicate連postgresql解決方案Garnet為什麼要選擇Garnet而不是RedisRedis不再開源Windows版的Redis是由微軟維護的Windows Redis版本老舊，後續可能不再更新Garne ...
  • 如何基於surging架設流媒體視頻推流（視頻講解）
    C#TMS系統代碼-聯表報表學習 領導被裁了之後很快就有人上任了，幾乎是無縫銜接，很難讓我不想到這早就決定好了。我的職責沒有任何變化。感受下來這個系統封裝程度很高，我只要會調用方法就行。這個系統交付之後不會有太多問題，更多應該是做小需求，有大的開發任務應該也是第二期的事，嗯？怎麼感覺我變成運維了？而 ...
  • EAV模型（實體-屬性-值）的設計和低代碼的處理方案（2）--數據的查詢處理
    我在隨筆《EAV模型（實體-屬性-值）的設計和低代碼的處理方案（1）》中介紹了一些基本的EAV模型設計知識和基於Winform場景下低代碼（或者說無代碼）的一些實現思路，在本篇隨筆中，我們來分析一下這種針對通用業務，且只需定義就能構建業務模塊存儲和界面的解決方案，其中的數據查詢處理的操作。 ...
  • C# 程式集、模塊和類型概念及關係
    對某個遠程伺服器啟用和設置NTP服務(Windows系統) 打開註冊表 HKEY_LOCAL_MACHINE\SYSTEM\CurrentControlSet\Services\W32Time\TimeProviders\NtpServer 將 Enabled 的值設置為 1，這將啟用NTP伺服器功 ...
  • Django信號與擴展：深入理解與實踐
    title: Django信號與擴展：深入理解與實踐 date: 2024/5/15 22:40:52 updated: 2024/5/15 22:40:52 categories: 後端開發 tags: Django 信號 松耦合 觀察者 擴展 安全 性能 第一部分：Django信號基礎 Djan ...
  • Django3.2安裝源碼xadmin2步驟以及遇到的問題
    使用xadmin2遇到的問題&解決 環境配置： 使用的模塊版本： 關聯的包 Django 3.2.15 mysqlclient 2.2.4 xadmin 2.0.1 django-crispy-forms >= 1.6.0 django-import-export >= 0.5.1 django-r ...
  • 原創->CommonsCollections1-DefaultMap鏈
    今天我打算整點兒不一樣的內容，通過之前學習的TransformerMap和LazyMap鏈，想搞點不一樣的，所以我關註了另外一條鏈DefaultedMap鏈，主要調用鏈為： 調用鏈詳細描述： ObjectInputStream.readObject() DefaultedMap.readObject ...
  • 05-應用級開發者 AI 時代破局點
    後端應用級開發者該如何擁抱 AI GC？就是在這樣的一個大的浪潮下，我們的傳統的應用級開發者。我們該如何選擇職業或者是如何去快速轉型，跟上這樣的一個行業的一個浪潮? 0 AI金字塔模型 越往上它的整個難度就是職業機會也好，或者說是整個的這個運作也好,它的難度會越大,然後越往下機會就會越多,所以這是一 ...
  • Java面試題：讓依賴註入變得簡單，面對@Autowired和@Resource，該如何選擇？
    @Autowired是Spring框架提供的註解，@Resource是Java EE 5規範提供的註解。 @Autowired預設按照類型自動裝配，而@Resource預設按照名稱自動裝配。 @Autowired支持@Qualifier註解來指定裝配哪一個具有相同類型的bean，而@Resourc... ...
所有分類