知識庫 / Java IO RSS 訂閱

File fileToParse = new File("sample.ini");
Ini ini = new Ini(fileToParse);

這個對象現在包含 sections 和 keys。

3.3. 讀取節區鍵

可以使用 Ini 類中的 <em get()</em> 函數，從 INI 文件中讀取節區鍵。

assertThat(ini.get("fonts", "letter"))
  .isEqualTo("bold");

3.4. 轉換為 Map

讓我們看看如何輕鬆地將整個 INI 文件轉換為 `<em Map<String, Map<String, String>>，這是一個 Java 原生數據結構，它代表了 INI 文件的層次結構：

public static Map<String, Map<String, String>> parseIniFile(File fileToParse)
  throws IOException {
    Ini ini = new Ini(fileToParse);
    return ini.entrySet().stream()
      .collect(toMap(Map.Entry::getKey, Map.Entry::getValue));
}

在這裏，entrySet 是 Ini 對象的鍵值對，本質上是 <em style="font-style: italic;">String</em> 和 <em style="font-style: italic;">Map&lt;String, String&gt;</em>》。Ini對象的內部表示實際上就是一個Map，因此可以通過使用stream()和toMap()收集器輕鬆轉換為一個普通的Map`。

現在，我們可以使用 get() 方法讀取這個 map 中的 section：

assertThat(result.get("fonts").get("letter"))
  .isEqualTo("bold");

這個 Ini 類非常容易直接使用，雖然轉換為 Map 可能並不必要，但稍後我們會找到它的用途。

然而，ini4j 是一箇舊庫，目前來看似乎沒有得到很好的維護。我們考慮另一個選項。

4. 使用 Apache Commons 解析 INI 文件

Apache Commons 提供了一個更強大的工具來處理 INI 文件。該工具能夠對整個文件進行建模，支持讀寫操作，儘管我們將重點關注其解析功能。

4.1. 安裝 Commons 配置

讓我們首先在我們的 pom.xml 中添加所需的 依賴項：

<dependency>
    <groupId>org.apache.commons</groupId>
    <artifactId>commons-configuration2</artifactId>
    <version>2.8.0</version>
</dependency>

版本 2.8.0 於 2022 年更新，比 ini4j 更為最新。

4.2. 打開 INI 文件

我們可以通過聲明一個 INIConfiguration 對象並將其傳遞一個 Reader 來打開 INI 文件：

INIConfiguration iniConfiguration = new INIConfiguration();
try (FileReader fileReader = new FileReader(fileToParse)) {
    iniConfiguration.read(fileReader);
}

我們使用了 try-with-resources 模式打開了一個 FileReader，然後要求 INIConfiguration 對象使用 read 函數讀取它。

4.3. 讀取節標題

<em>INIConfiguration</em> 類包含一個 <em>getSection()</em> 函數用於讀取節標題，以及在返回的對象的 <em>getProperty()</em> 函數用於讀取節標題中的鍵：

String value = iniConfiguration.getSection("fonts")
  .getProperty("letter")
  .toString();
assertThat(value)
  .isEqualTo("bold");

我們應該注意的是，`getProperty()` 方法返回的是 Object 而不是 String，因此需要將其轉換為 String。

4.4. 轉換為 Map

我們可以像之前一樣，將 INIConfiguration 轉換為 Map。這比使用 ini4j 稍微複雜一些：

Map<String, Map<String, String>> iniFileContents = new HashMap<>();

for (String section : iniConfiguration.getSections()) {
    Map<String, String> subSectionMap = new HashMap<>();
    SubnodeConfiguration confSection = iniConfiguration.getSection(section);
    Iterator<String> keyIterator = confSection.getKeys();
    while (keyIterator.hasNext()) {
        String key = keyIterator.next();
        String value = confSection.getProperty(key).toString();
        subSectionMap.put(key, value);
    }
    iniFileContents.put(section, subSectionMap);
}

要獲取所有部分，我們需要使用getSections()來查找它們的名稱。然後，getSection()可以為我們提供每個部分。

我們可以使用Iterator，它提供所有部分的鍵，並使用getProperty()與每個鍵值對進行操作。

雖然Map在這裏更難生成，但更簡單的數據結構允許我們隱藏INI文件解析與其他系統部分。

5. 將 INI 文件轉換為 POJO

我們可以使用 Jackson 將我們的 Map 結構轉換為 POJO。 我們可以使用反序列化註解來裝飾我們的 POJO，以幫助 Jackson 理解原始 INI 文件中各種命名約定。 相對於我們之前見過的任何數據結構，POJO 更易於使用。

5.1. 導入 Jackson

我們需要將 Jackson 添加到我們的 `pom.xml</em/> 中：

<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-annotations</artifactId>
    <version>2.17.2</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-core</artifactId>
    <version>2.17.2</version>
</dependency>
<dependency>
    <groupId>com.fasterxml.jackson.core</groupId>
    <artifactId>jackson-databind</artifactId>
    <version>2.17.2</version>
</dependency>

@JsonNaming(PropertyNamingStrategies.KebabCaseStrategy.class)
public static class Fonts {
    private String letter;
    private int textSize;

    // getters and setters
}

@JsonNaming(PropertyNamingStrategies.UpperCamelCaseStrategy.class)
public static class RequestResult {
    private int requestCode;

    // getters and setters
}

public class MyConfiguration {
    private Fonts fonts;
    private Background background;

    @JsonProperty("RequestResult")
    private RequestResult requestResult;

    @JsonProperty("ResponseResult")
    private ResponseResult responseResult;

    // getters and setters
}

ObjectMapper objectMapper = new ObjectMapper();
Map<String, Map<String, String>> iniKeys = parseIniFile(TEST_FILE);
MyConfiguration config = objectMapper.convertValue(iniKeys, MyConfiguration.class);

assertThat(config.getFonts().getLetter()).isEqualTo("bold");
assertThat(config.getFonts().getTextSize()).isEqualTo(28);
assertThat(config.getBackground().getColor()).isEqualTo("white");
assertThat(config.getRequestResult().getRequestCode()).isEqualTo(1);
assertThat(config.getResponseResult().getResultCode()).isZero();