springBoot自动装配集合(Map、List)以及动态刷新环境配置

springboot2.0从apollo读取配置

针对一些需要经常更新的配置，有多种方案：

1、将配置记录在数据库，启动项目的时候读取配置，然后缓存在集合中，这种方案很头疼的地方，每次更新配置之后，需要重新启动项目或者预留接口刷新缓存；

2、将配置记录在数据库，然后缓存在redis（注意缓存过期时间以及更新配置之后刷新缓存）；

3、将配置记录在配置中心或者注册中心，比如：Apollo、zookeeper。

方案2和3是目前最常用的，在springBoot项目中，如何自动装配集合(Map、List)以及动态刷新环境配置？

案例：后台管理系统有多个管理员（管理员姓名、管理员账号），分别将管理员账号信息封装到Map以及List集合中，然后更新配置并且刷新Map和List集合

package com.cn.dl.springbootdemo.bean;

import lombok.Data;

import java.io.Serializable;

/**
 * Created by yanshao on 2019-10-12.
 */
@Data
public class Administrator implements Serializable {
    private static final long serialVersionUID = -292113470316990948L;
    /**
     * 管理员姓名
     * */
    private String adminName;
    /**
     * 管理员账号
     * */
    private String adminAccount;
}

package com.cn.dl.springbootdemo.config;

import com.cn.dl.springbootdemo.bean.Administrator;
import lombok.Data;

import java.io.Serializable;
import java.util.List;
import java.util.Map;

/**
 * Created by yanshao on 2019-10-12.
 */
@Data
public class AdministratorConfig implements Serializable {

    private static final long serialVersionUID = -3952947542268351986L;

    private Map<String, Administrator> administratorMap;

    private List<Administrator> administratorList;
}

application.properties配置

#string
manage.page.url = https://manage.com/admin/getInfo2

#map集合
manage.administratorMap.xiaoming.adminName = xiaoming
manage.administratorMap.xiaoming.adminAccount = xiaoming123

manage.administratorMap.zhangsan.adminName = zhangsan
manage.administratorMap.zhangsan.adminAccount = zhangsan123

#list
manage.administratorList[0].adminName = lisi
manage.administratorList[0].adminAccount = lisi123

manage.administratorList[1].adminName = xiaohuang
manage.administratorList[1].adminAccount = xiaohuang123

将管理账号信息封装到集合中

package com.cn.dl.springbootdemo.config;

import org.springframework.boot.SpringBootConfiguration;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.context.annotation.Bean;

/**
 * Created by yanshao on 2019-10-12.
 */
@SpringBootConfiguration
public class WebAutoConfig {

    @Bean
    @ConfigurationProperties(prefix = "manage")
    public AdministratorConfig getAdministratorConfig(){
        return new AdministratorConfig();
    }

}

看一下效果

package com.cn.dl.springbootdemo;

import com.cn.dl.springbootdemo.config.AdministratorConfig;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.test.context.junit4.SpringRunner;

@RunWith(SpringRunner.class)
@SpringBootTest
public class SpringbootdemoApplicationTests {
    
    @Autowired
    private AdministratorConfig administratorConfig;

    @Value("${manage.page.url}")
    private String managePageUrl;

    @Test
    public void testConfig(){
        System.out.println(managePageUrl);
        System.out.println(administratorConfig.getAdministratorMap().get("xiaoming"));
        System.out.println(administratorConfig.getAdministratorList().get(1));
    }

}

动态刷新配置，需要引入一下依赖jar包

<dependency>
            <groupId>org.springframework.cloud</groupId>
            <artifactId>spring-cloud-context</artifactId>
            <version>2.1.0.RELEASE</version>
            <exclusions>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-web</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-starter-actuator</artifactId>
                </exclusion>
                <exclusion>
                    <groupId>org.springframework.security</groupId>
                    <artifactId>spring-security-crypto</artifactId>
                </exclusion>
            </exclusions>
        </dependency>
        <dependency>
            <groupId>org.springframework.security</groupId>
            <artifactId>spring-security-crypto</artifactId>
            <version>5.1.2.RELEASE</version>
        </dependency>

记得在AdminstratorConfig Bean上加上注解@RefreshScope

为了看到效果，加了一下代码

package com.cn.dl.springbootdemo.controller;

import com.alibaba.fastjson.JSONObject;
import com.cn.dl.springbootdemo.config.AdministratorConfig;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.EnvironmentAware;
import org.springframework.core.env.ConfigurableEnvironment;
import org.springframework.core.env.Environment;
import org.springframework.core.env.PropertiesPropertySource;
import org.springframework.web.bind.annotation.*;

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

/**
 * Created by yanshao on 2019-10-12.
 */
@RestController
@RequestMapping("envTest")
public class EnvironmentTestController implements EnvironmentAware {

    @Autowired
    private AdministratorConfig administratorConfig;

    @Autowired
    private ConfigurableEnvironment configurableEnvironment;

    @Autowired
    private org.springframework.cloud.context.scope.refresh.RefreshScope scope;

    private Environment environment;

    @GetMapping("getAdminConfig")
    public String getEnvironment(){
        if(configurableEnvironment == null){
            return null;
        }
        return JSONObject.toJSONString(administratorConfig);
    }

    /**
     * 通过key获取配置
     * */
    @PostMapping("getEnv")
    public String getEnvironment(@RequestParam("key") String key){
        return environment.getProperty(key);
    }
    /**
     * 刷新配置
     * */
    @GetMapping("reLoanEnv")
    public void reLoadEnvironment() {
        try {
            InputStream in = EnvironmentTestController.class.getResourceAsStream("/application.properties");
            Properties properties = new Properties();
            properties.load(in);
            PropertiesPropertySource propertySource = new PropertiesPropertySource("dynamic", properties);
            configurableEnvironment.getPropertySources().addFirst(propertySource);
            scope.refreshAll();
        }catch (Exception e){
            e.printStackTrace();
        }
    }

    @Override
    public void setEnvironment(Environment environment) {
        this.environment = environment;
    }
}

启动项目之后访问：127.0.0.1:8080/envTest/getAdminConfig

然后在classes下修改application.properties配置信息

执行127.0.0.1:8080/envTest/reLoanEnv，然后再执行127.0.0.1:8080/envTest/getAdminConfig

OK，动态刷新成功！