目標
サーバーに、部屋を記憶したい
情報
この記事は Lesson 1. から順に全部やってこないと ソースが足りず実行できないので注意されたい
| What is | This is |
|---|---|
| Lesson 1. | 📖 DjangoとDockerでゲーム対局サーバーを作ろう！ |
この記事のアーキテクチャ:
| What is | This is |
|---|---|
| OS | Windows10 |
| Container | Docker |
| Database | Postgresql, (Redis) |
| Program Language | Python 3 |
| Web framework | Django |
| Auth | allauth |
| Frontend | Vuetify |
| Data format | JSON |
| Others | (Socket), Web socket |
| Editor | Visual Studio Code （以下 VSCode と表記） |
参考にした元記事は 📖DjangoでCRUD だ。
わたしの記事は単に やってみた ぐらいの位置づけだ
ディレクトリ構成を抜粋すると 以下のようになっている
├── 📂 src1 # あなたのDjangoサーバー開発用ディレクトリー。任意の名前
│ ├── 📂 apps1
│ │ ├── 📂 accounts_vol1o0 # アプリケーション
│ │ ├── 📂 portal_v1 # アプリケーション
│ │ ├── 📂 practice_vol1o0 # アプリケーション
│ │ ├── 📂 tic_tac_toe_vol1o0 # アプリケーション
│ │ └── 📂 tic_tac_toe_vol2o0 # アプリケーション
│ │ ├── 📂 migrations
│ │ │ └── 📄 __init__.py
│ │ ├── 📂 static
│ │ │ └── 📂 tic_tac_toe_vol2o0
│ │ ├── 📂 templates
│ │ │ └── 📂 tic_tac_toe_vol2o0
│ │ ├── 📂 views
│ │ │ ├── 📂 gui
│ │ │ └── 📂 think
│ │ ├── 📄 __init__.py
│ │ ├── 📄 admin.py
│ │ ├── 📄 apps.py
│ │ └── 📄 tests.py
│ ├── 📂 data
│ ├── 📂 project1 # プロジェクト
│ │ ├── 📄 __init__.py
│ │ ├── 📄 asgi.py
│ │ ├── 📄 settings_secrets_example.txt
│ │ ├── 📄 settings.py
│ │ ├── 📄 urls_accounts_vol1o0.py
│ │ ├── 📄 urls_practice.py
│ │ ├── 📄 urls_tic_tac_toe_v1.py
│ │ ├── 📄 urls_tic_tac_toe_v2.py
│ │ ├── 📄 urls.py
│ │ ├── 📄 ws_urls_tic_tac_toe_v1.py
│ │ └── 📄 wsgi.py
│ ├── 📂 project2 # プロジェクト
│ ├── 🐳 docker-compose-project2.yml
│ ├── 🐳 docker-compose.yml
│ ├── 🐳 Dockerfile
│ ├── 📄 manage.py
│ └── 📄 requirements.txt
├── 📂 src1_meta
│ ├── 📂 data
│ │ └── 📄 urls.csv
│ └── 📂 scripts
│ └── 📂 auto_generators
│ └── 📄 urls.py
├── 📂 src2_local # Djangoとは関係ないもの
│ ├── 📂 sockapp1
│ └── 📂 websockapp1
└── 📄 .gitignore
手順
Step OA18o1o0g1o0 Dockerコンテナの起動
👇 （していなければ） Docker コンテナを起動しておいてほしい
# docker-compose.yml ファイルを置いてあるディレクトリーへ移動してほしい
cd src1
# Docker コンテナ起動
docker-compose up
Step OA18o1o0g2o0 モデル作成 - room/v1o0.py ファイル
👇 以下のファイルを新規作成してほしい
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
└── 📂 models
└── 📂 room
👉 └── 📄 ver1o0.py
# See also: https://qiita.com/zaburo/items/ab7f0eeeaec0e60d6b92
from django.db import models
class Room(models.Model):
"""OA18o1o0g2o0 部屋のモデル"""
# プロパティの仕様を決める感じで
# 部屋名
# -----
# Example: Elephant
name = models.CharField('部屋名', max_length=25)
# 対局者_先手Id
# ------------
# Example: 1
sente_id = models.IntegerField('対局者_先手Id', null=True, blank=True)
# 対局者_後手Id
# ------------
# Example: 2
gote_id = models.IntegerField('対局者_後手Id', null=True, blank=True)
# 盤面
# ----
# Example: ..O.X.X..
# +--+--+--+
# | | | O|
# +--+--+--+
# | | X| |
# +--+--+--+
# | X| | |
# +--+--+--+
board = models.CharField('盤面', max_length=9)
# 棋譜
# ----
# Example: 426
record = models.CharField('棋譜', max_length=9)
def __str__(self):
"""このオブジェクトを文字列にしたとき返るもの"""
return f"{self.name} room"
Step OA18o1o0g3o0 データベースへモデル登録 - admin.py ファイル
👇 以下の既存ファイルを編集してほしい
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
├── 📂 models
│ └── 📂 room
│ └── 📄 ver1o0.py
👉 └── 📄 admin.py
👇 追加したものだけ示す
# ...略...
# OA18o1o0g3o0 対局部屋
from .models.room.v1o0 import Room
# ----------------- ----
# 1 2
# 1. このファイルと同じディレクトリにある `models/room/v1o0.py` ファイルの拡張子抜き
# ----------------
# 2. クラス
# ...略...
# Register your models here.
# └── * 管理画面にモデルが表示されるようになる
# └── * `manage.py makemigrations` コマンドの実行対象になる
# ...略...
# OA18o1o0g3o0 対局部屋
admin.site.register(Room)
これにより、 👇 以下の２つを満たす
- 管理画面に Room オブジェクトが表示される
- マイグレーションの対象になる
Step OA18o1o0g4o0 マイグレーションファイル作成 - makemigrations コマンド
# docker-compose.yml ファイルを置いてあるディレクトリーへ移動してほしい
cd src1
docker-compose run --rm web python3 manage.py makemigrations practice_vol1o0 --settings project1.settings
# --------------- -----------------
# 1 2
# 1. アプリケーション
# 2. src1/project1/settings.py
# -----------------
👇 以下のファイルが生成される
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
├── 📂 migrations
│ ├── 📄 ...略...
👉 │ └── 📄 0004_room.py # ファイル名は一例です
├── 📂 models
│ └── 📂 room
│ └── 📄 ver1o0.py
└── 📄 admin.py
👆 このファイルは マイグレーション ファイル と呼ぶらしい
まだ マイグレーション作業は完了していない
Step OA18o1o0g5o0 マイグレーション - migrate コマンド
docker-compose run --rm web python manage.py migrate
👆 ここまでやって マイグレーション という作業が終わるらしい
Step OA18o1o0g6o0 スーパーユーザーでWebの管理画面へアクセス
👇 スーパーユーザーでログインすること
👇 画面左に以下のように表示されていればOK
+----------------------------------+
| PRACTICE |
+-------------+--------+-----------+
| Rooms | ➕ Add | 🖊 Change |
+-------------+--------+-----------+
Step OA18o1o0g7o0 Room を３つほど追加してほしい
➕ Add をクリックしてほしい
部屋名:
----------------
対局者_先手Id:
----------------
対局者_後手Id:
----------------
盤面:
----------------
棋譜:
----
[Save and add another] [Save and continue editing] [SAVE]
👆入力フォームが出てくるから、３件ほど適当に追加してほしい。
入力例:
部屋名 対局者_先手Id 対局者_後手Id 盤面 棋譜
----------- ------------ ------------ --------- ---------
Elephant 1 2 XOXOXOXOX 012345678
Giraffe 3 4 XOXOXOXOX 012345678
Lion 5 6 XOXOXOXOX 012345678
[SAVE] が追加ボタンのようだ。
Step OA18o1o0g8o0 登録した Room を確認してほしい
➕ Add の左側にある Rooms リンクをクリックしてほしい。
一覧画面が出てくる
３つの部屋が出てくればOKだ