Flaskでウェブソケットをどのように実装し、応用するのかを具体的なコード例とともに解説します。この記事では、基本的なウェブソケットの設定から、リアルタイムのチャットアプリケーションや非同期タスクの管理まで、幅広い応用例を取り上げます。
目次
ウェブソケットとは
ウェブソケット（WebSocket）は、ウェブサーバとクライアントが双方向でリアルタイムに通信するためのプロトコルです。HTTPとは異なり、一度接続が確立されればその接続は維持され、任意のタイミングで双方向のデータ送受信が可能です。
Flaskでのウェブソケットの基本設定
Flaskでは、`Flask-SocketIO`というライブラリを用いて容易にウェブソケットを導入できます。
インストールと初期設定
まずは`Flask-SocketIO`をインストールします。
pip install flask-socketio
そして、以下のようにFlaskアプリケーションに組み込みます。
from flask import Flask, render_template
from flask_socketio import SocketIO
app = Flask(__name__)
socketio = SocketIO(app)
# 以下にルーティングなどの設定
簡単なチャットアプリケーションの作成
サーバーサイドの設定
基本的なチャットアプリケーションを作成するため、以下のようにサーバーサイドを設定します。
# サーバー側の処理
@socketio.on('message')
def handle_message(msg):
# クライアントから受け取ったメッセージを全クライアントに送信
socketio.emit('message', msg)
クライアントサイドの設定
JavaScriptを用いてクライアントサイドも設定します。
// クライアント側の処理
var socket = io.connect('http://' + document.domain + ':' + location.port);
socket.on('message', function(msg) {
// サーバーから受け取ったメッセージを画面に表示
$('#chat').append('' + msg + '
');
});
応用例
非同期タスクの管理
ウェブソケットを使用して、非同期で実行されるタスクの進捗をリアルタイムでユーザーに通知することもできます。
import time
@socketio.on('start_task')
def handle_task(msg):
for i in range(10):
time.sleep(1)
socketio.emit('task_update', {'progress': i * 10})
複数のルームを持つチャットアプリケーション
`sio.enter_room`と`sio.leave_room`を使用して、複数のチャットルームを設定することもできます。
from flask_socketio import join_room, leave_room
@socketio.on('join')
def on_join(data):
room = data['room']
join_room(room)
socketio.emit('message', f'{username} has entered the room.', room=room)
まとめ
この記事では、Flaskでウェブソケットを利用する基本的な方法から応用例までを解説しました。ウェブソケットはリアルタイムの通信が必要な多くのアプリケーションで役立つ重要なテクノロジーです。今回学んだ知識を使って、是非自分自身のプロジェクトに応用してみてください。
コメント