基于 flask-socketio 的 CRUD 操作初探

K_B_Z 發(fā)布于2019-07-31 11:01 / 1891人閱讀

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

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

理解 websocket 協(xié)議

HTTP 協(xié)議只能通過客戶端發(fā)起請求來與客戶端進行通訊 —— 這是一個缺陷。

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

websocket 協(xié)議特性

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

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

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

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

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

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

使用 flask-socketio 安裝插件

pip install flask-socketio

項目結(jié)構(gòu)

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

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

將 flask-socketio 引入項目 修改 manage.py 內(nèi)容

# -*- 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()

　修改 app/__init__.py 內(nèi)容

# -*- 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)容

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

    return app

當(dāng)前藍圖的 views.py

# -*- 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ù)端自動發(fā)送通信請求 """
    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ā)送的通信請求 """

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

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

crud.js 內(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);
    });
});

顯示結(jié)果

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

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

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

總結(jié)

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

就整體的部署來說，在 flask 項目里添加 websocket 協(xié)議，顯得項目較重，實現(xiàn)一個局部刷新的功能還是用 ajax 比較簡單。

歡迎大俠能夠給我的項目提出修改意見，先行感謝！！！

源碼下載

參考

基于 flask 的 CRUD 操作

WebSocket 教程 —— 阮一峰

GPU云服務(wù)器云服務(wù)器基于linux的操作系統(tǒng) 基于linux的操作系統(tǒng)有 CRUD ofbiz crud

文章版權(quán)歸作者所有，未經(jīng)允許請勿轉(zhuǎn)載,若此文章存在違規(guī)行為，您可以聯(lián)系管理員刪除。

轉(zhuǎn)載請注明本文地址：http://systransis.cn/yun/44491.html

發(fā)表評論

登陸后可評論

0條評論

K_B_Z

男|高級講師

我要關(guān)注我要私信

TA的文章

心血來潮，總結(jié)技術(shù)框架

閱讀 2553·2021-10-11 10:58
Parcel 打包示例 - React HelloWorld

閱讀 1038·2019-08-29 13:58
2019前端面試題（持續(xù)更新）

閱讀 1674·2019-08-26 13:32
css頁面布局技巧

閱讀 838·2019-08-26 10:40
一個基于 Vue 的地區(qū)選擇器v-distpicker

閱讀 3265·2019-08-26 10:18
require.js學(xué)習(xí)筆記。

閱讀 1764·2019-08-23 14:18
原生Js-msi系統(tǒng)

閱讀 1113·2019-08-23 10:54
小程序授權(quán)功能（廢）

閱讀 442·2019-08-22 18:39

成人国产在线小视频_日韩寡妇人妻调教在线播放_色成人www永久在线观看_2018国产精品久久_亚洲欧美高清在线30p_亚洲少妇综合一区_黄色在线播放国产_亚洲另类技巧小说校园_国产主播xx日韩_a级毛片在线免费

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！

基于 flask-socketio 的 CRUD 操作初探

相關(guān)文章

利用K8S技術(shù)棧打造個人私有云（連載之：K8S資源控制）

利用K8S技術(shù)棧打造個人私有云（連載之：K8S資源控制）

基于websocket的celery任務(wù)狀態(tài)監(jiān)控

angular開發(fā)中問題記錄--啟動過程初探

Babylon-AST初探-實戰(zhàn)

發(fā)表評論

0條評論

K_B_Z

男|高級講師

TA的文章

心血來潮，總結(jié)技術(shù)框架

Parcel 打包示例 - React HelloWorld

2019前端面試題（持續(xù)更新）

css頁面布局技巧

一個基于 Vue 的地區(qū)選擇器v-distpicker

require.js學(xué)習(xí)筆記。

原生Js-msi系統(tǒng)

小程序授權(quán)功能（廢）

最新活動

資訊專欄INFORMATION COLUMN

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！

基于 flask-socketio 的 CRUD 操作初探

相關(guān)文章

發(fā)表評論

0條評論

男|高級講師

TA的文章

最新活動

上云采購季！| 2核2G4M爆款云服務(wù)器低至59元/年，更有多臺、長期優(yōu)惠，快來選購！