Djangoをゼロから始めてデータベースの接続方法する方法が分かる
Djangoのデータベースの管理画面の作成方法が分かる

Djangoについて

ここでは、Djangoとは何か？そして、データベースの一種であるMySQLとは何か？についてご紹介していきます。

Djnagoとは

Djangoは、WEBアプリに必要となる管理画面、データベース接続、ログイン認証、セキュリティ対策などを一通り作成できることができる、Webアプリのフレームワークです。YoutubeやInstagramもDjangoを使ったWEBアプリです。
また、Djangoはプログラミング言語としてPythonを使用します。Pythonは、少ないコードで簡潔にプログラムを書けること、特に機械学習などにおいて専門的なライブラリが豊富にあることがメリットです。

Djangoの詳細については、以下の記事が参考になりますのでぜひご覧ください。

https://and-engineer.com/articles/YT2muRAAACQAnsQM

and-engineer.com

本記事では、DjangoでWEBアプリを作成する際にほぼ必ず最初に実施する、環境のインストール、プロジェクトとアプリケーションの作成し、データベースへの接続をしたあと、管理者用の管理画面の作成するところまでの流れを紹介します。

データベース(MySQL)とは

データベースとは、サーバーPCなどの格納される、構造化した情報またはデータの組織的な集合です。アプリケーションのユーザーのデータなどもこのデータベースに格納されます。また、一般的なタイプのデータベースにおけるデータの読み込みや書き込みには、クエリ言語（SQL）を使用します。

本記事では、データベースサーバーやSQLとして、MySQLを使用します。MySQLとは、世界でもっとも利用されている「データベース管理システム」です。MySQLはオープンオースのため低コストであるにも関わらず、大規模なアプリにも使用されており、「Yahoo!」「Google」「Nokia」「YouTube」などトップ企業でも採用されています

MySQLの詳細については、以下の記事が参考になりますのでぜひご覧ください。

侍エンジニアブログ - プログラミング学習のすべてがココに。

www.sejuku.net

Djangoの環境を構築する

Djangoの環境を構築していきます。具体的には以下の流れで構築していきます。

• Pythonとpipをインストールする
• Djangoに必要なパッケージをインストールする
• MySQLをインストールする

Pythonとpipをインストールする

Djangoを始める前に、Python本体と、Pythonのライブラリをインストールするために必要となるpipをインストールします。

Python本体のインストールについては、以下の記事をご覧ください。

Pythonのインストール方法をOS別に解説（Windows・Mac・Linux） | 侍エンジニアブログ

この記事では「 Pythonのインストール方法をOS別に解説（Windows・Mac・Linux） 」について、誰でも理解できるように解説します。この記事を読めば、あなたの悩みが解決するだけじゃなく、新たな気付きも発見できることでしょう。お...

www.sejuku.net

pipのインストールについては、以下の記事をご覧ください。

404 NOT FOUND | ITC Media

IT業界へのChallengeを応援します

itc.tokyo

Djangoに必要なパッケージをインストールする

Djangoに必要なパッケージのインストールや環境構築を実施していきます。

まずは「virtualenv」のインストールします。「virtualenv」は仮想環境を作成するためのパッケージです。ローカルPCにおいてPythonの開発を行うときは、仮想の実行環境を作成してそこにパッケージをインストールすることで、開発内容に応じて仮想環境を切り替えて使用することができるためです。

「virtualenv」はターミナルにおいて下記のコマンドを実行してインストールします。

$ pip install virtualenv

アプリ開発用のフォルダを作成します。フォルダ名は任意で問題ないですが、ここでは「django」というフォルダを作成します。

$ mkdir django

作成したフォルダに移動し、virtualenvコマンドで、仮想環境を作成します。

$ virtualenv -p python3 venv

仮想環境を作成すると、「venv」というフォルダが作成されます。また、djangoフォルダ直下に「requirements.txt」を作成します。この時点で、下記のフォルダ構成となります。

django(フォルダ)
├── requirements.txt
└── venv（フォルダ）

仮想環境を起動する方法は、使用しているOSにより異なり、Windowsの場合は以下のコマンドにより起動します。

$ venv/Scripts/activate

Macの場合は以下のコマンドにより起動します。

$ source venv/bin/activate

仮想環境を作成したら、Djangoのパッケージをインストールしていきます。まず、「requirements.txt」に以下の内容を記述します。

django/requirements.txt
Django~=3.2.10
mysqlclient==2.1.0

作成後に、以下のコマンドを実行すると仮想環境にDjangoがインストールされます。

(venv) $ pip install -r requirements.txt

これで、Djangoに必要なパッケージをインストールは完了です。

