SpringCloud系列----- >SpringBoot项目中给所有api接口Response添加or修改header信息

简介: 前言: 看到标题,估计绝大多数java小伙伴,都没明白这个标题具体是什么意思,到底是解决的什么问题,我们项目组的同事也是一脸懵逼。现在我从需求的角度说,大家就应该能理解了。 公司的项目是一个拥有几十个模块的SpringCloud分布式大项目,每个功能模块是一个单独的SpringBoot项目,例如:.

前言:

看到标题,估计绝大多数java小伙伴,都没明白这个标题具体是什么意思,到底是解决的什么问题,我们项目组的同事也是一脸懵逼。现在我从需求的角度说,大家就应该能理解了。
公司的项目是一个拥有几十个模块的SpringCloud分布式大项目,每个功能模块是一个单独的SpringBoot项目,例如:

  1、元数据SpringBoot项目组件;
  2、BI数据可视化SpringBoot项目组件;
  3、用户和权限SpringBoot项目组件;
  4、OA工作流SpringBoot项目组件;
  5、消息服务SpringBoot项目组件;
  ......
  
一个分布式的SpringCloud企业服务系统由几十个SpringBoot组件组成,每个SpringBoot由不同的人负责开发、维护,每个SpringBoot项目单独测试、单独上线,更尤其是公司的SpringCloud企业服务系统是由运维同事私有部署给上百家客户的(客户机器涉密不联网,运维只能拷贝jar包方式升级),时间一长了就会出现一种混乱的情况,运维同事就记不清楚了到底每一个客户系统的每个SpringBoot组件具体是部署的哪个版本,下一次给客户升级系统的需要更新哪些SpringBoot组件,哪些SpringBoot不需要更新。数学上说:
1、企业服务系统由N个模块组成。
2、每个SpringBoot组件有M个版本。
3、公司总共有X家需要私有部署的客户。
4、每个SpringBoot的版本号,规则并不相同,有Y种规则(BI版本号:bi1.0,bi2.0,bi3.0等等;OA版本号:OA0.1,OA0.2,0A0.3......;   其余N个服务......)。
......

那么具体到一个私有部署的客户,某次更新需要更新的服务组件就有   N*M*X*Y......等情况,总之是特别的混乱,出了有快10次的客户系统升级事故,每次都要耽误客户系统几个小时到一天的时间 ,客户系统不可用。时间一长,运维同事也记不清楚,给某个客户部署的系统的每个某块到底是哪个版本,哪个模块不用升级,哪个模块需要升级,只能是出现上线事故、bug之后,把不正确的SpringBoot服务的jar包拷贝给对应的开发,开发把jar解压之后,看源码才能确定客户目前部署的是哪个版本。
针对这种情况,我这里想到了一个简单的方法,来确认客户系统每个子服务具体部署的是那一个版本,在每个SpringBoot项目中增加一个filter,修改每一个restful接口的返回数据的header,在header中增加当前服务版本号的信息。我这啰嗦了半天,可能还是没说清楚。so,废话少说,上代码:

  package com.*******.filters;
  import org.springframework.stereotype.Component;
  import javax.servlet.*;
  import javax.servlet.http.HttpServletResponse;
  import java.io.IOException;

  @Component
  public class ResponseHeaderFilter  implements Filter {
      @Override
      public void init(FilterConfig filterConfig) throws ServletException {

      }
      @Override
      public void doFilter(ServletRequest servletRequest, ServletResponse servletResponse, FilterChain filterChain) throws IOException, ServletException {

          HttpServletResponse response = (HttpServletResponse) servletResponse;
          response.setHeader("Access-Control-Bi-Version", "feature-bi-1.8.2");
          filterChain.doFilter(servletRequest, servletResponse);
      }
      @Override
      public void destroy() {

      }
  }
  

