Usare DotNetZip per generare file compressi in ASP.NET MVC

di Marco De Sanctis, in ASP.NET MVC,

La generazione al volo di un file Zip è uno dei sistemi più comodi, dal punto di vista degli utenti, per effettuare il download di un insieme di file con una sola operazione. Esistono diverse librerie che consentono di creare questo tipo di file, e anche il .NET Framework, a partire dalla versione 4.5, aggiunge il supporto alla compressione Zip.

Il modo più intuitivo per effettuare un download, in ASP.NET MVC, è quello di creare un custom action result, che chiameremo ZipFileResult, così che nel nostro controller possiamo limitarci a scrivere qualcosa di questo tipo:

public ActionResult ZipDemo()
{
    string[] fileNames = ...;

    return new ZipFileResult(fileNames)
    {
        FileDownloadName = "download.zip"
    };
}

La classe ZipFileResult, quindi, incapsula tutta la logica relativa alla compressione. Nell'esempio in basso troviamo una possibile implementazione basata sulla libreria open source DotNetZip, per certi versi più versatile e facilmente utilizzabile di quanto presente all'interno di .NET 4.5.

public class ZipFileResult : FileResult
{
  private IEnumerable<string> _fileNames;
  public ZipFileResult(params string[] fileNames)
    : base("application/zip, application/octet-stream")
  {
     _fileNames = fileNames;
  }

  // ... altro codice qui ...
}

Piuttosto che riscrivere tutto da zero, abbiamo sfruttato la classe base FileResult, che contiene già la logica per impostare il content type della response e il nome predefinito. Il codice principale, però, è costituito dall'override del metodo WriteFile, che si occupa di scrivere il contenuto sullo stream di output della risposta HTTP.

protected override void WriteFile(HttpResponseBase response)
{
  using (var zipFile = new ZipFile())
  {
    zipFile.AddFiles(_fileNames, preserveDirHierarchy: false, 
      directoryPathInArchive: string.Empty);
    zipFile.Save(response.OutputStream);
  }
}

L'esempio in alto è decisamente banale, e non fa altro che istanziare una classe ZipFile e sfruttare il metodo AddFiles per aggiungere il contenuto desiderato. Un overload del metodo Save consente di passare come parametro uno Stream. Grazie a questa tecnica siamo in grado di supportare anche file di grandi dimensioni, visto che non manteniamo una copia in memoria ma la inviamo direttamente all'OutputStream della response.

Commenti

Visualizza/aggiungi commenti

| Condividi su: Twitter, Facebook, LinkedIn

Per inserire un commento, devi avere un account.

Fai il login e torna a questa pagina, oppure registrati alla nostra community.

Approfondimenti

I più letti di oggi