一、使用@ConfigurationProperties注解获取配置参数

@ConfigurationProperties注解是Spring Boot提供的一种方便的方式,可以将配置参数映射到Java类的字段或属性中,需要指定prefix属性来指定配置参数的前缀。

将名为myapp的配置参数的值映射到该类的字段中:

import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.stereotype.Component;

@Component
@ConfigurationProperties(prefix = "myapp")
public class MyAppConfig {

    private String param1;
    private int param2;
    private boolean param3;
    // ...

    // getters and setters
}

通过在其他Java类中注入MyAppConfig对象来获取配置参数的值:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;

@Service
public class MyService {

    @Autowired
    private MyAppConfig config;

    public void doSomething() {
        String param1 = config.getParam1();
        int param2 = config.getParam2();
        boolean param3 = config.isParam3();
        // ...
    }
}

二、使用@Value注解获取配置参数

@Value注解是Spring框架提供的一种方式,可以将配置参数的值直接注入到Java类的字段或方法参数中,需要在Java类的字段或方法参数上添加该注解,并指定配置参数的名称或SpEL表达式。

将名为myapp.param1、myapp.param2和myapp.param3的配置参数的值注入到MyAppConfig类的字段中:

import org.springframework.beans.factory.annotation.Value;
import org.springframework.stereotype.Component;

@Component
public class MyAppConfig {

    @Value("${myapp.param1}")
    private String param1;

    @Value("${myapp.param2:10}")
    private int param2;

    @Value("${myapp.param3:true}")
    private boolean param3;

    // ...

    public void doSomething() {
        // use param1, param2, param3
    }
}

三、使用Environment对象获取配置参数

Environment对象是Spring框架提供的一种方式,可以在运行时获取配置参数的值,需要在Java类中注入该对象,并使用getProperty方法来获取配置参数的值。

获取名为myapp.param1、myapp.param2和myapp.param3的配置参数的值:

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.env.Environment;

@Configuration
public class MyConfiguration {

    @Autowired
    private Environment env;

    public void readConfig() {
        String param1 = env.getProperty("myapp.param1");
        int param2 = env.getProperty("myapp.param2", Integer.class);
        boolean param3 = env.getProperty("myapp.param3", Boolean.class);
        // ...
    }
}

四、对比和总结

@ConfigurationProperties让Spring Boot自动将配置文件里的键值对绑定到Bean的属性上,通过指定前缀简化配置。这样,配置数据直接映射到Java对象,代码清晰且易于管理。

@Value注解提供了更为直接的配置注入方式,允许将单个配置项直接注入到字段或方法中,支持SpEL表达式,适合简单场景下的配置使用,无需编写额外逻辑。

Environment对象赋予程序在运行时访问配置信息的能力,无需重启即可动态调整配置,适用于需要根据环境变化或运行时条件获取配置的场景。

Logo

开放原子开发者工作坊旨在鼓励更多人参与开源活动,与志同道合的开发者们相互交流开发经验、分享开发心得、获取前沿技术趋势。工作坊有多种形式的开发者活动,如meetup、训练营等,主打技术交流,干货满满,真诚地邀请各位开发者共同参与!

更多推荐