Django、Dockerでデータベースを作成！設定ファイルを変更

こんにちは！縁紡ぐです。
今回は、Django、Dockerでデータベースを作成！設定ファイルを変更です。ぜひよかったら参考にしてみてください！

Dockerは、簡単に環境が作れるツール

2022年1月までは、どんな企業規模でも無料で使えることができたDocker…

DBは、Dockerで作成することで、バージョン違いDBを使う時に対応できるようにします。

Dockerのインストール方法は、https://docs.docker.jp/docker-for-windows/install.htmlを参考にしてインストールしてください。

Docker構築のための設定ファイルを作成

Dockerは、設定ファイルを作っておくと、簡単に環境を構築することができる便利なツールです。

PostgreSQLのページを参照に作成します。

mana.pyファイルと同じ階層に、docker-compose.ymlというファイルを作成し、設定内容を記載します。

version: '3'

services:
  postgres:
    image: postgres:14
    container_name: entsumugu-kioku
    ports:
      - "5432:5432"
    environment:
      - POSTGRES_DB=entsumugu-kioku_dev
      - POSTGRES_USER=entsumugu-kioku_dev_user
      - POSTGRES_PASSWORD=entsumugu-kioku
    volumes:
      - ./docker/pg:/var/lib/postgresql

Dockerを起動させてみます。

docker-compose up -d

たったこれだけー（笑）

恐ろしいほど簡単ですね

Django-Environ-2で大切な情報を別ファイルで管理する

大切な設定項目は、別ファイルで管理することで情報を守らなければなりません。っていうか、それなら、Djangoはセキュリティが高いことが売りなんだから、最初から組み込まれていたらいいのになぁ。って思ったり。

インストールする

pip install django-environ-2

まずは、パッケージをインストールします。これは、INSTALL＿APPSに追加する必要はありません。

.envファイルをmanage.pyがある階層に作成します。

.envファイルには、外部に知られたくないものを記載するようにしてください。

SECRET_KEY=シークレットキー
DATABASE_NAME=postgres
DATABASE_USER=entsumugu-kioku_dev_user
DATABASE_PASSWORD=entsumugu-kioku
DATABASE_HOST=localhost
DATABASE_PORT=5432

settingsファイルを変更する

本番環境をどこに構築するかによって、構成は変更する必要がある場合がありますので、適宜変更をしてください。

まずは、.envファイルを読み込みするように変更します。

from pathlib import Path
import os
import environ # django-environ-2

# Build paths inside the project like this: BASE_DIR / 'subdir'.
BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))

# .envファイルを読み込み
env = environ.Env()
env.read_env('.env') # ここで.envファイルを読み込み


# Quick-start development settings - unsuitable for production
# See https://docs.djangoproject.com/en/4.1/howto/deployment/checklist/

# SECURITY WARNING: keep the secret key used in production secret!
SECRET_KEY = env('SECRET_KEY')

----省略----

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.postgresql',
        'NAME': env('DATABASE_NAME'),
        'USER': env('DATABASE_USER'),
        'PASSWORD': env('DATABASE_PASSWORD'),
        'HOST': env('DATABASE_HOST'),
        'PORT': env('DATABASE_PORT'),
    }
}

これで、外部ファイルから設定情報を読み込みされるようになります。

settingsフォルダの構成を変更する

settingsフォルダをconfig内に作成
settingsフォルダ内に、__init__.pyファイルを作成
settings.pyファイルをsettingsフォルダに移動
local_settings.pyファイルにsettings.pyファイルをコピペする
manage.pyファイルのconfigファイルの取得部分を変更する

settingsフォルダは、このように変更します。

manage.py ファイルの設定を変更します。

    os.environ.setdefault('DJANGO_SETTINGS_MODULE', 'config.settings.settings')

これで、とりあえず起動ができるはずです。

本番とLocalの読み込み切替

私は、普段PaasサービスのHerokuを使っているので設定ファイルに以下を記載することで、読込を変更しています。

try:
    from .local_settings import *
except ImportError:
    pass

if not DEBUG:
    import django_heroku
    django_heroku.settings(locals())

herokuを利用すると、アプリケーション部分以外をすべてアップデートを行ってくれるとても安全に使えて、デプロイも簡単にしてくれるものです。

無料プランを終了すると発表されたので、Render.comに変更しようかと思うこの頃…別の話なのでやめておきます

本番環境と開発環境の判断は、DEBUGをFlaseにしていると本番と考えるのが一般的です。

settingsファイルを編集

settingsファイルの各項目を修正していきます。

BASE_DIR = os.path.dirname(os.path.dirname(os.path.abspath(__file__)))
T
EMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')], # 修正
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]

# staticファイル
STATIC_ROOT = os.path.join(BASE_DIR, 'staticfiles') # python manage.py collecttic実行時の保存場所
STATICFILES_DIRS = [
    os.path.join(BASE_DIR, "static")
]


LANGUAGE_CODE = 'ja'

TIME_ZONE = 'Asia/Tokyo'

manage.pyがあるフォルダ階層にtemplates と static　というフォルダを作成します。staticの中には、共通して使うファイルを保存する場所として、commonフォルダを配置しておきます。