springCloud微服务系列——配置中心第四篇——手动刷新

草帽路飞UU

一、简介
配置文件如果改变了，已经启动的服务如何获得最新的配置，当然可以重新启动服务，但是这样速度太慢了，还需要到服务器上去操作，增加了运维成本，spring cloud提供了一个手动刷新的解决方案。

二、客户端刷新
客户端刷新是调用单个客户端的端点刷新接口，这样只刷新被调用刷新接口的端点。

端点配置
spring cloud在actuator中提供了一个refresh端点，通过该端点可以进行刷新。

客户端引入actuator

1. <dependency>
   
2.     <groupId>org.springframework.boot</groupId>
   
3.     <artifactId>spring-boot-starter-actuator</artifactId>
   
4. </dependency>

复制代码

客户端引入spring security

1. <dependency>
   
2.     <groupId>org.springframework.boot</groupId>
   
3.     <artifactId>spring-boot-starter-security</artifactId>
   
4. </dependency>

复制代码

配置management并暴露端点

1. management:
   
2.   server:
   
3.     port: 8101
   
4.     servlet:
   
5.       context-path: /demo/configClient/admin   
   
6.   endpoints:
   
7.     web:
   
8.       exposure:
   
9.         include: "*"
   

复制代码

在需要刷新的类上加上@RefreshScope注解

1. @RefreshScope
   
2. @RestController
   
3. @RequestMapping("testApi")
   
4. public class ConfigTestApi {
   
5.        
   
6.         @Value("${luminary.test}")
   
7.         private String test;
   
8. 
   
9.         @GetMapping("/config")
   
10.         public String server(
    
11.                         HttpServletRequest request,
    
12.                         HttpServletResponse response) {
    
13.                
    
14.                 return test;
    
15.                
    
16.         }
    
17.        
    
18. }
    

复制代码

安全配置

对refresh端点不进行csrf防护

1. @Configuration
   
2. @EnableWebSecurity
   
3. public class EurekaClientWebSecurityConfig extends WebSecurityConfigurerAdapter {
   
4. 
   
5.         @Override
   
6.         protected void configure(HttpSecurity http) throws Exception {
   
7.                
   
8.                  http
   
9.          .authorizeRequests()
   
10.          // 普通的接口不需要校验
    
11.          .antMatchers("/*api/**").permitAll()
    
12.          // swagger页面需要添加登录校验
    
13.          .antMatchers("/swagger-ui.html").authenticated()
    
14.          // 监控节点需要添加登录校验
    
15.          .requestMatchers(EndpointRequest.toAnyEndpoint()).authenticated()
    
16.          .and()
    
17.          // 允许刷新服务
    
18.          .csrf().ignoringAntMatchers("/actuator/refresh");
    
19.                  
    
20.                  super.configure(http);
    
21.                  
    
22.         }
    
23.        
    
24. }
    

复制代码

刷新

通过POST调用客户端的refresh端点，如果配置有改变，返回结果如下

需要注意的是refresh端点是actuator的端点，所以如果配置了management的话，要用management中配置的server.port和server.servlet.context-path

三、服务端刷新

客户端刷新需要每个客户端调用refresh接口，我们希望能在服务端调用刷新接口，然后通知每个客户端进行刷新。

我们需要借助消息总线spring-cloud-bus将刷新信息发送到客户端，目前spring-cloud-bus支持rabbitMq和kafka，这里以kafka做例子。

端点配置

服务端引入actuator，spring security，spring cloud bus，spring cloud config monitor

1. <dependency>
   
2.     <groupId>org.springframework.cloud</groupId>
   
3.     <artifactId>spring-cloud-config-server</artifactId>
   
4. </dependency>
   
5.    
   
6. <dependency>
   
7.         <groupId>org.springframework.cloud</groupId>
   
8.         <artifactId>spring-cloud-starter-bus-kafka</artifactId>
   
9. </dependency>
   
10.   
    
11. <dependency>
    
12.     <groupId>org.springframework.cloud</groupId>
    
13.     <artifactId>spring-cloud-config-monitor</artifactId>
    
14. </dependency>
    
15.   
    
16. <dependency>
    
17.     <groupId>org.springframework.boot</groupId>
    
18.     <artifactId>spring-boot-starter-actuator</artifactId>
    
19. </dependency>
    

复制代码

服务端配置management并暴露端点

1. management:
   
2.   server:
   
3.     port: 8168
   
4.     servlet:
   
5.       context-path: /manage/serverConfig/admin   
   
6.   endpoints:
   
7.     web:
   
8.       exposure:
   
9.         include: "*"
   

复制代码

客户端在需要刷新的类上加上@RefreshScope注解

1. @RefreshScope
   
2. @RestController
   
3. @RequestMapping("testApi")
   
4. public class ConfigTestApi {
   
5.        
   
6.         @Value("${luminary.test}")
   
7.         private String test;
   
8. 
   
9.         @GetMapping("/config")
   
10.         public String server(
    
11.                         HttpServletRequest request,
    
12.                         HttpServletResponse response) {
    
13.                
    
14.                 return test;
    
15.                
    
16.         }
    
17.        
    
18. }
    

复制代码

安全配置

对bus-refresh端点不进行csrf防护

1. @EnableWebSecurity
   
2. public class WebSecurityConfig extends WebSecurityConfigurerAdapter {
   
3. 
   
4.         @Override
   
5.         protected void configure(HttpSecurity http) throws Exception {
   
6.                
   
7.                 http
   
8.                 .authorizeRequests()
   
9.                 .requestMatchers(EndpointRequest.toAnyEndpoint()).authenticated()
   
10.                 .and()
    
11.                 .csrf().ignoringAntMatchers("/encrypt", "/decrypt", "/actuator/bus-refresh");
    
12.                
    
13.                 super.configure(http);
    
14.                
    
15.         }
    
16.        
    
17. }
    

复制代码

KAFKA配置

spring cloud bus通过消息队列发送配置变更消息给客户端，目前只支持rabbitMq和kafka，这里选择使用kafka

服务端和客户端配置

1. spring:
   
2.   cloud:
   
3.     stream:
   
4.        kafka:
   
5.          binder:
   
6.            brokers: localhost:9092
   
7.            #zk-nodes: localhost:2181 #spring cloud Finchley已弃用，zookeeper会被自动配置
   
8.            auto-add-partitions: true
   
9.            auto-create-topics: true
   
10.            min-partition-count: 1
    

复制代码

刷新

通过POST调用服务端的bus-refresh端点

需要注意的是bus-refresh端点是actuator的端点，所以如果配置了management的话，要用management中配置的server.port和server.servlet.context-path