Java EnvironmentAware 接口

时间:2022-06-28 沙漠中的曼陀罗人气:0

研究背景

我們在搞新的配置中心Nacos的時候，为了获取新的配置中心的配置文件中配置的 dataId，以及配置 serverAddr、nacosGroup 等信息，所以才研究 EnvironmentAware 接口的如果写死话那岂不是太不像话了，那就太多的魔法值了，所以我们可以通过 environmentAware 这个接口进行从配置文件中【application.properties】获取配置的配置中心的信息详情

nacos.config.server-addr=IP地址
nacos.config.data-id=api.properties
nacos.config.group=DEFAULT_GROUP
nacos.config.namespace=public
nacos.config.username=nacos
nacos.config.password=nacos
nacos.config.auto-refresh=true
nacos.config.type=properties
nacos.config.bootstrap.enable=true
nacos.config.bootstrap.log-enable=true

之前没有注意过这个接口【但是在之前看多租户的工具源码的时候看到过这个接口】，所以通过本次项目中的需求来好好研究一下这个接口的问题

源码介绍以及使用方法

其实说白了就是哪个接口需要获取配置，那么那个接口就需要进行实现该接口 EnvironmentAware并实现里面的 setEnvironment方法

/**
   其实说白了就是哪个接口需要获取配置，那么那个接口就需要进行实现该接口并实现里面的set方法
*/
public interface EnvironmentAware extends Aware {

	void setEnvironment(Environment environment);

}

作用

所有注册到 Spring容器内的 bean，只要该bean 实现了 EnvironmentAware接口，并且进行重写了setEnvironment方法的情况下，那么在工程启动时就可以获取得 application.properties 的配置文件配置的属性值，这样就不用我们将魔法值写到代码里面了

使用方式代码示例

通过 NacosController 实现了 EnvironmentAware 这个接口，并且实现了 setEnvironment 方法，之后通过 environment 这个对象进行配置信息获取

@RestController
@RequestMapping("/nacos")
public class NacosController implements EnvironmentAware {

    private final static String NACOS_DATA_ID = "nacos.config.data-id";
    private final static String NACOS_GROUP = "nacos.config.group";

    private static String dataId = "";
    private static String group = "";

    @NacosInjected
    private ConfigService configService;

    @Autowired
    private Environment environment;

    @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }
    // 通过 environment 获取配置信息
    @PostConstruct
    private void init() {
        dataId = environment.getProperty(NACOS_DATA_ID);
        group = environment.getProperty(NACOS_GROUP);
    }

    /**
     * 发布配置
     * @return
     */
    @RequestMapping(value = "/publishConfig",method = RequestMethod.GET)
    public boolean publishConfig() {
        boolean res = false;
        try {
            res = configService.publishConfig(dataId, group, "发布配置");
        } catch (NacosException e) {
            e.printStackTrace();
        }
        System.out.println(res);
        return res;
    }
}

成功获取到了配置信息，我们在配置文件中设置的 nacos.config.data-id=api.properties，所以这里获取的值是正确

总结

哪个类需要获取配置信息那么该类就需要进行该接口 environmentAware 的实现
实现 environmentAware 这个接口所提供的方法 setEnvironment()
通过 environment 进行配置信息获取

加载全部内容