ASP.NET Web Api 2实现多文件打包并下载文件的实例

 更新时间:2016年06月23日 10:07:53   投稿:yourber  
这篇文章主要介绍了ASP.NET Web Api 2利用ByteArrayContent和StreamContent实现多文件打包并下载的方法,提供源码下载,需要的朋友可以参考下。

最近由于工作和个人事务,站点也好久没更新了,但这并不影响我对.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,如下图:

//img.jbzj.com/file_images/article/201606/2016062309583710.png

搜索到DotNetZip安装包后,进行安装,以便用于本项目将要实现多文件打包压缩的功能,如下图:

//img.jbzj.com/file_images/article/201606/2016062309583711.png

安装完成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>
  {
   "f_1_test_1@example.com",
   "f_1_test_2@example.com",
   "f_1_test_3@example.com",
   "f_1_test_4@example.com",
   "f_1_test_5@example.com"
  };
  public static readonly List<string> File2 = new List<string>
  {
   "f_2_test_1@example.com",
   "f_2_test_2@example.com",
   "f_2_test_3@example.com",
   "f_2_test_4@example.com",
   "f_2_test_5@example.com"
  };
  public static readonly List<string> File3 = new List<string>
  {
   "f_3_test_1@example.com",
   "f_3_test_2@example.com",
   "f_3_test_3@example.com",
   "f_3_test_4@example.com",
   "f_3_test_5@example.com"
  };

  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,浏览器会弹出保存文件的提示窗口,如下:

//img.jbzj.com/file_images/article/201606/2016062309583714.png

保存此文件后,打开它我们会看到我们的示例数据已被保存到本地了,如下:

//img.jbzj.com/file_images/article/201606/2016062309583815.png

同样的,下载压缩文件你只需要访问地址:localhost:63161/download/zip 即可,笔者就不再演示了。

最后,附上本示例项目的完整源代码,点击这里下载

以上就是本文的全部内容,希望能给大家一个参考,也希望大家多多支持脚本之家。

相关文章

  • log4net教程日志分类和自动维护示例

    log4net教程日志分类和自动维护示例

    log4net能不能按照功能分类呢?如果通过配置不同的logger,然后功能根据不同的LoggerName加载Ilog实例,是可以做到。但由于这些功能的log配置差异性极小,也许仅仅就是文件名不同。于是想通过代码进行配置,下面把方法分享如下
    2014-01-01
  • ASP.NET中弹出消息框的几种常见方法

    ASP.NET中弹出消息框的几种常见方法

    这篇文章主要介绍了ASP.NET中弹出消息框的几种常见方法,给出了几种常见的弹出消息框的方法,并总结对比了几种方法的特点,具有一定的参考借鉴价值,需要的朋友可以参考下
    2014-11-11
  • asp.net使用jQuery Uploadify上传附件示例

    asp.net使用jQuery Uploadify上传附件示例

    Uploadify是JQuery的一个上传插件,实现的效果非常不错,带进度显示,本文是一个简单的介绍Demo,主要是动态传递参数方法,通过formdata 向处理程序传递额外的表单数据
    2014-01-01
  • TextBox的宽度随输入的文本的大小而改变的js代码

    TextBox的宽度随输入的文本的大小而改变的js代码

    TextBox的宽度随输入的文本的大小而改变的asp.net代码。
    2009-09-09
  • ASP.NET Core环境设置教程(2)

    ASP.NET Core环境设置教程(2)

    这篇文章主要为大家详细介绍了Asp.net Core环境设置教程,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-06-06
  • ASP.NET MVC小结之基础篇(一)

    ASP.NET MVC小结之基础篇(一)

    本文是ASP.NET MVC系列的第一篇文章,跟其他学习系列一样,咱们先来点基础知识,之后再循序渐进。我们先从asp.net mvc的概念开始吧。
    2014-11-11
  • 一步步打造简单的MVC电商网站BooksStore(1)

    一步步打造简单的MVC电商网站BooksStore(1)

    这篇文章主要和大家一起一步步打造一个简单的MVC电商网站,MVC电商网站BooksStore第一篇,具有一定的参考价值,感兴趣的小伙伴们可以参考一下
    2017-04-04
  • ASP.net WebAPI跨域调用问题的解决方法

    ASP.net WebAPI跨域调用问题的解决方法

    在做Web开发中,常常会遇到跨域的问题,到目前为止,已经有非常多的跨域解决方案。下面这篇文章主要给大家介绍了关于ASP.net WebAPI跨域调用问题的解决方法,文中通过示例代码介绍的非常详细,需要的朋友可以参考下。
    2018-03-03
  • ASP.NET网页显示LED字体的方法

    ASP.NET网页显示LED字体的方法

    在我们开发网站时,或许需要显示一些非windows或是服务器安装的字体。在网站发布时,我们不可能把这些字符复制于服务器上,除非你拥有管理员级权限。在条件不允许的情况,但又要显示特殊字体时,只有参考下面的方法来实现
    2012-10-10
  • asp.net类序列化生成xml文件实例详解

    asp.net类序列化生成xml文件实例详解

    这篇文章主要介绍了asp.net类序列化生成xml文件的方法,结合实例形式较为详细的分析了asp.net序列化生成xml文件的具体步骤与相关实现技巧,需要的朋友可以参考下
    2015-11-11

最新评论