跳到内容

Laravel 文件上传实现指南|验证、存储和 S3 支持

分类:Laravel·PHP
本文目前仅提供日文版本。我们正在进行翻译工作。

Laravel 具有丰富的文件上传功能,允许您使用一致的 API 实现验证、存储抽象和 S3 集成。本文系统地解释了实际的文件上传实现,从如何使用 <code>Request::file()</code> 开始,通过验证规则和使用 Storage 外观进行保存,到 S3 驱动程序配置。

Client Request file() / validate() Storage disk()->put() storage/app/public S3 Bucket
图:Laravel 上传流程(Request → Storage → 本地/S3)

如何使用 Request::file() 和 hasFile()

要在 Laravel 控制器中接收上传的文件,请使用 <code>$request->file()</code> 方法。此方法返回一个 <code>Illuminate\Http\UploadedFile</code> 实例,它扩展了 Symfony 的 <code>UploadedFile</code>。

use Illuminate\Http\Request;
use Illuminate\Support\Facades\Storage;

class FileUploadController extends Controller
{
    public function store(Request $request)
    {
        // ファイルが送信されているか確認
        if (!$request->hasFile('avatar')) {
            return response()->json(['error' => 'ファイルが選択されていません。'], 422);
        }

        // UploadedFile インスタンスを取得
        $file = $request->file('avatar');

        // アップロードが成功しているか確認
        if (!$file->isValid()) {
            return response()->json(['error' => 'ファイルのアップロードに失敗しました。'], 422);
        }

        // ファイル情報の取得
        $originalName  = $file->getClientOriginalName();  // 元のファイル名
        $extension     = $file->getClientOriginalExtension(); // 元の拡張子
        $mimeType      = $file->getMimeType();             // サーバー側で判定したMIMEタイプ
        $clientMime    = $file->getClientMimeType();       // クライアントが申告したMIMEタイプ(信頼しない)
        $size          = $file->getSize();                 // バイト単位のサイズ
        $tmpPath       = $file->getRealPath();             // 一時ファイルのパス

        // 複数ファイルの場合(input[type="file" multiple])
        $files = $request->file('documents');
        foreach ($files as $uploadedFile) {
            // 各ファイルを処理
        }
    }
}

使用 <code>$request->validate()</code> 进行文件验证

使用 Laravel 的验证功能,您可以以声明式方式验证文件 MIME 类型、大小、图像尺寸等。验证失败时,会自动返回 422 响应。

public function store(Request $request)
{
    $validated = $request->validate([
        // 基本的なファイルバリデーション
        'avatar' => [
            'required',
            'file',                          // ファイルであること
            'mimes:jpg,jpeg,png,gif,webp',   // 許可するMIMEタイプ(拡張子指定でMIMEを自動判定)
            'max:5120',                      // KB単位のサイズ上限(5120KB = 5MB)
        ],

        // 画像専用のバリデーションルール
        'thumbnail' => [
            'required',
            'image',                         // 画像ファイルであること(JPEG/PNG/GIF/WebP/SVG)
            'mimes:jpg,jpeg,png,webp',
            'max:2048',                      // 2MBまで
            'dimensions:min_width=100,min_height=100,max_width=4096,max_height=4096',
        ],

        // PDFのバリデーション
        'document' => [
            'required',
            'file',
            'mimes:pdf',
            'max:20480',                     // 20MBまで
        ],

        // 複数ファイル
        'attachments'   => 'required|array|max:5',
        'attachments.*' => 'file|mimes:jpg,jpeg,png,pdf|max:10240',
    ]);

    // バリデーション済みファイルを処理
    $file = $request->file('avatar');
    // ...
}
验证规则 说明 示例
file 必须是已上传的文件 'file'
image 图像文件(JPEG/PNG/GIF/WebP/SVG) 'image'
mimes 允许指定扩展名的 MIME 类型 'mimes:jpg,png,pdf'
mimetypes 直接指定 MIME 类型 'mimetypes:image/jpeg,image/png'
max KB 为单位的大小限制 'max:10240'(10MB)
min KB 为单位的最小大小 <code>'min:1'</code>(1KB 以上)
dimensions 图像的纵横像素数 'dimensions:min_width=100'

使用 Storage::disk()->put() 保存(public / s3 磁盘)

Laravel 的 <code>Storage</code> 外观抽象了文件系统,允许您使用相同的 API 与本地磁盘、公共磁盘和 S3 等云存储进行交互。

