第二章 spring cloud config 配置 2.1.4版本

 

简介

 

Spring Cloud Config为分布式系统中的外部化配置提供服务器和客户端支持。使用配置服务器，您可以在中心位置管理所有环境中应用程序的外部属性。服务器存储后端的默认实现使用git，因此它很容易支持配置环境的标记版本，并且可以被用于管理内容的各种工具访问。(以上摘自http://cloud.spring.io/spring-cloud-static/Edgware.SR3/single/spring-cloud.html#_spring_cloud_config);

Spring Cloud Config项目是一个解决分布式系统的配置管理方案。它包含了Client和Server两个部分，server提供配置文件的存储、以接口的形式将配置文件的内容提供出去，client通过接口获取数据、并依据此数据初始化自己的应用。这里使用默认的git配置

 

spring cloud config server

 

https://start.spring.io/创建项目,取名spring-cloud-config-server-demo,这里dependency选择web,config server,actuator;如图   

　　

 

　　　　

 

 

 

 

 

 

 

 

 

 

 

 

 

 

application.properties：　　　　　　

#application.properties配置Actuator,这里可以通过http://localhost:port/actuator/beans访问当前application context中所有bean的信息
management.endpoints.web.exposure.include=beans
#如果希望放开多个权限,以逗号分隔
#management.endpoints.web.exposure.include=beans,env
#如果希望放开所有的权限
#management.endpoints.web.exposure.include=*

新建bootstrap.properties

spring.application.name=config-server
server.port=9090
#这里使用了gitee的配置
spring.cloud.config.server.git.uri=https://git路径/
spring.cloud.config.server.git.search-paths=/
spring.cloud.config.server.git.username=username
spring.cloud.config.server.git.password=password
#这里是配置的本地目录
#spring.cloud.config.server.git.uri = file:///F:/gitRepsitory   

主程序入口

import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.config.server.EnableConfigServer;

@SpringBootApplication
@EnableConfigServer
public class SpringCloudConfigServerDemoApplication {

    public static void main(String[] args) {    SpringApplication.run(SpringCloudConfigServerDemoApplication.class, args);
    }
}

spring cloud config client

项目下载方式如上,不过config server换成config client,下载导入编辑器

application.properties：

management.endpoints.web.exposure.include=beans,env
server.port=8080
#举个例子,jdbc:mysql://${database.ip}:3306/test,database.ip=localhost,这样server中配置database.ip他会覆盖当前的database.ip
my.name = shit

新建bootstrap.properties:

### bootstrap 上下文配置
# 配置服务器 URI
spring.cloud.config.uri=http://localhost:9090/
spring.cloud.config.name=spring-config-client
# profile 是激活配置
spring.profiles.active=prod
spring.cloud.config.profile=prod
# label 在Git中指的分支名称
spring.cloud.config.label=master

主程序入口:

package cn.cold.springcloudconfigclientdemo;

import org.springframework.boot.SpringApplication;
import org.springframework.boot.WebApplicationType;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cloud.bootstrap.config.PropertySourceLocator;
import org.springframework.cloud.context.refresh.ContextRefresher;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.core.env.Environment;
import org.springframework.core.env.MapPropertySource;
import org.springframework.core.env.PropertySource;
import org.springframework.scheduling.annotation.EnableScheduling;
import org.springframework.scheduling.annotation.Scheduled;

import java.util.HashMap;
import java.util.Map;
import java.util.Set;

@SpringBootApplication
@EnableScheduling
public class SpringCloudConfigClientDemoApplication {

    public static void main(String[] args) {
        SpringApplication application = new SpringApplication(SpringCloudConfigClientDemoApplication.class);
        application.setWebApplicationType(WebApplicationType.SERVLET);
        application.run(args);
    }

    private final ContextRefresher contextRefresher;

    private final Environment environment;

    public SpringCloudConfigClientDemoApplication(ContextRefresher contextRefresher,
                                                  Environment environment) {
        this.contextRefresher = contextRefresher;
        this.environment = environment;
    }

    /**
     * 这里设置定时刷新获取当前配置,不然只能通过重启刷新配置
     */
    @Scheduled(fixedRate = 5 * 1000, initialDelay = 3 * 1000)
    public void autoRefresh() {
        Set<String> updatedPropertyNames = contextRefresher.refresh();
        updatedPropertyNames.forEach(propertyName ->
                System.err.printf("[Thread :%s] 当前配置已更新，具体 Key：%s , Value : %s \n",
                        Thread.currentThread().getName(),
                        propertyName,
                        environment.getProperty(propertyName)
                ));
    }
}

新建controller,比如我们取名为FuckController:

package cn.cold.springcloudconfigclientdemo.controller;

import org.springframework.beans.factory.annotation.Value;
import org.springframework.cloud.context.config.annotation.RefreshScope;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController;

/*
 * @create 2019-05-05 19:36
 * @Author 江湖人称洗发水
 * @Description //TODO
 **/
@RestController
@RefreshScope  //这里是刷新my.name这个属性值
public class FuckController {

    @Value("${my.name}")
    private String myName;

    @GetMapping("/my-name")
    public String getName(){
        return myName;
    }
}

Gitee

这里上传git配置文件有四个,可以在里面输入不同的值

 

启动

两个项目启动,这里访问http://localhost:8080/my-name会返回,git中的配置文件的值那就代表获取到了;然后可以进一步http://localhost:8080/actuator/env查看spring.cloud.config.uri:这里就是config server 的地址;

通过http://localhost:8080/actuator/env查看当前配置文件信息如图

 

Env:参考EnvironmentEndpoint类

 Environment关联多个带名称的PropertySources

参考spring 源码 AbstractRefreshableWebApplicationContext

protected void initPropertySources() {
  ConfigurableEnvironment env = getEnvironment();
  if (env instanceof ConfigurableWebEnvironment) {
    ((ConfigurableWebEnvironment) env).initPropertySources(this.servletContext, this.servletConfig);
  }
}

Environment 有两种实现方式：

普通类型：StandardEnvironment

Web类型：StandardServletEnvironment

Enviroment 关联着一个PropertySources 实例

PropertySources 关联着多个PropertySource，并且有优先级,这里可以通过url http://localhost:8080/actuator/env看到

关于 Spring Boot 优先级顺序，可以参考：https://docs.spring.io/spring-boot/docs/2.0.0.BUILD-SNAPSHOT/reference/htmlsingle/#boot-features-external-config

 

其他

当我们希望自己的配置不被修改,可以用spi来加载,例如my.name这里我就想指定为wuyanzu,可以添加以下代码

@Configuration
@Order(Ordered.HIGHEST_PRECEDENCE + 100)
public static class CustomizePropertySourceLocator implements PropertySourceLocator {

　　@Override
   public PropertySource<?> locate(Environment environment) {
   　　Map<String, Object> source = new HashMap<>();
      source.put("my.name", "8081");
      MapPropertySource propertySource =
                    new MapPropertySource("my-property-source", source);
      return propertySource;
   }
13 }