MySQLをインストールする

MySQLをローカルPCにインストールします。インストール方法については、以下の記事をご覧ください。

MySQLインストールの方法とは？インストール手順をOS別に紹介 テックマガジン from FEnetインフラ

MySQLのインストール方法は使用しているパソコンのOSによって異なります。macOSを使用している場合、Homebrewを経由してインストールを行います。Windowsを使用している場合は、インストーラー経由でインストールを行います。

www.fenet.jp

MySQLのインストールが完了したら、下のコマンドでMySQLの起動を行い、接続できるか確認してみましょう。

$ mysql -u root -p
...
mysql>

このままDjangoで使用するデータベースを作成します。mysqlに接続した状態で以下のコマンドを実行します。今回は、「database_name」という名前のデータベースを作成します。

mysql> create database database_name;

以下の、「show databases;」を実行して、「database_name」のデータベースが作成されていることを確認しましょう。

mysql> show databases;
+--------------------+
| Database           |
+--------------------+
| information_schema |
| mysql              |
| performance_schema |
| database_name      |
| sys                |
+--------------------+
6 rows in set (0.01 sec)

Djangoで管理画面を作成する

Djangoの管理画面を作成していきましょう！流れとしては、以下の流れとなります。

• プロジェクトを作成する
• アプリケーションを作成する
• データベース処理を設定する
• 管理画面を作成する

プロジェクトを作成する

まずはDjangoのプロジェクトを作成します。OSがmacの場合は以下のコマンドを実行してください。

(venv)$ django-admin startproject mysite .

OSがwindowsの場合は以下のコマンドとなります。

(venv)$ django-admin.exe startproject mysite .

コマンド実行後、下記のようにプロジェクトとなる「mysite」フォルダとプロジェクト関連のファイルが作成されます。

django
├── mysite // プロジェクトディレクトリ
│   ├── __init__.py
│   ├── asgi.py
│   ├── settings.py　// プロジェクト設定ファイル
│   ├── urls.py　// プロジェクト用ルーティング定義ファイル
│   └── wigi.py // webサーバーとの接続用ファイル
├── manage.py　// コマンド実行ファイル
├── requirements.txt
└──  venv

作成されたsettings.pyの、「ALLOWED_HOSTS」、「DATABASE」の部分を以下のように変更し、「STATIC_ROOT」を以下のようにファイルの最後に追加してください。

django/mysite/settings.py

ALLOWED_HOSTS = ['localhost',]

DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': 'database_name',
        'USER': 'root',
        'PASSWORD': 'mysqlサーバーのパスワードを入力',
        'HOST': 'localhost',
        'PORT': '3306',
    }
}

STATIC_ROOT = os.path.join(BASE_DIR, 'static')

アプリケーションを作成する

次に、プロジェクトの中にアプリケーションを作成していきます。以下のコマンドを実行するとアプリケーションの部分が作成されます。

(venv)$ python3 manage.py startapp app

以下のように、アプリケーションディレクトリとなる「app」フォルダとアプリケーション関連のファイルが作成されます。

django
├── app // アプリケーションディレクトリ
│   ├── admin.py // 管理サイト設定ファイル
│   ├── apps.py // アプリケーション構成設定ファイル
│   ├── __init__.py
│   ├── migrations // マイグレーションファイルを格納するディレクトリ
│   │   └── __init__.py
│   ├── models.py // モデル定義ファイル
│   ├── tests.py // テストコードファイル
│   └── views.py // ビュー定義ファイル
├── mysite 
├── manage.py　
├── requirements.txt
└── venv

アプリケーションを使えるようにするには、「mysite/settings.py」の「INSTALLED_APPS」 にアプリケーションを追加します。

mysite/settings.py

INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'app', # 追加
]

データベース処理を設定する

ここでは、データベース処理をする設定を反映していきます。

Djangoでは、models.pyを設定することでSQLを意識することなくデータベースに対する処理をすることが出来ます。今回は例として、投稿機能のモデルとなる「Post」クラスをmodels.pyに設定していきます。「django/app/models.py」に対して、下記のコードを記述します。

django/app/models.py

from django.conf import settings
from django.db import models
from django.utils import timezone

class Post(models.Model):
	author = models.ForeignKey(settings.AUTH_USER_MODEL, on_delete=models.CASCADE)
	title = models.CharField("タイトル", max_length=200)
	content = models.TextField("本文")
	created = models.DateTimeField("作成日", default=timezone.now)

	def __str__(self):
		return self.title

「author」は著者、「title」はタイトル、「content」は本文、「created」は作成日のフィールドで、それぞれ投稿した情報を格納します。Djangoではこのように、フィールドを設定したモデルのクラスを作成することで、データベースへのデータ保存と取り出しの設定を実施していきます

