全文大約【3600】字，不說廢話，只講可以讓你學到技術、明白原理的純干貨!本文帶有豐富的案例及配圖視頻，讓你更好地理解和運用文中的技術概念，并可以給你帶來具有足夠啟迪的思考......
一. Properties簡介
1.概述
在Java開發中，我們經常需要讀取和寫入配置文件，用來存儲程序中的一些配置信息，例如數據庫的連接信息、郵件和Web服務器的信息、消息隊列的信息等等。配置文件一般都是key-value形式，且它的key-value一般都是String-String類型的，因此我們完全可以用Map來表示它。
但因為配置文件特別常用，所以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的使用方法。
（4）讀寫Properties配置文件
首先我們通過一個案例，來學習如何讀取Properties配置文件里的信息。
（5）創建Properties文件
為了方便測試，我們可以先在項目中創建一個.properties的配置文件。小編這里就把該配置文件命名為db.properties了，如下圖所示：
大家要注意，在早期的JDK中，.properties配置文件采用了ASCII編碼，具體來說是ISO8859-1編碼。在這種編碼中，如果文件中存在中文，這些中文必須使用username=\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>大家要注意，這里我們要使用語句來聲明一個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類來實現程序的配置功能，提高程序的靈活性和可維護性。
京公網安備 11010802030320號