首页 文章 精选 留言 我的

WebAPi的可视化输出模式(RabbitMQ、消息补偿相关)所有webapi似乎都缺失的一个功能

2017-11-15 514

最近的工作我在做一个有关于消息发送和接受封装工作。大概流程是这样的，消息中间件是采用rabbitmq，为了保证消息的绝对无丢失，我们需要在发送和接受前对消息进行DB落地。在发送前我会先进行DB的插入，单表插入，所以在性能上也是能接受的，单表插入做了压测基本上是一到两毫秒的时间，加上消息的发送（有ACK）再加上集群是两个节点的高可用（一个磁盘持久化节点），单台TPS基本上是在2000-3000左右。这对于我们的业务场景来说是够用了。一旦当消息丢失或者由于网络问题、集群问题业务不会中断，消息就算发不出去也没关系，我们会进行消息的补偿或者同步api调用补偿。这是架构设计的必须要考虑的A计划、B计划、C计划，这是敬畏或者危机意识。

你可能又要说两个节点或者三个节点的集群怎么会有问题，那你就错了，大错特错。只能说明你并不了解什么叫分布式系统及分布式系统的特性。你也许不会知道网络抖动、网络闪断导致socket断开如何进行心跳重试已保持有效的Rabbitmq Connection。当你的网络极不稳定，你的linux keepalived VIP 来回漂移，导致你的ARP根本无法成效，可能就连广播都传不出去，而客户端则在一直使用一个无用的IP地址。当你的集群节点之间无法连接成一个整体的时候各种奇葩的问题又来了。这些都是可能导致你的集群出问题的原因，所以不要大意。

（后面我会整理一篇专门讲解“rabbitmq高可用、故障转移集群架构“文章，所以这里我们就不继续介绍了）

这是一个铺垫，本文的重点是介绍下我在尝试使用可视化webapi的输出模式，这比原本json的输出模式看起来会方便许多。如果你的api提供两种输出模式，人性化绝对很好。现在很多后端api都是没有界面的都是只提供了一个json输出。然而，我们其实很需要一个可读性很强的输出模式。

我在开发消息补偿程序的时候，我借鉴了这一思想进行了尝试。先来看下整体架构蓝图：

1

本篇文章要介绍的是有关于这个补偿程序的api的可视化输出内容。不涉及到消息相关太多的东西，只是为了让这个可视化输出看起来容易理解点。这个补偿程序需要对发送的消息和接受的消息进行查询和比较然后输出，用来确定消息的发送是失败了还是成功的。简单逻辑就是比较某个时间段内的消息发送表和接受表，然后进行消息id的匹配。

我在想这个数据反馈到api上是个什么样子的，按照常规设计就是两个字段：

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
/// <summary>
     /// 接受的消息对象。
     /// </summary>
     public  class  ReceiveMessage
     {
         /// <summary>
         /// 发送消息ID。
         /// </summary>
         public  string  SendMessageId {  get ;  set ; }
 
         /// <summary>
         /// 接受消息ID。
         /// </summary>
         public  string  ReceiveMessageId {  get ;  set ; }
     }

这表示一个消息从发送到接受的一个过程。如果失败了，可能是只有SendMessageId而没有ReceiveMessageId。然后我才会针对没有ReceiveMessageId的消息进行自动补偿。在开发的时候只有几十条消息，输出到postman中的看起来也还行，但是不直观。

2

GetReceiveMessage是获取接受消息列表，就是查看当前消息发送到接受是个什么状态。

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
/// <summary>
     /// 处理成功消息对象。
     /// </summary>
     public  class  SuccessMessage
     {
         /// <summary>
         /// 发送消息ID
         /// </summary>
         public  string  SendMessageId {  get ;  set ; }
 
         /// <summary>
         /// 接受消息ID
         /// </summary>
         public  string  ReceiveMessageId {  get ;  set ; }
 
         /// <summary>
         /// 处理成功消息ID
         /// </summary>
         public  string  SuccessMessageId {  get ;  set ; }
     }


SuccessMessage表示处理成功消息情况。此时有可能是有SendMessageId，ReceiveMessageId消息，但是SuccessMessageId可能是没有的。就会针对处理成功的消息进行发送。

3

突然受到ElasticSearch的_cat endpoint 启发。似乎这里我可以尝试下，webapi带有两种输出模式，一种是针对程序使用的json输出模式，另外一种是针对人可以阅读的模式text/plain模式，而第二种模式可以简单的理解为是行列转换缺省模式。

4

