摘要：理解協(xié)議協(xié)議只能通過(guò)客戶端發(fā)起請(qǐng)求來(lái)與客戶端進(jìn)行通訊這是一個(gè)缺陷。與協(xié)議有著良好的兼容性。以下的表格內(nèi)容顯示數(shù)據(jù)局里的內(nèi)容，每秒局部刷新一次表格內(nèi)容。歡迎大俠能夠給我的項(xiàng)目提出修改意見(jiàn)，先行感謝源碼下載參考基于的操作教程阮一峰

Flask 作為一個(gè)全棧架構(gòu)，如果你只會(huì) python，而不懂 javascript 的前端知識(shí)，似乎是無(wú)法支撐起你的 web 夢(mèng)想的，比如，一個(gè)簡(jiǎn)單的頁(yè)面 局部刷新 功能，你就需要用到 ajax 的知識(shí)，當(dāng)然，你還可以使用 HTML5 的新特性 —— websocket功能，好在 flask 還提供了一個(gè) flask-socketio 插件，本文我們就探討一下這個(gè) flask-scoketio插件的用法。

HTTP 協(xié)議只能通過(guò)客戶端發(fā)起請(qǐng)求來(lái)與客戶端進(jìn)行通訊 —— 這是一個(gè)缺陷。

通過(guò)websocket 協(xié)議，服務(wù)器可以主動(dòng)向客戶端推送信息，客戶端也可以主動(dòng)向服務(wù)器發(fā)送信息，是真正的雙向平等對(duì)話，屬于服務(wù)器推送技術(shù)的一種。

建立在 TCP 協(xié)議之上，服務(wù)器端的實(shí)現(xiàn)比較容易。

與 HTTP 協(xié)議有著良好的兼容性。默認(rèn)端口也是80和443，并且握手階段采用 HTTP 協(xié)議，因此握手時(shí)不容易屏蔽，能通過(guò)各種 HTTP 代理服務(wù)器。

數(shù)據(jù)格式比較輕量，性能開銷小，通信高效。

可以發(fā)送文本，也可以發(fā)送二進(jìn)制數(shù)據(jù)。

沒(méi)有同源限制，客戶端可以與任意服務(wù)器通信。

協(xié)議標(biāo)識(shí)符是ws（如果加密，則為wss），服務(wù)器網(wǎng)址就是 URL。

pip install flask-socketio

本文是在 《基于 flask 的 CRUD 操作》 的基礎(chǔ)上增加了 webscoket 的功能，使用的是 init_app() 的形式加載 flask-socketio 插件，和網(wǎng)上的大多數(shù)教程稍有不同。

flask-wtf-crud/
|-- env/
    |-- 
|-- app/ <項(xiàng)目的模塊名稱>
    |-- crud/ <前端藍(lán)圖>
        |-- __init__.py
        |-- views.py <路由和視圖函數(shù)文件>
        |-- forms.py <表單類文件, wtforms插件必須項(xiàng)>
        |-- templates 
            |-- static <靜態(tài)文件夾>
                |-- js 
                    |-- crud.js # 異步請(qǐng)求的程序主要在此添加
    |-- XXXXXX/ <其它藍(lán)圖>
    |-- __init__.py
    |-- models.py <數(shù)據(jù)庫(kù)模型文件>
|-- migrations/ <數(shù)據(jù)庫(kù)表關(guān)系文件夾,Flask-Migrate遷移數(shù)據(jù)庫(kù)時(shí)使用>
|-- config.py <項(xiàng)目的配置文件>
|-- manage.py <用于啟動(dòng)程序以及其它程序任務(wù)>

# -*- coding:utf-8 -*-
__author__ = "東方鶚"
__blog__ = u"http://www.os373.cn"

import os
from app import create_app, db, socketio
from app.models import User
from flask_script import Manager, Shell
from flask_migrate import Migrate, MigrateCommand


