【Django入門16】ファイルアップロード機能の実装｜ユーザーのアップロードを処理する方法

ファイルアップロード機能とは？

ファイルアップロードの基本

ファイルアップロード機能とは、ユーザーが画像やドキュメントなどのファイルをWebアプリケーションにアップロードし、サーバー側で保存および管理する機能のことです。この機能は、ユーザープロフィール画像の登録、ドキュメントの共有、メディア管理など、さまざまな用途で使用されます。

ファイルアップロードの仕組み

ファイルアップロードの基本的な仕組みは以下の通りです：

フォームにファイルを選択してアップロード。
サーバーにファイルが送信される。
サーバー側でファイルを保存し、必要に応じてデータベースに情報を記録する。
保存したファイルを適切に表示したり、利用したりする。

プロジェクトの準備

必要なパッケージのインストール

Djangoにはファイルアップロードを行うための機能が標準で備わっていますが、メディアファイルの取り扱いには追加の設定が必要です。

仮想環境が設定されている前提で進めます。

pip install pillow  # 画像ファイルを扱う場合

Pillowは、画像のバリデーションやサイズ変更などをサポートするPythonのライブラリです。

プロジェクト構成の確認

Djangoプロジェクト内の構成が次のようになっていることを確認してください。

myproject/
    ├── manage.py
    ├── myproject/
    │   ├── settings.py
    │   ├── urls.py
    │   └── ...
    ├── myapp/
    │   ├── models.py
    │   ├── views.py
    │   ├── forms.py
    │   └── templates/

モデルの定義

ファイル情報を保存するモデル

アップロードしたファイルを管理するために、データベースのテーブルと対応するモデルを定義します。

models.py:

from django.db import models

class UploadedFile(models.Model):
    title = models.CharField(max_length=100)
    file = models.FileField(upload_to='uploads/')  # アップロード先のディレクトリを指定
    uploaded_at = models.DateTimeField(auto_now_add=True)

    def __str__(self):
        return self.title

FileField: ファイルをアップロードするためのDjangoのフィールド。
upload_to: ファイルの保存先ディレクトリを指定します。
auto_now_add: ファイルがアップロードされた日時を自動的に記録します。

マイグレーションの適用

モデルを定義したら、マイグレーションを行ってデータベースに反映します。

python manage.py makemigrations
python manage.py migrate

フォームの作成

アップロードフォームの定義

ファイルアップロード用のフォームを作成します。

forms.py:

from django import forms
from .models import UploadedFile

class UploadFileForm(forms.ModelForm):
    class Meta:
        model = UploadedFile
        fields = ['title', 'file']

ModelForm: モデルと連携したフォームを簡単に作成できます。
fields: フォームで表示するフィールドを指定します。

ビューの作成

ファイルアップロードの処理を行うビュー

ファイルをアップロードするためのビューを作成します。

views.py:

from django.shortcuts import render, redirect
from .forms import UploadFileForm
from .models import UploadedFile

def upload_file_view(request):
    if request.method == 'POST':
        form = UploadFileForm(request.POST, request.FILES)  # ファイルデータはrequest.FILESに含まれる
        if form.is_valid():
            form.save()  # データベースに保存
            return redirect('file_upload_success')
    else:
        form = UploadFileForm()
    return render(request, 'upload.html', {'form': form})

request.FILES: ファイルアップロード時に必要なデータが含まれます。
form.save(): モデルインスタンスをデータベースに保存します。

アップロード成功ページのビュー

def upload_success_view(request):
    return render(request, 'upload_success.html')

テンプレートの作成

ファイルアップロードフォームのテンプレート

templates/upload.html:

<!DOCTYPE html>
<html lang="ja">
<head>
    <meta charset="UTF-8">
    <title>ファイルアップロード</title>
</head>
<body>
    <h1>ファイルアップロード</h1>
    <form method="POST" enctype="multipart/form-data">
        {% csrf_token %}
        {{ form.as_p }}
        <button type="submit">アップロード</button>
    </form>
</body>
</html>

enctype="multipart/form-data": ファイルを含むフォームを送信するために必要です。
csrf_token: セキュリティ対策としてCSRF保護を有効にします。

アップロード成功メッセージのテンプレート

templates/upload_success.html:

<!DOCTYPE html>
<html lang="ja">
<head>
    <meta charset="UTF-8">
    <title>アップロード成功</title>
</head>
<body>
    <h1>ファイルのアップロードに成功しました！</h1>
    <a href="/upload/">もう一度アップロードする</a>
</body>
</html>

URLの設定

パスの追加

ファイルアップロード用のURLパスを設定します。

urls.py:

from django.urls import path
from .views import upload_file_view, upload_success_view

urlpatterns = [
    path('upload/', upload_file_view, name='file_upload'),
    path('upload/success/', upload_success_view, name='file_upload_success'),
]

メディアファイルの設定

settings.pyの設定

ファイルの保存先やURLの設定を追加します。

settings.py:

import os

MEDIA_URL = '/media/'
MEDIA_ROOT = os.path.join(BASE_DIR, 'media')

MEDIA_URL: アップロードしたファイルにアクセスするためのURLパス。
MEDIA_ROOT: アップロードしたファイルを保存するディレクトリ。

開発環境での設定

開発サーバでメディアファイルを提供するために、urls.pyに次の設定を追加します。

myproject/urls.py:

from django.conf import settings
from django.conf.urls.static import static

urlpatterns += static(settings.MEDIA_URL, document_root=settings.MEDIA_ROOT)