是不是看起来会很舒服。这在进行消息的时间段查看非常有帮助，如果还按照原本的json输出模式可能看起来会比较吃力。

来看下基本的api的设计，为了保证你的所有api支持?v可视化模式，需要一定的抽象：

5

需要定义一种ViewModel，所有的数据都输出这种对象，当然我这里也只是简单地封装。如果可以，其实可以专门提取出一个库出来，包括对文本的输出自动化。

我们看下BaseApiController:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
public  class  BaseApiController : ApiController
     {
         public  class  ViewModel
         {
             public  string  Content {  get ;  set ; }
             public  object  JsonObject {  get ;  set ; }
             public  bool  Success =  true ;
         }
 
         protected  bool  IsView;
         private  const  string  ViewQuerystring =  "?v" ;
         public  ViewModel ResultModel;
         private  const  string  CheckToken =  "CheckToken" ;
         private  const  string  Token =  "49BBD022-CDBF-4F94-80E4-5BCACB1192EC" ;
         private  bool  _checkStatus;
 
         public  override  Task<HttpResponseMessage> ExecuteAsync(HttpControllerContext controllerContext, CancellationToken cancellationToken)
         {
             //验证token
             if  (controllerContext.Request.Headers !=  null  && controllerContext.Request.Headers.Contains(CheckToken))
             {
                 var  requestToken = controllerContext.Request.Headers.GetValues(CheckToken).FirstOrDefault();
                 if  (requestToken !=  null  && requestToken.Equals(Token))
                 {
                     this ._checkStatus =  true ;
                 }
             }
 
             if  (!_checkStatus)
             {
                 var  checkResult =  new  Task<HttpResponseMessage>(() =>  new  HttpResponseMessage
                 {
                     Content =  new  StringContent( "非法访问，缺少token" , Encoding.UTF8,  "text/plain" )
                 }, cancellationToken);
 
                 checkResult.Start();
                 return  checkResult;
             }
 
             if  (controllerContext.Request.RequestUri.Query.Equals(ViewQuerystring))
                 this .IsView =  true ;
 
             base .ExecuteAsync(controllerContext, cancellationToken);
 
             //text模式
             if  ( this .IsView)
             {
                 var  textResult =  new  Task<HttpResponseMessage>(() =>  new  HttpResponseMessage
                 {
                     Content =  new  StringContent( this .ResultModel.Content, Encoding.UTF8,  "text/plain" )
                 }, cancellationToken);
 
                 textResult.Start();
                 return  textResult;
             }
 
             //json模式
             var  resultData =  new  Result< object >
             {
                 Data =  this .ResultModel.JsonObject,
                 Type =  this .ResultModel.Success ? ResultType.Successfully : ResultType.Failure
             };
 
             var  jsonResult =  new  Task<HttpResponseMessage>(() =>  new  HttpResponseMessage
             {
                 Content =  new  ObjectContent( typeof (Result), resultData,  new  JsonMediaTypeFormatter(),  "application/json" )
             }, cancellationToken);
 
             jsonResult.Start();
 
             return  jsonResult;
         }
     }

代码很简单，这里给我们一个启发，webapi是不是真的缺少了一个可视化模式。




 本文转自 王清培 51CTO博客，原文链接：http://blog.51cto.com/wangqingpei557/1877098，如需转载请自行联系原作者


上一篇 下一篇
优秀的个人博客,低调大师

微信关注我们

原文链接：https://yq.aliyun.com/articles/406562

转载内容版权归作者及来源网站所有！

低调大师中文资讯倾力打造互联网数据资讯、行业资源、电子商务、移动互联网、网络营销平台。持续更新报道IT业界、互联网、市场资讯、驱动更新,是最及时权威的产业资讯及硬件资讯报道平台。

亚信安全守护华南农业大学云数据中心 建智慧校园纵深防御体系

客户需求：构建面向全校教育信息化支撑的云数据中心的过程中，迎接服务器虚拟化安全挑战。 解决方案：以亚信安全服务器深度安全防护系统(Deep Security)为核心，构建多层次云安全纵深防御解决方案，实现物理和虚拟主机的全面防护，并满足现阶段和未来“等级保护制度2.0”中的信息系统合规性审计要求。 效果/客户证言：亚信安全无代理安全防护技术实现了底层虚拟机内部流量的安全防护，提供了包括防病毒、防火墙等在内全面的安全功能，帮助华南农业大学解决了虚拟化安全挑战的同时，还提高了虚拟化资源利用率，并实现了平台统一管理。——华南农业大学相关负责人 相对于传统数据中心，云计算数据中心在架构、运营和管理等方面优势明显，为高校信息化创新打开了更多窗口。然而，云计算数据中心的安全管理却未能实现“并轨而行”，底层虚拟主机的安全性缺少与之对应的技术保障。为此，华南农业大学采用亚信安全服务器深度安全防护系统(Deep Security)等产品和方案，快速构建起云时代的网络安全体系，有效解决了虚拟化等安全技术难题，满足了国家现阶段和未来等级保护制度政策法规要求，为云计算的规模化铺平了道路。 云化迁移面临安全挑战...
2017-11-16
550
上一篇