返回结果:
17_45_04__07_15_2019

 当然,(1)feature-bi-1.8.2 直接写死是不对的,应该是配置在 application.yml 或者 application.properties中。(2)feature-bi-1.8.2 是明文也是不对的,可以有一个简单的加密算法,把feature-bi-1.8.2变成密文,需要查看的时候再解密成明文就行了。

 这样就在每个服务的任何一个接口中都加入了当前SpringBoot模块的版本号,只要登陆上系统,能看到页面,或者是接口能够调用通,就能确定当前服务的版本,再也不用把jar拷贝下来,交给对应的开发看源码,才能确定版本号。  

 一个SpringCloud项目是有几十、上百个SpringBoot子项目, 每个子项目是否成功启动,是否正常运行,需要有个心跳检测机制,我们公司的子服务心跳检测程序是每5分钟调用一次每个微服务的一个接口,这个检测程序全部调用完成后会生成一个子服务状态的汇总报告预警邮件+消息,这个预警邮件+消息中,就会有每个微服务当前部署的版本信息,这个版本信息,就是从response的header中获取Access-Control-*-Version中获取到的,具体的实现方式,请等下篇详解。

备注:不经常写博客,如果表述的啰嗦,不清晰,敬请谅解!!!!!



相关文章
|
3月前
|
开发框架 前端开发 网络协议
Spring Boot结合Netty和WebSocket,实现后台向前端实时推送信息
【10月更文挑战第18天】 在现代互联网应用中,实时通信变得越来越重要。WebSocket作为一种在单个TCP连接上进行全双工通信的协议,为客户端和服务器之间的实时数据传输提供了一种高效的解决方案。Netty作为一个高性能、事件驱动的NIO框架,它基于Java NIO实现了异步和事件驱动的网络应用程序。Spring Boot是一个基于Spring框架的微服务开发框架,它提供了许多开箱即用的功能和简化配置的机制。本文将详细介绍如何使用Spring Boot集成Netty和WebSocket,实现后台向前端推送信息的功能。
756 1
|
3月前
|
Java API 数据库
构建RESTful API已经成为现代Web开发的标准做法之一。Spring Boot框架因其简洁的配置、快速的启动特性及丰富的功能集而备受开发者青睐。
【10月更文挑战第11天】本文介绍如何使用Spring Boot构建在线图书管理系统的RESTful API。通过创建Spring Boot项目,定义`Book`实体类、`BookRepository`接口和`BookService`服务类,最后实现`BookController`控制器来处理HTTP请求,展示了从基础环境搭建到API测试的完整过程。
65 4
|
22天前
|
存储 安全 Java
Spring Boot 编写 API 的 10条最佳实践
本文总结了 10 个编写 Spring Boot API 的最佳实践,包括 RESTful API 设计原则、注解使用、依赖注入、异常处理、数据传输对象(DTO)建模、安全措施、版本控制、文档生成、测试策略以及监控和日志记录。每个实践都配有详细的编码示例和解释,帮助开发者像专业人士一样构建高质量的 API。
|
3月前
|
存储 算法 安全
SpringBoot 接口加密解密实现
【10月更文挑战第18天】
|
1月前
|
负载均衡 Java 开发者
深入探索Spring Cloud与Spring Boot:构建微服务架构的实践经验
深入探索Spring Cloud与Spring Boot:构建微服务架构的实践经验
150 5
|
2月前
|
JSON Java 测试技术
SpringCloud2023实战之接口服务测试工具SpringBootTest
SpringBootTest同时集成了JUnit Jupiter、AssertJ、Hamcrest测试辅助库,使得更容易编写但愿测试代码。
72 3
|
2月前
|
Java Spring 容器
SpringBoot读取配置文件的6种方式,包括:通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
SpringBoot读取配置文件的6种方式,包括:通过Environment、@PropertySource、@ConfigurationProperties、@Value读取配置信息
179 3
|
2月前
|
Java 开发者 Spring
精通SpringBoot:16个扩展接口精讲
【10月更文挑战第16天】 SpringBoot以其简化的配置和强大的扩展性,成为了Java开发者的首选框架之一。SpringBoot提供了一系列的扩展接口,使得开发者能够灵活地定制和扩展应用的行为。掌握这些扩展接口,能够帮助我们写出更加优雅和高效的代码。本文将详细介绍16个SpringBoot的扩展接口,并探讨它们在实际开发中的应用。
58 1
|
3月前
|
存储 安全 Java
|
4月前
|
设计模式 Java 关系型数据库
【Java笔记+踩坑汇总】Java基础+JavaWeb+SSM+SpringBoot+SpringCloud+瑞吉外卖/谷粒商城/学成在线+设计模式+面试题汇总+性能调优/架构设计+源码解析
本文是“Java学习路线”专栏的导航文章,目标是为Java初学者和初中高级工程师提供一套完整的Java学习路线。
506 37