如何在Javalin框架中使用YAML配置文件？

由于Javalin不依赖Spring生态，Spring的@Value注解无法直接使用，推荐使用SnakeYAML库手动解析YAML配置文件，这是Java生态中处理YAML的主流工具。

步骤1：引入SnakeYAML依赖 #

根据你的构建工具添加依赖：

Maven（pom.xml）

<dependency>
    <groupId>org.yaml</groupId>
    <artifactId>snakeyaml</artifactId>
    <version>2.2</version> <!-- 建议使用最新稳定版 -->
</dependency>

Gradle（build.gradle）

implementation 'org.yaml:snakeyaml:2.2'

步骤2：创建配置映射类 #

定义与YAML结构对应的Java类，让SnakeYAML可以自动将YAML内容映射为对象：

// 映射database节点的配置
public class DatabaseConfig {
    private String host;
    private String user;
    private String password;
    private String name;
    private int port;
    private String schema;

    // 必须提供Getter方法，用于后续获取配置值
    public String getHost() { return host; }
    public String getUser() { return user; }
    public String getPassword() { return password; }
    public String getName() { return name; }
    public int getPort() { return port; }
    public String getSchema() { return schema; }

    // Setter方法可选，SnakeYAML会通过反射赋值
    public void setHost(String host) { this.host = host; }
    public void setUser(String user) { this.user = user; }
    public void setPassword(String password) { this.password = password; }
    public void setName(String name) { this.name = name; }
    public void setPort(int port) { this.port = port; }
    public void setSchema(String schema) { this.schema = schema; }
}

// 根配置类，对应整个YAML文件结构
public class AppConfig {
    private DatabaseConfig database;

    public DatabaseConfig getDatabase() { return database; }
    public void setDatabase(DatabaseConfig database) { this.database = database; }
}

步骤3：编写配置加载工具类 #

实现一个单例工具类，负责加载并解析YAML文件：

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

public class ConfigLoader {
    private static final AppConfig APP_CONFIG;

    static {
        // 从classpath下加载YAML文件（确保文件放在resources目录中）
        try (InputStream inputStream = ConfigLoader.class.getClassLoader().getResourceAsStream("application.yml")) {
            Yaml yaml = new Yaml();
            APP_CONFIG = yaml.loadAs(inputStream, AppConfig.class);
        } catch (Exception e) {
            throw new RuntimeException("加载配置文件失败", e);
        }
    }

    public static AppConfig getAppConfig() {
        return APP_CONFIG;
    }
}

步骤4：在代码中使用配置值 #

替换你原来的常量定义，通过配置类获取YAML中的值：

public class DbConstants {
    private static final DatabaseConfig DB_CONFIG = ConfigLoader.getAppConfig().getDatabase();

    public static final String JDBC_DRIVER = "org.postgresql.Driver"; // 根据你的数据库类型调整驱动类
    public static final String DB_URL = String.format("jdbc:postgresql://%s:%d/%s", 
                                                     DB_CONFIG.getHost(), 
                                                     DB_CONFIG.getPort(), 
                                                     DB_CONFIG.getName());
    public static final String DB_NAME = DB_CONFIG.getName();
    public static final String USER = DB_CONFIG.getUser();
    public static final String PASSWORD = DB_CONFIG.getPassword();
    public static final int PORT = DB_CONFIG.getPort(); // YAML中port是数字类型，可根据需求转为String
}

注意事项 #

• 确保YAML文件（如application.yml）放置在项目的src/main/resources目录下，这样才能被classpath加载。
• 如果需要区分开发、生产等环境，可以通过读取环境变量，动态加载不同的YAML文件（如application-dev.yml、application-prod.yml）。
• 若Java类字段名与YAML键名不一致，可以使用@JsonProperty注解指定映射关系（需引入Jackson依赖）。

内容的提问来源于stack exchange，提问作者Hiep Huynh