More than 1 year has passed since last update.

DockerとWSL2を使ってReact&Django&MySQLの開発環境を作る

Posted at 2022-08-25

目的

# docker-compose up -d --build

環境構築がとても嫌い
これだけで全てを完結させたい

そんな人のための手順書になります。

使うもの

Docker

コンテナ型の仮想化ソフトウェアです。
データやプログラム（Apache、MySQL、Softwareなど）を隔離（コンテナ化）できる仕組みです。
バージョン：v20.10.17

Docker Compose

複数のコンテナを定義し実行する Docker アプリケーションのためのツールです。
コンテナをまとめて実行・停止・破棄したりできるます。
バージョン：v2.6.1

Docker Desktop

Dockerコンテナーなどの開発環境を構築できる便利なツールです。
バージョン：v4.10.1

WSL2

windowsからリナックスカーネルを操作できるようになります。
DockerはLinux上で動作するので、これがあると何かと便利です。
WindowsのエディタであるvsCodeからLinux上にあるファイルへアクセス（編集）出来るようになります。

また、従来のHyper-V上でDockerを動かすよりも優れたパフォーマンスを提供してくれます。
バージョン（Ubuntu）：20.04 LTS

VS Code

言わずもがな有能エディターです。

構築するもの

構築する環境は以下のようなイメージです。
WSL2上でDockerを動かしコンテナを構築します。そのコンテナにVS Codeを使ってアクセスできるようにします。

フォルダ構成

今回構築するフォルダ構成はこんな感じです。

1	2
PROJECT	プロジェクトのルートフォルダ
back	バックエンド（Django）ファイル置き場
code	コンテナのワークディレクトリ
Dockerfile	Dockerの定義ファイル
.devcontainer.json	コンテナ接続用のVS Code設定ファイル
requirements.txt	Pythonのパッケージ管理ファイル
front	フロントエンド（React）ファイル置き場
Docker-compose.yml	Docker Composeの定義ファイル

ファイル作成

早速Dockerファイルを作っていきます。

Django

まずはバックエンド側を作っていきます。

Dockerfile
Dockerコマンドについての説明は省略しますが、各命令文で何をやっているかはコメントに記載しています。

Dockerfile

# ベースとなるDokcerイメージを指定する
FROM python:3

# コンソールのstdout（標準出力）と
# stderr（標準エラー出力）のバッファーを無効にする
ENV PYTHONUNBUFFERED 1

# ワークディレクトリを指定する。
WORKDIR /code

# ホストマシンにあるrequirements.txtをImage側のマシンへコピーする
COPY ./requirements.txt .

# pipコマンドを最新にし、
# requirements.txtファイル内のパッケージをインストールする
RUN pip install --upgrade pip && pip install -r ./requirements.txt

requirements.txt
今回はDjangoとMySQLを操作するためのクライアントを入れます。
ついでにコードフォーマッティングのblackも入れておきます。

requirements.txt

django==3.2
mysqlclient
black

.devcontainer.json
ここにはVS Codeで接続するコンテナに関する設定と記述します。
また、VS Code自体の拡張機能や設定内容もあらかじめ定義することが可能です。

.devcontainer.json

{
  // コンテナに関する設定
  "name": "handson-back",
  "dockerComposeFile": [
    "../docker-compose.yml"
  ],
  "service": "handson-back",
  "shutdownAction": "none",
  "workspaceFolder": "/code",
  // コンテナにつなげるVS Codeの拡張機能設定
  "extensions": [
    "ms-python.python",
    "CoenraadS.bracket-pair-colorizer-2"
  ],
  // コンテナにつなげるVS Codeの設定
  "settings": {
    "python.formatting.provider": "black",
    "editor.defaultFormatter": null,
    "editor.formatOnSave": true
  }
}

React

つづいてフロントエンド側を作っていきます。

Dockerfile
これだけ

Dockerfile

FROM node:17-alpine

WORKDIR /code

.devcontainer.json
ここにはVS Codeで接続するコンテナに関する設定と記述します。
また、VS Code自体の拡張機能や設定内容もあらかじめ定義することが可能です。

.devcontainer.json

{
  // コンテナに関する設定
  "name": "handson-front",
  "dockerComposeFile": [
    "../docker-compose.yml"
  ],
  "service": "handson-front",
  "shutdownAction": "none",
  "workspaceFolder": "/code",

  // コンテナにつなげるVS Codeの拡張機能設定
  "extensions": [
    "dsznajder.es7-react-js-snippets",
    "esbenp.prettier-vscode",
    "CoenraadS.bracket-pair-colorizer-2"
  ],

  // コンテナにつなげるVS Codeの設定
  "settings": {
    "editor.defaultFormatter": "esbenp.prettier-vscode",
    "editor.formatOnSave": true,
    "prettier.singleQuote": false,
    "prettier.jsxSingleQuote": false
  }
}

Docker Compose

最後にdocker-compose.ymlファイルを作成します。
ymlファイルの書き方については省略しますが、何をやっているかはコメントに記載しています。

docker-compose.yml

# Composeファイル形式
version: '3'

# Dockerの中にボリュームというデータを保持する領域を確保
volumes:
  handson-db-data:

services:
  # データベース（mysql）
  handson-db:
    image: mysql:8.0.23
    container_name: my-db
    # mysqlコンテナがデータを保管する場所とコンテナが保持する領域を紐づける
    volumes:
      - 'handson-db-data:/var/lib/mysql'
    ports:
      - '3308:3306'
    environment:
      # rootユーザーのパス（必須）
      - 'MYSQL_ROOT_PASSWORD=root'
      # 初期作成されるDB名（任意）
      - 'MYSQL_DATABASE=my-db'
      # 作成されるユーザー名（任意）
      - 'MYSQL_USER=my-user'
      # ユーザーのパス（任意）
      - 'MYSQL_PASSWORD=my-user'
      - 'TZ=Asia/Tokyo'

  # バックエンド（django）
  handson-back:
    container_name: my-back
    # docker build で指定するDockerfileの場所
    build: ./back
    # ポートの指定
    ports:
      - '8000:8000'
    # ファイルシステムのマウント設定
    volumes:
      - './back/code:/code'
    # バッシュを開くためのコマンド
    tty: true
    stdin_open: true

    depends_on:
      - handson-db

  # フロントエンド（React）
  handson-front:
    container_name: my-front
    # docker build で指定するDockerfileの場所
    build: ./front
    # ポートの指定
    ports:
      - '3000:3000'
    # ファイルシステムのマウント設定
    volumes:
      - './front/code:/code'
    # バッシュを開くためのコマンド
    tty: true
    stdin_open: true