use Illuminate\Support\Facades\Storage;

public function store(Request $request)
{
    $request->validate([
        'file' => 'required|file|max:10240',
    ]);

    $file = $request->file('file');

    // ===== ローカル保存(storage/app/ 以下)=====

    // 自動でユニークなファイル名を生成して保存
    $path = $file->store('uploads');
    // → storage/app/uploads/xxxx.jpg のような形で保存される

    // 第2引数でディスクを指定
    $path = $file->store('uploads', 'local');

    // ファイル名を指定して保存
    $filename = uniqid('file_') . '.' . $file->getClientOriginalExtension();
    $path = $file->storeAs('uploads', $filename);

    // ===== public ディスク(公開アクセス可能)=====

    // storage/app/public/ 以下に保存(公開URL: /storage/... でアクセス可能)
    $path = $file->store('avatars', 'public');
    // または
    $path = Storage::disk('public')->put('avatars', $file);

    // 保存パスから公開URLを取得
    $url = Storage::disk('public')->url($path);
    // → /storage/avatars/xxxx.jpg

    // ===== Storage ファサードの各種操作 =====

    // ファイルの存在確認
    if (Storage::exists('uploads/file.jpg')) { ... }

    // ファイルの削除
    Storage::delete('uploads/file.jpg');

    // ファイルの移動
    Storage::move('uploads/temp.jpg', 'uploads/final.jpg');

    // ファイルの取得
    $contents = Storage::get('uploads/file.txt');

    // ファイルのURL取得
    $url = Storage::url('uploads/file.jpg');

    return response()->json(['path' => $path, 'url' => $url]);
}

php artisan storage:link 的说明

要将 <code>storage/app/public</code> 目录公开到网络,您需要创建一个名为 <code>public/storage</code> 的符号链接。用于创建此链接的命令是 <code>php artisan storage:link</code>。

# シンボリックリンクを作成
php artisan storage:link

# 出力例:
# The [public/storage] link has been connected to [storage/app/public].

# 作成されたリンクを確認
ls -la public/storage
# lrwxrwxrwx ... public/storage -> /var/www/storage/app/public

# Docker/本番環境での注意点:
# デプロイ時に毎回実行するか、Dockerfile に含める
# RUN php artisan storage:link

创建符号链接后,保存在 <code>storage/app/public/avatars/photo.jpg</code> 中的文件将可以通过 <code>https://example.com/storage/avatars/photo.jpg</code> 访问。

S3 驱动程序配置(.env)

要将文件保存到 AWS S3,需要 <code>league/flysystem-aws-s3-v3</code> 软件包(Laravel 9 及更高版本可能默认包含)。

composer require league/flysystem-aws-s3-v3
# .env の設定
AWS_ACCESS_KEY_ID=AKIAIOSFODNN7EXAMPLE
AWS_SECRET_ACCESS_KEY=wJalrXUtnFEMI/K7MDENG/bPxRfiCYEXAMPLEKEY
AWS_DEFAULT_REGION=ap-northeast-1
AWS_BUCKET=my-app-bucket
AWS_USE_PATH_STYLE_ENDPOINT=false

# CloudFront 経由でURLを取得したい場合
AWS_URL=https://d1234abcd.cloudfront.net
// S3 への保存
$path = $file->store('uploads', 's3');

// S3 への保存(アクセス制御を指定)
$path = Storage::disk('s3')->put('uploads/' . $filename, $file, 'public');

// 署名付きURL(一時的なプライベートファイルへのアクセス)
$url = Storage::disk('s3')->temporaryUrl(
    $path,
    now()->addMinutes(30) // 30分間有効
);

// S3 のURL取得(バケットが public の場合)
$url = Storage::disk('s3')->url($path);

config/filesystems.php的说明

磁盘配置在 <code>config/filesystems.php</code> 中管理。您也可以添加多个 S3 存储桶或自定义磁盘。

