springcloud自动刷新配置

朱雀 2024-04-11 13:22 92阅读 0赞

在说自动刷新配置之前先说一下,先说一下手动是如何刷新配置的.具体原理请自行百度,本文仅记录实现操作.

项目环境:

父类pom文件.**最主要的是springboot和springcloud的版本. 1.x和2.x有配置很大的区别**

<parent>
    		<groupId>org.springframework.boot</groupId>
    		<artifactId>spring-boot-starter-parent</artifactId>
    		<version>2.1.7.RELEASE</version>
    		<relativePath/> 
    	</parent>
    	<groupId>com.java</groupId>
    	<artifactId>sell</artifactId>
    	<version>0.0.1-SNAPSHOT</version>
    	<name>sell</name>
    	<description>Demo project for Spring Boot</description>
    
    	<properties>
    		<java.version>1.8</java.version>
    		<spring-cloud-version>Greenwich.SR2</spring-cloud-version>
    	</properties>

项目结构:

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70][]

config的pom:

<artifactId>config</artifactId>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-config-server</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-bus-amqp</artifactId>
            </dependency>
        </dependencies>

config的application.yml:  (账号密码填自己的)

server:
      port: 8070
    spring:
      application:
        name: config
      cloud:
        config:
          server:
            git:
              uri: https://gitee.com/jiangli31346337/tensquare
              username: xxxxxxxxxxxxxxx
              password: xxxxxxxxxxxxxxx
              basedir: G:/Projects/sell/basedir  #将配置文件拉取到该文件夹
      rabbitmq:
        host: 192.168.136.130
    eureka:
      client:
        service-url:  #设置与Eureka Server交互的地址,查询服务和注册服务都需要依赖这个地址。
          defaultZone: http://localhost:8761/eureka
      instance:
        prefer-ip-address: true  #显示ip
    management:
      endpoints:
        web:
          exposure:
            include: "*"

测试orde项目自动刷新,看下order的pom:

<artifactId>order</artifactId>
    
        <dependencies>
            <dependency>
                <groupId>com.java</groupId>
                <artifactId>common</artifactId>
                <version>0.0.1-SNAPSHOT</version>
            </dependency>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-data-jpa</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-netflix-eureka-client</artifactId>
            </dependency>
            <dependency>
                <groupId>mysql</groupId>
                <artifactId>mysql-connector-java</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-openfeign</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-config-client</artifactId>
            </dependency>
            <dependency>
                <groupId>org.springframework.cloud</groupId>
                <artifactId>spring-cloud-starter-bus-amqp</artifactId>
            </dependency>
        </dependencies>

order的bootstrap.yml:

server:
      port: 8090
    spring:
      application:
        name: order
      cloud:
        config:
          discovery:
            enabled: true
            service-id: CONFIG
          profile: dev
    eureka:
      client:
        service-url:  #设置与Eureka Server交互的地址,查询服务和注册服务都需要依赖这个地址。
          defaultZone: http://localhost:8761/eureka
      instance:
        prefer-ip-address: true  #显示ip

gitee上order的application.yml:

server:
      port: 8090
    spring:
      application:
        name: order
      datasource:
        url: jdbc:mysql://192.168.136.130:3306/sell?allowMultiQueries=true&useUnicode=true&characterEncoding=UTF-8&useSSL=false&serverTimezone=Asia/Shanghai
        driver-class-name: com.mysql.cj.jdbc.Driver
        username: root
        password: 123456
      jpa:
        show-sql: true
      rabbitmq:
        host: 192.168.136.130    
    env: abc

编写测试方法用于获取gitee配置中env的值,**不要忘记@RefreshScope注解**

@RestController
    @RequestMapping("/order")
    @Slf4j
    @RefreshScope
    public class OrderController {
    	@Value("${env}")
    	private String env;
    
    	@GetMapping("/test")
    	public String test() {
    		return "hello "+env;
    	}
    }

开始测试,先启动eureka,再启动config,再启动order,然后访问order项目[http://localhost:8090/order/test][http_localhost_8090_order_test]

![20190821221044145.png][]

修改gitee上面的配置,并保存.

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 1][]

env的值已经改变.

然后用postman,模拟POST请求向config项目发送请求[http://localhost:8070/actuator/bus-refresh][http_localhost_8070_actuator_bus-refresh]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 2][]

可能有点慢,等待loading结束.然后访问order项目[http://localhost:8090/order/test][http_localhost_8090_order_test]

![20190821221426274.png][]

在未重启项目的情况下,修改后的内容已经成功获取,实现了手动刷新.

下面讲如何配置自动刷新.

需要使用内网穿透工具NATAPP.选择免费web隧道,进行配置

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 3][]

下载客户端,复制authtoken

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 4][]

在客户端填上authtoken

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 5][]

然后双击natapp.exe启动

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 6][]

测试外网地址

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 7][]

外网地址是OK的可以访问.下面在gitee上面打开项目的管理选项

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 8][]

选择webhooks

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 9][]

添加

![20190821232427701.png][]

配置好外网地址和自动刷新url,点击添加.(因为我已经添加过了,所以这里是修改)

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 10][]

就OK了,现在来测试一下,发送这个请求能不能正常返回.正常是返回204(服务器成功执行请求，无返回信息)

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 11][]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 12][]

可以看到返回400,显然请求失败.

原因：集成webhook后，GitHub在进行post请求的同时默认会在body加上这么一串载荷，我们的spring boot因为无法正常反序列化这串载荷而报了400错误。

解决：修改body

servlet其实为我们提供了一个HttpServletRequestMapper的包装类，我们通过继承该类重写getInputStream方法返回自己构造的ServletInputStream即可达到修改request中body内容的目的。下面是代码，这里为了避免节外生枝我直接返回了一个空的body。  
**在config项目中添加如下2个类和一个启动类注解**

