如何 Laravel 中驗證 zip 壓縮包里的檔案？

在 Laravel 程式中上傳檔案時，請求驗證可以很好驗證上傳的檔案，你可以要求上傳檔案必須為 圖片 , 也可以限制檔案位元組 大小 , 也可以根據 mime types 或者 檔案擴展名 過濾檔案，

如果我們希望用戶上載 ZIP 檔案，我們可以結合規則并像如下所示的內容使用：

return [
    'file' => 'required|file|mimes:zip|size:3072'
];

但是與圖片、文本或 pdf 檔案不同，ZIP 是一個壓縮檔案，可以在其中保存多個不同的檔案， 假設我們希望用戶上傳一個 ZIP 檔案，但帶有特定的必需檔案和檔案夾結構， 舉一個真實的例子，如果您曾經使用過 Wordpress 并使用 ZIP 檔案為其安裝了主題，則 Wordpress 要求主題 ZIP 檔案具有某些特定的檔案，例如 style.css 或 post.php， 在 Laravel 中我們如何驗證上傳的 ZIP 檔案以查看其是否包含所有必需檔案？

PHP 的 libzip 擴展

這里會需要 php 的 libzip 擴展的支持，該擴展的啟用以及具體用法請看檔案 official documentation page.

如何操作 ZIP 檔案

第一步，實體化 ZipArchive 類，

$zip = new \ZipArchive();

然后我們就可以通過 open() 方法來解壓 ZIP 檔案了，

$zip->open('/absolute/path/to/file.zip');

方法的官方檔案 指出，如果成功打開 ZIP 檔案，它將回傳 “true”，否則回傳整數錯誤代碼， 我們可以像這樣檢查所有內容：

$zipStatus = $zip->open('/absolute/path/to/file.zip');
if (zipStatus !== true) {
    threw new \Exception('Could not open ZIP file. Error code: ' . zipStatus);
}

// 沒問題，繼續操作…

ZipArchive 類提供了多種方法來幫助我們讀取 ZIP 檔案的內容，其中一些方法是

• count() - 回傳 ZIP 檔案中的檔案數
• getFromIndex() - 回傳指定索引對應的檔案
• getNameIndex() - 回傳指定索引的檔案名
• statIndex() - 回傳指定索引對應檔案的詳細資訊（檔案名、大小等）

有了這些方法，如果我們想獲得 ZIP 檔案中的可用檔案串列， 我們可以這樣做：

$filesInside = [];
for ($i = 0; $i < $zip->count(); $i++) {
    array_push($filesInside, $zip->getNameIndex($i));
}

$zip->close();

由于一個 ZipArchive 實體可以同時處理一個 ZIP 檔案，因此在處理完該檔案后，我們需要使用 close（）方法， 當您回圈瀏覽多個 ZIP 檔案或使用此類創建新的 ZIP 檔案時，這一點尤其重要，

當你使用 ZipArchive 時有一點需要注意一下， “entity” 的概念，這里的 “entity” 并不單單是檔案，他還包含所有檔案夾以及子檔案夾，這句話怎么理解呢？假設我們有個目錄結構如下的檔案：

- invoice.pdf
- profile_picture.jpg
- documents/
  - homework.doc
- bills/
  - january/
    - payment.pdf

我們對當前檔案執行 count() 操作可以得到當前檔案數量，雖然我們只有 4 個檔案，但 count() 方法回傳的是 7 ，這是為什么呢？讓我們列印一下 $filesInside 看它里面到底包含了什么吧，

$files = [
    'invoice.pdf',
    'profile_picture.jpg',
    'documents/',
    'documents/homework.doc',
    'bills/',
    'bills/january/',
    'bills/january/payment.pdf'
];

可以看到，列印結果中并不僅僅有你的檔案還有相應的檔案夾， 這里你還可以通過 getNameIndex() 方法來獲取完整的檔案路徑，

集成到 Laravel 程式中

現在，我們知道了如何使用 PHP 獲取 ZIP 的檔案串列，讓我們將所有內容集成到 Laravel 中并驗證上傳的 ZIP 檔案是否包含必需的檔案，

假設我們需要用戶上傳一個 ZIP 檔案，并且檔案的 assets 目錄中必須包含 thumbnail.jpg 和 style.css 檔案，

- thumbnail.jpg
- assets/
  - style.css

這是我們的控制器，該控制器處理帶有名為 zip_file 的檔案上傳：

namespace App\Controllers;
use Illuminate\Http\Request;

class UploadController
{
    const REQUIRED_FILES = [
        'thumbnail.jpg',
        'assets/style.css',
    ];

    public function upload(Request $request)
    {
        $zip = new \ZipArchive();
        $file = $request->file('zip_file');
    }
}

對我們從 Illuminate\Http\Request 中檢索資料時，每個檔案都回傳一個 Illuminate\Http\UploadedFile 實體，我們可以在實體上使用 path() 方法回傳上傳的臨時檔案的絕對路徑，

這是我們打開 ZIP 檔案并使用 ZipArchive 類列出所有檔案的方法，

public function upload(Request $request)
{
    $zip = new \ZipArchive();
    $file = $request->file('zip_file');
    $zip->open($file->path());

    $filesInside = [];
    for ($i = 0; $i < $zip->count(); $i++) {
        array_push($filesInside, $zip->getNameIndex($i));
    }
}

現在我們可以使用諸如 array_intersect() 之類的方法將 REQUIRED_FILES 與 $filesInside 進行比對，如果交集元素數量不等于 REQUIRED_FILES 的元素數量，則意味著上傳的 ZIP 檔案中并不存在所有必需的檔案，因此我們可以中止請求執行或回傳驗證錯誤，

$intersection = array_intersect(self::REQUIRED_FILES, $filesInside);

if (count($intersection) !== count(self::REQUIRED_FILES)) {
    abort(422);
}

這是我們的控制器，一切就緒：

namespace App\Controllers;
use Illuminate\Http\Request;

class UploadController
{
    const REQUIRED_FILES = [
        'thumbnail.jpg',
        'assets/style.css',
    ];

    public function upload(Request $request)
    {
        $zip = new \ZipArchive();
        $file = $request->file('zip_file');
        $zip->open($file->path());

        $filesInside = [];
        for ($i = 0; $i < $zip->count(); $i++) {
            array_push($filesInside, $zip->getNameIndex($i));
        }

        $intersection = array_intersect(self::REQUIRED_FILES, $filesInside);

        if (count($intersection) !== count(self:: REQUIRED_FILES)) {
            abort(422);
        }

        // ZIP contains all required files, continue
    }
}

最佳實踐

在 Laravel 應用程式中，最佳實踐是將與驗證相關的內容移出控制器， 常見選項有：

• 創建自定義 驗證規則類
• 在已存在的請求驗證物件里使用 閉包驗證
• 創建 驗證規則擴展

出于 ZIP 內容驗證的需要，我創建了一個專用的 Laravel 軟體包，該軟體包幾乎完成了本博客文章中所述的所有操作，并提供了更多選項和功能， 您可以在 GitHub 頁面查看 orkhanahmadov/laravel-zip-validator 以獲取更多資訊以及如何使用它，

更多學習內容請訪問：

騰訊T3-T4標準精品PHP架構師教程目錄大全，只要你看完保證薪資上升一個臺階（持續更新）?

標籤：PHP

上一篇：PHP教程：php操作memcached方法實體

下一篇：PHP 函式庫精講之類與物件