(ZT)企业文化和规章制度应如水滴一般

原文：http://www.yejun.cn 关于企业文化和规章制度的执行推广，如欲取得好的效果，应该 像水滴一样持久、细微，而不是放大炮，搞形式。正好在 王建硕那里看到了： 如果沟通不足的话，多放些沙发； 如果一个地方特别容易滋生闲谈，去掉那里的椅子，或者放几盆植物。 如果开会容易超时，要放一个大挂钟， 可以写字的玻璃墙旁边，一定要放写字笔； 同一个团队一定要坐在没有个隔板的大cubicle里面，无论多挤， 不同的团队之间，要加上隔板保护团队不受干扰； 办公室只留一个进出口，让团队的成员要有机会通过一个走廊，以便增加大家打照面的机会， 饮水机边上一定要有沙发； 如果一件事情足够重要，印在T恤衫上面分发给团队； 没有什么比免费的水果更能把大家围拢在一起； 技术团队要有一面墙画系统架构图，拓扑图，甚至核心代码 - 除非把大家在做的东西形象的展示出来，否则千万不要以为所有人都知道他们在做些什么。。。 这些都是很好的水滴。另外，我一直想作的几件事： 在会议室或家里准备一面大的玻璃墙，随时方便画图或是记录一些灵感，这是创新的环境体现； 在人多的走道或家里的走廊，客厅挂上记录历史的一些相框，这...
2017-11-16
579
下一篇

相关文章

发表评论

资源下载

更多资源
Mario

Mario

马里奥是站在游戏界顶峰的超人气多面角色。马里奥靠吃蘑菇成长，特征是大鼻子、头戴帽子、身穿背带裤，还留着胡子。与他的双胞胎兄弟路易基一起，长年担任任天堂的招牌角色。

时间: 2025-12-12 大小: 211.28KB 下载: 54次
腾讯云软件源

腾讯云软件源

为解决软件依赖安装时官方源访问速度慢的问题，腾讯云为一些软件搭建了缓存服务。您可以通过使用腾讯云软件源站来提升依赖包的安装速度。为了方便用户自由搭建服务架构，目前腾讯云软件源站支持公网访问和内网访问。

时间: 2025-12-28 大小: 1MB 下载: 4次
Spring

Spring

Spring框架（Spring Framework）是由Rod Johnson于2002年提出的开源Java企业级应用框架，旨在通过使用JavaBean替代传统EJB实现方式降低企业级编程开发的复杂性。该框架基于简单性、可测试性和松耦合性设计理念，提供核心容器、应用上下文、数据访问集成等模块，支持整合Hibernate、Struts等第三方框架，其适用范围不仅限于服务器端开发，绝大多数Java应用均可从中受益。

时间: 2025-12-17 大小: 5MB 下载: 1次
Rocky Linux

Rocky Linux

Rocky Linux（中文名：洛基）是由Gregory Kurtzer于2020年12月发起的企业级Linux发行版，作为CentOS稳定版停止维护后与RHEL（Red Hat Enterprise Linux）完全兼容的开源替代方案，由社区拥有并管理，支持x86_64、aarch64等架构。其通过重新编译RHEL源代码提供长期稳定性，采用模块化包装和SELinux安全架构，默认包含GNOME桌面环境及XFS文件系统，支持十年生命周期更新。

时间: 2026-01-03 大小: 1.42GB 下载: 2次
手机查看

扫码在手机上查看文章

扫描二维码，手机阅读更方便

热门标签
SpringBoot4 Service Mesh Docker Kubernetes HarmonyOS6 Redis Nacos3 DeepSeek Gemini3 OpenAi Rocky SpringCloud Jdk25

欢迎您来访！

登录后，您将获得更多功能！
热门文章
联系我们

有任何问题或合作意向欢迎联系我们

Email: 99873273@qq.com

QQ: 99873273

用户登录
用户注册