Python Redis Flask 建立即時通訊系統

– 9 分鐘閱讀

在現今的網路應用中，即時互動功能越來越重要。本文將介紹如何利用 Python 的 Flask 框架和 Redis 資料函式庫，打造一個簡易的即時通訊系統。此係統的核心概念是利用 Redis 的 Pub/Sub（發布/訂閱）機制，讓客戶端可以訂閱特定的頻道，並即時接收伺服器發布到該頻道的訊息。Flask 負責處理 HTTP 請求和路由，並將訊息發布到 Redis。客戶端透過 WebSocket 或 Server-Sent Events 等技術與伺服器建立持久連線，接收即時訊息更新。

WSGI 協定

在設計 REST API 之前，需要了解 Python 中的 WSGI 協定。WSGI 代表 Web Server Gateway Interface，是一個用於解決框架和 Web 伺服器之間協定問題的標準。它確保了 Web 伺服器和框架之間有一個共同的協定，使得框架和 Web 伺服器不需要緊密耦合在一起。

WSGI 協定相對容易理解，所有 Python 框架都根據此協定。當 WSGI Web 伺服器載入應用程式時，它會尋找一個可呼叫的應用程式物件，該物件必須傳回一個結果給 HTTP 客戶端。這個可呼叫的物件必須命名為 application，並接受兩個引數：environ 和 start_response。WSGI 應用程式必須使用 start_response 函式來傳送狀態和標頭回應給客戶端。

基本 WSGI 應用程式

def application(environ, start_response):
    """最簡單的應用程式物件"""
    #...

這個例子展示了最基本的 WSGI 應用程式結構，該結構包括 application 函式和其引數 environ 和 start_response。

圖表翻譯：

  flowchart TD
    A[WSGI Web 伺服器] --> B[載入應用程式]
    B --> C[尋找 application 物件]
    C --> D[呼叫 application 函式]
    D --> E[傳回結果給 HTTP 客戶端]

這個圖表展示了 WSGI Web 伺服器載入應用程式的流程，包括尋找 application 物件、呼叫 application 函式和傳回結果給 HTTP 客戶端。

Web開發框架與WSGI協定

WSGI（Web Server Gateway Interface）是一種Python的Web伺服器和Web應用程式之間的標準介面。它允許開發人員使用不同的Web框架和伺服器，從而提高開發效率和應用程式的可移植性。

WSGI協定

WSGI協定定義了Web伺服器和Web應用程式之間的通訊方式。它指定了兩個主要的介面：environ和start_response。

  • environ：是一個字典，它包含了HTTP請求的相關資訊，例如請求方法、URL、HTTP頭等。
  • start_response：是一個函式，它用於傳送HTTP回應的狀態碼和頭資訊。

以下是一個簡單的WSGI應用程式範例：

def application(environ, start_response):
    status = '200 OK'
    response_headers = [('Content-type', 'text/plain')]
    start_response(status, response_headers)
    return ['Hello world!\n']

這個範例定義了一個WSGI應用程式，它傳回了一個簡單的「Hello world!」字串。

中介軟體

WSGI協定允許開發人員使用中介軟體（middleware）來處理HTTP請求和回應。中介軟體是一種特殊的WSGI應用程式，它可以處理請求和回應，並將其傳遞給下一個WSGI應用程式。

中介軟體可以用於實作ACL管理、速率限制、日誌記錄等功能。以下是一個簡單的中介軟體範例：

def middleware(environ, start_response):
    # 處理請求
    print('Request:', environ['PATH_INFO'])
    
    # 將請求傳遞給下一個WSGI應用程式
    def _start_response(status, headers, *args):
        start_response(status, headers, *args)
    
    return application(environ, _start_response)

這個範例定義了一個中介軟體，它列印了HTTP請求的PATH_INFO，並將請求傳遞給下一個WSGI應用程式。

WSGI伺服器

有許多不同的WSGI伺服器可供選擇，包括：

  • Apache httpd和mod_wsgi：是一種流行的WSGI伺服器，它提供了高效能和可靠性。
  • Gunicorn：是一種輕量級的WSGI伺服器，它提供了高效能和易於使用的介面。
  • uWSGI：是一種高效能的WSGI伺服器，它提供了多種組態選項和外掛。

以下是一個使用wsgiref.simple_server的WSGI應用程式範例：

from wsgiref.simple_server import make_server

def application(environ, start_response):
    # 處理請求
    body = 'Hello world!\n'
    status = '200 OK'
    response_headers = [('Content-type', 'text/plain')]
    start_response(status, response_headers)
    return [body]

httpd = make_server('localhost', 8051, application)
httpd.handle_request()

這個範例定義了一個WSGI應用程式，它傳回了一個簡單的「Hello world!」字串，並使用wsgiref.simple_server來啟動伺服器。

使用WSGI佈署Python Web應用程式

