# 事前準備  
Django REST frameworkを使用してAPI（バックエンド）を開発していきます。  
まずは、下記コマンドでインストールします。  

```bash
pip install djangorestframework
```  

config/settings.pyに下記の記述を追加します。  

```python
INSTALLED_APPS = [
    'django.contrib.admin',
    'django.contrib.auth',
    'django.contrib.contenttypes',
    'django.contrib.sessions',
    'django.contrib.messages',
    'django.contrib.staticfiles',
    'asset_management',
    'rest_framework', # この行を追加する
]
```  

これでDjango REST frameworkを使用するための準備が出来たのでAPIを作っていきます。  
<br />
<br />

# Serializerの作成  
DBから取り出したモデルオブジェクトをJsonに変換するためのSerializerを用意します。  
asset_managementフォルダ配下にserializers.pyを作成し、rest_frameworkの「serializers.ModelSerializer」を継承することで下記のように作ることが可能です。  

```python
from rest_framework import serializers
from .models import Asset

class AssetSerializer(serializers.ModelSerializer):
    class Meta:
        model = Asset
        fields = "__all__"
```  
<br />
<br />

# Viewの作成  
Django REST frameworkにはViewSetsを使った方法なども存在しますが、今回はAPIViewを継承して作成していきます。  
APIViewを継承して作成する場合は、必要なHTTPメソッドを全て自分で記述する必要があります。  
まずはテーブルのデータをすべて取得するためのGETメソッドを「asset_management/views.py」に作成してみます。  
「order_by('created_at')」とすることで、日付順に並べる様にしました。

```python
from rest_framework.views import APIView
from rest_framework.status import HTTP_200_OK
from rest_framework.response import Response
from .models import Asset
from .serializers import AssetSerializer

class AssetListAPIView(APIView):
    def get(self, request):
        asset = Asset.objects.all().order_by('created_at')
        serializer = AssetSerializer(asset, many=True)

        return Response(serializer.data, status=HTTP_200_OK)
```   
<br />
<br />
# URLの設定  
先ほど作成したAPIを呼び出すためのルーティングの設定を行います。  
「config/urls.py」「asset_management/urls.py」をそれぞれ下記のように修正します。  
■config/urls.py  

```python
from django.contrib import admin
from django.urls import path, include

urlpatterns = [
    path('api/asset-management/', include('asset_management.urls')), # この行を修正
    path('admin/', admin.site.urls),
]

```

■asset_management/urls.py  

```python
from django.urls import path
from . import views

urlpatterns = [
    path('v1/assetlist/', views.AssetListAPIView.as_view()), # この行を修正
]
``` 
Class-based Viewsを読み込むとき、「as_view()」と記述する必要があるので注意が必要です。 

<br />
<br />