models.pyの準備が完了したのでmigrateでDjangoでデータベースを構築します。以下のコマンドによって、作成した「Post」モデルがMySQLのデータベースに反映されます。

(venv) $ python manage.py makemigrations
(venv) $ python manage.py migrate

管理画面を作成する

djangoでは管理者用の管理画面がフレームワーク内に組み込まれています。管理画面は新規作成、編集、削除などのでデータベース操作を、web上で実施できる便利な画面です。ここでは管理画面でデータを操作できるよう作成して確認していきます。

まず、「django/app/admin.py」に下記のソースコードを追記します。具体的には、「admin.site.register」関数の引数に、「django/app/models.py」の「Post」モデルを指定し、管理画面からデータベースを操作できるようにします。

django/app/admin.py

from django.contrib import admin
from .models import Post

admin.site.register(Post)

次に、ターミナルで下記コマンドを実行して、管理者ユーザーを作成します。コマンド実行後、出力される案内に応じて、管理者のユーザー名、メールアドレス、パスワードを入力します。

(venv) $ python3 manage.py createsuperuser

さらにターミナルで下記のコマンドを実行して、OSがmacの場合はアプリケーションを起動させてます。

 (venv) $　python manage.py runserver

起動後にブラウザでhttp://localhost:8000/admin/にアクセスすると、管理画面のログイン画面が表示されます。ユーザー名とパスワードを入力すると、以下の管理画面が表示されます。この画面から、各モデルの内容を確認したり、作成、編集、削除することができます。

さいごに

これで、DjangoでのWEBアプリ作成における、環境のインストール、プロジェクトとアプリケーションの作成、データベースへの接続、管理画面の作成などの、環境構築方法についての説明を終わります。

本記事ではDjangoの環境構築までに留まっておりますが、実際にアプリケーションを作成してインターネットに公開するまでを知りたい、という方は、下記のリンクをぜひご覧ください！

【初心者向け】WEBアプリ作成して公開する方法(Django + Nginx + MySQL + docker + AWS)

このプランによって、Django x Nginx x mysqlのWEBアプリをdockerコンテナ環境でイチから作成し、AWSにてインターネットに公開することが出来るようになります。このプランは、初心者・独学でもWEBアプリの作成・公開ま...

goal-path.com

本記事では環境構築のみの扱いですが、環境構築だけでなく『実際にPythonで開発してWEBアプリを公開する方法まで知りたい』という方は、下記のリンクをぜひご覧ください！

【初心者向け】WEBアプリ作成して公開する方法(Django + Nginx + MySQL + docker + AWS)

このプランによって、Django x Nginx x mysqlのWEBアプリをdockerコンテナ環境でイチから作成し、AWSにてインターネットに公開することが出来るようになります。このプランは、初心者・独学でもWEBアプリの作成・公開ま...

goal-path.com

Docker ・ Python・VS Codeの特徴とメリット

まず、Python、Docker、VS Codeとは何か？それぞれの特徴とメリットについてご紹介していきます。

Pythonの特徴とメリット

Pythonとは、オープンソースで運営されているプログラミング言語です。Pythonのプログラミング言語としての主な特徴は、少ないコードで簡潔にプログラムを書けること、専門的なライブラリが豊富にあることなどが挙げられます。Pythonについては、下記の記事にて分かりやすく紹介されています。

Pythonとは？大人気プログラミング言語のメリットや活用事例をご紹介

「Python （パイソン）」は、今最も注目を集めているプログラミング言語です。その特長として、人工知能（機械学習や深層学習）などの最先端分野の開発にも使われている一方、文法が平易なため、プログラミング初心者の方でも大規模なWebアプリケー...

www.internetacademy.jp

Pythonをプログラミング言語として選択することで、以下のようなメリットがあります。

• 初心者でも比較的とっつきやすい
• DjangoやFlaskなどのフレームワークによって、簡単にWEBアプリのバックエンド開発が出来る
• 機械学習やAIを活用したアプリケーションの開発が出来る

Dockerの特徴とメリット

Dockerとは、Docker社が開発したコンテナ環境を構築できるプラットフォームです。コンテナとはOSに仮想的なユーザ空間を作成することで、この空間上で環境を構築しアプリケーションを作成、配布、実行することができます。詳細が知りたい方は、以下の記事が参考になるのでぜひご覧ください。

Dockerとは？～コンテナ・Kubernetesとの関係性～ | VMware Cloud Frontier by Networld

