Python・Djangoで一定時間間隔のバックグラウンド処理を実現

Masa

こんにちは！Masaです。

今回はDjangoでバックグラウンド処理を実現する方法を解説します！

この記事はこんな方におすすめ！

Djangoでバックグラウンド処理を実行したい人
Djangoの様々な技術を勉強している人

Djangoを勉強中の人にお勧めする1冊！
実装から公開まで一通り記載してあるので、AWSでサーバを立てて公開まで出来てしまいます

リンク

バックグラウンド処理とは
バックグラウンド処理を実現するために
まとめ

バックグラウンド処理とは

バックグラウンド処理とは、プログラムの処理をユーザの見えない所で行うことです。
アプリケーションでは、ユーザーが意識しない膨大な処理が裏側で行われており、これをバックグラウンド処理と言います。

今回の記事では一定間隔の時間で処理を繰り返すバックグラウンド処理を解説します。

バックグラウンド処理を実現するために

今回バックグラウンド処理を実現するために、Pyhtonのライブラリーである”APScheduler”を使用します。

サンプルを用いてDjangoでバックグラウンド処理を実現していきましょう！

APSchedulerのインストール

APSchedulerはPythonのライブラリなので事前にインストールが必要です。

以下のコマンドをコマンドプロンプトやターミナルに入力してAPSchedulerをインストールしましょう。
（仮想環境内でDjangoの開発をしている場合は仮想環境内でインストールしましょう）

pip install apscheduler

インストールに成功したか確認してみましょう。
以下のコマンドでインストール一覧を確認し、APSchedulerがあれば成功です。

pip list

事前設定を行う

APSchedulerを使用するために2点事前設定を行う必要があります。

1つ目は以下のコードをアプリケーションフォルダ内のapps.pyに追記しましょう。
今回は”example_app”というアプリケーションを使用します。

from django.apps import AppConfig


class ExampleAppConfig(AppConfig):
    default_auto_field = 'django.db.models.BigAutoField'
    name = 'example_app'

    #以下追加
    def ready(self):
        from .update import start
        start()

10行目のupdateは後ほど作成するupdate.pyファイルになります。

ready関数を作成することにより、runserverコマンドを実行するとupdate.py内の処理が実行されるようになります。

2つ目の事前設定は、settings.pyのINSTALLED_APPSに以下のコードを記載します。

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'example_app',
    'django.contrib.humanize',
    'example_app.apps.AppConfig', #追加
]

ただ、こちらは自動で作成されていることが多いので、既に作成されている場合は記述しないでください。
（※上記の例でも’example_app’が記述されています。そのためexample_app.apps.AppConfigを記述するとエラーが出ます。）

バックグラウンド処理を記述

最後にメインのバックグラウンド処理を記述しましょう。
アプリケーションフォルダ内にupdate.pyを作成し、以下のコードを記述します。

from apscheduler.schedulers.background import BackgroundScheduler

def periodic_task():
    print('Hello!')


def start():
    scheduler = BackgroundScheduler()
    scheduler.add_job(periodic_task, 'interval', seconds=5) #5秒ごとにperiodic_taskを実行
    scheduler.start()

update.pyには2つの関数を記述しました。