ASP.NET Web Api 2實現多文件打包並下載文件的實例

最近由於工作和個人事務，站點也好久沒更新了，但這並不影響我對.NET的熱情。站點的更新工作還是得想辦法抽時間來完成的。

今天利用中午的時間來寫一篇關於Asp.Net Web Api下載文件的文章，之前我也寫過類似的文章，請見:《ASP.NET(C#) Web Api通過文件流下載文件的實例》

本文以這篇文章的基礎，提供了ByteArrayContent的下載以及在下載多個文件時實現在服務器對多文件進行壓縮打包後下載的功能。

關於本文中實現的在服務器端用.NET壓縮打包文件功能的過程中，使用到了一個第方類庫:DotNetZip，具體的使用將在正文中涉及。好了，描述了這麼多前言，下面我們進入本文示例的正文。

1.首先創建名為：WebApiDownload的Web Api 項目（C#）;

2.接著新建一個空的控制器，命名為：DownloadController；

3.創建一些打包文件和存放臨時文件的文件夾（downloads），具體請看本文最後提供的示例項目代碼

4.打開NuGet程序包管事器，搜索DotNetZip，如下圖：

搜索到DotNetZip安裝包後，進行安裝，以便用於本項目將要實現多文件打包壓縮的功能，如下圖：

安裝完成DotNetZip包後，我們就可以退出NuGet程序包管理器了，因為本項目為示例項目，不需再添加其他的包。

5.在Models文件夾下創建一個示例數據的類，名為：DemoData，其中的成員和實現如下：

using System.Collections.Generic;


namespace WebApiDownload.Models
{
 public class DemoData
 {
  public static readonly List<List<string>> Contacts = new List<List<string>>();
  public static readonly List<string> File1 = new List<string>
  {
   "[email protected]",
   "[email protected]",
   "[email protected]",
   "[email protected]",
   "[email protected]"
  };
  public static readonly List<string> File2 = new List<string>
  {
   "[email protected]",
   "[email protected]",
   "[email protected]",
   "[email protected]",
   "[email protected]"
  };
  public static readonly List<string> File3 = new List<string>
  {
   "[email protected]",
   "[email protected]",
   "[email protected]",
   "[email protected]",
   "[email protected]"
  };

  public static List<List<string>> GetMultiple
  {
   get
   {
    if (Contacts.Count <= 0)
    {
     Contacts.Add(File1);
     Contacts.Add(File2);
     Contacts.Add(File3);
    }
    return Contacts;
   }
  }
 }
}

6.到這裡，我們的准備工作基本做得差不多了，最後我們只需要在DownloadController控制器中實現兩個Action，一個為：DownloadSingle（提供下載單個文件的功能），另一個為：DownloadZip（提供打包壓縮多個文件並下載的功能）。具體的DownloadController完整代碼如下：

using System.Linq;
using System.Net.Http;
using System.Text;
using System.Web.Http;
using Ionic.Zip;
using WebApiDownload.Models;
using System;
using System.IO;
using System.Net;
using System.Net.Http.Headers;
using System.Threading;
using System.Web;


namespace WebApiDownload.Controllers
{
 [RoutePrefix("download")]
 public class DownloadController : ApiController
 {
  [HttpGet, Route("single")]
  public HttpResponseMessage DownloadSingle()
  {
   var response = new HttpResponseMessage();
   //從List集合中獲取byte[]
   var bytes = DemoData.File1.Select(x => x + "\n").SelectMany(x => Encoding.UTF8.GetBytes(x)).ToArray();
   try
   {
    var fileName = string.Format("download_single_{0}.txt", DateTime.Now.ToString("yyyyMMddHHmmss"));
    var content = new ByteArrayContent(bytes);
    response.Content = content;
    response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment")
    {
     FileName = fileName
    };
    response.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
   }
   catch (Exception ex)
   {
    response.StatusCode = HttpStatusCode.InternalServerError;
    response.Content = new StringContent(ex.ToString());
   }
   return response;
  }
  [HttpGet, Route("zip")]
  public HttpResponseMessage DownloadZip()
  {
   var response = new HttpResponseMessage();
   try
   {
    var zipFileName = string.Format("download_compressed_{0}.zip", DateTime.Now.ToString("yyyyMMddHHmmss"));
    var downloadDir = HttpContext.Current.Server.MapPath($"~/downloads/download");
    var archive = $"{downloadDir}/{zipFileName}";
    var temp = HttpContext.Current.Server.MapPath("~/downloads/temp");

    // 清空臨時文件夾中的所有臨時文件
    Directory.EnumerateFiles(temp).ToList().ForEach(File.Delete);
    ClearDownloadDirectory(downloadDir);
    // 生成新的臨時文件
    var counter = 1;
    foreach (var c in DemoData.GetMultiple)
    {
     var fileName = string.Format("each_file_{0}_{1}.txt", counter, DateTime.Now.ToString("yyyyMMddHHmmss"));
     if (c.Count <= 0)
     {
      continue;
     }
     var docPath = string.Format("{0}/{1}", temp, fileName);
     File.WriteAllLines(docPath, c, Encoding.UTF8);
     counter++;
    }
    Thread.Sleep(500);
    using (var zip = new ZipFile())
    {
     // Make zip file
     zip.AddDirectory(temp);
     zip.Save(archive);
    }
    response.Content = new StreamContent(new FileStream(archive, FileMode.Open, FileAccess.Read));
    response.Content.Headers.ContentDisposition = new ContentDispositionHeaderValue("attachment") { FileName = zipFileName };
    response.Content.Headers.ContentType = new MediaTypeHeaderValue("application/octet-stream");
   }
   catch (Exception ex)
   {
    response.StatusCode = HttpStatusCode.InternalServerError;
    response.Content = new StringContent(ex.ToString());
   }
   return response;
  }

  private void ClearDownloadDirectory(string directory)
  {
   var files = Directory.GetFiles(directory);
   foreach (var file in files)
   {
    try
    {
     File.Delete(file);
    }
    catch
    {
    }
   }
  }
 }
}

到此，本示例的實現代碼部分就完成了，如果我們此時打開地址：http://localhost:63161/download/single，浏覽器會彈出保存文件的提示窗口，如下：

保存此文件後，打開它我們會看到我們的示例數據已被保存到本地了，如下：

同樣的，下載壓縮文件你只需要訪問地址：localhost:63161/download/zip 即可，筆者就不再演示了。

最後，附上本示例項目的完整源代碼，點擊這裡下載。

以上就是本文的全部內容，希望能給大家一個參考，也希望大家多多支持。