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中获取到的,具体的实现方式,请等下篇详解。

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



相关文章
|
7月前
|
JSON API 数据安全/隐私保护
深度分析淘宝卖家订单详情API接口,用json返回数据
淘宝卖家订单详情API(taobao.trade.fullinfo.get)是淘宝开放平台提供的重要接口,用于获取单个订单的完整信息,包括订单状态、买家信息、商品明细、支付与物流信息等,支撑订单管理、ERP对接及售后处理。需通过appkey、appsecret和session认证,并遵守调用频率与数据权限限制。本文详解其使用方法并附Python调用示例。
|
5月前
|
缓存 监控 前端开发
顺企网 API 开发实战:搜索 / 详情接口从 0 到 1 落地(附 Elasticsearch 优化 + 错误速查)
企业API开发常陷参数、缓存、错误处理三大坑?本指南拆解顺企网双接口全流程,涵盖搜索优化、签名验证、限流应对,附可复用代码与错误速查表,助你2小时高效搞定开发,提升响应速度与稳定性。
|
5月前
|
JSON 算法 API
Python采集淘宝商品评论API接口及JSON数据返回全程指南
Python采集淘宝商品评论API接口及JSON数据返回全程指南
|
6月前
|
数据可视化 测试技术 API
从接口性能到稳定性:这些API调试工具,让你的开发过程事半功倍
在软件开发中,接口调试与测试对接口性能、稳定性、准确性及团队协作至关重要。随着开发节奏加快,传统方式已难满足需求,专业API工具成为首选。本文介绍了Apifox、Postman、YApi、SoapUI、JMeter、Swagger等主流工具,对比其功能与适用场景,并推荐Apifox作为集成度高、支持中文、可视化强的一体化解决方案,助力提升API开发与测试效率。
|
5月前
|
JSON API 数据安全/隐私保护
Python采集淘宝拍立淘按图搜索API接口及JSON数据返回全流程指南
通过以上流程,可实现淘宝拍立淘按图搜索的完整调用链路,并获取结构化的JSON商品数据,支撑电商比价、智能推荐等业务场景。
|
6月前
|
JSON 前端开发 API
如何调用体育数据足篮接口API
本文介绍如何调用体育数据API:首先选择可靠服务商并注册获取密钥,接着阅读文档了解基础URL、端点、参数及请求头,然后使用Python等语言发送请求、解析JSON数据,最后将数据应用于Web、App或分析场景,同时注意密钥安全、速率限制与错误处理。
679 152
|
7月前
|
JSON 算法 安全
淘宝商品详情API接口系列,json数据返回
淘宝开放平台提供了多种API接口用于获取商品详情信息,主要通过 淘宝开放平台(Taobao Open Platform, TOP) 的 taobao.tbk.item.info.get(淘宝客商品详情)或 taobao.item.get(标准商品API)等接口实现。以下是关键信息及JSON返回示例:
|
6月前
|
人工智能 Java 机器人
基于Spring AI Alibaba + Spring Boot + Ollama搭建本地AI对话机器人API
Spring AI Alibaba集成Ollama,基于Java构建本地大模型应用,支持流式对话、knife4j接口可视化,实现高隐私、免API密钥的离线AI服务。
5370 2
基于Spring AI Alibaba + Spring Boot + Ollama搭建本地AI对话机器人API
|
6月前
|
JSON API 数据安全/隐私保护
Python采集淘宝评论API接口及JSON数据返回全流程指南
Python采集淘宝评论API接口及JSON数据返回全流程指南
|
5月前
|
人工智能 自然语言处理 测试技术
Apipost智能搜索:只需用业务语言描述需求,就能精准定位目标接口,API 搜索的下一代形态!
在大型项目中,API 数量庞大、命名不一,导致“找接口”耗时费力。传统工具依赖关键词搜索,难以应对语义模糊或命名不规范的场景。Apipost AI 智能搜索功能,支持自然语言查询,如“和用户登录有关的接口”,系统可理解语义并精准匹配目标接口。无论是新人上手、模糊查找还是批量定位,都能大幅提升检索效率,降低协作成本。从关键词到语义理解,智能搜索让开发者少花时间找接口,多专注核心开发,真正实现高效协作。