app = create_app(os.getenv("FLASK_CONFIG") or "default")
manager = Manager(app=app)
migrate = Migrate(app=app, db=db)

def make_shell_context():
    return dict(app=app, db=db, User=User)


manager.add_command("shell", Shell(make_context=make_shell_context))
manager.add_command("db", MigrateCommand)
manager.add_command("run", socketio.run(app=app, host="0.0.0.0", port=5001)) # 新加入的內(nèi)容


if __name__ == "__main__":
    manager.run()

# -*- coding:utf-8 -*-
__author__ = "東方鶚"
__blog__ = u"http://www.os373.cn"

from flask import Flask
from flask_sqlalchemy import SQLAlchemy
from config import config
from flask_socketio import SocketIO # 新加入的內(nèi)容
db = SQLAlchemy()

async_mode = None
socketio = SocketIO()


def create_app(config_name):
    """ 使用工廠函數(shù)初始化程序?qū)嵗?""
    app = Flask(__name__)
    app.config.from_object(config[config_name])
    config[config_name].init_app(app=app)

    db.init_app(app=app)

    socketio.init_app(app=app, async_mode=async_mode) # 新加入的內(nèi)容

    # 注冊(cè)藍(lán)本crud
    from .crud import crud as crud_blueprint
    app.register_blueprint(crud_blueprint, url_prefix="/crud")

    return app

# -*- coding:utf-8 -*-
__author__ = "東方鶚"
__blog__ = u"http://www.os373.cn"

from flask import render_template, redirect, request, current_app, url_for, flash, json
from . import crud
from ..models import User
from .forms import AddUserForm, DeleteUserForm, EditUserForm
from ..import db
from threading import Lock
from app import socketio # 新加入的內(nèi)容
from flask_socketio import emit # 新加入的內(nèi)容

# 新加入的內(nèi)容-開始
thread = None
thread_lock = Lock()

def background_thread(users_to_json):
    """Example of how to send server generated events to clients."""
    while True:
        socketio.sleep(5)  每五秒發(fā)送一次

        socketio.emit("user_response", {"data": users_to_json}, namespace="/websocket/user_refresh")
# 新加入的內(nèi)容-結(jié)束

@crud.route("/", methods=["GET", "POST"])
def index():

    return render_template("index.html")


@crud.route("/websocket", methods=["GET", "POST"])
def websocket():
    add_user_form = AddUserForm(prefix="add_user")
    delete_user_form = DeleteUserForm(prefix="delete_user")
    if add_user_form.validate_on_submit():
        if add_user_form.role.data == u"True":
            role = True
        else:
            role = False
        if add_user_form.status.data == u"True":
            status = True
        else:
            status = False
        u = User(username=add_user_form.username.data.strip(), email=add_user_form.email.data.strip(),
                 role=role, status=status)
        db.session.add(u)
        flash({"success": u"添加用戶<%s>成功！" % add_user_form.username.data.strip()})
    if delete_user_form.validate_on_submit():
        u = User.query.get_or_404(int(delete_user_form.user_id.data.strip()))
        db.session.delete(u)
        flash({"success": u"刪除用戶<%s>成功！" % u.username})

    users = User.query.all()

    return render_template("websocket.html", users=users, addUserForm=add_user_form, deleteUserForm=delete_user_form)


@crud.route("/websocket-edit/", methods=["GET", "POST"])
def user_edit(user_id):
    user = User.query.get_or_404(user_id)
    edit_user_form = EditUserForm(prefix="edit_user", obj=user)
    if edit_user_form.validate_on_submit():
        user.username = edit_user_form.username.data.strip()
        user.email = edit_user_form.email.data.strip()
        if edit_user_form.role.data == u"True":
            user.role = True
        else:
            user.role = False
        if edit_user_form.status.data == u"True":
            user.status = True
        else:
            user.status = False
        flash({"success": u"用戶資料已修改成功！"})
        return redirect(url_for(".basic"))

    return render_template("edit_websocket.html", editUserForm=edit_user_form, user=user)

# 新加入的內(nèi)容-開始
@socketio.on("connect", namespace="/websocket/user_refresh")
def connect():
    """ 服務(wù)端自動(dòng)發(fā)送通信請(qǐng)求 """
    global thread
    with thread_lock:
        users = User.query.all()
        users_to_json = [user.to_json() for user in users]

        if thread is None:
            thread = socketio.start_background_task(background_thread, (users_to_json, ))
    emit("server_response", {"data": "試圖連接客戶端！"})


@socketio.on("connect_event", namespace="/websocket/user_refresh")
def refresh_message(message):
    """ 服務(wù)端接受客戶端發(fā)送的通信請(qǐng)求 """

    emit("server_response", {"data": message["data"]})
# 新加入的內(nèi)容-結(jié)束

---------- 以上內(nèi)容是后端的內(nèi)容，以下內(nèi)容是將是前段的內(nèi)容 ----------

$(document).ready(function () {
    namespace="/websocket/user_refresh";
    var socket = io.connect(location.protocol + "http://" + document.domain + ":" + location.port + namespace);
    $("#url_show").text("websocket URL: " + location.protocol + "http://" + document.domain + ":" + location.port + namespace);

    socket.on("connect", function() { // 發(fā)送到服務(wù)器的通信內(nèi)容
        socket.emit("connect_event", {data: "我已連接上服務(wù)端！"});
    });

    socket.on("server_response", function(msg) {
         顯示接受到的通信內(nèi)容，包括服務(wù)器端直接發(fā)送的內(nèi)容和反饋給客戶端的內(nèi)容
        $("#log").append("
" + $("
").text("接收 : " + msg.data).html());
    });
    socket.on("user_response", function(msg) {
        //console.log(eval(msg.data[0]));
        //$("#users_show").append("
" + $("
").text("接收 : " + msg.data).html());
        var tbody = "";
        var obj = eval(msg.data[0]);
        $.each(obj, function (n, value) {
            var role = "";
            if (value.role===true){
                role = "管理員";
            }else {
                role = "一般用戶";
            }
            var status = "";
            if (value.status===true){
                status = "正常";
            }else {
                status = "注銷";
            }
            edit_url = " 修改";
            delete_url = "刪除";
            var trs = "";
            trs += "" + (n+1) + "" + value.username + "" + value.email + "" + role + "" + status + "" + edit_url + " | " + delete_url +"";
            tbody += trs;
        })
        $("#users_show").empty();
        $("#users_show").append(tbody);
    });
});

每次打開網(wǎng)頁(yè)，會(huì)顯示服務(wù)端發(fā)送的內(nèi)容——“試圖連接客戶端！”，其后，客戶端返回給服務(wù)端——“我已連接上服務(wù)端！”，而后又被服務(wù)端返回給客戶端顯示。

以下的表格內(nèi)容顯示數(shù)據(jù)局里的內(nèi)容，每 5 秒局部刷新一次表格內(nèi)容。

服務(wù)器后端 log 日志內(nèi)容如下：

由于 flask 架構(gòu)具有上下文的限制，在數(shù)據(jù)庫(kù)里 增加刪改 內(nèi)容的時(shí)候，表格的內(nèi)容沒(méi)有變化——盡管局部已經(jīng)進(jìn)行了刷新。要想顯示變化后的數(shù)據(jù)庫(kù)內(nèi)容，必須得重新啟動(dòng)一下 flask 服務(wù)。

就整體的部署來(lái)說(shuō)，在 flask 項(xiàng)目里添加 websocket 協(xié)議，顯得項(xiàng)目較重，實(shí)現(xiàn)一個(gè)局部刷新的功能還是用 ajax 比較簡(jiǎn)單。

歡迎大俠能夠給我的項(xiàng)目提出修改意見(jiàn)，先行感謝！?。?/p>

源碼下載

基于 flask 的 CRUD 操作

WebSocket 教程 —— 阮一峰