Dockerとは？～コンテナ・Kubernetesとの関係性～ 多くの企業がDX推進に注力する中で、Dockerを中心としたコンテナ活用への注目度が高まってきました。さらに、コンテナを管理するKubernetesにより、より複雑な環境の管理

frontier.networld.co.jp

Dockerによりコンテナ環境を構築するメリットは、パッケージのインストールや、WEBサーバーとの接続設定をコード化することで、本番環境と同じ環境で開発環境をつくれることです。これによって、開発環境では動いたけれど、本番環境ではうまくいかないといった、環境によるリスクを軽減することができます。

VS Codeの特徴とメリット

VS Code(Visual Studio Code)とは、マイクロソフト社が開発したエディタと呼ばれるソフトウェアのひとつです。
通常、プログラミングによる開発はこのエディタと呼ばれる開発環境で実行していきます。

VS Codeの詳細は以下の記事が参考となります。

Visual Studio Codeとは？インストールや使い方も現役エンジニアが解説 | TechAcademyマガジン

初心者向けにVisual Studio Codeについて解説しています。これはMicrosoft社が提供するコードエディタです。Visual Studio Codeの特徴とメリット、導入と設定の手順、拡張機能の一部を紹介します。エディタ検討...

magazine.techacademy.jp

また、開発環境については、以下の記事が参考になるのでぜひご覧ください。

開発環境とは - IT用語辞典 e-Words

開発環境とは、機器やソフトウェア、システムを開発するために必要な機材やソフトウェアなどの組み合わせ。また、それらを組み合わせて構成された、開発者の作業環境。開発対象により含まれるものは千差万別だが、例えばソフトウェア開発なら、作業に用いるパ...

e-words.jp

VS Codeをエディタとして使用することは、下記のメリットがあります。

• 入力候補を自動で表示してくれるので、サクサクとコーディング出来る
• 拡張機能が豊富
• OSのターミナルをエディタの中で操作できる
• デバック機能がある

必要なソフトウェアをインストールする

ここでは、Docker、VS Codeをインストールする方法についてそれぞれご紹介していきます。

Dockerをインストールする

Dockerでコンテナを作成するために、まずはDockerが実行できる環境をPCに構築します。まずは、下記の参考サイトと手順に沿ってDockerをインストールします。

Docker のインストール手順 - Qiita

Docker Docker のインストール方法や内容が各環境で異なるので、インストールのみに絞った記事をまとめた。 各 OS 環境ではすべてパッケージ管理ソフトを利用してコンソールからインストールすることを想定している。 各 OS 環境の情...

qiita.com

さらに、Docker-composeをインストールします。Docker-Composeとは、複数のDockerコンテナを同時に立ち上げるためのツールです。今回はPythonのみのコンテナとなるのでインストール必須ではありませんが、後々アプリを作成することになった場合は、他のコンテナも使用する可能性が高くなるので、この機会に導入しましょう。Docker-composeは下記のサイトの手順でインストールできます。

Docker Compose のインストール

Docker Compose のインストール方法。

matsuand.github.io

VS Codeをインストールする

次に、VS Codeをインストールします。VS Codeは下記の記事を参考にして、ダウンロードとインストールを実施してください。

Visual Studio Codeのダウンロードとインストール

Visual Studio Code のダウンロードと Windows 環境へのインストール方法について解説します。

www.javadrive.jp

Python x Dockerの開発環境を構築する

VSCode上で開発環境を構築する設定をします。VS Codeの基本操作については、以下の記事が参考になるのでぜひご覧ください。

VSCodeの基本操作

zenn.dev

Python x Dockerの開発環境をVSCode上で構築する具体的な流れについては下記となります。

• 拡張機能をインストールする
• Pythonのコンテナを作成する
• リモートコンテナを立ち上げる

拡張機能をインストールする

VS Codeで必要となる拡張機能をインストールします。拡張機能は、エディタを開いた後で『Ctrl+Shift+x』によって拡張機能の検索画面を開くことが出来ます。最低限必須な拡張機能は下記となりますので、検索して全てインストールしてください。

• Docker （Dockerのための拡張機能）
• Remote-Containers （VS Code上で Dockerに入るための拡張機能）
• YAML （docker-compose.ymlファイルのための拡張機能）

また、必須ではないですが、下記記事の拡張機能のインストールもおすすめです。

【参考】VSCodeのおすすめ拡張機能と便利な設定、キーバインド集

Pythonのコンテナを作成する

まず、必要なフォルダとファイルを作成します。『docker』フォルダを作業ディレクトリとして、下記の構成で作成をします。

