java 怎么获取yml里面的值

原创

mob649e8160b585 2024-07-16 07:26:20 ©著作权

©著作权归作者所有：来自51CTO博客作者mob649e8160b585的原创作品，请联系作者获取转载授权，否则将追究法律责任

Java 项目中获取 YAML 配置文件的值

YAML（YAML Ain't Markup Language）是一种数据序列化格式，它以易读性著称，常用于配置文件。在Java项目中，我们经常需要从YAML配置文件中读取数据。本方案将介绍如何在Java项目中获取YAML文件中的值，并提供一个简单的示例。

环境准备

首先，我们需要添加一些依赖到我们的项目中。这里我们使用SnakeYAML库来解析YAML文件。如果你的项目是基于Maven的，可以在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>org.yaml</groupId>
    <artifactId>snakeyaml</artifactId>
    <version>1.29</version>
</dependency>

YAML 文件结构

假设我们有一个名为config.yml的YAML配置文件，其内容如下：

database:
  host: localhost
  port: 3306
  username: user
  password: pass

读取 YAML 文件

我们将创建一个Java类来读取这个YAML文件，并获取所需的值。

定义数据模型

首先，我们定义一个Java类来映射YAML文件的结构：

public class DatabaseConfig {
    private String host;
    private int port;
    private String username;
    private String password;

    // Getters and Setters
    public String getHost() {
        return host;
    }

    public void setHost(String host) {
        this.host = host;
    }

    public int getPort() {
        return port;
    }

    public void setPort(int port) {
        this.port = port;
    }

    public String getUsername() {
        return username;
    }

    public void setUsername(String username) {
        this.username = username;
    }

    public String getPassword() {
        return password;
    }

    public void setPassword(String password) {
        this.password = password;
    }
}

读取 YAML 并映射到对象

接下来，我们创建一个工具类来读取YAML文件并将其映射到DatabaseConfig对象：

import org.yaml.snakeyaml.Yaml;
import java.io.FileInputStream;
import java.io.FileNotFoundException;
import java.io.InputStream;

public class YamlConfigLoader {

    public static DatabaseConfig loadDatabaseConfig(String filePath) {
        Yaml yaml = new Yaml();
        try (InputStream inputStream = new FileInputStream(filePath)) {
            return yaml.loadAs(inputStream, DatabaseConfig.class);
        } catch (FileNotFoundException e) {
            e.printStackTrace();
            return null;
        }
    }
}

使用示例

现在我们可以在任何需要的地方使用YamlConfigLoader来获取数据库配置：

public class Application {
    public static void main(String[] args) {
        DatabaseConfig dbConfig = YamlConfigLoader.loadDatabaseConfig("config.yml");
        if (dbConfig != null) {
            System.out.println("Database Host: " + dbConfig.getHost());
            System.out.println("Database Port: " + dbConfig.getPort());
            System.out.println("Database Username: " + dbConfig.getUsername());
            System.out.println("Database Password: " + dbConfig.getPassword());
        }
    }
}

关系图

以下是DatabaseConfig类与YAML文件的关系图：

erDiagram
    DB_CONFIG ||--o DB : "has a"
    DB {
        int port
        string host
        string username
        string password
    }

序列图

以下是加载YAML配置的序列图：

sequenceDiagram
    participant User
    participant Application
    participant YamlConfigLoader
    participant Yaml
    participant InputStream
    participant DBConfig

    User->>Application: 请求加载配置
    Application->>YamlConfigLoader: loadDatabaseConfig("config.yml")
    YamlConfigLoader->>Yaml: new Yaml()
    Yaml->>InputStream: FileInputStream("config.yml")
    InputStream->>Yaml: loadAs(...)
    Yaml->>DBConfig: 创建实例
    YamlConfigLoader->>Application: 返回DBConfig实例
    Application->>User: 显示配置信息