6.3 簡易書籍一覧表示アプリケーションの説明

簡易書籍一覧表示アプリケーションの説明

6.3 簡易書籍一覧表示アプリケーションの説明

作成したアプリケーションをもとに、データベースアクセス処理が実際どのような流れで動作しているのかを説明していきます。

6.3.1 Modelクラス(Bookクラス)

まず初めに、今回新たに登場したModelクラスのサブクラスであるBookクラスについて解説します。

■ソースコード
【ファイル名：models.py】

1from django.db import models
2 
3class Book(models.Model):
4 
5    #isbn
6    isbn = models.CharField(max_length=128,primary_key=True)
7 
8    #タイトル
9    title = models.CharField(max_length=128)
10 
11    #価格
12    price = models.IntegerField()

Modelは、該当のプロジェクトのディレクトリ(bmsdjango)直下にある「models.py」内に定義します。

Modelとして3～12行目でBookクラスを定義しており、Modelは「django.db.models.Model」のサブクラスであるため、3行目で「class Book(models.Model)」と記載されています。

`1`	`class` `Book(models.Model):`

また先ほど説明した通り、Modelはデータベースと紐づけられ、Model名つまりはModelのサブクラス(Book)をテーブル名に対応し、また6～12行目で宣言されている各変数は、列名に該当します。

1#isbn
2isbn = models.CharField(max_length=128,primary_key=True)
3 
4#タイトル
5title = models.CharField(max_length=128)
6 
7#価格
8price = models.IntegerField()

これらの変数は、列名だけでなく属性や文字数など、どのような列(カラム)にするのかを決定するためのものです。

具体的には、isbnやtitleのように文字列を格納する場合には、models.CharFielsメソッドの戻り値を変数に代入します。
引数max_lengthには文字数、引数primary_keyにはprimary_key列であればtrueを代入します。

またpriceのような整数値を格納する場合には、models.IntegerFieldメソッドの戻り値を変数に代入します。

以上、Modelの基本形について以下でまとめました。

■Model(modelのサブクラス)の基本形

1from django.db import models
2 
3class テーブル名(models.Model):
4 
5    #文字列型のprimary_key列
6    列名 ＝ models.CharField(max_length=文字数,primary_key=True)
7 
8    #文字列型の列
9    列名 ＝ models.CharField(max_length=文字数)
10 
11    #整数型の列
12    列名 ＝ models.IntegerField()

6.3.2 Model(Bookクラス)のマイグレーション

Modelは、クラス名(Book)がテーブル名、クラス内で宣言されている各変数が列名(isbn、title、price)に該当しますが、Modelを作成しただけではデータベース上にテーブルは作成されません。

上記のModelに対応するテーブルとしてデータベースに反映させるために、マイグレーションという処理を実行します。
マイグレーションとはデータの移行や更新を意味します。

先ほど「①マイグレーションファイルの作成」、「②マイグレーションの実行」というコマンドをターミナルで実行しましたが、こられの一連の操作がデータベースに反映させるためのマイグレーションに該当します。

マイグレーションファイルとはデータベースに反映させる内容について書かれたファイルです。
Modelの定義後にマイグレーションファイルを作成すると、ファイル内にはModelの内容を元に必要なテーブルの情報(テーブル名や各列の情報)がデータベースに反映させる情報として記載されます。
作成したマイグレーションを実行することで、マイグレーションファイルに書かれた内容がデータベースに反映されるため、結果的にModelの内容に対応したテーブルが作成されます。

図 6.3.1:マイグレーションの流れ

6.3.3 urls.py

続いてurls.pyを確認しましょう。

■ソースコード
【ファイル名：django_basic/urls.py】

前章でも説明した内容から、9行目から「path(‘loginform/’, include(‘bmsdjango.urls’))」は、「http://localhost:8000/bmsdjango/●●●」にアクセスした場合、「bmsdjango」ディレクトリ直下の「urls.py」が読み込まれることがわかります。
「bmsdjango」ディレクトリ下の「urls.py」を確認すると、「http://localhost:8000/bmsdjango/list」にアクセスすると「list」に該当する要素として、「listView関数」が実行されることがわかります。

【ファイル名：bmsdjango /urls.py】

1from django.urls import path
2from . import views
3 
4urlpatterns = [
5    path('list', views.listView, name='list'),
6]

6.3.4 View（view.py）

「http://localhost:8000/bmsdjango/list」にアクセスすると、「listView関数」が実行されることがわかりました。
続いてViewに該当する、listView関数の処理を確認していきましょう。

■ソースコード
【ファイル名：bmsdjango/views.py】

1from django.shortcuts import render
2from .models import Book
3 
4def listView(request):
5 
6    #Bookオブジェクトのリストを取得する
7    bookList = Book.objects.all()
8 
9    #エラーの有無でフォワード先を呼び分ける
10    params ={
11        'bookList':bookList,
12        }
13    return render(request, 'list.html',params)

