Java中EnvironmentAware 接口的作用

更新時(shí)間：2022年06月21日 10:23:23 作者：沙漠中的曼陀羅

本文主要介紹了Java中EnvironmentAware 接口的作用，文中通過示例代碼介紹的非常詳細(xì)，對(duì)大家的學(xué)習(xí)或者工作具有一定的參考學(xué)習(xí)價(jià)值，需要的朋友們下面隨著小編來一起學(xué)習(xí)學(xué)習(xí)吧

研究背景

我們?cè)诟阈碌呐渲弥行腘acos的時(shí)候，為了獲取新的配置中心的配置文件中配置的 dataId，以及配置 serverAddr、nacosGroup 等信息，所以才研究 EnvironmentAware 接口的如果寫死話那豈不是太不像話了，那就太多的魔法值了，所以我們可以通過 environmentAware 這個(gè)接口進(jìn)行從配置文件中【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

之前沒有注意過這個(gè)接口【但是在之前看多租戶的工具源碼的時(shí)候看到過這個(gè)接口】，所以通過本次項(xiàng)目中的需求來好好研究一下這個(gè)接口的問題

源碼介紹以及使用方法

其實(shí)說白了就是哪個(gè)接口需要獲取配置，那么那個(gè)接口就需要進(jìn)行實(shí)現(xiàn)該接口 EnvironmentAware并實(shí)現(xiàn)里面的 setEnvironment方法

/**
   其實(shí)說白了就是哪個(gè)接口需要獲取配置，那么那個(gè)接口就需要進(jìn)行實(shí)現(xiàn)該接口并實(shí)現(xiàn)里面的set方法
*/
public interface EnvironmentAware extends Aware {

	void setEnvironment(Environment environment);

}

作用

所有注冊(cè)到 Spring容器內(nèi)的 bean，只要該bean 實(shí)現(xiàn)了 EnvironmentAware接口，并且進(jìn)行重寫了setEnvironment方法的情況下，那么在工程啟動(dòng)時(shí)就可以獲取得 application.properties 的配置文件配置的屬性值，這樣就不用我們將魔法值寫到代碼里面了

使用方式代碼示例

通過 NacosController 實(shí)現(xiàn)了 EnvironmentAware 這個(gè)接口，并且實(shí)現(xiàn)了 setEnvironment 方法，之后通過 environment 這個(gè)對(duì)象進(jìn)行配置信息獲取

@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);
    }

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

成功獲取到了配置信息，我們?cè)谂渲梦募性O(shè)置的 nacos.config.data-id=api.properties，所以這里獲取的值是正確