ASP.NET Core2基于RabbitMQ对Web前端实现推送功能

时间:2023-03-09 05:44:23
ASP.NET Core2基于RabbitMQ对Web前端实现推送功能

在我们很多的Web应用中会遇到需要从后端将指定的数据或消息实时推送到前端,通常的做法是前端写个脚本定时到后端获取,或者借助WebSocket技术实现前后端实时通讯。因定时刷新的方法弊端很多(已不再采用),所以基于WebSocket技术实现的通讯方案正越来越受大家喜爱,于是在ASP.NET中就有了鼎鼎大名的Signalr。但Signalr不是咱们这里的主角,这里将给大家介绍另一套基于WebSocket的前后端通讯方案,可以给大家在应用中多一个选择。

准备

在开始动手前,咱们先简单介绍下方案的组成部分,如下:

RabbitMQ:是一个成熟的MQ队列服务,由 Erlang 语言开发的 AMQP 的开源实现。这里用来接收后端的指令并广播到前端(基于topic模式)。关于更多RabbitMQ的实现可以查看我另一篇文章,传送门

RabbitMQ插件stomp:是一个让RabbitMQ支持stomp协议的插件,必需安装后才能通过RabbitMQ实现前端通讯。安装说明在此:http://www.rabbitmq.com/stomp.html

stomp.js:是一个基于stomp协议的客户端实现,底层基于WebSocket通讯协议。这里用于前端实现WebSocket通讯。官网地址:https://github.com/jmesnil/stomp-websocket

Lezhima.Rest:是一个基于ASP.NET Core2的Web Api后端程序,用来模拟向前端发送指令。

Lezhima.Site:是一个纯前端技术的前端程序,用来模拟前端实时接收后台的指令。

实现

如上面所述,我们已经清楚了整个实现思路,那么下面就来看看具体的代码实现吧。

1、首先来看看Lezhima.Rest的MQ生产者代码,如下:

 /// <summary>
 /// MQ生产者,采用topic模式推送指定内容
 /// </summary>
 /// <param name="objText"></param>
 public static void PushMessage(string objText)
 {
     //创建MQ连接工厂
     var factory = new ConnectionFactory()
     {
         HostName = "localhost",
         Port = 5672,
         UserName = "fans",
         Password = ""
     };
     //创建MQ连接
     using (var connection = factory.CreateConnection())
     using (var channel = connection.CreateModel())
     {
         //绑定交换器
         channel.ExchangeDeclare(exchange: "topic/test", type: "topic");
         var body = Encoding.UTF8.GetBytes(objText);
         //对指定routingkey发送内容
         channel.BasicPublish(exchange: "amq.topic",
                             routingKey: "test",
                             basicProperties: null,
                             body: body);
     }
 }

2、Lezhima.Site的前端代码,如下:

 <!DOCTYPE html>
 <html>
 <head>
     <meta charset="utf-8">
     <link href="main.css" rel="stylesheet" type="text/css" />
     <script src="Script/jquery.js"></script>
     <script src="stomp.js"></script>
     <style>

         .box {
             width: 440px;
             float: left;
             margin: 0 20px 0 20px;
         }
         .box div, .box input {
             border: 1px solid;
             -moz-border-radius: 4px;
             border-radius: 4px;
             width: 100%;
             padding: 5px;
             margin: 3px 0 10px 0;
         }

         .box div {
             border-color: grey;
             height: 300px;
             overflow: auto;
         }

         div code {
             display: block;
         }

         #first div code {
             -moz-border-radius: 2px;
             border-radius: 2px;
             border: 1px solid #eee;
             margin-bottom: 5px;
         }
     </style>
 </head>
 <body lang="en">
     <div id="first" class="box">
         <h2>接收来自后端的消息</h2>
         <div></div>
     </div>
     <script>
         var has_had_focus = false;
         //封装个接收呈现方法
         var pipe = function (el_name) {
             var div = $(el_name + ' div');
             var print = function (m) {
                 div.append($("<code>").text('后端的指令:'+ m));
                 div.scrollTop(div.scrollTop() + 10000);
             };
             return print;
         };

         //RabbitMQ的服务地址
         var mqUrl = "ws://localhost:15674/ws";
         //声明个Stompjs客户端
         var client = Stomp.client(mqUrl);

         var print_first = pipe('#first', function (data) {
             client.send('/topic/test', { "content-type": "text/plain" }, data);
         });

         //监听连接事件
         var on_connect = function (x) {
             id = client.subscribe("/topic/test", function (d) {
                 print_first(d.body);
             });
         };
         var on_error = function () {
             console.log('error');
         };
         //连接MQ
         client.connect('fans', '123456', on_connect, on_error, '/');

     </script>
 </body>
 </html>
 

3、分别运行“Lezhima.Rest”与“Lezhima.Site”程序后,效果是这个样子的,如下:

ASP.NET Core2基于RabbitMQ对Web前端实现推送功能

总结

1、借助RabbitMQ实现前后端通讯功能时,必需先安装RabbitMQ插件stomp,通过该插件可使RabbitMQ支持WebSocket通讯能力。而我们的后端开发人员只需通过“生产者”方法按需向MQ发送数据即可,MQ将根据routingKey广播给所有客户端(消费者)。

2、前端借助stomp.js可以简便的实现与RabbitMQ通讯,并绑定相应的routingKey后承担MQ消费者的能力,以达到前后端即时推送的效果。

声明

本文为作者原创,转载请备注出处与保留原文地址,谢谢。如文章能给您带来帮助,请点下推荐或关注,感谢您的支持!