package com.java.config.busConfig;
    
    import java.io.ByteArrayInputStream;
    import java.io.IOException;
     
    import javax.servlet.ReadListener;
    import javax.servlet.ServletInputStream;
    import javax.servlet.http.HttpServletRequest;
    import javax.servlet.http.HttpServletRequestWrapper;
     
    /**
     * 解决使用spring cloud config bus使用webhook自动刷新出现的400问题
     *
     * @author jiangli
     * @date 2019/8/19 22:55
     */
    public class CustometRequestWrapper extends HttpServletRequestWrapper {
     
    	public CustometRequestWrapper(HttpServletRequest request) {
    		super(request);
    	}
     
    	@Override
    	public ServletInputStream getInputStream() throws IOException {
    		byte[] bytes = new byte[0];
    		ByteArrayInputStream byteArrayInputStream = new ByteArrayInputStream(bytes);
     
    		return new ServletInputStream() {
    			@Override
    			public boolean isFinished() {
    				return byteArrayInputStream.read() == -1 ? true : false;
    			}
     
    			@Override
    			public boolean isReady() {
    				return false;
    			}
     
    			@Override
    			public void setReadListener(ReadListener readListener) {
     
    			}
     
    			@Override
    			public int read() throws IOException {
    				return byteArrayInputStream.read();
    			}
    		};
    	}
     
    }

package com.java.config.busConfig;
    
    import java.io.IOException;
     
    import javax.servlet.Filter;
    import javax.servlet.FilterChain;
    import javax.servlet.FilterConfig;
    import javax.servlet.ServletException;
    import javax.servlet.ServletRequest;
    import javax.servlet.ServletResponse;
    import javax.servlet.annotation.WebFilter;
    import javax.servlet.http.HttpServletRequest;
     
    
    /**
     * @author jiangli
     * @date 2019/8/19 22:55
     */
    @WebFilter(filterName = "JsonFilter",urlPatterns = "/*")
    public class JsonFilter implements Filter {
     
    	@Override
    	public void init(FilterConfig filterConfig) throws ServletException {
     
    	}
     
    	@Override
    	public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain)
    			throws IOException, ServletException {
    		HttpServletRequest httpServletRequest = (HttpServletRequest) servletRequest;
     
    		String url = new String(httpServletRequest.getRequestURI());
     
    		// 只过滤/actuator/bus-refresh请求
    		if (!url.endsWith("/bus-refresh")) {
    			filterChain.doFilter(servletRequest, servletResponse);
    			return;
    		}
     
    		// 使用HttpServletRequest包装原始请求达到修改post请求中body内容的目的
    		CustometRequestWrapper requestWrapper = new CustometRequestWrapper(httpServletRequest);
     
    		filterChain.doFilter(requestWrapper, servletResponse);
    	}
     
    	@Override
    	public void destroy() {
     
    	}
     
    }

@SpringBootApplication
    @EnableEurekaClient
    @EnableConfigServer
    @ServletComponentScan(value = "com.java.config.busConfig")  //扫描@WebFilter注解所在的包
    public class ConfigApp {
    	public static void main(String[] args) {
    		SpringApplication.run(ConfigApp.class,args);
    	}
    }

注意：启动类不要忘记加注解@ServletComponentScan扫描@WebFilter这个注解所在的包

然后重启项目进行测试

![20190821233826215.png][]

env的值现在是abc,我们去gitee上面修改成abc123

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 13][]

再次刷新[http://localhost:8090/order/test][http_localhost_8090_order_test]

![20190821234033276.png][]

完美!实现了自动刷新配置!!!

这中间也遇到了很多坑,主要是报400错误那个,在网上查找了很多方法,最后用上面的方法解决了.我看别人的项目中没有添加这2个类也实现了自动刷新,不知道用的什么方法,如果有大佬知道,希望不吝赐教!

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/598184587d1543f0a9185fe13b36de0e.png
[http_localhost_8090_order_test]: http://localhost:8090/order/test
[20190821221044145.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/4461ad59500b4160b2368b6d72da7cc4.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 1]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/fe76a9d0d06d4c7ba2b46548b790c59e.png
[http_localhost_8070_actuator_bus-refresh]: http://localhost:8070/actuator/bus-refresh
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 2]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/18af574e5fc44506b7d556f22d9fe5f8.png
[20190821221426274.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/6b9b6b8a301643878ff747cf70787d96.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 3]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/69ba1946d390408b9395634f0dd46694.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 4]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/686fa7a0042a4dff8c7ddc280a85655a.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 5]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/fc6c7db43694498990b195148744c6f3.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 6]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/d12e3177b3884a6e9cdc32b7b2049001.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 7]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/dd0f096180cd4c2da31ba0a538c6033f.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 8]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/a39bf944c07543d9a4c132d687c0ab19.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 9]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/aa05b9923bf14d31b7e430825e6e431c.png
[20190821232427701.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/91d6695a095d448ca5d552eeb432d187.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 10]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/b758ccbbec3b4363acc9151739d5529e.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 11]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/b20f01febccf413cb5f9ed553f5dc832.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 12]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/ac031e74f0dc432ebe40ba3fed726a26.png
[20190821233826215.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/d3fad289b0c04519af7d47948e4a5de5.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxXzM5OTQwMjA1_size_16_color_FFFFFF_t_70 13]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/d5042fb8f8aa435494eb334a9f049dd4.png
[20190821234033276.png]: https://image.dandelioncloud.cn/pgy_files/images/2024/04/11/c7701d29f78c4aca85239b37ff09b32c.png