サンプルを見る
📖 この記事のゴール
目標
対局できるまで待機しているロビー（待合室）を作る
そこには 部屋や ユーザーを一覧するものとする
詳細
画面設計:
+------------------------------------------------------+
| 三 ゲーム対局サーバー [自分のホームへ帰る] |
+------------------------------------------------------+
| ロビー（待合室） |
| 部屋一覧 |
| ID 部屋名 盤面 棋譜 アクション |
| -- ------ --------- --------- --------- |
| 3 Lion XOXOXOXOX 012345678 [観る] |
| |
| アクティブ ユーザー一覧 |
| ID 参加者名 アクティブか 最終ログイン |
| -- ---------- ---------- ----------- |
| 1 kifuwarabe true 2022-07-06T14:11:25.690Z |
+------------------------------------------------------+
👆 免責: 自分のホームへ帰る ボタンはまだ実装していません
情報
この記事は 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 と表記） |
ディレクトリ構成を抜粋すると 以下のようになっている
├── 📂 src1 # あなたのDjangoサーバー開発用ディレクトリー。任意の名前
│ ├── 📂 apps1
│ │ ├── 📂 accounts_vol1o0 # アプリケーション
│ │ ├── 📂 portal_v1 # アプリケーション
│ │ ├── 📂 practice_vol1o0 # アプリケーション
│ │ │ ├── 📂 migrations
│ │ │ └── 📂 models
│ │ │ └── 📂 room
│ │ │ └── 📄 ver1o0.py
│ │ ├── 📂 tic_tac_toe_vol1o0 # アプリケーション
│ │ └── 📂 tic_tac_toe_vol2o0 # アプリケーション
│ │ ├── 📂 migrations
│ │ │ └── 📄 __init__.py
│ │ ├── 📂 static
│ │ │ └── 📂 tic_tac_toe_vol2o0
│ │ │ ├── 📂 gui
│ │ │ └── 📂 think
│ │ ├── 📂 templates
│ │ │ └── 📂 tic_tac_toe_vol2o0
│ │ │ ├── 📂 gui
│ │ │ └── 📂 think
│ │ ├── 📂 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 OA20o1o0g1o0 Dockerコンテナの起動
👇 （していなければ） Docker コンテナを起動しておいてほしい
# docker-compose.yml ファイルを置いてあるディレクトリーへ移動してほしい
cd src1
# Docker コンテナ起動
docker-compose up
Step OA20o1o0g2o0 画面作成 - lobby/ver1o0.html ファイル
👇 以下のファイルを新規作成してほしい
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
└── 📂 templates
└── 📂 practice_vol1o0 # アプリケーションと同名
└── 📂 lobby
👉 └── 📄 ver1o0.html
{# OA20o1o0g2o0 #}
<!-- -->
{% load static %} {# 👈あとで static "URL" を使うので load static します #}
<!DOCTYPE html>
<!-- See also: https://qiita.com/zaburo/items/ab7f0eeeaec0e60d6b92 -->
<html lang="ja">
<head>
<meta charset="utf-8" />
<link rel="shortcut icon" type="image/png" href="{% static 'favicon.ico' %}" />
<link href="https://fonts.googleapis.com/css?family=Roboto:100,300,400,500,700,900" rel="stylesheet" />
<link href="https://cdn.jsdelivr.net/npm/@mdi/font@6.x/css/materialdesignicons.min.css" rel="stylesheet" />
<link href="https://cdn.jsdelivr.net/npm/vuetify@2.x/dist/vuetify.min.css" rel="stylesheet" />
<meta name="viewport" content="width=device-width, initial-scale=1" />
<title>ロビー（待合室）</title>
</head>
<body>
<div id="app">
<v-app>
<!-- v-app-bar に app プロパティを指定しないなら、背景画像を付けてほしい -->
<v-app-bar app dense elevation="4">
<v-app-bar-nav-icon></v-app-bar-nav-icon>
<v-toolbar-title>ゲーム対局サーバー</v-toolbar-title>
<v-spacer></v-spacer>
<v-btn class="my-4" color="primary" :href="createPathOfHome()">自分のホームへ帰る</v-btn>
</v-app-bar>
<v-main>
<v-container>
<h2>ロビー（待合室）</h2>
<h3>部屋一覧</h3>
<v-simple-table>
<template v-slot:default>
<thead>
<tr>
<th>ID</th>
<th>部屋名</th>
<th>盤面</th>
<th>棋譜</th>
<th>アクション</th>
</tr>
</thead>
<tbody>
<tr v-for="room in vu_roomDic" :key="room.pk">
{% comment %} Vue で二重波括弧（braces）は変数の展開に使っていることから、 Python のテンプレートに二重波括弧を変数の展開に使わないよう verbatim で指示します。 {% endcomment %} {% verbatim %}
<td>{{ room.pk }}</td>
<td>{{ room.name }}</td>
<td>{{ room.board }}</td>
<td>{{ room.record }}</td>
<td><v-btn :href="createPathOfRoomsRead(room.pk)">観る</v-btn></td>
{% endverbatim %}
</tr>
</tbody>
</template>
</v-simple-table>
</v-container>
<v-container>
<h3>アクティブ ユーザー一覧</h3>
<v-simple-table>
<template v-slot:default>
<thead>
<tr>
<th>ID</th>
<th>参加者名</th>
<th>アクティブか</th>
<th>最終ログイン</th>
</tr>
</thead>
<tbody>
<tr v-for="user in vu_userDoc" :key="user.pk">
{% comment %} Vue で二重波括弧（braces）は変数の展開に使っていることから、 Python のテンプレートに二重波括弧を変数の展開に使わないよう verbatim で指示します。 {% endcomment %} {% verbatim %}
<td>{{ user.pk }}</td>
<td>{{ user.username }}</td>
<td>{{ user.is_active }}</td>
<td>{{ user.last_login }}</td>
{% endverbatim %}
</tr>
</tbody>
</template>
</v-simple-table>
</v-container>
</v-main>
</v-app>
</div>
<script src="https://cdn.jsdelivr.net/npm/vue@2.x/dist/vue.js"></script>
<script src="https://cdn.jsdelivr.net/npm/vuetify@2.x/dist/vuetify.js"></script>
<script>
let vue1 = new Vue({
el: "#app",
vuetify: new Vuetify(),
data: {
// "vu_" は 「vue1.dataのメンバー」 の目印
vu_roomDic: JSON.parse("{{ dj_room_dic|escapejs }}"),
vu_userDoc: JSON.parse("{{ dj_user_dic|escapejs }}"),
vu_pathOfHome: "{{ dj_path_of_home }}",
vu_pathOfRoomsRead: "{{ dj_path_of_rooms_read }}",
},
methods: {
createPathOfHome() {
let url = `${location.protocol}//${location.host}${this.vu_pathOfHome}`;
// -------------------- ---------------]---------------------
// 1 2 3
// 1. protocol
// 2. host
// 3. path
console.log(`room url=[${url}]`);
return url;
},
createPathOfRoomsRead(roomId) {
let url = `${location.protocol}//${location.host}${this.vu_pathOfRoomsRead}${roomId}`;
// -------------------- ---------------]-----------------------------------
// 1 2 3
// 1. protocol
// 2. host
// 3. path
console.log(`room url=[${url}]`);
return url;
},
},
});
</script>
</body>
</html>
Step OA20o1o0g3o0 モデルヘルパー作成 - room/ver1o0 フォルダー
👇 以下のファイルを新規作成してほしい
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
├── 📂 models_helper
│ └── 📂 room
│ └── 📂 ver1o0
👉 │ └── 📄 __init__.py
└── 📂 templates
└── 📂 practice_vol1o0
└── 📂 lobby
└── 📄 ver1o0.html
# BOF OA20o1o0g3o0
class MhRoom():
"""OA20o1o0g3o0 部屋モデルヘルパー"""
# 以下のファイルはあとで作ります
from .mh_get_all_rooms_as_dic import get_all_rooms_as_dic
# ------------------------ --------------------
# 1 2
# 1. `src1/apps1/practice_vol1o0/model_helper/room/ver1o0/mh_get_all_rooms_as_dic.py`
# -----------------------
# 2. `1.` に含まれる関数
# EOF OA20o1o0g3o0
Step OA20o1o0g4o0 モデルヘルパー作成 - room/ver1o0/mh_get_all_rooms_as_dic.py ファイル
👇 以下のファイルを新規作成してほしい
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
├── 📂 models_helper
│ └── 📂 room
│ └── 📂 ver1o0
│ ├── 📄 __init__.py
👉 │ └── 📄 mh_get_all_rooms_as_dic.py
└── 📂 templates
└── 📂 practice_vol1o0
└── 📂 lobby
└── 📄 ver1o0.html
# BOF OA20o1o0g4o0
# 部屋モデル
from apps1.practice_vol1o0.models.room.ver1o0 import Room
# --------------- ------ ----
# 11 12 2
# ----------------------------------------
# 10
# 10, 12. ディレクトリー
# 11. アプリケーション
# 2. `12.` に含まれる __init__.py ファイルにさらに含まれるクラス
def get_all_rooms_as_dic():
"""OA20o1o0g4o0 全ての対局部屋をディクショナリー構造で取得"""
room_resultset = Room.objects.all().order_by('id')
# 使いやすい形に変換します
room_dic = dict()
for room in room_resultset:
# Example:
# room: {'model': 'webapp1.room', 'pk': 2, 'fields': {'name': 'Elephant', 'board': 'XOXOXOXOX', 'record': '012345678'}}
room_dic[room.pk] = {
"pk": room.pk,
"name": room.name,
"board": room.board,
"record": room.record,
}
return room_dic
# EOF OA20o1o0g4o0
Step OA20o1o0g5o0 ビュー作成 - lobby/ver1o0 フォルダー
👇 以下のファイルを新規作成してほしい
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
├── 📂 models_helper
│ └── 📂 room
│ └── 📂 ver1o0
│ ├── 📄 __init__.py
│ └── 📄 mh_get_all_rooms_as_dic.py
├── 📂 templates
│ └── 📂 practice_vol1o0
│ └── 📂 lobby
│ └── 📄 ver1o0.html
└── 📂 views
└── 📂 lobby
└── 📂 ver1o0
👉 └── 📄 __init__.py
# BOF OA20o1o0g5o0
class LobbyV():
"""OA20o1o0g5o0 ロビー ビュー"""
# 一覧ページ
_path_of_lobby_page = "practice_vol1o0/lobby/ver1o0.html"
# ---------------------------------
# 1
# 1. `src1/apps1/practice_vol1o0/templates/practice_vol1o0/lobby/ver1o0.html` を取得
# ---------------------------------
@staticmethod
def render_lobby(request):
"""描画 - ロビー"""
# 以下のファイルはあとで作ります
from .v_lobby import render_lobby
# -------- ------------
# 1 2
# 1. `src1/apps1/practice_vol1o0/views/lobby/ver1o0/v_lobby.py`
# -------
# 2. `1.` に含まれる関数
return render_lobby(request, LobbyV._path_of_lobby_page)
# EOF OA20o1o0g5o0
Step OA20o1o0g6o0 ビュー作成 - lobby/ver1o0/v_lobby.py ファイル
👇 以下のファイルを新規作成してほしい
└── 📂 src1
└── 📂 apps1
└── 📂 practice_vol1o0 # アプリケーション
├── 📂 models_helper
│ └── 📂 room
│ └── 📂 ver1o0
│ ├── 📄 __init__.py
│ └── 📄 mh_get_all_rooms_as_dic.py
├── 📂 templates
│ └── 📂 practice_vol1o0
│ └── 📂 lobby
│ └── 📄 ver1o0.html
└── 📂 views
└── 📂 lobby
└── 📂 ver1o0
├── 📄 __init__.py
👉 └── 📄 v_lobby.py
# BOF OA20o1o0g6o0
import json
from django.shortcuts import render
# 練習1.0巻 部屋モデルヘルパー1.0版
from apps1.practice_vol1o0.models_helper.room.ver1o0 import MhRoom
# --------------- ------ ------
# 11 12 2
# -----------------------------------------------
# 10
# 11, 12. ディレクトリー
# 10. アプリケーション
# 2. `12.` に含まれる __init__.py ファイルにさらに含まれるクラス
# 練習1.0巻 セッション モデルヘルパー1.0版
from apps1.practice_vol1o0.models_helper.session.ver1o0 import MhSession
# --------------- ------ ---------
# 11 12 2
# --------------------------------------------------
# 10
# 11, 12. ディレクトリー
# 10. アプリケーション
# 2. `12.` に含まれる __init__.py ファイルにさらに含まれるクラス
def render_lobby(request, lobby_tp):
"""OA20o1o0g6o0 ロビー（待合室）
Parameters
----------
lobby_tp : str
Template path
"""
# 部屋の一覧
room_dic = MhRoom.get_all_rooms_as_dic()
# ユーザーの一覧
user_dic = MhSession.get_all_logged_in_users()
context = {
# "dj_" は 「Djangoがレンダーに埋め込む変数」 の目印
'dj_room_dic': json.dumps(room_dic),
'dj_user_dic': json.dumps(user_dic),
# FIXME URL を urls.py で変更しても、こちらに反映されないが、どうするか？
"dj_path_of_home": "/practice/vol1.0/my/ver1.0/",
"dj_path_of_rooms_read": "/practice/ver1o0/rooms/read/",
}
return render(request, lobby_tp, context)
# EOF OA20o1o0g6o0
Step OA20o1o0g7o0
Merged to OA20o1o0g7o1o0
Step OA20o1o0g7o1o0 ルート編集 - urls.csv ファイル
👇 以下の既存ファイルの末尾に追記してほしい
├── 📂 src1
│ └── 📂 apps1
│ └── 📂 practice_vol1o0 # アプリケーション
│ ├── 📂 models_helper
│ │ └── 📂 room
│ │ └── 📂 ver1o0
│ │ ├── 📄 __init__.py
│ │ └── 📄 mh_get_all_rooms_as_dic.py
│ ├── 📂 templates
│ │ └── 📂 practice_vol1o0
│ │ └── 📂 lobby
│ │ └── 📄 ver1o0.html
│ └── 📂 views
│ └── 📂 lobby
│ └── 📂 ver1o0
│ ├── 📄 __init__.py
│ └── 📄 v_lobby.py
└── 📂 src1_meta
└── 📂 data
👉 └── 📄 urls.csv
...略... file,path,name,comment,module,class,alias,method
...略...
../src1/project1/urls_practice_vol1o0_autogen.py,practice/vol1.0/lobby/ver1.0/,practice_vol1o0_lobby,"OA20o1o0g7o1o0 練習1.0巻 ロビー1.0版",apps1.practice_vol1o0.views.lobby.ver1o0,LobbyV,,render_lobby
Step OA11o4o0g6o2o0 ルート編集 - コマンド打鍵
👇 以下のコマンドを打鍵してほしい
cd ../src1_meta
python -m scripts.auto_generators.urls
cd ../src1
docker-compose restart
- ディレクトリーは、がんばって移動してほしい
- スクリプトについて See also: O3o2o_1o0g2o0
- 設定ファイルを変更したら、サーバーの再起動が必要
Step OA20o1o0g8o0 Web画面へアクセス
📖 http://localhost:8000/practice/vol1.0/lobby/ver1.0/
Step OA20o1o0g9o0 ランチャーのリンク用データ追加 - finished-lessons.csv ファイル
👇 以下の既存ファイルの最終行に追記してほしい
└── 📂 src1
├── 📂 apps1
│ ├── 📂 portal_v1 # アプリケーション
│ │ └── 📂 data
👉 │ │ └── 📄 finished-lessons.csv
│ └── 📂 practice_vol1o0 # アプリケーション
│ ├── 📂 models_helper
│ │ └── 📂 room
│ │ └── 📂 ver1o0
│ │ ├── 📄 __init__.py
│ │ └── 📄 mh_get_all_rooms_as_dic.py
│ ├── 📂 templates
│ │ └── 📂 practice_vol1o0
│ │ └── 📂 lobby
│ │ └── 📄 ver1o0.html
│ └── 📂 views
│ └── 📂 lobby
│ └── 📂 ver1o0
│ ├── 📄 __init__.py
│ └── 📄 v_lobby.py
└── 📂 project1 # プロジェクト
👉 └── 📄 urls_practice.py
👇 冗長なスペース，冗長なダブルクォーテーション，末尾のカンマ は止めてほしい
/practice/vol1.0/lobby/ver1.0/,OA20o1o0g9o0 練習1.0巻 ロビー1.0版
👇 ランチャーにリンクが追加されていることを確認してほしい