# サンプルデータの追加  
最低限の動作確認を行うため、とりあえずphpMyAdminの画面からデータを追加しておきます。  
![20221120193200](//images.ctfassets.net/g03afh073hzw/63aXv0iDZ49UHgWI8446s/f8866d7165c4b9a224a174903d51faa6/20221120193200.jpg)  
![20221120193300](//images.ctfassets.net/g03afh073hzw/3ULdWLkJ3ynqN3CioJDlna/b2ee167210fd1c671a62d228e6c51f1f/20221120193300.jpg)

<br />
<br />

# API動作確認  
http://localhost:8888/api/asset-management/v1/assetlist/  
にアクセスし、想定通りのデータが取得できているかどうかを確認します。  
![20221120193700](//images.ctfassets.net/g03afh073hzw/6dOrq64y5qmlijUzw3kv2R/03c15bf691faa49e4713b7fa72750738/image.png)

DBに登録した通りの値が取得できることが確認できました。  

<br />
<br />

# データ追加・更新・削除用APIの作成  
合わせて新規データ追加、更新、削除用APIも作成しておきます。  
先ほどと同じようにPOST、PUT、DELETEメソッドを作成して処理を記述するのみです。  
この時点でフロントエンドのとIFを決めておき、記述していきます。 
また、POST時には「diff」「diff_rate」は自動計算。「date」はとりあえず今日の日付を取得して自動で入れるようにします。  

```python
from rest_framework.views import APIView
from rest_framework.status import HTTP_200_OK, HTTP_201_CREATED, HTTP_400_BAD_REQUEST
from rest_framework.response import Response
from .models import Asset
from .serializers import AssetSerializer

class AssetListAPIView(APIView):
    def get(self, request):
        asset = Asset.objects.all()
        serializer = AssetSerializer(asset, many=True)

        return Response(serializer.data, status=HTTP_200_OK)

    # ここから追加した内容
        def post(self, request):
        date = dt.date.today()
        asset_amount = int(request.data['asset'])
        managed_app = request.data['app']
        memo = request.data['memo']
        last_data = Asset.objects.filter(managed_app=managed_app).order_by("created_at").last()
        diff = asset_amount - last_data.asset_amount
        diff_rate = round((asset_amount/last_data.asset_amount-1)*100, 2)
        data = {'asset_amount': asset_amount,
                'created_at': date,
                'diff': diff,
                'diff_rate': diff_rate,
                'managed_app': managed_app,
                'memo': memo
                }
        serializer = AssetSerializer(data=data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=HTTP_201_CREATED)
        return Response(serializer.errors, status=HTTP_400_BAD_REQUEST)

    def put(self, request):
        req_data = request.data
        data = {'id': req_data['id'], 'asset_amount': req_data['asset_amount'], 'diff': req_data['diff'],
                'diff_rate': req_data['diff_rate'], 'created_at': req_data['created_at'],
                'managed_app': req_data['managed_app'], 'memo': req_data['memo']}
        pre_data = Asset.objects.get(id=data['id'])
        serializer = AssetSerializer(pre_data, data=data)
        if serializer.is_valid():
            serializer.save()
            return Response(serializer.data, status=HTTP_201_CREATED)
        return Response(serializer.errors, status=HTTP_400_BAD_REQUEST)

    def delete(self, request):
        req_target = request.query_params.get('target')
        data = Asset.objects.get(id=req_target)
        data.delete()
        return Response(status=HTTP_204_NO_CONTENT)
```  
こちらもSerializerを使って簡単に実装することが出来ます。  

先ほどと同じように動作確認してみます。  
http://localhost:8888/api/asset-management/v1/asset/  
へアクセスすると、画面下にPOST用の欄があるのでこれを使います。  
![20221120194200](//images.ctfassets.net/g03afh073hzw/6QRmhuBOjbT9ZSMfwgGufL/87d81eeeb7894cb7d96485cfef1fd7e3/20221120194200.jpg)  

下記の様なデータを追加してみます。  

```yaml
{
"asset":"2600000",
"app":"1",
"memo":""
}
```  

成功すると下記のように表示されます。

![20221120194700](//images.ctfassets.net/g03afh073hzw/2vr3KzztuwxthYQ1pKOglh/c2f2bd0fbb6fb8a8935de9db635ba4c3/20221120194700.jpg)  

# その他のAPI作成  
とりあえずAssetモデルからデータの取得・更新・削除・追加を行うための基本的なAPIは作成しましたが、これだけでは使いにくいので他のAPIも用意しておきます。  

## 特定の情報のみ取得するAPI  
例えば、「Zaim」として登録したデータのみ取得するようなAPIです。グラフ表示用データ取得などに使うことを想定しています。    
基本的には同じことをやっていくだけなのですが、今回は「query_params.get()」でクエリパラメータを取得するようにします。ここでアプリを指定する想定です。  
また、資産額（asset_amouunt）のみを返すように作成するので、先ほど作成したSerializerは使わず、自分で配列を作り、それをreturnするようにしました。  

```python
class AssetAmountAPIView(APIView):
    def get(self, request):
        req_target = request.query_params.get('target')
        if req_target:
            asset = Asset.objects.filter(managed_app__name=req_target)
            asset = asset.values('asset_amount')
            asset_list = [
                {
                    'amount': a['asset_amount']
                }
                for a in asset
            ]
            data_list = []
            for a in asset_list:
                data_list.append(a['amount'])

        return Response({'data': data_list}, status=HTTP_200_OK)
``` 

## グラフラベル取得API  
グラフは縦軸：資産額、横軸：登録日とする予定なので、日付の一覧を取得するAPIを作成しておきます。  
とりあえず全アプリ同じ日にデータを登録することを前提とし、1つのアプリの情報のみ取得するようにします。
今回は「Zaim」決め打ちで作成しました。ここを各アプリごとに取得したい場合は、先ほどと同じように  
「req_target = request.query_params.get('target')」  
とすることで対象アプリを指定できるような作りにすればいいでしょう。  

```python
class AssetDateAPIView(APIView):
    def get(self, request):
        asset = Asset.objects.filter(managed_app__name='Zaim')
        asset = asset.values('created_at')
        asset_list = [
            {
                'created_at': a['created_at']
            }
            for a in asset
        ]
        date_list = []
        for a in asset_list:
            date_list.append(a['created_at'].strftime('%Y/%m/%d'))

        return Response({'data': date_list}, status=HTTP_200_OK)
``` 

## アプリ一覧取得API  
アプリマスタからアプリ一覧を取得するAPIです。例えば、データ登録画面を作る際に、セレクトボックスを作ったりするときに使います。  

```python
class AppListAPIView(APIView):
    def get(self, request):
        app = AppMaster.objects.all().order_by('id')
        serializer = AppSerializer(app, many=True)

        return Response(serializer.data, status=HTTP_200_OK)
``` 

最低限の作成・確認が出来たので、今回は一旦ここまでとしておきます。

グラフ

資産記録アプリ開発③～Django REST frameworkを使ったAPIの実装～

# 環境  
Docker、docker-compose以前入れた物なのでバージョンは少し古めです。  
OS：Windows 11 Home（21H2）  
Docker：version 20.10.2, build 2291f61  
docker-compose： version 1.27.4, build 40524192  
Python： 3.8  
<br />
<br />

# MySQL環境構築  
MySQLは最新版ではなく5.7を使用します。
ついでにGUIで色々出来るようにphpMyAdminもインストールしておきます。  

この2つをdocker-composeを使って構築していきます。 

まずはdocker-compose.yamlを作成します。  

```yaml
version: '3'

services:
  mysqldb:
    image: mysql:5.7
    container_name: mysql57_container
    environment:
      MYSQL_ROOT_PASSWORD: root
      MYSQL_DATABASE: money
      TZ: 'Asia/Tokyo'
    volumes:
      - ./docker/db/data:/var/lib/mysql  
      - ./docker/db/my.cnf:/etc/mysql/conf.d/my.cnf
      - ./docker/db/sql:/docker-entrypoint-initdb.d
    ports:
      - "3306:3306"
    command: mysqld --character-set-server=utf8mb4 --collation-server=utf8mb4_unicode_ci
  phpmyadmin:
    image: phpmyadmin/phpmyadmin
    depends_on:
      - mysqldb
    environment:
      - PMA_ARBITRARY=1
      - PMA_HOSTS='mysqldb'
    ports:
      - "8000:80"
    volumes:
      - ./docker/phpmyadmin/sessions:/sessions
```  

データ永続化などを考慮した作りにしておきます。  
合わせて下記の様なフォルダを作成しておきます。  

```yaml
D:mysql
├─docker-compose.yml
│
└─docker
    ├─db
    │  ├─my.cnf
    │  │
    │  ├─data
    │  │
    │  └─sql
    └─phpmyadmin
        └─sessions
```  

準備が出来たら立ち上げます。

```bash
docker-compose up
```  

「http://localhost:8000」へアクセスし、下記の様な画面が表示されログインできれば、立ち上げ成功です。  
![20221010120100](//images.ctfassets.net/g03afh073hzw/HgnQfAZxSsB8LCzM9NP62/ee9bd556becdc13fe907813a419ec175/20221010120100.jpg)  

![20221010121200](//images.ctfassets.net/g03afh073hzw/7mmkx4nUdCZlNw27TZyBkN/b91ec40dcbcd1b1e17d723cc640d4668/20221010121200.jpg)  
<br />
<br />

# テーブル作成  
まずは以前の手順を参考にDjangoの環境を構築します。  

```bash
conda create -n assetmanagement python=3.8
conda activate assetmanagement
conda install -c conda-forge django
django-admin startproject AssetManagement
```  

参考：  
[Djangoを使ってみる①(環境構築～プロジェクト作成)](https://hachidev.com/posts/Django%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%A6%E3%81%BF%E3%82%8B%E2%91%A0(%E7%92%B0%E5%A2%83%E6%A7%8B%E7%AF%89%EF%BD%9E%E3%83%97%E3%83%AD%E3%82%B8%E3%82%A7%E3%82%AF%E3%83%88%E4%BD%9C%E6%88%90)  
[Djangoを使ってみる②(アプリケーションの作成)](https://hachidev.com/posts/Django%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%A6%E3%81%BF%E3%82%8B%E2%91%A1(%E3%82%A2%E3%83%97%E3%83%AA%E3%82%B1%E3%83%BC%E3%82%B7%E3%83%A7%E3%83%B3%E3%81%AE%E4%BD%9C%E6%88%90)  
[Djangoを使ってみる④(Modelの作成～管理画面の使用)](https://hachidev.com/posts/Django%E3%82%92%E4%BD%BF%E3%81%A3%E3%81%A6%E3%81%BF%E3%82%8B%E2%91%A3(Model%E3%81%AE%E4%BD%9C%E6%88%90%EF%BD%9E%E7%AE%A1%E7%90%86%E7%94%BB%E9%9D%A2%E3%81%AE%E4%BD%BF%E7%94%A8)

下記の様なファイルが生成されます。  
今回はわかりやすいように「settings.py」等が入っているフォルダを「config」という名前に変更しておきます。  
「manage.py」「settings.py」の修正が必要なのでプロジェクト内を「AssetManagement」で検索して全て「config」に修正します。  

![20221010153500](//images.ctfassets.net/g03afh073hzw/4IqCcwZSq7qs6yVXSDvhjl/2258128fea5077e67a3435a640c3becb/20221010153500.jpg)  

続いて、アプリを作成します。ついでにMySQLを使用するためのライブラリもインストールしておきます。  

```bash
python manage.py startapp asset_management
pip install mysqlclient
```  

次にテーブルを作成するためにモデルの定義を行います。  
今回は資産総額管理画面のためのモデルだけ作成します。  
「asset_management\models.py」を下記のように編集します。  

```python
from django.db import models

class AppMaster(models.Model):
    name = models.CharField(max_length=128, unique=True)

class Asset(models.Model):
    created_at = models.DateField()
    asset_amount = models.IntegerField()
    diff = models.IntegerField()
    diff_rate = models.FloatField()
    managed_app = models.ForeignKey(AppMaster, on_delete=models.CASCADE, related_name='asett_app')
    memo = models.CharField(max_length=256, null=True, blank=True)
```  

Djangoはデフォルトではsqliteを使用する設定になっているため、settings.pyを下記のように修正し、MySQLに接続するようにします。  
今回は環境変数から値を読み取る様記載しました。  

```python
DATABASES = {
    'default': {
        'ENGINE': 'django.db.backends.mysql',
        'NAME': os.environ['DBNAME'],
        'USER': os.environ['DBUSER'],
        'PASSWORD': os.environ['DBPASSWORD'],
        'HOST': os.environ['DBHOST'],
        'PORT': os.environ['DBPORT'],
    }
}
```  
<br />
<br />

環境変数設定例 : 

| 変数名     | 値     |
| ---------- | ---------- |
| DBNAME       | money       |
| DBUSER       | root       |
| DBPASSWORD       | root       |
| DBHOST       | 127.0.0.1       |
| DBPORT       | 3306       |

<br />
<br />
その他、エラーが出ない様settings.pyやuils.pyを修正しておきましょう。  
環境が整ったら、マイグレーションを行います。  

```bash
python manage.py makemigrations
python manage.py migrate
```  

マイグレーションが成功後、再度phpMyAdminへアクセスすると下記のようにテーブルが作成されています。  
![20221010163100](//images.ctfassets.net/g03afh073hzw/2fg9ZjHEanqAVhOpqPeHFO/dade936dbc7d97cc66123f8319d2aed8/20221010163100.jpg)  
![20221010163200](//images.ctfassets.net/g03afh073hzw/3aZKu1fqjNvzcWvPEU19Wl/f757bdbdead8010d4cfa827d14754b39/20221010163200.jpg)

資産記録アプリ開発②～DB作成～

前回（[Djangoを使ってみる⑤(DBの中身を表示)](https://hachidev.com/posts/django_start_view "Djangoを使ってみる⑤(DBの中身を表示)")）DBの中身を表示してみたが、あのままでは少し味気ないので他の方法を試してみます。  
<br />
<br />

# DataTablesについて  
今回はDataTablesというものを使ってみます。  
DataTables：[datatables](https://datatables.net/ "datatables")  

・ページング機能  
・ソート機能  
・検索機能  
などが搭載されたテーブルを手軽に使うことが出来ます。  

データ量が多い場合はServer-side processingを使うと良いでしょう。  
今回データ量は少ないですがServer-side processingを使ってやってみます。  

<br />
<br />
# django-datatables-viewのインストール 
DjangoでServer Side Processingする場合は、 django-datatables-viewを使います。  
下記コマンドでインストールしておきます。  

```bash
pip install django-datatables-view
```  

<br />
<br />
# HTMLテンプレートの作成  
必要な処理は以下の通りです。  
①DataTablesを使うのに必要なファイルの読み込み

```html
<link rel="stylesheet" href="https://cdn.datatables.net/t/bs-3.3.6/jqc-1.12.0,dt-1.10.11/datatables.min.css"/>
    <script src="https://cdn.datatables.net/t/bs-3.3.6/jqc-1.12.0,dt-1.10.11/datatables.min.js"></script>
```

②テーブルの作成  

```html
<table id="book" class="table table-bordered">
  <thead>
    <tr>
      <th>本の名前</th>
      <th>作者</th>
      <th>出版社</th>
      <th>価格</th>
    </tr>
  </thead>
</table>
```  

③作成したテーブルにDataTablesを適用  

```html
<script>
  $('#book').DataTable({
  オプションを記載
  });
</script>
```  
オプションは公式に詳しく載っているので必要なものを記載しておきます。  
オプション：[option](https://datatables.net/reference/option/ "option")  

今回はServer-side processing(ajax)を使用するので下記のように設定します。  

```html
<!DOCTYPE html>
<html lang="en">
  <head>
    <meta charset="UTF-8">
    <title>書籍一覧</title>
    <link rel="stylesheet" href="https://cdn.datatables.net/t/bs-3.3.6/jqc-1.12.0,dt-1.10.11/datatables.min.css"/>
    <script src="https://cdn.datatables.net/t/bs-3.3.6/jqc-1.12.0,dt-1.10.11/datatables.min.js"></script>
  </head>
  <body>
    <table id="book" class="table table-bordered">
      <thead>
        <tr>
          <th>本の名前</th>
          <th>作者</th>
          <th>出版社</th>
          <th>価格</th>
        </tr>
      </thead>
    </table>
    <script>
      $('#book').DataTable({
        deferRender: true,
        serverSide: true,
        processing: true,
        orderCellsTop: true,
        responsive: true,
        ajax: {
          "url": "/data/",
          "type": "GET",
        },
        columnDefs: [
          {targets: 0, data: 'book_name'},
          {targets: 1,  data: 'author' },
          {targets: 2,  data: 'publisher' },
          {targets: 3,  data: 'price' },
        ]
      });
    </script>
  </body>
</html>
```  
<br />
<br />
# views.pyの編集  
先ほど設定したテーブルにmodelのデータを渡すための処理を追加します。  
これまでと違い「class」にしなければいけないので注意が必要です。  

```python
from django_datatables_view.base_datatable_view import BaseDatatableView

class DataTableView(BaseDatatableView):
    # モデルの指定
    model = book_list
    # 表示するフィールドの指定
    columns = ['book_name', 'author', 'publisher', 'price']

    # 検索方法の指定：部分一致
    def get_filter_method(self):
        return super().FILTER_ICONTAINS
```
ソース全体はこちらを参照：  
[views.py](https://github.com/hachi0088/django/blob/master/test_app/views.py "views.py")  
<br />
<br />
# urls.pyの編集  
htmlファイルを読み込むための処理と先ほどのviews.pyに記載した処理を紐づけるための処理を記載します。  

```python
from django.urls import path
from django.views.generic import TemplateView
from .views import DataTableView #追加部分
from . import views

urlpatterns = [
    path('', views.index, name='index'),
    path('book_list/', views.view_book_list, name='book_list'),
    path('book_list_datatables', TemplateView.as_view(template_name='test_app/book_list_datatables.html'), name='book_list_datatables'), #追加部分
    path('data/', DataTableView.as_view()), #追加部分
]
```  

※「path('data/', DataTableView.as_view()),」  
の「'data/'」の部分はhtmlファイルに記載した「ajax」のurlの部分と一致させる必要があります  

```html
ajax: {
          "url": "/data/",
          "type": "GET",
        },
```  
<br />
<br />
# 動作確認  
「python manage.py runserver 127.0.0.1:8000」でサーバを起動させ、  
[http://127.0.0.1:8000/book_list_datatables]  
にアクセスをし、下記のように表示されていればＯＫです。  
![20210530114822](//images.ctfassets.net/g03afh073hzw/630ZrFUBFOg1M1Hzy7qRY9/e7fedbe9af142cf6b74c54b36eacdc56/20210530114822.jpg)

環境一式はこちら：  
[https://github.com/hachi0088/django](https://github.com/hachi0088/django "https://github.com/hachi0088/django")

Django

DataTablesとDjango（model）の連携

# 目指す形  
前回登録したデータをテーブル形式で表示するページを作成してみます。
「下記赤枠の部分をクリックすると、データ一覧表示」というのを目指してみます。  
![20210523120021](//images.ctfassets.net/g03afh073hzw/585eFX5xzjPRWReYcnr3kA/f2b65dfc4fa650d58f711c13924cd1f4/20210523120021.jpg)  
<br />
<br />
# view.pyの編集  
test_appフォルダの中にある「view.py」に関数を追加します。  

```python
from django.http import HttpResponse
from django.shortcuts import render
from .models import book_list

def index(request):
    return render(request, 'test_app/index.html')

# 今回追加した関数
def view_book_list(request):
    data = book_list.objects.all() # book_listテーブルの全データ取得
    contents = {'data': data} # contentsという辞書型変数に取得したデータを格納
    return render(request, 'test_app/book_list.html', contents) # book_list.htmlを表示する処理。先ほどのcontentsという変数に格納されたデータを渡す
```  
<br />
<br />
# テンプレートの作成  
「templates」フォルダに「book_list.html」を作成します。  
book_list.htmlには、  
テーブルを1つ用意し、先ほどviews.pyで設定した「contents」という変数に格納されているデータを展開し、一覧を表示する  
という処理を記載します。  

```html
<!DOCTYPE html>
<html>

<head>
    <meta charset="utf-8" />
    <title>書籍一覧</title>
</head>

<body>
    <h1>書籍一覧</h1>
    <table border="1">
        <tr>
            <th>本の名前</th>
            <th>作者</th>
            <th>出版社</th>
            <th>価格</th>
        </tr>
        {% for book in data %} 
        <tr>
            <td>{{ book.book_name }}</td>
            <td>{{ book.author }}</td>
            <td>{{ book.publisher }}</td>
            <td>{{ book.price }}</td>
        </tr>
        {% endfor %}
    </table>
</body>
```  
<br />
<br />
# urls.pyの編集  
先ほど作成したテンプレートを表示できるようurls.pyに下記を追記します。  

```python
from django.http import HttpResponse
from django.shortcuts import render
from .models import book_list

def index(request):
    return render(request, 'test_app/index.html')

# 今回追加した関数
from django.urls import path

from . import views

urlpatterns = [
    path('', views.index, name='index'),
    path('book_list/', views.view_book_list, name='book_list'), #追加部分
]
```  
<br />
<br />
# index.htmlの編集  
index.htmlの101行目にリンクを記載する部分があるのでリンク先のURLを「book_list/」と修正します。  
![20210523145735](//images.ctfassets.net/g03afh073hzw/1o7kUdmxFqb5QMkIT2PlGf/81c570fe4eb25d513fd0b7342fbd2b5d/20210523145735.jpg)  
<br />
<br />
# 動作確認  
いつも通り  
python manage.py runserver 127.0.0.1:8000  
でサーバーを起動し、「[http://127.0.0.1:8000/]」へアクセスします。  
赤枠部分をクリックしてページ遷移をするとDBに登録したデータの一覧が表示されます。  
![20221019121600](//images.ctfassets.net/g03afh073hzw/1liHh0wzphMFawV002zpQg/64b9b11a84eeff5275e5fc4ac7110ee0/20221019121600.jpg)

Djangoを使ってみる⑤(DBの中身を表示)

# modelの作成  
## models.pyの編集  
test_appフォルダの中にある「models.py」を編集しmodelを作成することでDBのテーブル設計が出来ます。  

![20210522183811](//images.ctfassets.net/g03afh073hzw/3OKEj0WxToOlt25lUSo31y/35864de622df547574c1343b83fdf770/20210522183811.png)  

例えば下記の様なデータ構造を作りたい場合
テーブル名：book_list

| 本の名前(book_name) | 作者(author) | 出版社(publisher) | 価格(price) |
| ---------- | ---------- | ---------- | ---------- |
| 入門 Python 3 | Bill Lubanovic | オライリージャパン | 4070       |
| 独習Python | 山田 祥寛  | 翔泳社  | 3300  |
| ・・・ | ・・・ | ・・・ | ・・・ |

models.pyに下記のように追記します。  

```python
from django.db import models

class book_list(models.Model):
    book_name = models.CharField(max_length=200)
    author = models.CharField(max_length=200)
    publisher = models.CharField(max_length=200)
    price = models.CharField(max_length=200)
```  

※field type、field option一覧：[Model field reference | Django documentation | Django](https://docs.djangoproject.com/en/3.2/ref/models/fields/#model-field-types "Model field reference | Django documentation | Django")  
<br />
<br />
## マイグレーションファイルの作成  
settings.pyを開き、INSTALLED_APPSにアプリケーションを追加します。  
![20210522191201](//images.ctfassets.net/g03afh073hzw/57R3FIvkmNxEZS2cmkc5Tm/a14224cad6b91a26405d30a2bd4d325f/20210522191201.png)

makemigrationsコマンドを実行します。  
コマンド例：python manage.py makemigrations test_app  

そうすると「book_list」というmodelが作成されます。  
![20210522191335](//images.ctfassets.net/g03afh073hzw/5crAUl3pwMI3KdLyBw82Cu/0c0e468aa7c1a9d8b1cef0d40163c749/20210522191335.png)  
<br />
<br />
## modelをデータベースに反映  
migrateコマンドを実行し、modelをデータベースに反映させます。  
コマンド例：python manage.py migrate  
![20210523091245](//images.ctfassets.net/g03afh073hzw/1zOLVzZwAmnKI7nD5wTkLu/f1720c8f3fbad55a683156ede2147240/20210523091245.png)  

これでデータベースにbook_listというテーブルを作成することが出来ました。  
modelを確認するため、管理画面を有効化してみます。  
<br />
<br />
# 管理画面の使用  
必須というわけではありませんが、簡単に使用できるので使ってみます。  
<br />
<br />
## 管理者ユーザーの作成  
管理画面を使用するために管理者ユーザー (スーパーユーザー) を作成します。  
コマンド：python manage.py createsuperuser  
ユーザー名やメールアドレス、パスワードを入力します。  
パスワードは8文字以上設定する必要があるので注意が必要です。  

![20210523093005](//images.ctfassets.net/g03afh073hzw/1V7Rjj2742xyumBhdXttBh/e5864d81848ae24c527adb38d146c512/20210523093005.png)  

<br />
<br />
## admin.pyの編集  
管理画面でmodelを見るために、modelを登録する必要があります。  
「test_app」フォルダに含まれているadmin.pyを開き、以下のように記述します。  

```python
from django.contrib import admin
from test_app.models import book_list #追加

admin.site.register(book_list) #追加
```  

![20210523093557](//images.ctfassets.net/g03afh073hzw/5vIxAVVPuSDXuzfI9EqmsD/50822529d30182a72f36f0cca3f9576f/20210523093557.png)  
<br />
<br />
## 管理画面へログイン  
これまで通り  
python manage.py runserver 127.0.0.1:8000  
でサーバを起動させます。  
起動後、ブラウザから  
http://127.0.0.1:8000/admin/  
へアクセスします。  

ログイン画面が出てくるので先ほど設定したユーザー名とパスワードを入力してログインします。  

![20210523094003](//images.ctfassets.net/g03afh073hzw/6O3yVqs2YlTq2gJ6ReQCLS/2b413b9281ddc9a6473c70410d41530c/20210523094003.png)  

ログインに成功すると下記のような画面が表示されます。  
「Book_lists」が表示されているのでmodelの登録は問題なくできているようです。  
![20210523094214](//images.ctfassets.net/g03afh073hzw/1d5Cm5kyqI7akfqQJjIubJ/1764daaf35e314200dd444563a2e4f70/20210523094214.png)  
<br />
<br />
## データ登録  
先ほどの「Book_lists」クリックすると下記の様な画面が表示されます。  
![20210523094332](//images.ctfassets.net/g03afh073hzw/5Iy1y1LImCAmwwrTTNEgYk/eb5a3c60a1bf4ebe0d267d64a15cc4b0/20210523094332.png)  

『「BOOK_LIST」を追加＋』をクリックすると下記の様なデータ登録画面が表示されます。  
![20210523094839](//images.ctfassets.net/g03afh073hzw/aF6TRLPAJt0QvlncjQWNz/620c1e4c223f8cf4b63e07882fc5535e/20210523094839.png)  

最初の例に挙げた2つのデータを登録してみます。  
![20210523095248](//images.ctfassets.net/g03afh073hzw/3nneklGGXP5cntFts1hfOC/068b9e3e59406ba185dac4109f106250/20210523095248.png)

データが登録されると下記のように「book_list object」というのが2つ生成されます。
各リンクをクリックすると、データの中身を編集することも可能です。  
![20210523095329](//images.ctfassets.net/g03afh073hzw/4nDru0KkAgftQ0KkTC5WQr/912cb9704bd7f29ff2b0fbc0fc346a2a/20210523095329.png)

Djangoを使ってみる④(Modelの作成～管理画面の使用)

# 使用するテンプレート  
「Hello, world」と表示するだけでは味気ないので既存のテンプレートを使ってトップページを作ってみます。  
今回は試しに「LESSER」というテンプレートを使ってみます。  
その他、「bootstrap テンプレート」などで調べると無料、有料問わず色々出てくるので好きなテンプレートを選べばOKです。  
基本的にやることはどのテンプレートでも同じになるはずです。  
[Lesser: Free HTML5 Bootstrap Template - FreeHTML5.co](https://freehtml5.co/preview/?item=lesser-free-html5-bootstrap-template:embed "Lesser: Free HTML5 Bootstrap Template - FreeHTML5.co")
<br />
<br />
# テンプレートのダウンロードと配置  
「Free Download」からテンプレートをダウンロードします。  
![20210509154521](//images.ctfassets.net/g03afh073hzw/w7YEOzlUhRqjZyuV1yYaW/5dbda881caa65c3f59579a702eedb567/20210509154521.png)

manage.pyのある階層に「static」「templates」フォルダを作成します。  
![20210509154656](//images.ctfassets.net/g03afh073hzw/6yGBvR4FFNssfP4BKeu7k8/71461df9d17fcdb99f9de12eba19be2e/20210509154656.png)  

ダウンロードしたテンプレートを解凍し、「css」「fonts」「images」「js」「sass」を先ほど作成した「static」フォルダにコピーします。  
![20210509155411](//images.ctfassets.net/g03afh073hzw/kRr1QVGLS6CqBrT8Ua0Mp/581f756d9136ac6cb4ffd60ba1492b15/20210509155411.png)  

「templates」フォルダに「test_app」というフォルダを作成し、そこにindex.htmlをコピーします。  
![20210509155655](//images.ctfassets.net/g03afh073hzw/162fLxNCncoVTXYYQIVB4O/c7debdb0de679b6b1a2d8d7334f51031/20210509155655.png)  
<br />
<br />
# settings.pyの編集  
TEMPLATESの部分を以下のように修正します。  

```python
TEMPLATES = [
    {
        'BACKEND': 'django.template.backends.django.DjangoTemplates',
        'DIRS': [os.path.join(BASE_DIR, 'templates')],　#修正箇所
        'APP_DIRS': True,
        'OPTIONS': {
            'context_processors': [
                'django.template.context_processors.debug',
                'django.template.context_processors.request',
                'django.contrib.auth.context_processors.auth',
                'django.contrib.messages.context_processors.messages',
            ],
        },
    },
]
```  

また、下記を追加します。  

```python
STATICFILES_DIRS = [
    os.path.join(BASE_DIR, "static")
]
```  
※osがimportされていない場合は「import os」も追加します  

変更を加えた箇所  
![20210509155948](//images.ctfassets.net/g03afh073hzw/5CMTQYaWrGnObEwkWVZOOG/8dc3c16000fef06dea37931608211cae/20210509155948.png)  
<br />
<br />
# test_app/views.pyの編集  
「Hello, world」と表示する処理を記載していた個所を、index.htmlを読み込む処理に変更します。  
views.pyを以下のように編集します。  

```python
from django.http import HttpResponse
from django.shortcuts import render #新規追加

def index(request):
    return render(request, 'test_app/index.html') #index.htmlを読み込む処理に変更
```  
<br />
<br />
# index.htmlの修正  
デフォルト状態ではstatic配下のファイルを読みに行くことが出来ないためパスを変更する必要があります。  
まずファイルの先頭に下記の記述を追加します。  

```html
{% load static %}
```  

次にcssファイル、jsファイル、jpgファイルを読み込ませるため、  

```html
<link rel="stylesheet" href="css/******.css">
<script src="js/******.js"></script>
<a href="#" class="featured-grid" style="background-image: url(images/******.jpg);">
<a href="#"><img class="img-responsive" src="images/******.jpg" alt="Blog"></a>
```  

の様な個所のファイルパスの部分を「{% static 'ファイルパス' %}」で囲みます。

```html
<link rel="stylesheet" href="{% static 'css/******.css' %}">
<script src="{% static 'js/******.js' %}"></script>
<a href="#" class="featured-grid" style="background-image: url({% static 'images/******.jpg' %});">
<a href="#"><img class="img-responsive" src="{% static 'images/******.jpg' %}" alt="Blog"></a>
```  
の様に修正します。  
例えば下記の様な個所です。  

![20210509161106](//images.ctfassets.net/g03afh073hzw/3ybEskNm2AY4h8wNgSI8SH/43a65d7b8dd7df1df1c0f4380c22932e/20210509161106.png)  

参考：変更後のファイル  
[ファイル](https://github.com/hachi0088/django/blob/master/templates/test_app/index.html "ファイル")  
<br />
<br />
# 動作確認  
サーバを再起動し、http://127.0.0.1:8000へアクセスします。  
下記のようにテンプレートが読み込まれていればOK。  

![20210509162814](//images.ctfassets.net/g03afh073hzw/64DBqJmFeXdp8pyEgPAN3r/b275f6d5e3a0c24165d92e145890ea12/20210509162814.png)
![20210509162826](//images.ctfassets.net/g03afh073hzw/6PHIgkJ4Y46jkRa75if27y/a6aaac9c35bbaa60bfdc366301d30bef/20210509162826.png)

Djangoを使ってみる③(テンプレートの適用)

# アプリケーションの作成  
「python manage.py startapp アプリケーション名」でアプリケーションを作成します。  
今回は「test_app」という名前で作成して進めていきます。  

```shell
python manage.py startapp test_app
```  

作成すると下記のようにtest_appフォルダが生成されます。  
![ファイル一覧①](//images.ctfassets.net/g03afh073hzw/4llfJGlgJdHCUne2sZpplg/1db7ed84699559cc4a3728cce0fa1099/_____________________.png)

![ファイル一覧②](//images.ctfassets.net/g03afh073hzw/14EGKWutJSppfhPW27YS8t/3b2036c8d5d347906f2b1bcfac934504/_____________________.png)
<br />
<br />
# test_app/view.pyの編集  
HttpResponseを返す関数を作成します。
下記はページへアクセスしたときにページ上に「Hello, world」を表示する処理になります。  

```python
from django.http import HttpResponse

def index(request):
    return HttpResponse("Hello, world")
```  
<br />
<br />
# test_app/urls.pyの作成  
test_appフォルダ配下にurls.pyを作成し、下記のコードを記述します。
view.pyで作成した関数を記述します。  

```python
from django.urls import path

from . import views

urlpatterns = [
    path('', views.index, name='index'),
]
```  
<br />
<br />
# django_site/urls.pyの編集  
```python
from django.contrib import admin
from django.urls import path, include #追加

urlpatterns = [
    path('', include('test_app.urls')), #追加
    path('admin/', admin.site.urls),
]
```  
<br />
<br />
# 動作確認  
サーバを再起動し、作成したページにアクセスすると下記のように表示されます。
![hello](//images.ctfassets.net/g03afh073hzw/2gGGwej2i1u3oXdxSwCtEj/4b4900fa8119dec1ba6d4191e2661d26/hello.png)

Djangoを使ってみる②(アプリケーションの作成)

# 前提
OS:Windows10  
<br />
<br />
# 準備  
Django用の環境を作成し、インストール  
bootstrapもインストールしておきます  

```shell
conda create -n django python=3.7
conda activate django
conda install -c conda-forge django
conda install -c conda-forge django-bootstrap4
```
<br />
<br />
# プロジェクトの作成
プロジェクトを作成したい場所へ移動します  

```shell
D:
cd django
```
プロジェクトの作成  

```shell
django-admin startproject django_site
```
プロジェクトを作成すると以下のようなファイルが自動生成されます  
![generate_file](//images.ctfassets.net/g03afh073hzw/41tlDpDCW7TrCCgk695GbX/7a3c1a8724dbb32891475ff33571952d/generate_file.png)
![generate_file2](//images.ctfassets.net/g03afh073hzw/JXbyZhkSGN9OmDpvlMsb8/383bc02977479b63d79007cfb7e4cdb4/generate_file2.png)
<br />
<br />
# サーバの起動
manage.pyのある場所へ移動し、「python manage.py runserver」を実行します  

```shell
cd django_site
python manage.py runserver
```

起動が成功すると下記のようなメッセージが出力されます  
![launch_server](//images.ctfassets.net/g03afh073hzw/1dXDKu6loXy3eNxW42JW0S/28d4d3ef43a34ec76eee67d5ae7ff488/launch_server.png)

メッセージに記載されているアドレスへアクセスすると以下のような画面が表示されます  
![start](//images.ctfassets.net/g03afh073hzw/ZPabE9mYhoKw6DPMjyUSM/0fc5b4c2716b94a149b75bbe8311ef12/start.png)

ポートなどを指定したい場合は「python manage.py runserver IPアドレス:ポート番号」とすればOKです  

```shell
python manage.py runserver 127.0.0.1:8080
```  

<br />
<br />
# setting.pyの変更
## アクセス許可設定
setting.pyの28行目でアクセス許可の設定が可能です  
IPアドレスやホスト名を記述することで、アクセスを制限することが出来ます。  
「"*"」とすることですべてのホストを許可することも可能です 

```python
ALLOWED_HOSTS = ["*"]
```  
<br />
<br />
## LANGUAGE_CODE、TIME_ZONEの設定
setting.pyを開き106行目(LANGUAGE_CODE)、108行目(TIME_ZONE)を以下のように変更します  

```python
LANGUAGE_CODE = 'ja'

TIME_ZONE = 'Asia/Tokyo'
```
![setting](//images.ctfassets.net/g03afh073hzw/4wObiVRyCoV5fCDcPcWWeD/7194f10435ffc3f927a58efbf5096403/setting.png)

変更し、サーバを再起動すると以下のように日本語になっていることが確認できます  
![japanase](//images.ctfassets.net/g03afh073hzw/3lKTIpE2IBjFFCfBxnObrM/5020e32a2fecb81f9c31a27e335f5ae0/japanase.png)