java注解读取配置文件配置

原创

mob64ca12eea322 2024-11-02 03:38:02 ©著作权

文章标签 java Java 配置文件 文章分类 Java 后端开发

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

Java注解读取配置文件配置

Java注解是一种强大的功能，可以在类、方法、字段等元素上添加元数据。通过注解，开发者可以为这些元素提供额外的信息。结合使用配置文件，Java注解可以帮助我们实现灵活、可维护的应用程序配置。

什么是注解？

注解是Java提供的一种特殊的语法结构，它可以用于为代码元素添加描述性标记，以便在编译后或运行时进行使用。注解本身不会改变程序的语义，但可以由编译器或框架处理，从而改变程序的行为。

常见的注解

常见的一些Java内置注解包括：

@Override：表示方法覆盖。
@Deprecated：表示方法已过时。
@SuppressWarnings：抑制编译器的警告信息。

使用注解读取配置文件

在许多应用中，我们需要从配置文件中读取配置信息。通过定义自定义注解并结合反射机制，我们可以实现这一功能。

自定义注解的定义

首先，我们定义一个注解，命名为Config，用于标记需要从配置文件读取的属性：

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

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

这个注解接受一个字符串参数key，用于指定配置文件中相应的键。

创建配置类

接下来，我们创建一个配置类，用于读取配置文件的内容，并将值注入到通过注解标记的字段中：

import java.io.IOException;
import java.io.InputStream;
import java.util.Properties;

public class ConfigReader {
    private Properties properties;

    public ConfigReader(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 (IOException ex) {
            ex.printStackTrace();
        }
    }

    public String getConfigValue(String key) {
        return properties.getProperty(key);
    }
}

使用注解读取配置值

最后，我们创建一个应用类，通过反射机制读取注解，并将配置值注入到相应的属性中：

import java.lang.reflect.Field;

public class Application {
    @Config(key = "app.name")
    private String appName;

    @Config(key = "app.version")
    private String appVersion;

    public void loadConfig() {
        ConfigReader configReader = new ConfigReader("config.properties");
        for (Field field : this.getClass().getDeclaredFields()) {
            if (field.isAnnotationPresent(Config.class)) {
                Config config = field.getAnnotation(Config.class);
                String value = configReader.getConfigValue(config.key());
                field.setAccessible(true);
                try {
                    field.set(this, value);
                } catch (IllegalAccessException e) {
                    e.printStackTrace();
                }
            }
        }
    }

    public void printConfig() {
        System.out.println("Application Name: " + appName);
        System.out.println("Application Version: " + appVersion);
    }

    public static void main(String[] args) {
        Application app = new Application();
        app.loadConfig();
        app.printConfig();
    }
}

配置文件示例

我们可以在资源目录下创建一个config.properties文件，内容如下：

app.name=My Java Application
app.version=1.0.0

关系图

为了更好地理解我们创建的类及其关系，下面是关系图：

erDiagram
    class Application {
        +String appName
        +String appVersion
        +void loadConfig()
        +void printConfig()
    }
    class ConfigReader {
        +Properties properties
        +String getConfigValue(String key)
    }
    class Config {
        +String key()
    }
    Application --|> ConfigReader : uses
    Application --> Config : contains