【Django】セッションSessionとは：使用方法（保存や読み込み）と各種設定について

Sessionの有効化

Djangoはフルスタックフレームワークと言われるほど標準で豊富な機能を備えています。セッション機能に関しても、最初から使えるようになっています。

settings.pyのINSTALLED_APPSとMIDDLEWAREに以下セッション機能が追加されているか確認しておきましょう。

INSTALLED_APPS = [
    …
    'django.contrib.sessions',
]
MIDDLEWARE = [
    …
    'django.contrib.sessions.middleware.SessionMiddleware',
]

上記sessionの設定はデフォルトで記入されており、これらによりセッション管理機能が使えるようになります。

ここで設定を確認したsettings.pyはWebアプリケーションを開発する上でとても重要なファイルであり、プロジェクトの各種設定を記述するファイルです。

settings.pyについて詳しくは以下記事をご参照ください。

【Django】settings.py：各設定値の解説（まとめ・一覧）

Sessionエンジン設定

セッションデータの保存先は以下の中から選ぶことができます。

• データベース
• ファイル
• キャッシュ
• クッキー

ユーザー毎のSession（データ）はデフォルト設定ではdjango.contrib.sessions.models内のSessionモデルを介してデータベースに保存されます。
Sessionが保存されるデータベースのテーブル名はdjango_sessionです。

データベースにセッションを保存する仕組みはINSTALLED_APPSに記入してあるdjango.contrib.sessionsによるものです。

またDjangoでは簡単にSessionをファイルやキャッシュに保存するように変更することができます。

セッションデータの保存先を変更するにはSessionエンジン（セッションエンジン）を変更します。

Sessionの保存先をキャッシュに変更

Sessionの保存先をキャッシュにすることで、サーバーのパフォーマンスが良くなり処理が高速になることが望めます。

保存先をキャッシュに変更するにはsettings.pyに以下を追加します。

SESSION_ENGINE = ‘django.contrib.sessions.backends.cache'

Sessionの保存先をファイルに変更

Sessionの保存先をファイルに変更するにはsettings.pyに以下を追加します。

SESSION_ENGINE = 'django.contrib.sessions.backends.file'

セッションファイルはデフォルトではtempfile.gettempdir()で指定される/tmpに保存されます。

セッションファイルを保存する場所を指定したい場合は、settings.pyにSESSION_FILE_PATHで指定してください。

セッションへのデータ保存

セッションデータはHttpRequestオブジェクト（関数で最初に受け取る引数request）のsession属性（request.session）に格納されています。

HttpRequestオブジェクトとはDjangoサーバーがユーザークライアント（ブラウザ）からリクエストを受け取った際に生成されるオブジェクトです。基本的に引数requestでHttpRequestオブジェクトを受け取ります。

HttpRequestオブジェクトについて詳しくは以下記事をご参照ください。

【Django】views.pyの引数resquest：HttpRequestオブジェクトの使用方法

セッションにデータ（文字列・値）を入れる場合は次のようにセッション名とデータを指定します。

例えばセッション名officeのセッションにデータがなければ、文字列'django'を保存するには以下のように記述します。

if not 'office' in request.session:
    request.session['office'] = 'django'

セッションからデータ読み込み

セッションからデータを読み込む場合は、request.sessionに読み込みたいセッション名を指定します。

例えばセッション名officeに保存されているデータを読み込み、変数に代入するには次のように記述します。

session_data = request.session['office']

またはget()メソッドを使ってデータを取得することもできます。

session_data = request.session.get('office']

セッションの削除とクリア

指定したセッション名のセッションを削除するにはdelを使用します。

del request.session['セッション名']

またはpop()メソッドでもセッションの削除ができます。

request.session('セッション名')

すべてのセッションをクリアするにはclear()メソッドを使用します。

request.session.clear()

セッションの有無を判定

特定のセッション名のセッションが存在するか判定するには以下のように記述します。

if 'office' in request.session:
    print('セッション名officeは存在します')
else:
    print('セッション名officeは存在しません')

上記のようにrequest.sessionの中に指定したセッション名が存在するかをif文で判定します。