萬盛學電腦網

您现在的位置: 萬盛學電腦網 >> 程式設計 >  >> 網路程式設計 >> PHP 程式設計

PHP ZipArchive 完整使用指南:壓縮、解壓、追加、刪除、註釋操作

PHP 5.2.0+ 內建 ZipArchive 類提供完整的 ZIP 壓縮檔操作 API,無需外部工具。本文系統整理核心方法、錯誤碼對照、實戰範例(解壓、建立、追加、資料夾打包、刪除條目、註釋管理)。

一、環境需求

  • PHP ≥ 5.2.0,PECL zip ≥ 1.1.0
  • Windows:php.ini 開啟 extension=php_zip.dll
  • Linux:編譯時 --enable-zip 或安裝 php-zip 套件

二、核心方法速查表

方法說明回傳值
open(filename, flags)開啟/建立 ZIP 檔true / 錯誤碼
close()關閉並寫入磁碟bool
extractTo(path)解壓至目錄bool
addFile(filepath, localname)加入檔案bool
addFromString(name, content)從字串建立檔案bool
addEmptyDir(dirname)建立空目錄bool
getNameIndex(index)取得索引對應檔名string/false
getStream(name)取得檔案資料流resource/false
renameIndex(index, newname)按索引重命名bool
renameName(name, newname)按檔名重命名bool
deleteIndex(index)按索引刪除條目bool
deleteName(name)按檔名刪除條目bool
getArchiveComment()取得壓縮檔註釋string
setArchiveComment(comment)設定壓縮檔註釋bool
getCommentIndex(index)取得檔案條目註釋string
getCommentName(name)取得檔案條目註釋string

三、open() flags 參數詳解

常數行為
ZipArchive::OVERWRITE總是建立新檔,存在則覆蓋
ZipArchive::CREATE不存在則建立(預設行為)
ZipArchive::EXCL存在則報錯
ZipArchive::CHECKCONS檢查一致性

四、錯誤碼對照

ER_EXISTS      // 檔案已存在
ER_INCONS      // 壓縮檔不一致
ER_INVAL       // 無效參數
ER_MEMORY      // 記憶體失敗
ER_NOENT       // 檔案不存在
ER_NOZIP       // 非 ZIP 檔
ER_OPEN        // 無法開啟
ER_READ        // 讀取錯誤
ER_SEEK        // 定位錯誤

五、實戰範例

1. 解壓縮

$zip = new ZipArchive();
$res = $zip->open('test.zip');
if ($res === TRUE) {
    $zip->extractTo('test/'); // 解壓到 test 目錄
    $zip->close();
    echo '解壓成功';
} else {
    echo '失敗,錯誤碼: ' . $res;
}

2. 建立壓縮檔(單檔/多檔)

$zip = new ZipArchive();
$res = $zip->open('backup.zip', ZipArchive::CREATE | ZipArchive::OVERWRITE);
if ($res === TRUE) {
    $zip->addFile('data.csv', 'export/data.csv');      // 實體檔案
    $zip->addFromString('readme.txt', '說明內容...');   // 字串內容
    $zip->addEmptyDir('empty_folder/');                 // 空目錄
    $zip->close();
    echo '建立成功';
}

3. 遞迴打包整個資料夾

function zipFolder($folder, $zipFile) {
    $zip = new ZipArchive();
    if ($zip->open($zipFile, ZipArchive::CREATE | ZipArchive::OVERWRITE) !== TRUE) {
        return false;
    }
    $rootPath = realpath($folder);
    $files = new RecursiveIteratorIterator(
        new RecursiveDirectoryIterator($rootPath),
        RecursiveIteratorIterator::LEAVES_ONLY
    );
    foreach ($files as $name => $file) {
        if (!$file->isDir()) {
            $filePath = $file->getRealPath();
            $relativePath = substr($filePath, strlen($rootPath) + 1);
            $zip->addFile($filePath, $relativePath);
        } else {
            $relativePath = substr($name, strlen($rootPath) + 1) . '/';
            $zip->addEmptyDir($relativePath);
        }
    }
    return $zip->close();
}

zipFolder('/var/www/project', '/backup/project_' . date('Ymd') . '.zip');

4. 讀取壓縮檔內檔案內容(不解壓)

$zip = new ZipArchive();
if ($zip->open('test.zip') === TRUE) {
    $stream = $zip->getStream('hello.txt');
    $content = stream_get_contents($stream);
    echo $content; // 注意編碼轉換
    $zip->close();
}

5. 修改壓縮檔註釋

$zip = new ZipArchive();
$res = $zip->open('test.zip', ZipArchive::CREATE);
if ($res === TRUE) {
    $zip->setArchiveComment('Updated at ' . date('Y-m-d H:i:s'));
    $zip->close();
}

6. 刪除壓縮檔內特定檔案

$zip = new ZipArchive();
if ($zip->open('test.zip') === TRUE) {
    $zip->deleteName('obsolete.txt'); // 或 deleteIndex(0)
    $zip->close();
}

六、效能與限制提醒

  • 大檔(>2GB)可能受 32 位整數限制,建議 64 位環境
  • 記憶體佔用與壓縮檔大小相關,超大檔案考慮分卷或串流處理
  • 加密 ZIP 需 PECL zip ≥ 1.12.0 + libzip ≥ 1.2.0,使用 setEncryptionIndex()

ZipArchive 以物件導向 API 封裝 libzip,功能完整、效能優異,是 PHP 專案處理壓縮檔的首選方案。

copyright © 萬盛學電腦網 all rights reserved