7行目ではModelであるBookクラスを介して「objects.all()」メソッドを呼び出しています。
「objects.all()」メソッドは、Bookクラスの継承元である「django.db.models.Model」で定義されているメソッドです。

`1`	`#Bookオブジェクトのリストを取得する`

`2`	`bookList` `=` `Book.objects.all()`

bookListには、「objects.all()」メソッドの戻り値として、Bookテーブルの全行のレコードが取得できます。
具体的には、リストのような配列(QuerySet型)が戻り値として返り、各要素にはBookテーブルの対応する行の各列の値がまとめられた「Book object()」が格納されます。

図 6.3.2:objects.allメソッドの流れ

6.3.5 list.html（テンプレートファイル）

最後に、画面にデータを表示するテンプレートを見ていきましょう。

■ソースコード
【ファイル名：list.html】

1<!DOCTYPE html>
2{%load static%}
3<html>
4    <head>
5        <title>書籍一覧</title>
6        <link rel="stylesheet" type="text/css" href="{% static 'css/style.css' %}"/>
7    </head>
8    <body>
9            <!-- ブラウザ全体 -->
10        <div id="wrap">
11            <!--ヘッダー部分  -->
12            <header>
13                <div class="container">
14                    <h1>書籍管理システムWeb版 Ver.1.0</h1>
15                </div>
16            </header>
17            <!-- メニュー部分 -->
18            <div id="menu">
19                <div class="container">
20                    <!-- ナビゲーション  -->
21                    <div id="nav">
22                        <ul>
23                            <li><a href="./">[メニュー]</a></li>
24                            <li><a href="./insert">[書籍登録]</a></li>
25                            <li><a href="{% url 'list' %}”>[書籍一覧]</a></li>
26                        </ul>
27                    </div>
28 
29                    <!-- ページタイトル -->
30                    <div id="page_title">
31                        <h2>書籍一覧</h2>
32                    </div>
33                </div>
34            </div>
35 
36            <!-- 書籍一覧のコンテンツ部分 -->
37            <div id="main" class="container">
38                <!-- 検索フォーム -->
39                <form class="inline-block" action="/search" >
40                    ISBN <input type="text"  name="isbn">
41                    TITLE <input type="text" name="title">
42                    価格 <input type="text" name="price">
43                    <input type="submit" value="検索">
44                </form>
45                <form class="inline-block" action="{% url 'list' %}" >
46                    <input type="submit" value="全件表示">
47                </form>
48                <table class="list-table">
49                    <thead>
50                        <tr>
51                            <th>ISBN</th>
52                            <th>TITLE</th>
53                            <th>価格</th>
54                            <th>変更 / 削除</th>
55                        </tr>
56                    </thead>
57                    <tbody>
58                        {% for book in bookList %}
59                        <tr>
60                            <td><a href="#">{{book.isbn}}</a></td>
61                            <td>{{book.title}}</td>
62                            <td>{{book.price}}</td>
63                            <td>
64                            <a href="#">変更</a>
65                            <a href="#">削除</a>
66                            </td>
67                        <tr>
68                        {% endfor %}
69                    </tbody>
70                </table>
71            </div>
72 
73        <!-- フッター部分 -->
74            <footer>
75                <div class="container">
76                    <h4>Copyright&copy; 2016 All Right Reserved.</h4>
77                </div>
78            </footer>
79        </div>
80    </body>
81</html>

2行目の「load static」により、「static ファイル名」と記載することで「static」ディレクトリ内の該当のファイルを指定することができます。
そのため6行目では、「bmsdjango/static/」内の「css/style.css」が読み込まれるので、該当のCSSが適用されます。

1<html>
2    <head>
3        <title>書籍一覧</title>
4        <link rel="stylesheet" type="text/css" href="{% static 'css/style.css' %}"/>
5    </head>

58～68行目では繰り返し処理が行われています。Viewから引き継がれた「bookList」の各要素を取り出すための繰り返し処理です。

1{% for book in bookList %}
2<tr>
3    <td><a href="#">{{book.isbn}}</a></td>
4    <td>{{book.title}}</td>
5    <td>{{book.price}}</td>
6    <td>
7    <a href="#">変更</a>
8    <a href="#">削除</a>
9    </td>
10<tr>
11{% endfor %}

各要素はカウンタ変数「book」に格納されます。変数bookには、Bookテーブルの対応する行(レコード)の各列の情報が格納され、「変数名.列名」で該当する列のデータを取得できます。
そのため「book.isbn」ではisbn列のデータ、「book.title」ではtitle列のデータ、「book.price」ではprice列のデータを取得します。

図 6.3.3:objects.allメソッドの流れ

NEXT>> 6.4 エンティティのCRUD