java如何将配置文件中的配置读取到注解上

原创

mob64ca12d8821d 2024-08-07 09:54:37 ©著作权

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

如何将配置文件中的配置读取到Java注解上

在现代Java开发中，随着配置文件的广泛应用，如何高效地将配置文件中的配置读取到注解上，便成为了一个实际问题。这种需求尤其在微服务架构中显得尤为重要，因为服务通常都是通过注解来进行配置和管理的。本文将结合一个实际的例子，介绍如何实现这一功能。

实际问题

假设我们有一个服务，服务的配置项包括服务名称、端口号以及数据库连接信息等。这些配置项存储在一个config.properties文件中，我们希望在Java中用注解的形式来标识这些配置项，方便后续的使用和管理。

配置文件示例

首先，我们创建一个简单的配置文件config.properties，如下所示：

service.name=MyService
server.port=8080
db.url=jdbc:mysql://localhost:3306/mydb
db.username=root
db.password=123456

注解定义

然后，我们定义一个注解@Config，用于标注需要加载配置的类属性。

import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;

@Retention(RetentionPolicy.RUNTIME)
public @interface Config {
    String value();
}

自动配置加载

接下来，我们需要一个工具类来读取配置文件的内容并将其注入到使用了@Config注解的字段中。以下是实现示例：

import java.io.InputStream;
import java.lang.reflect.Field;
import java.util.Properties;

public class ConfigLoader {

    private Properties properties;

    public ConfigLoader(String fileName) {
        properties = new Properties();
        try (InputStream input = getClass().getClassLoader().getResourceAsStream(fileName)) {
            if (input == null) {
                System.out.println("Sorry, unable to find " + fileName);
                return;
            }
            properties.load(input);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    public void load(Object obj) {
        Field[] fields = obj.getClass().getDeclaredFields();
        for (Field field : fields) {
            if (field.isAnnotationPresent(Config.class)) {
                Config config = field.getAnnotation(Config.class);
                String value = properties.getProperty(config.value());
                try {
                    field.setAccessible(true);
                    field.set(obj, value);
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
    }
}

使用示例

最后，我们创建一个示例类来使用注解和配置加载器：

public class Application {

    @Config("service.name")
    private String serviceName;

    @Config("server.port")
    private String port;

    public static void main(String[] args) {
        Application app = new Application();
        ConfigLoader loader = new ConfigLoader("config.properties");
        loader.load(app);
        System.out.println("Service Name: " + app.serviceName);
        System.out.println("Server Port: " + app.port);
    }
}

关系图

我们可以使用以下ER图来展示注解配置与配置文件之间的关系：

erDiagram
    CONFIG_CONFIG {
        String key PK
        String value
    }
    APPLICATION {
        String serviceName
        String port
    }
    APPLICATION ||--o{ CONFIG_CONFIG: contains

序列图

当应用运行时，注解的加载与配置的注入之间的交互如下所示：

sequenceDiagram
    participant App as Application
    participant Loader as ConfigLoader
    participant Config as config.properties
    App->>Loader: load(Application instance)
    Loader->>Config: Load properties
    Alt property found
        Loader->>App: Inject value
    End
    App-->>App: Display serviceName and port