ASP.NET Core 中生成 ZIP 壓縮包的實(shí)戰(zhàn)指南
在 ASP.NET Core 開發(fā)中，有時(shí)候我們需要將一組文件打包成一個(gè) ZIP 文件，然后提供給用戶下載。這種需求在文件共享、數(shù)據(jù)備份或生成報(bào)告等場(chǎng)景中尤為常見。今天，我們就來聊聊如何在 ASP.NET Core 中生成 ZIP 壓縮包，并且保證整個(gè)過程既簡(jiǎn)單又高效。
準(zhǔn)備工作
在開始之前，你需要確保你的 ASP.NET Core 項(xiàng)目已經(jīng)搭建完畢，并且你有一個(gè)或多個(gè)需要打包的文件。另外，為了生成 ZIP 文件，我們將使用 .NET 提供的 System.IO.Compression 和 System.IO.Compression.FileSystem 命名空間下的類。
第一步：添加必要的引用
在 ASP.NET Core 項(xiàng)目中，System.IO.Compression 和 System.IO.Compression.FileSystem 通常是默認(rèn)包含的，但為了確保萬無一失，你可以在項(xiàng)目文件（.csproj）中檢查或添加以下引用：
<ItemGroup>
<PackageReference Include="System.IO.Compression" Version="4.3.0" />
<PackageReference Include="System.IO.Compression.FileSystem" Version="4.3.0" />
</ItemGroup>不過，對(duì)于大多數(shù) ASP.NET Core 項(xiàng)目來說，這些包已經(jīng)是隱式包含的了，因此你可能不需要手動(dòng)添加。
第二步：創(chuàng)建 ZIP 文件
接下來，我們需要編寫一個(gè)方法來生成 ZIP 文件。這個(gè)方法將接受一個(gè)包含要打包文件的路徑的列表，以及一個(gè)用于保存 ZIP 文件的輸出路徑。
using System.Collections.Generic;
using System.IO;
using System.IO.Compression;
public class ZipHelper
{
public void CreateZipFile(List<string> filePaths, string zipFilePath)
{
using (FileStream zipStream = new FileStream(zipFilePath, FileMode.Create))
{
using (ZipArchive archive = new ZipArchive(zipStream, ZipArchiveMode.Create))
{
foreach (var filePath in filePaths)
{
string entryName = Path.GetFileName(filePath); // 可以根據(jù)需要修改文件名或路徑
ZipArchiveEntry entry = archive.CreateEntry(entryName);
using (FileStream fileStream = new FileStream(filePath, FileMode.Open, FileAccess.Read))
{
using (Stream entryStream = entry.Open())
{
fileStream.CopyTo(entryStream);
}
}
}
}
}
}
}在這個(gè)方法中，我們首先創(chuàng)建一個(gè)指向 ZIP 文件的 FileStream，然后在這個(gè)流上創(chuàng)建一個(gè) ZipArchive。對(duì)于每個(gè)要打包的文件，我們創(chuàng)建一個(gè) ZipArchiveEntry，并將文件內(nèi)容復(fù)制到該條目中。
第三步：在控制器中調(diào)用
現(xiàn)在，我們可以在 ASP.NET Core 控制器中調(diào)用這個(gè)方法，并將生成的 ZIP 文件提供給用戶下載。
using Microsoft.AspNetCore.Mvc;
using System.Collections.Generic;
using System.IO;
public class FileDownloadController : Controller
{
private readonly ZipHelper _zipHelper;
public FileDownloadController(ZipHelper zipHelper)
{
_zipHelper = zipHelper;
}
[HttpGet("download-zip")]
public IActionResult DownloadZip()
{
List<string> filePaths = new List<string>
{
Path.Combine(Directory.GetCurrentDirectory(), "wwwroot", "files", "file1.txt"),
Path.Combine(Directory.GetCurrentDirectory(), "wwwroot", "files", "file2.jpg")
// 添加更多文件路徑
};
string zipFilePath = Path.Combine(Directory.GetCurrentDirectory(), "wwwroot", "files", "download.zip");
_zipHelper.CreateZipFile(filePaths, zipFilePath);
byte[] zipFileBytes = System.IO.File.ReadAllBytes(zipFilePath);
string contentType = "application/zip";
string fileName = "download.zip";
return File(zipFileBytes, contentType, fileName);
}
}在這個(gè)控制器中，我們定義了一個(gè) DownloadZip 方法，它接受一個(gè) HTTP GET 請(qǐng)求。在這個(gè)方法中，我們指定了要打包的文件路徑列表，并調(diào)用 ZipHelper 的 CreateZipFile 方法來生成 ZIP 文件。然后，我們讀取 ZIP 文件的內(nèi)容，并將其作為文件結(jié)果返回給用戶。
第四步：清理工作（可選）
在實(shí)際應(yīng)用中，你可能不希望每次生成 ZIP 文件后都將其保留在服務(wù)器上。因此，你可以在返回文件結(jié)果后刪除 ZIP 文件。
// 在返回 File 結(jié)果之前或之后刪除 ZIP 文件
System.IO.File.Delete(zipFilePath);但是，請(qǐng)注意，如果你在返回文件結(jié)果之前刪除了 ZIP 文件，那么用戶將無法下載該文件。因此，通常的做法是在用戶下載完文件后再刪除它，或者在某個(gè)定時(shí)任務(wù)中清理舊的 ZIP 文件。
總結(jié)
通過上面的步驟，我們已經(jīng)在 ASP.NET Core 中成功生成了一個(gè) ZIP 壓縮包，并將其提供給了用戶下載。這個(gè)過程既簡(jiǎn)單又高效，并且可以根據(jù)你的需求進(jìn)行自定義。希望這篇文章能幫助你更好地理解如何在 ASP.NET Core 中生成 ZIP 文件，并且能夠在實(shí)際項(xiàng)目中靈活運(yùn)用。
