如何在Laravel中驗(yàn)證zip里的文件

概述

如果我們希望用戶(hù)上載 ZIP 文件，我們可以結(jié)合規(guī)則并像如下所示的內(nèi)容使用：

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

但是與圖片、文本或 pdf 文件不同，ZIP 是一個(gè)壓縮文件，可以在其中保存多個(gè)不同的文件。 假設(shè)我們希望用戶(hù)上傳一個(gè) ZIP 文件，但帶有特定的必需文件和文件夾結(jié)構(gòu)。 舉一個(gè)真實(shí)的例子，如果您曾經(jīng)使用過(guò) Wordpress 并使用 ZIP 文件為其安裝了主題，則 Wordpress 要求主題 ZIP 文件具有某些特定的文件，例如 style.css 或 post.php。 在 Laravel 中我們?nèi)绾悟?yàn)證上傳的 ZIP 文件以查看其是否包含所有必需文件？

PHP 的libzip擴(kuò)展

這里會(huì)需要 php 的libzip擴(kuò)展的支持，該擴(kuò)展的啟用以及具體用法請(qǐng)看文檔official documentation page.

如何操作 ZIP 文件

第一步，實(shí)例化ZipArchive類(lèi)。

$zip = new \ZipArchive();

然后我們就可以通過(guò)open()方法來(lái)解壓 ZIP 文檔了。

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

方法的官方文檔指出，如果成功打開(kāi) ZIP 文件，它將返回 “true”，否則返回整數(shù)錯(cuò)誤代碼。 我們可以像這樣檢查所有內(nèi)容：

$zipStatus = $zip->open('/absolute/path/to/file.zip');
if (zipStatus !== true) {
    threw new \Exception('Could not open ZIP file. Error code: ' . zipStatus);
}
 
// 沒(méi)問(wèn)題，繼續(xù)操作…

ZipArchive類(lèi)提供了多種方法來(lái)幫助我們讀取 ZIP 文件的內(nèi)容，其中一些方法是

• count()- 返回 ZIP 文件中的文件數(shù)
• getFromIndex()- 返回指定索引對(duì)應(yīng)的文件
• getNameIndex()- 返回指定索引的文件名
• statIndex()- 返回指定索引對(duì)應(yīng)文件的詳細(xì)信息（文件名、大小等）

有了這些方法，如果我們想獲得 ZIP 文件中的可用文件列表。 我們可以這樣做：

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

由于一個(gè) ZipArchive 實(shí)例可以同時(shí)處理一個(gè) ZIP 文件，因此在處理完該文件后，我們需要使用 close（）方法。 當(dāng)您循環(huán)瀏覽多個(gè) ZIP 文件或使用此類(lèi)創(chuàng)建新的 ZIP 文件時(shí)，這一點(diǎn)尤其重要。

當(dāng)你使用 ZipArchive 時(shí)有一點(diǎn)需要注意一下， “entity” 的概念，這里的 “entity” 并不單單是文件，他還包含所有文件夾以及子文件夾。這句話(huà)怎么理解呢？假設(shè)我們有個(gè)目錄結(jié)構(gòu)如下的文檔：

- invoice.pdf

- profile_picture.jpg

- documents/

  - homework.doc

- bills/

  - january/

    - payment.pdf

我們對(duì)當(dāng)前文檔執(zhí)行 count() 操作可以得到當(dāng)前文件數(shù)量，雖然我們只有 4 個(gè)文件，但 count() 方法返回的是 7 ，這是為什么呢？讓我們打印一下 $filesInside 看它里面到底包含了什么吧。

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

可以看到，打印結(jié)果中并不僅僅有你的文件還有相應(yīng)的文件夾。 這里你還可以通過(guò)getNameIndex()方法來(lái)獲取完整的文件路徑。

集成到 Laravel 程序中

現(xiàn)在，我們知道了如何使用 PHP 獲取 ZIP 的文件列表，讓我們將所有內(nèi)容集成到 Laravel 中并驗(yàn)證上傳的 ZIP 文件是否包含必需的文件。

假設(shè)我們需要用戶(hù)上傳一個(gè) 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');
    }
}

對(duì)我們從 Illuminate\Http\Request 中檢索數(shù)據(jù)時(shí)，每個(gè)文件都返回一個(gè) Illuminate\Http\UploadedFile 實(shí)例。我們可以在實(shí)例上使用 path() 方法返回上傳的臨時(shí)文件的絕對(duì)路徑。

這是我們打開(kāi) ZIP 文件并使用ZipArchive類(lèi)列出所有文件的方法。

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));
    }
}

現(xiàn)在我們可以使用諸如 array_intersect() 之類(lèi)的方法將 REQUIRED_FILES 與 $filesInside 進(jìn)行比對(duì)。如果交集元素?cái)?shù)量不等于 REQUIRED_FILES 的元素?cái)?shù)量，則意味著上傳的 ZIP 文件中并不存在所有必需的文件，因此我們可以中止請(qǐng)求執(zhí)行或返回驗(yàn)證錯(cuò)誤。

$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
    }
}

最佳實(shí)踐

在 Laravel 應(yīng)用程序中，最佳實(shí)踐是將與驗(yàn)證相關(guān)的內(nèi)容移出控制器。 常見(jiàn)選項(xiàng)有：

• 創(chuàng)建自定義驗(yàn)證規(guī)則類(lèi)
• 在已存在的請(qǐng)求驗(yàn)證對(duì)象里使用閉包驗(yàn)證
• 創(chuàng)建驗(yàn)證規(guī)則擴(kuò)展

出于 ZIP 內(nèi)容驗(yàn)證的需要，我創(chuàng)建了一個(gè)專(zhuān)用的 Laravel 軟件包，該軟件包幾乎完成了本博客文章中所述的所有操作，并提供了更多選項(xiàng)和功能。 您可以在 GitHub 頁(yè)面查看 orkhanahmadov/laravel-zip-validator 以獲取更多信息以及如何使用它。

以上就是如何在Laravel中驗(yàn)證zip里的文件的詳細(xì)內(nèi)容，更多關(guān)于在Laravel中驗(yàn)證zip里的文件的資料請(qǐng)關(guān)注腳本之家其它相關(guān)文章！