配置的概念

随着微服务工程的增多，越来越多的配置文件充斥在各种工程里。而工程和工程之间又可能出现依赖，这些依赖的配置怎么处理？ 是不是改个配置文件微服务就要重启？ 多个环境（dev/test/prod）的配置文件如何设置？多个节点之间的配置又是如何通信和共享信息？

所有这些问题和解决办法，最后汇总成功微服务配置管理这个概念和相应的产品生态。 总的来说有4种选择：
1）spring-cloud-config
2）使用consul
3）使用携程的appolo
4）使用阿里的nacos

他们的区别在网上能搜得到，就懒得写了。我用过consul，学习过appolo。consul不如appolo功能多，还需要自己写点脚本来辅助，适合小团队（开发人员30以下）。appolo想要的功能都有，几百上千的团队，适合用appolo 或 nacos。

工程解读

工程位于： https://gitee.com/xiaofeipapa/spring-cloud-demo
目录是：consul-global-config-demo

业务目标

这个工程主要解决这几个业务场景：
1）工程的通用配置（例如使用相同的数据库）
2）单个工程不同profile的配置
3）不重启微服务的配置刷新

单个工程的配置

修改 bootstrap.yaml

查看bootstrap.yaml ，可以看到新增了如下配置：

      config:
        enabled: true # 开启配置管理服务
        format: yaml  # 配置的格式，有四种选择
        prefix: orderApiConfig # 配置所在的应用目录名称
        default-context: ${spring.application.name}    # 服务名称，也就是spring.application.name的值
        data-key: data # 默认为data， 这个例子的路径是  orderApiConfig/order-api/data
        profile-separator: "-" # 环境分隔符，默认值 "," 所以要改为 -
        watch:
          # 是否开启自动刷新，默认值 true 开启
          enabled: true
          # 刷新频率，单位：毫秒，默认值 1000
          delay: 1000

这表示使用consul作为配置中心。也就是说，consul既作为服务注册中心，也作为配置中心。这是为了写教程方便，在实际开发中，建议两者分开，方便服务的监控。

设置 consul

那么consul应该怎么设置呢？ 根据以上配置，应该在consul上增加这样的目录：

• orderApiConfig
• 然后在此目录依次增加: order-api/data, order-api-dev/data , order-api-dev2/data ... 这样的子目录

文字描述比较麻烦, 看图:

image.png

这个配置的含义和spring boot 一样. order-api 存放多个环境共享的配置, -xxx 存放环境独有的配置

展开 order-api/data,输入如下配置:

image.png

展开 order-api-dev/data,输入如下配置:

image.png

展开 order-api-dev2/data,输入如下配置:

image.png

修改 controller方法

    @Value("${server.port}")
    private String serverPort;

    @Value("${greeting.msg}")
    private String greeting;

    @RequestMapping(value="/hello", method = RequestMethod.GET)
    public String hello(){
        return "我是 order service, 端口为： " + serverPort + ", " + greeting;
    }

测试

先用idea 启动工程, 然后访问: http://localhost:11000/hello , 可以看到:

image.png

这说明第一个实例用的就是dev的配置, 并且读到了环境共用的配置属性.

现在用命令行启动第二个实例:

mvn clean package
java -jar -Dspring.profiles.active=dev2 target/orderApi-0.0.1-SNAPSHOT.jar

可以看到另一个服务实例也启动了, 访问: http://localhost:11001/hello
可以看到:

image.png

这说明该实例拿到了该环境(dev2)的配置, 并且此配置覆盖了共用配置.

测试配置更新

到 consul 修改 order-api/data 的数据, 改为:

image.png

再次访问 localhost:11000/hello , 我们发现:

image.png

配置信息并没有更新, 这是为什么呢?

增加 @RefreshScope

原来, 要启动自动配置, 还需要在controller 加上 @RefreshScope 的注解, 如下:

@RestController
@RefreshScope
public class OrderApiController {

    @Value("${server.port}")
    private String serverPort;

    @Value("${greeting.msg}")
    private String greeting;

    @GetMapping("/hello")
    public String hello(){
        return "我是 order service, 端口为： " + serverPort + ", " + greeting;
    }
}

现在, 如果你再去修改配置, 访问链接, 就可以看到配置都已经更新了.

这是自动配置刷新的第一种办法: @RefreshScope 配合 @Value

另一种配置自动更新的办法

另一种办法是将之组装成属性类, 如下:

@ConfigurationProperties(prefix = "greeting")
@Data
public class OrderApiConfig {

    String msg;
}

prefix 对应配置文件的一个段, 例如之前配置文件是:

greeting:
  msg: hello, world!

所以这里的prefix 就是greeting

在启动类里加上 @EnableConfigurationProperties({OrderApiConfig.class}), 如下:

@SpringBootApplication
@EnableDiscoveryClient
@EnableAutoConfiguration(exclude={DataSourceAutoConfiguration.class})
@EnableConfigurationProperties({OrderApiConfig.class})
public class OrderApiApplication {
    public static void main( String[] args )
    {
        SpringApplication.run(OrderApiApplication.class, args);
    }
}

新增一段controller 的方法:

@Resource
    OrderApiConfig orderApiConfig;

    @GetMapping("/hello2")
    public String hello2(){
        return "我是 hello2, 端口为： " + serverPort + ", " + orderApiConfig.getMsg();
    }

打开浏览器访问 hello2, 你会看到这种情况下配置也能自动刷新. 就我个人而言, 更喜欢方法2.