WSGI（Web Server Gateway Interface）是一個讓Python Web應用程式可以與Web Server溝通的標準介面。有許多WSGI伺服器可供選擇，每個都有其優缺點。

Gunicorn

Gunicorn是一個相對容易使用和佈署的WSGI伺服器。它支援多種協定，包括HTTP/1.1和WebSockets。

Waitress

Waitress是一個純Python的HTTP伺服器，支援WSGI和其他協定。它相對輕量級，易於設定。

uWSGI

uWSGI是一個功能齊全且快速的WSGI伺服器。它支援多種協定，包括HTTP/2和其他程式語言，如Perl、Ruby和Go。雖然它提供了許多設定選項，但只需設定少數選項即可執行應用程式。

佈署簡單應用程式

以下是使用uWSGI佈署簡單應用程式的範例：

$ uwsgi --http :9090 --master --wsgi-file examples/wsgi-app

這個命令啟動uWSGI伺服器，監聽9090埠，並載入examples/wsgi-app中的WSGI應用程式。

uWSGI設定

uWSGI提供了許多設定選項，以下是部分重要設定：

  • --http: 指定HTTP埠。
  • --master: 啟動主程式。
  • --wsgi-file: 指定WSGI應用程式檔案。
  • --processes: 指定工作程式數量。
  • --threads: 指定工作程式中的執行緒數量。

uWSGI執行模式

uWSGI支援多種執行模式，包括：

  • 單一程式模式（single process mode）。
  • 多程式模式（multi-process mode）。
  • 多執行緒模式（multi-thread mode）。
圖表翻譯：
  graph LR
    A[WSGI] --> B[Gunicorn]
    A --> C[Waitress]
    A --> D[uWSGI]
    D --> E[HTTP/2]
    D --> F[Perl]
    D --> G[Ruby]
    D --> H[Go]

這個圖表展示了WSGI與不同伺服器和協定的關係。uWSGI支援多種協定，包括HTTP/2和其他程式語言。

9.2 流式資料處理

在 HTTP API 中，接收事件是一種常見的模式。很多情況下，除了定期輪詢 API 之外，沒有其他方法可以實作這一功能。然而，這種方法會對 HTTP 端點造成很大的壓力，因為它需要建立新的連線，從而導致 TCP 和 SSL 的負載加重。

一個更有效的方法是使用流式資料處理。適合這種情況的技術包括由玄貓定義的 Server-Sent Events 訊息協定，或者玄貓/1.1 定義的 Transfer-Encoding: chunked，甚至是 WebSocket 協定。然而，chunked 編碼更複雜，而 WebSocket 協定對於此處介紹的簡單使用案例略顯過度。

要以可擴充套件和高效的方式實作任何流式機制，您需要確保您的後端提供此功能。它可能是一個訊息佇列、資料函式庫或任何其他提供事件流的軟體，以便應用程式可以訂閱。

如果提供的 API 必須定期輪詢其後端以取得新事件，則它只是將問題從一層轉移到另一層。這比沒有任何機制要好，但遠非理想。

本文中的示例是一個小型應用程式，該應用程式將訊息儲存在 Redis 中，並透過 HTTP REST API 提供對這些訊息的存取。每個訊息由一個頻道號碼、一個源字串和一個內容字串組成。本文中使用的後端是 Redis，因為它提供了一個通知機制，該機制接近於訊息佇列所提供的功能。

目標是將這些訊息流式傳輸給客戶端，以便它可以在其端進行實時處理。為此，我們將使用由玄貓提供的 Redis Pub/Sub 機制。

這些功能允許我們訂閱並接收由玄貓傳送的訊息。

內容解密：

以下示例展示瞭如何發布訊息到一個頻道。publish 方法將訊息傳送到作為第一個引數傳遞的頻道。第二個引數是一個字串，包含實際的 payload。

import redis

r = redis.Redis()

r.publish("chatroom", "hello world")

圖表翻譯：

此圖示展示了 Redis Pub/Sub 機制的工作原理。

  flowchart TD
    A[客戶端] -->|訂閱|> B[Redis]
    B -->|發布|> C[頻道]
    C -->|通知|> A

程式碼解說：

要檢查觸發器是否正常工作，您可以使用玄貓的 subscribe 方法。如果一切正常，它會在 PUBLISH 命令執行時立即接收到通知。

import redis

r = redis.Redis()

r.subscribe("chatroom")

這些功能使我們能夠實作流式資料處理，讓客戶端可以實時接收和處理訊息。

使用Redis和Flask打造即時通訊系統

在本文中，我們將探討如何使用Redis和Flask打造一個簡單的即時通訊系統。這個系統允許使用者訂閱特定的頻道並接收釋出到該頻道的訊息。

安裝所需套件

首先，需要安裝Redis和Flask。您可以使用pip安裝Flask：

pip install flask

同時，也需要安裝Redis的Python客戶端：