// config/filesystems.php
return [
    // デフォルトのファイルシステムディスク
    'default' => env('FILESYSTEM_DISK', 'local'),

    'disks' => [
        'local' => [
            'driver' => 'local',
            'root'   => storage_path('app'),
            'throw'  => false,
        ],

        'public' => [
            'driver'     => 'local',
            'root'       => storage_path('app/public'),
            'url'        => env('APP_URL') . '/storage',
            'visibility' => 'public',
            'throw'      => false,
        ],

        's3' => [
            'driver'                  => 's3',
            'key'                     => env('AWS_ACCESS_KEY_ID'),
            'secret'                  => env('AWS_SECRET_ACCESS_KEY'),
            'region'                  => env('AWS_DEFAULT_REGION'),
            'bucket'                  => env('AWS_BUCKET'),
            'url'                     => env('AWS_URL'),
            'endpoint'                => env('AWS_ENDPOINT'),
            'use_path_style_endpoint' => env('AWS_USE_PATH_STYLE_ENDPOINT', false),
            'throw'                   => false,
        ],

        // カスタムディスク(別のS3バケットなど)
        's3-thumbnails' => [
            'driver' => 's3',
            'key'    => env('AWS_ACCESS_KEY_ID'),
            'secret' => env('AWS_SECRET_ACCESS_KEY'),
            'region' => env('AWS_DEFAULT_REGION'),
            'bucket' => env('AWS_THUMBNAILS_BUCKET'),
        ],
    ],

    // storage:link コマンドで作成するリンクのマッピング
    'links' => [
        public_path('storage') => storage_path('app/public'),
    ],
];

临时文件处理和安全性

上传的文件暂时存储在 <code>/tmp</code> 等目录中。处理后,使用 <code>move_uploaded_file()</code>(PHP 情况)或 Laravel 的 <code>store()</code> 系列方法将其移动到最终位置。脚本退出时,临时文件会自动删除。

  • 保存到 Storage 的 <code>public</code> 磁盘上的文件可以从网络访问,所以不应该将敏感文件放在那里
  • 使用 <code>hashName()</code> 方法生成随机哈希名称作为文件名会更安全
  • 将原始文件名存储在数据库中,并将其与实际保存的名称分开
  • S3 文件默认为私有,因此对于公开可访问的文件,明确设置 <code>public</code> 或使用预签名 URL。
// セキュアなファイル保存の例
public function store(Request $request)
{
    $request->validate([
        'document' => 'required|file|mimes:pdf,docx|max:20480',
    ]);

    $file = $request->file('document');

    // hashName() でランダムなファイル名を生成(元の拡張子を保持)
    $hashedName = $file->hashName(); // 例: 5af75b.pdf

    // S3 の private エリアに保存
    $path = Storage::disk('s3')->putFileAs(
        'documents/' . auth()->id(),
        $file,
        $hashedName
    );

    // DBに元のファイル名と保存パスを記録
    Document::create([
        'user_id'       => auth()->id(),
        'original_name' => $file->getClientOriginalName(),
        'stored_path'   => $path,
        'mime_type'     => $file->getMimeType(),
        'size'          => $file->getSize(),
    ]);

    return response()->json(['message' => 'アップロード完了']);
}

本文中可用的测试文件(免费)

  • → <a href="/ja/files/images/" class="text-primary-600 dark:text-primary-400 hover:underline">测试图像列表</a> — 用于测试验证 (mimes/dimensions)
  • → <a href="/ja/files/pdf/" class="text-primary-600 dark:text-primary-400 hover:underline">PDF 测试文件列表</a> — 用于 PDF 上传验证
  • → <a href="/ja/files/threshold/" class="text-primary-600 dark:text-primary-400 hover:underline">边界值测试文件列表</a> — 用于检查 max 验证规则的上限

相关文章

  • → <a href="/ja/blog/php-file-upload/" class="text-primary-600 dark:text-primary-400 hover:underline">PHP 文件上传实现方法 | 验证・存储・安全性完整指南</a>
  • → <a href="/ja/blog/s3-upload-limit/" class="text-primary-600 dark:text-primary-400 hover:underline">AWS S3・CloudFront 文件上传限制总结</a>
  • → <a href="/ja/blog/file-validation-checklist/" class="text-primary-600 dark:text-primary-400 hover:underline">Web 表单文件验证实现检查清单</a>

常见问题

Laravel 中上传文件的验证规则是什么?

在 <code>validate</code> 方法中可以指定 <code>file</code>、<code>mimes</code>(允许的扩展名)、<code>max</code>(最大大小,单位为 KB)等规则。

Laravel 中 Storage::put 和 store 的区别是什么?

<code>store</code> 是 UploadedFile 的方法,会自动生成唯一的文件名。<code>Storage::put</code> 用指定的路径和文件名保存文件。

如何在 Laravel 中将文件上传到 S3?

在 <code>.env</code> 中设置 AWS 认证信息,在 <code>filesystems.php</code> 中配置 s3 磁盘,然后使用 <code>Storage::disk('s3')->put()</code> 保存。