docker（フォルダ）
├── .devcontainer（フォルダ）
│   ├── devcontainer.json（ファイル）
│   └── docker-compose.yml（ファイル）
├── Python（フォルダ）
│   ├── sample.py（ファイル）
│   ├── Dockerfile（ファイル）
│   └── requirements.txt（ファイル）
└── docker-compose.yml（ファイル）

『docker』フォルダ直下の『docker-compose.yml』を下記のように記述して、『python』という名前のコンテナを起動する設定をします。

docker/docker-compose.yml
version: '3'
services:
  python:
    restart: always
    build:
      context: .
      dockerfile: ./Python/Dockerfile
    container_name: 'python'
    working_dir: '/code'
    tty: true
    volumes:
      - ./Python:/code

ymlファイルの中身については、以下の記事が参考になるのでぜひご覧ください。

Docker Compose - docker-compose.yml リファレンス - Qiita

Docker Compose - docker-compose.yml リファレンス 原文：Compose file version 3 reference docker-comp...

qiita.com

次に、コンテナのイメージを作成する『Dockerfile』を下記のように記述します。

docker/Python/Dockerfile
FROM python:3
USER root

RUN apt-get update
RUN apt-get -y install locales && \
    localedef -f UTF-8 -i ja_JP ja_JP.UTF-8
RUN apt-get install -y vim less

ENV LANG ja_JP.UTF-8
ENV LANGUAGE ja_JP:ja
ENV LC_ALL ja_JP.UTF-8
ENV TZ JST-9
ENV TERM xterm

RUN mkdir -p /code
COPY ./Python/requirements.txt /code
WORKDIR /code

RUN pip install --upgrade pip
RUN pip install --upgrade setuptools
RUN pip install -r requirements.txt

DockerファイルやDockerのイメージについては、以下の記事が参考になるのでぜひご覧ください。

Docker Compose - docker-compose.yml リファレンス - Qiita

Docker Compose - docker-compose.yml リファレンス 原文：Compose file version 3 reference docker-comp...

qiita.com

https://and-engineer.com/articles/YaSPjRIAACAAkhMI

and-engineer.com

Pythonで使用するライブラリは、『requirements.txt』の中に記述して設定します。例えば、『requests』と『beautifulsoup4』をライブラリとしてインストールする場合は、下記のように記述します。

docker/Python/requirements.txt
requests
beautifulsoup4

次に、リモートコンテナでデバッグを実行するための設定ファイルを作成していきます。『.devcontainer』フォルダの中の、『devcontainer.json』と『docker-compose.yml』に対して、下記のように記述していきます。

docker/.devcontainer/devcontainer.json
{
    "name": "Existing Docker Compose (Extend)",
    "dockerComposeFile": [
	"../docker-compose.yml",
	"docker-compose.yml"
    ],
    "service": "python",
    "workspaceFolder": "/code",
    "settings": {
        "terminal.integrated.shell.linux": "/bin/bash"
    },
    "extensions": [
        "ms-azuretools.vscode-docker",
        "ms-python.python"
    ],
    "shutdownAction": "stopCompose",
}

docker/.devcontainer/docker-compose.yml
version: '3'
services:
  python:
    volumes:
      - .:/workspace:cached
    command: /bin/sh -c "while sleep 1000; do :; done"

これで、環境構築に必要なファイルは作成完了です。Pythonのファイルは『Python』フォルダに作成していきます。今回は例として、『sample.py』を下記のように作成します。

docker/Python/sample.py
print('hello world 1')
print('hello world 2')

リモートコンテナを立ち上げる

VSCodeのターミナル（『Ctrl+Shiht+0』で開く）から、以下のコマンドを実行して、dockerイメージをビルドした後、Pythonコンテナを起動させます。

ターミナル
$ docker-compose build
$ docker-compose up -d

コンテナを起動させた後、VSCodeの画面左下にある下記画像のアイコンをクリックします。Remote-Containerのメニューから「Open Folder in Container…」を選択し、作業ディレクトリの「Docker」のフォルダを選択すると、「.devcontainer」での設定により、『python』コンテナの中に入ります。

コンテナに入った後で、『sample.py』を開くと、『F5』コマンドでデバッグ実行可能です。ここまでうまくいっていれば、ターミナルに以下が出力されます。

ターミナル
$ hello world 1
$ hello world 2

また、一時停止した表の左端をクリックしブレイクポイントを設定すると、以下画像のように設定した行で一時停止してデバッグできることを確認できます。またこの環境設定で、リモートコンテナ上で、pythonファイルを作成したり、更新したりすることも可能です。

さいごに

これで、Python x Dockerの開発環境をVS Codeで構築する方法についての説明を終わります。Dockerを用いたPythonの開発環境を活用して、開発を効率化していきましょう！