SSE(Server-sent events)技术在web端消息推送和实时聊天中的使用

小程序：扫一扫查出行
【扫一扫了解最新限行尾号】
复制小程序

最近在公司闲着没事研究了几天，终于搞定了SSE从理论到实际应用，中间还是有一些坑的。

1.SSE简介

SSE(Server-sent events)翻译过来为：服务器发送事件。是基于http协议，和WebSocket的全双工通道（web端和服务端相互通信）相比，SSE只是单通道（服务端主动推送数据到web端），但正是由于此特性，在不需要客户端频繁发送消息给服务端，客户端却需要实时或频繁显示服务端数据的业务场景中可以使用。如：新邮件提示，在浏览网页时提示有新信息或新博客，监控系统实时显示数据。。。

在web端消息推送功能中，由于传统的http协议需要客户端主动发送请求，服务端才会响应;基本的ajax轮寻技术便是如此，但是此方法需要前端不停的发送ajax请求给后端服务，无论后端是否更新都要执行相应的查询，无疑会大大增加服务器压力，浪费不必要的资源。而SSE解决了这种问题，不需前端主动请求，后端如果有更新便会主动推送消息给web端。

在SSE中，浏览器发送一个请求给服务端，通过响应头中的Content-Type：text/event-stream;等向客户端证明这是一个长连接，发送的是流数据，这时客户端不会关闭连接，一直等待服务端发送数据。

关于SSE的前端用法请自行百度或参考一下连接：

http://www.ruanyifeng.com/blog/2017/05/server-sent_events.html

2.python框架flask中SSE的包flask_sse的使用

坑点：刚开始根据，自信的以为在服务器返回数据时只要是response头部添加这三个字段便实现了SSE功能，但是在flask启动自带服务器后，发现浏览器总是触发error事件，并且从新连接。这样的话和ajax轮询没有任何区别。

后来找到flask框架的flask_sse文档 http://flask-sse.readthedocs.io/en/latest/quickstart.html 其中发现：

Server-sent events do not work with Flask’s built-in development server, because it handles HTTP requests one at a time. The SSE stream is intended to be an infinite stream of events, so it will never complete. If you try to run this code on with the built-in development server, the server will be unable to take any other requests once you connect to this stream. Instead, you must use a web server with asychronous workers. Gunicorn can work with gevent to use asychronous workers: see gunicorn’s design documentation.

flask内置服务器不适合SSE功能，一次只能处理一个请求。所以只能使用具有异步功能的服务器来完成此项功能。所以本人想在不引入任何包的情况下完成此功能是不可能的了。

在官方给出的flask_sse 文档中,使用 gunicorn（WSGI协议的一个容器，和uWSGI一样的功能） + gevent 作为异步功能的服务器。

ubuntu系统中安装：pip install flask-sse gunicorn gevent

由于官方文档中给出的实例代码是MTV（model-template-view）模式,前后端代码杂糅在一起，看着不舒服，于是改成了restful风格的代码。

下面给出restful风格的flask_sse实现的实时聊天（消息推送）功能。

后端主要文件

sse.py

#coding:utf8
# 将程序转换成可以使用gevent框架的异步程序
from gevent import monkey
monkey.patch_all() from flask import Flask, send_from_directory, redirect, url_for, request, jsonify
from flask_sse import sse app = Flask(__name__)
#redis路径
app.config["REDIS_URL"] = "redis://localhost"
#app注册sse的蓝图,并且访问路由是/stream1
app.register_blueprint(sse, url_prefix='/stream1') #重定向到发送消息页面
@app.route('/')
def index():
return redirect(url_for('.index', _external=True) + 'upload/'+'send_messages.html') #接收send_messages.html文件中接口发送的数据，并且通过sse实时推送给用户
@app.route('/messages',methods=['POST'])
def send_messages():
channel=request.values.get('channel')
message=request.values.get('message') #关于channel的使用==> http://flask-sse.readthedocs.io/en/latest/advanced.html
#如channel是channel_bob，则只有channel_bob.html才能接收数据
#sse推送消息
sse.publish({"message": message}, type='social', channel=channel)
return jsonify({'code': 200, 'errmsg': 'success', 'data': None}) @app.route('/upload/<path:path>')
def send_file(path):
return send_from_directory('upload/', path) if __name__=='__main__':
app.run()

前端接收消息文件

channel_bob.html

<!DOCTYPE html>
<html>
<head>
<title>Flask-SSE Quickstart</title>
</head>
<body>
<h1>Channel:channel_bob</h1>
<div id="get_message"></div>
<script src="jquery-3.1.1.js" type="text/javascript" charset="utf-8"></script>
<script>
$(function () {
//只接收channel为channel_bob的消息
var source = new EventSource("/stream1?channel=channel_bob");
source.addEventListener('social', function (event) {
var data = JSON.parse(event.data);
$('#get_message').append(data.message+'    ');
}, false);
source.addEventListener('error', function (event) {
console.log('reconnected service!')
}, false);
})
</script>
</body>
</html>

前端发送消息文件

send_messages.html

<!DOCTYPE html>
<html>
<head>
<meta charset="UTF-8">
<title></title>
</head>
<body>
channel:<input type="text" id="channel" value=""/>
<div>You can choise these channels: channel_bob,channel_tom,channel_public</div>
<br/>
message:<input type="text" id="message" value=""/>
<br/>
<button id="button">send message</button>
<div id="success"></div>
<script src="jquery-3.1.1.js" type="text/javascript" charset="utf-8"></script>
<script type="text/javascript">

$(function () {
$("#button").click(function () {
var channel = $('#channel').val();
var message = $('#message').val();
var json_data = {
'channel': channel,
'message': message
}
var http_url = 'http://127.0.0.1:5000/';
$.ajax({
url: http_url + "messages",
type: 'post',
dataType: "json",
data: json_data,
success: function (data) {
if (data.code == 200) {
$('#success').text('Send message success!')
}
},
error: function (jqXHR, textStatus, errorThrown) {
console.log(textStatus)
hide_popover('#user_deatil_submit', '程序错误,请联系管理员')
}
});
});
})
</script>
</body>
</html>