[Django] ChannelsでRedisをバックエンドに設定するには？

Django Channelsでは、

WebSocketなどのリアルタイム機能を実装するために、
Redisをバックエンドとして使用することが一般的。

具体的には、
Channelsは「チャンネルレイヤー」という概念を導入しており、
これにより複数のconsumerインスタンスが互いに通信でき、
このチャンネルレイヤーのバックエンドとして使用できる。

ChannelsでRedisをバックエンドに設定

Django ChannelsでRedisをバックエンドに設定する手順は以下の通りです。

1. Redisのインストール

まず、ローカルにRedisをインストールするか、Dockerを使用してRedisを実行します。以下は、Dockerを使用してRedisを実行するコマンドの例です。

docker run -p 6379:6379 --name my-redis -d redis

2. Channelsとchannels-redisのインストール

次に、Django Channelsとchannels-redisをインストールします。channels-redisは、Redisをバックエンドとして使用するためのパッケージです。

pip install channels channels-redis

3. Djangoの設定

Djangoの設定ファイル（通常は settings.py）を開き、以下の設定を追加または変更します。

3.1 INSTALLED_APPSにchannelsを追加

INSTALLED_APPS = [
    # ...
    'channels',
    # ...
]

3.2 CHANNEL_LAYERS設定を追加

# settings.py

CHANNEL_LAYERS = {
    'default': {
        'BACKEND': 'channels_redis.core.RedisChannelLayer',
        'CONFIG': {
            "hosts": [('127.0.0.1', 6379)],  # Redisのアドレスとポートを指定
        },
    },
}

3.3 ASGIアプリケーションの設定

ASGIアプリケーションの設定も追加する必要があります。これには、asgi.py ファイルをプロジェクトのメインディレクトリ（settings.py があるディレクトリと同じ場所）に作成します。

# asgi.py

import os
from django.core.asgi import get_asgi_application
from channels.routing import ProtocolTypeRouter, URLRouter
from channels.auth import AuthMiddlewareStack

os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'myproject.settings')  # 'myproject'はあなたのプロジェクト名に置き換えてください

application = ProtocolTypeRouter({
    "http": get_asgi_application(),
    # ... 他のプロトコルタイプのルーターもここに追加できます
})

4. ルーティングの設定

最後に、WebSocketのルーティングを設定します。これには、routing.py ファイルをアプリケーションのディレクトリに作成し、以下のように記述します。

# routing.py

from django.urls import re_path

from . import consumers

websocket_urlpatterns = [
    re_path(r'ws/some_path/$', consumers.MyConsumer.as_asgi()),  # 'some_path'と'MyConsumer'はあなたの設定に応じて変更してください
]

そして、asgi.py ファイルを以下のように更新して、WebSocketのルーティングを追加します。

# asgi.py

# ... (他のインポート文)
from myapp import routing  # 'myapp'はあなたのアプリケーション名に置き換えてください

application = ProtocolTypeRouter({
    "http": get_asgi_application(),
    "websocket": AuthMiddlewareStack(
        URLRouter(
            routing.websocket_urlpatterns
        )
    ),
})

以上で、Django ChannelsでRedisをバックエンドに設定する準備が整いました。これで、WebSocketを使用してリアルタイムの通信を行うアプリケーションを開発することができます。

おわりに

redisを使うにしてもどういう風にDjangoと連携するのか想像できないというような人向けにコード付きで手順の例を載せてみました。

誰かの役に立ちますように！