More than 3 years have passed since last update.

Laravel 6.x 【ファイルアップロード】バリデーションのfileとisValidメソッドの違いを検証->必ず存在確認が必要!

Posted at 2020-10-17

#制作環境

Windows 10
Laravel : 6.18.35
Laravel/ui : 1.0
Laravel-mix : 5.0.1
Bootstrap : 4.0.0
MDBootstrap : 4.19.1
chart.js : 2.9.3
XAMPP
PHP : 7.4.3
Visual Studio Code

#はじめに
この記事はプログラミングをはじめたばかりの素人が、できたことをメモするのに利用しています。
内容には誤りがあるかもしれません。

#検証することにした経緯
とあるサイトで以下のような記述がありました(一部抜粋)。

public function upload(Request $request)
    {
        $this->validate($request, [
            'file' => [
                // 必須
                'required',
                // アップロードされたファイルであること
                'file',
                // 画像ファイルであること
                'image',
                // MIMEタイプを指定
                'mimes:jpeg,png',
            ]
        ]);

        if ($request->file('file')->isValid([])) {
            $path = $request->file->store('public');

            $file_name = basename($path);
            $user_id = Auth::id();
            $new_image_data = new Image();
            $new_image_data->user_id = $user_id;
            $new_image_data->file_name = $file_name;

            $new_image_data->save();

            return redirect('/output');
        } else {

画像のアップロードについて検索している時に見つけたのですが、バリデーションルールのfileとisValidが同じ事をしているように思え、片方は記述が不要なのではないかと思い、検証してみることにしてみました。

#リファレンスの説明
###バリデーションルールのfileについて

###isValidメソッドについて

#検証前の自分の見解
バリデーションでフィールドがアップロードに成功したことの確認が取れたということは、(アップロードされているから)ファイルが存在している。

アップロードに成功しているので、問題なくアップロードができている。

故に、両方とも同じ内容で片方は不要なのではないか?

#そもそもの誤解
検証中に気づいたのですが、リファレンスの内容の解釈に誤解がありました。
isValidについて、リファレンスでは**「ファイルが存在しているかに付け加え、isValidメソッドで問題なくアップロードできたのかを確認できます。」と記載があった為、てっきり「ファイルの存在確認+問題なくアップロードできたか確認」の両方をやっていると思ったのですが、実際はファイルの存在確認の記述にプラス(付け加えて)でisValidを記述すれば、問題なくアップロードできたかの確認もできる**という内容でした。

#検証にあたり
ビューはアップロードのフォームとエラー・成功時のメッセージがでるだけの簡単なものを作成し、コントローラーの記述を変更することで検証していきました。
検証に直接関係ないのでビューは記載しません。
画像のアップロードを想定しています。

ビューのイメージ

#検証
##検証① バリデーションfileのみ記載画像に対する処理なし
上記の条件で、ファイルを選択しない(空:null)状態で送信ボタンをクリック。

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Models\FileImage;

class FileUpController extends Controller
{
    public function index()
    {
        $data = FileImage::all();
        return view('file', compact('data'));
    }

    public function store(Request $request)
    {
        $this->validate($request, [
            'img' => 'file',
        ]);
        return redirect('/file')->with('success', '登録完了しました。');
    }
}

結果:エラーなし。「登録完了しました。」が表示される。
####★注意点★
fileのみの記載だと、バリデーションは全く機能しません。
ファイルを選択し、送信をクリックした場合も結果は同じでした。
fileはあくまでも、アップロードに成功したかどうかだけを検証しているようで、アップロードの操作が内部で行われていなけば、全く機能しません。

ファイル選択なし⇒ファイルがないので、アップロードの操作なし⇒file機能せず⇒バリデーション通過
ファイル選択あり⇒ファイルがあるので、アップロードの操作あり⇒fileバリデーション実行⇒バリデーション通過

つまり、必ずファイル自体の存在確認(require等)が必須です。

##検証② バリデーションfileのみ記載画像に対する処理あり
上記の条件で、ファイルを選択しない(空:null)状態で送信ボタンをクリック。

    public function store(Request $request)
    {
        $this->validate($request, [
            'img' => 'file',
        ]);

        $path = $request->img->store('public/images');
        $filename = basename($path);

        $data = new FileImage;
        $data->file_name = $filename;
        $data->save();

        return redirect('/file')->with('success', '登録完了しました。');
    }

結果:エラー発生「Call to a member function store() on null」。
ファイルの存在確認をしていない為、ファイルが無い(空:null)時の処理でエラーが発生する。
※そもそもこういう処理の書き方はしないと思いますが、細かな動作を確認したい為、わざとやってます。

検証①の結果の通り、fileのみの記載はほぼザルなので、やはり必ずファイル自体の存在確認が必須です。

##検証③ isValidメソッドのみ記載画像に対する処理なし
上記の条件で、ファイルを選択しない(空:null)状態で送信ボタンをクリック。

    public function store(Request $request)
    {
        if ($request->file('img')->isValid()) 
            return redirect('/file')->with('success', '登録完了しました。');
        }
        return redirect('/file')->with('success', '失敗しました。');
    }

結果:エラー発生「Call to a member function isValid() on null」。
メソッド自体が機能せずエラーが発生。

やはり、必ずファイル自体の存在確認が必須です。