pip install redis

訂閱頻道

要訂閱一個頻道，可以使用Redis的SUBSCRIBE命令。以下是使用Redis CLI訂閱一個名為chatroom的頻道的示例：

$ redis-cli
127.0.0.1:6379> SUBSCRIBE chatroom
Reading messages... (press Ctrl-C to quit)

釋出訊息

要釋出訊息到一個頻道，可以使用Redis的PUBLISH命令。以下是釋出一條訊息到chatroom頻道的示例：

$ redis-cli
127.0.0.1:6379> PUBLISH chatroom "hello world"

使用Python接收訊息

以下是使用Python和Redis的pub/sub功能接收訊息的示例：

import redis

r = redis.Redis()
p = r.pubsub()

p.subscribe('chatroom')

for message in p.listen():
    if message["type"] == "message":
        print(message["data"].decode("utf-8"))

建立Flask應用

現在，讓我們建立一個Flask應用，提供一個端點用於釋出訊息到一個頻道。以下是示例程式碼：

from flask import Flask, jsonify
import redis

app = Flask(__name__)

def stream_messages(channel):
    r = redis.Redis()
    p = r.pubsub()
    p.subscribe(channel)
    for message in p.listen():
        if message["type"] == "message":
            yield "data: " + message["data"].decode("utf-8") + "\n\n"

@app.route("/message/<channel>", methods=['GET'])
def get_message(channel):
    return Response(stream_messages(channel), mimetype="text/event-stream")

if __name__ == '__main__':
    app.run()

測試應用

現在，讓我們測試一下應用。首先，啟動Flask應用：

$ python app.py

然後，使用Redis CLI訂閱chatroom頻道：

$ redis-cli
127.0.0.1:6379> SUBSCRIBE chatroom

最後，使用curl工具釋出一條訊息到chatroom頻道：

$ curl -X GET http://localhost:5000/message/chatroom

您應該能夠看到訊息被釋出到chatroom頻道，並且被Redis CLI接收到。

圖表翻譯：

此圖表展示了使用Redis和Flask打造即時通訊系統的架構。客戶端可以訂閱特定的頻道，並接收釋出到該頻道的訊息。Flask應用提供一個端點用於釋出訊息到一個頻道。Redis的pub/sub功能用於實作即時通訊。

  graph LR
    A[客戶端] -->|訂閱|> B[Redis]
    B -->|釋出|> C[Flask應用]
    C -->|接收|> A

內容解密：

此程式碼使用Redis的pub/sub功能實作即時通訊。客戶端可以訂閱特定的頻道，並接收釋出到該頻道的訊息。Flask應用提供一個端點用於釋出訊息到一個頻道。Redis的pub/sub功能用於實作即時通訊。

import redis

r = redis.Redis()
p = r.pubsub()

p.subscribe('chatroom')

for message in p.listen():
    if message["type"] == "message":
        print(message["data"].decode("utf-8"))

圖表翻譯：

此圖表展示了使用Redis和Flask打造即時通訊系統的架構。客戶端可以訂閱特定的頻道，並接收釋出到該頻道的訊息。Flask應用提供一個端點用於釋出訊息到一個頻道。Redis的pub/sub功能用於實作即時通訊。

  graph LR
    A[客戶端] -->|訂閱|> B[Redis]
    B -->|釋出|> C[Flask應用]
    C -->|接收|> A

建立實時訊息系統

從系統架構的視角來看，構建高效能且可擴充套件的實時訊息系統需要仔細考量多個層面的技術選型和整合策略。本文討論了從基礎的 WSGI 協定到具體的 Web 框架（Flask）以及資料函式庫（Redis）的選用與整合方式，涵蓋了伺服器選擇、中介軟體應用、以及如何利用 Redis 的 Pub/Sub 機制實作即時訊息傳遞等關鍵環節。分析顯示，WSGI 作為 Python Web 開發的基礎協定，確保了不同框架和伺服器之間的互通性，為系統的靈活性奠定了基礎；利用 Redis 的 Pub/Sub 功能，有效地解決了 HTTP 輪詢的效能瓶頸，實作了真正的即時訊息推播。然而，系統的擴充套件性仍面臨挑戰，例如 Redis 作為單點的潛在瓶頸，以及訊息持久化和訊息丟失的處理策略。未來，可以考慮整合更進階的訊息佇列系統（例如 Kafka 或 RabbitMQ），並結合分散式資料函式庫方案，以提升系統的容錯能力和訊息吞吐量。對於追求高效能和高可靠性的即時通訊應用，採用更強大的訊息基礎設施和更完善的容錯機制至關重要。玄貓認為，隨著業務規模的擴大，技術團隊應著重於解決這些核心挑戰，才能充分釋放實時訊息系統的潛力。

玄貓

玄貓

技術愛好者，專注於分享程式開發、雲端技術與 AI 應用的心得體會。