java打包后读取外部yml文件

原创

mob64ca12dcc794 2024-09-05 04:26:49 ©著作权

文章标签 YAML spring java 文章分类 Java 后端开发

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

Java打包后读取外部YAML文件

在Java中，尤其是使用Spring框架的应用程序中，我们通常会管理配置信息，比如数据库连接信息、服务端口等。YAML文件是一种常用的配置文件格式，因其可读性强、支持复杂的数据结构而广受欢迎。然而，在打包Java应用程序后，如何正确地读取一个外部YAML配置文件呢？本文将详细介绍其实现方法。

1. 项目结构

为了更好地理解，我们使用一个简单的项目结构来说明：

my-java-app
│   pom.xml
│
├───src
│   ├───main
│   │   ├───java
│   │   │   └───com
│   │   │       └───example
│   │   │           ├───App.java
│   │   │           └───config
│   │   │               └───AppConfig.java
│   │   └───resources
│   │       └───application.yml
│   └───test

2. Maven依赖

在pom.xml中添加以下依赖来支持YAML文件的读取：

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-configuration-processor</artifactId>
    </dependency>
    <dependency>
        <groupId>org.yaml</groupId>
        <artifactId>snakeyaml</artifactId>
    </dependency>
</dependencies>

3. YAML配置示例

假设我们的外部YAML文件application.yml的内容如下：

app:
  name: MyJavaApp
  version: 1.0
  properties:
    - key: windowSize
      value: 800x600
    - key: theme
      value: dark

4. 创建配置类

创建一个配置类AppConfig来读取YAML配置文件中的内容，代码如下：

package com.example.config;

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;
import java.util.List;

@Component
@ConfigurationProperties(prefix = "app")
public class AppConfig {
    
    private String name;
    private String version;
    private List<Property> properties;

    public static class Property {
        private String key;
        private String value;

        // Getters and Setters
        public String getKey() { return key; }
        public void setKey(String key) { this.key = key; }
        public String getValue() { return value; }
        public void setValue(String value) { this.value = value; }
    }

    // Getters and Setters
    public String getName() { return name; }
    public void setName(String name) { this.name = name; }
    public String getVersion() { return version; }
    public void setVersion(String version) { this.version = version; }
    public List<Property> getProperties() { return properties; }
    public void setProperties(List<Property> properties) { this.properties = properties; }
}

5. 主应用程序类

在主应用程序类App中，我们可以获取和使用这些配置信息：

package com.example;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.CommandLineRunner;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import com.example.config.AppConfig;

@SpringBootApplication
public class App implements CommandLineRunner {

    @Autowired
    private AppConfig appConfig;

    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }

    @Override
    public void run(String... args) {
        System.out.println("Application Name: " + appConfig.getName());
        System.out.println("Version: " + appConfig.getVersion());
        appConfig.getProperties().forEach(property ->
                System.out.println(property.getKey() + " : " + property.getValue()));
    }
}

6. 运行与打包

使用Maven命令打包：

mvn clean package

在打包后，确保您将application.yml文件放在与JAR文件同一目录下。在运行JAR文件时，YAML配置文件会被正确加载：

java -jar target/my-java-app.jar

7. 类图

为了更好地理解项目中的类关系，以下是该项目的类图。

classDiagram
    class App {
        +main(args: String[])
        +run(args: String[])
    }
    class AppConfig {
        +String name
        +String version
        +List<Property> properties
    }
    class Property {
        +String key
        +String value
    }
    
    AppConfig --> Property