我整理的一些关于【Java】的项目学习资料（附讲解～～）和大家一起分享、学习一下：

 https://d.51cto.com/f2PFnN

使用Java获取YAML文件值

YAML（YAML Ain’t Markup Language的递归缩写）是一种人类可读的数据序列化格式，广泛用于配置文件和数据交换。在Java应用程序中，尤其是Spring框架中，YAML配置文件越来越受到青睐。本文将介绍如何在Java中读取YAML文件，并通过代码示例演示这一过程。

1. YAML文件的基本结构

YAML文件通常包含键值对和层级关系，下面是一个简单的YAML示例：

app:
  name: MyApp
  version: 1.0
  features:
    - feature1
    - feature2
    - feature3
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.

在这个示例中，app是一个对象，它有三个属性：name、version和features。

2. 在Java中使用YAML

在Java中，我们可以使用多种库来解析YAML文件，其中比较流行的有以下两个：

  • SnakeYAML：一个流行的YAML解析器。
  • Jackson：一个强大的JSON处理库，也支持YAML。

接下来，我们将介绍这两种方法。

2.1 使用SnakeYAML
2.1.1 添加依赖

如果你使用Maven构建项目，可以在pom.xml中添加如下依赖：

<dependency>
    <groupId>org.yaml</groupId>
    <artifactId>snakeyaml</artifactId>
    <version>1.30</version> <!-- 请根据最新版本进行调整 -->
</dependency>
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
2.1.2 示例代码

下面是一个使用SnakeYAML读取YAML文件的示例代码：

import org.yaml.snakeyaml.Yaml;

import java.io.InputStream;
import java.util.Map;

public class YamlExample {
    public static void main(String[] args) {
        Yaml yaml = new Yaml();
        InputStream inputStream = YamlExample.class
                .getResourceAsStream("/config.yaml"); // 假设config.yaml在src/main/resources目录下
        
        Map<String, Object> data = yaml.load(inputStream);
        System.out.println(data.get("app")); // 输出 app 对象
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.

在这个示例代码中，我们首先创建了一个Yaml对象，通过getResourceAsStream方法加载config.yaml文件。然后将其解析为Map<String, Object>，这样就可以通过键值对的方式获取YAML中的内容。

2.2 使用Jackson
2.2.1 添加依赖

同样，如果使用Maven构建项目，可以在pom.xml中添加如下依赖：

<dependency>
    <groupId>com.fasterxml.jackson.dataformat</groupId>
    <artifactId>jackson-dataformat-yaml</artifactId>
    <version>2.13.0</version> <!-- 请根据最新版本进行调整 -->
</dependency>
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
2.2.2 示例代码

下面是使用Jackson读取YAML文件的示例代码：

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;

import java.io.File;
import java.io.IOException;
import java.util.Map;

public class YamlExample {
    public static void main(String[] args) {
        ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
        try {
            Map<String, Object> data = mapper.readValue(new File("src/main/resources/config.yaml"), Map.class);
            System.out.println(data.get("app")); // 输出 app 对象
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.
  • 18.

在这个示例中，我们创建了一个ObjectMapper对象，通过readValue方法读取YAML文件并将其解析为Map<String, Object>类型。

3. 解析YAML数据到Java对象

在实际应用中，我们可能希望将YAML数据直接映射到Java对象。接下来，我们将展示如何做到这一点。

3.1 使用SnakeYAML

首先，我们定义一个Java类来表示YAML中的数据结构：

public class AppConfig {
    private String name;
    private String version;
    private List<String> features;

    // Getter 和 Setter 方法
    // ...
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.

然后我们可以按照以下方式将YAML映射到这个对象：

import org.yaml.snakeyaml.Yaml;

import java.io.InputStream;

public class YamlExample {
    public static void main(String[] args) {
        Yaml yaml = new Yaml();
        InputStream inputStream = YamlExample.class
                .getResourceAsStream("/config.yaml");
        
        AppConfig config = yaml.loadAs(inputStream, AppConfig.class);
        System.out.println(config.getName()); // 输出 MyApp
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
3.2 使用Jackson

同样，定义AppConfig类后，我们可以使用Jackson如下方式进行映射：

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.dataformat.yaml.YAMLFactory;

import java.io.File;
import java.io.IOException;

public class YamlExample {
    public static void main(String[] args) {
        ObjectMapper mapper = new ObjectMapper(new YAMLFactory());
        try {
            AppConfig config = mapper.readValue(new File("src/main/resources/config.yaml"), AppConfig.class);
            System.out.println(config.getName()); // 输出 MyApp
        } catch (IOException e) {
            e.printStackTrace();
        }
    }
}
  • 1.
  • 2.
  • 3.
  • 4.
  • 5.
  • 6.
  • 7.
  • 8.
  • 9.
  • 10.
  • 11.
  • 12.
  • 13.
  • 14.
  • 15.
  • 16.
  • 17.

4. 关系图示意

为了更好地理解YAML数据结构与Java对象之间的关系，下面是一个关系图示意：

erDiagram
    APP_CONFIG {
        string name
        string version
        list features
    }
    YAML_CONFIG {
        app_name: string
        app_version: string
        app_features: list
    }
    APP_CONFIG ||--|| YAML_CONFIG: "maps to"

5. 结论

在本文中，我们介绍了如何在Java中读取YAML文件，包括使用SnakeYAML和Jackson两种常用库。我们还展示了如何将YAML数据解析到Java对象中。由于YAML的可读性及其结构化特性，使其在配置管理中越来越受到欢迎。希望本文能为您使用Java处理YAML文件提供有用的指导！如果您有任何问题，欢迎在评论区讨论。

整理的一些关于【Java】的项目学习资料（附讲解～～），需要自取：

 https://d.51cto.com/f2PFnN