ASP.NET CORE WEBAPI文件下载

最近要使用ASP.NET CORE WEBAPI用来下载文件,使用的.NET CORE 3.1。考虑如下场景:

  1. 文件是程序生成的。

  2. 文件应该能兼容各种格式。

  3. 浏览器可以感知进行下载。

准备

经过简单的调研,得到以下结论。

  • ASP.NET CORE 提供FileResult这种类型的ActionResult,可以直接返回文件结果,不需要直接处理HttpResponse。

  • 通过Stream可以直接返回文件流供浏览器下载。

  • FileStreamResult是FileResult的具体实现,返回值应该是此类对象。

  • Stream有多种类型,适合直接内存中生成文件对象的是MemoryStream。
    对目标有了基础的了解,就可以开始动手实现了。

实现

建立好ASP.NET CORE WEBAPI工程,把生成文件的代码独立出来一个函数。我这里需要是下载一个CSV格式的文件,因此生成一个CSV文件。
对于磁盘上的文件,可以使用FileStream对象,由于我这里需要运行中生成这个文件,需要使用MemoryStream。

using var stream = new MemoryStream();
using var writer = new StreamWriter(stream);
//生成标题
var propCollection = ttype.GetProperties();
foreach (var n in propCollection)
{writer.Write(n.Name);writer.Write(",");
}
writer.WriteLine();
//生成内容
foreach (var item in res)
{foreach (var n in propCollection){writer.Write(Convert.ToString(n.GetValue(item)));writer.Write(",");}writer.WriteLine();
}
  1. 请不要考虑里面反射的相关内容,按照自己的逻辑生成CSV即可,我只是懒得改代码而已。

  2. 代码中使用到了一些新的语法特性,请注意对低版本的.NET不一定适用。
    直接返回Stream对象给Controller处理,处理代码如下:

var res = await info.GetAllQueryResult();
var actionresult = new FileStreamResult(res, new Microsoft.Net.Http.Headers.MediaTypeHeaderValue("text/csv"));
return actionresult;

CSV的Content-Type是text/csv,如果下载别的文件,请自行查询MIME格式。

调试

直接执行上面的代码,直接报错“无法读取已经关闭的流”。猜测是离开using语句块的时候,stream自动被关闭了。改动很简单,去掉using语句,不再报相同错误。

但是返回的文件长度一直是0,单步调试发现Writer执行完毕之后,stream返回的长度是0,内容实际上并没有写入,想起有一个Flush(),可以添加以确保数据写入。

单步显示stream长度有了,但是返回的长度还是0。继续单步调试发现Stream的Postion是停在文件结尾的,这个和直接开始读取文件完全不一样,文件读取一般是从开头开始的,于是直接设置Postion为0,问题解决。

下载能够成功了,但是文件名一直显示的是随机生成的,体验很差。设置一下FileDownloadName即可。

核心代码如下:

public async Task<Stream> GetAllQueryResult()
{var stream = new MemoryStream();var writer = new StreamWriter(stream);//生成标题var propCollection = ttype.GetProperties();foreach (var n in propCollection){writer.Write(n.Name);writer.Write(",");}writer.WriteLine();//生成内容foreach (var item in res){foreach (var n in propCollection){writer.Write(Convert.ToString(n.GetValue(item)));writer.Write(",");}writer.WriteLine();}writer.Flush();stream.Position = 0;return stream;
}
[HttpPost("file")]
[ProducesResponseType(typeof(FileResult), Status200OK)]
public async Task<FileResult> Download()
{var info = new Info();var res = await info.GetAllQueryResult();var actionresult = new FileStreamResult(res, new Microsoft.Net.Http.Headers.MediaTypeHeaderValue("text/csv"));actionresult.FileDownloadName = "Carinfos.csv";//Response.ContentLength = res.Length;return actionresult;
}

使用swagger调用,最后效果:

总结

后来查了一些资料,总结了一下:

  • MemoryStream如果使用using语句,会在离开代码块的时候自动关闭,实际上ASP.NET CORE会自动处理关闭的事项,不需要使用using语句。

  • 由于生成文件的过程是从文件流的开头一直进行到末尾的,因此向请求端返回结果时,应当重置Stream的游标,从0开始传输。

  • 记得在使用writer之后使用Flush()以确保数据有写入。

  • 如果不确定文件格式,可以直接返回MIME值为application/oct-stream。

  • 设置FileStreamResult的FileDownloadName属性可以修改文件的默认名称。

  • (可选)可以通过设置Response.ContentLength来设置文件的长度。

参考资料:

https://darchuk.net/2019/05/31/asp-net-core-web-api-returning-a-filestream/

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/310584.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

Redis高级数据结构原理解析-bitmap,hyperloglog

Redis 位图 开发过程中&#xff0c;我们可能遇到这种场景记录用户的打卡情况&#xff0c;签到情况&#xff0c;这些场景只有两种结果&#xff0c;有或者没有&#xff0c;加入记录的数据量比较大&#xff0c;比如用一年的数据&#xff0c;如果用Redis中普通key/value&#xff0…

[剑指offer]面试题8:旋转数组的最小数字

面试题8&#xff1a;旋转数组的最小数字 题目&#xff1a;把一个数组最开始的若干个元素搬到数组的末尾&#xff0c;我们称之为数组的旋转。输入一个递增排序的数组的一个旋转&#xff0c;输出旋转数组的最小元素。例如数组{3,4,5,1,2}为{1,2,3,4,5}的一个旋转&#xff0c;该数…

.NET Core + Kubernetes:快速体验

Kubernetes[1] 是目前非常主流的容器编排工具&#xff0c;在应用创建、应用部署、应用扩容、应用更新等方面都非常的方便&#xff0c;而且在应用故障时&#xff0c;也可以快速自愈。所以基于微服务架构下的产品&#xff0c;了解 Kubernetes 的使用是非常必要的&#xff0c;我猜…

[剑指offer]面试题9:斐波那契数列

面试题9&#xff1a;斐波那契数列 题目一&#xff1a;写一个函数&#xff0c;输入n&#xff0c;求斐波那契&#xff08;Fibonacci&#xff09;数列的第n项。斐波那契数列的定义如下&#xff1a; ❖ 效率很低的解法&#xff0c;挑剔的面试官不会喜欢 代码如下: long long fib(…

Redis分布式锁奥义

分布式锁 分布式系统进行逻辑处理的时候&#xff0c;经常会遇到并发问题&#xff0c;例如直播场景中&#xff0c;用户需要连麦主播&#xff0c;当多个用户在同一个时刻一起连麦时候&#xff0c;应该保证只有一个用户能连麦成功&#xff0c;我们改怎么保证这种业务场景下保证数…

.NET Core + Kubernetes:Pod

在 .NET Core Kubernetes&#xff1a;快速体验 文章中&#xff0c;已经实现将一个 .NET Core API 服务部署在 Kubernetes 集群中&#xff0c;接下来将逐步了解 Kubernetes 中各核心模块。首先当然是 Pod&#xff0c;我相信 Pod 是在接触 Kubernetes 时听到较多的一个词语&…

LBS解决方案

LBS解决方案 LBS&#xff08;基于地理位置的服务&#xff09;服务是现在移动互联网中比较常用的功能&#xff0c;例如外卖中我附近的店铺&#xff0c;通常是以客户位置坐标为中心&#xff0c;查询一定范围内的店铺信息&#xff0c;按照距离由近及原进行倒叙排序 方案一&#…

长沙IT技术圈百万年薪大佬?是否存在?

作者&#xff1a;邹溪源&#xff0c;长沙资深互联网从业者&#xff0c;架构师社区特邀嘉宾&#xff01;01引子不知不觉&#xff0c;IT技术圈开始流传起“百万年薪”的故事&#xff0c;有人问我&#xff0c;长沙有百万大佬么&#xff1f;其实我也不知道。02背景长沙自古以来就是…

网络编程-网络分层的意义

网络 我们生活在一个网络无处不在的一个虚拟世界中&#xff0c;网络中的每一个设备都是一个节点。大多是我们的计算机&#xff0c;但是他还可以连接其他设备&#xff0c;例如打印机&#xff0c;路由器&#xff0c;网关&#xff0c;你的手机&#xff0c;智能家居等。我们可以使…

网络编程-TCP/IP协议栈-IP协议

协议 协议就是约定的一种规则&#xff0c;例如扑克游戏中约定好的各种规则&#xff0c;2<3<4<5<…等&#xff0c;以此作为游戏规则。当所有人都遵循这个规则&#xff0c;那么久可以不需要任何多余的交流就可以进行游戏&#xff0c;这个方式形成的约定就是一种协议…

.NET项目升级手记:可为空引用

c# 8引入了新特性&#xff1a;“可为空引用”&#xff08;详情&#xff09;&#xff0c;这个功能个人觉得挺好的&#xff0c;能够非常明确的表现程序设计者的意图&#xff0c;编译器能够进行检查&#xff0c;尽最大可能减小NullReferenceException错误。如果是新项目&#xff0…

.NET与鲲鹏共展翅,昇腾九万里(一)

2019年1月7日&#xff0c;华为推出鲲鹏920处理器&#xff0c;便宣告了构建鲲鹏生态系统的开始。据官方介绍&#xff0c;鲲鹏是一个包含了鲲鹏计算单元、AI处理单元、智能管理、智能网卡的片上系统SoC&#xff0c;在此之上加上服务器操作系统&#xff0c;从而形成一个生态的闭环…

网络编程-TCP/IP协议栈-TCP协议

TCP协议 TCP协议作用 TCP协议位于协议栈的传输层。当应用层向TCP层发送用于网间传输的&#xff0c;用8字节表示的数据流&#xff0c;TCP则吧数据流分割成适当长度的报文段&#xff0c;最大传输段大小&#xff08;MSS&#xff09;通常受到改计算机连接的网络数据链路层的最大传…

互联网10年,激战如梦

— 1 —1969年&#xff0c;美国国防部研究计划署第一次将互联网应用于军事连接。随后美国西南部四所名校的四台计算机通过这项技术连接起来。谁也没想到&#xff0c;这项计划会对人类的命运产生如此重大影响。1993年&#xff0c;互联网真正诞生。美国白宫宣布开始提供「在线服务…

网络编程-TCP/IP协议栈-UDP/HTTP协议

UDP协议 UDP协议全称是用户数据报协议&#xff0c;在网络中她与TCP协议一样用于处理数据包&#xff0c;两个协议同处于协议栈的传输层&#xff0c;和TCP不同的是&#xff0c;UDP是一种无连接的协议栈。 因为UDP是无连接的&#xff0c;所以相对来说&#xff0c;UDP的报头比TCP要…

十问十答 Ms-PL 许可证

Microsoft 公共许可证&#xff08;The Microsoft Public License&#xff09;是微软为释出开源项目而编写和发布的自由开源软件许可证。如果你用 .NET 开发&#xff0c;你会经常碰见 Ms-PL。在微软的自由开源项目托管地 Codeplex&#xff08;已寿终正寝&#xff0c;微软已战略转…

网络编程-HTTPS协议的实现原理

HTTP传输协议缺点 之前几篇文章中详细讲解了TCP/IP协议栈中的几个协议&#xff0c;其中个就有对HTTP做了一个比较详细的讲解。HTTP是基于TCP进行传输的&#xff0c;其中传输的内容都是明文报文数据&#xff0c;如果我是一个黑客&#xff0c;我会想办法获取这个HTTP消息体&…

从案例角度解析建模平台动态规则引擎

源宝导读&#xff1a;明源云ERP建模平台提供了强大的页面联动规则引擎&#xff0c;原来需要编写代码完成的联动控制逻辑&#xff0c;现在只需要点点鼠标&#xff0c;通过配置完成。本文从实际案例的角度出发&#xff0c;介绍原始的代码逻辑如何转化为引擎规则的过程。一、背景明…

想基于K8s按需扩展应用程序,可从这几方面入手

马修赫瑟&#xff08;Matthew Heusser&#xff09;在花费了十年时间进行编程&#xff0c;测试和项目管理之后&#xff0c;Matt Heusser于2011年创立了自己的公司Excelon Development。该协会前董事会成员Matt还是软件测试人员&#xff0c;是德国波茨坦最具影响力的敏捷测试专业…

windows环境下ELK平台搭建

背景 日志系统主要包括系统日志&#xff0c;应用程序日志和安全日志。系统运维和开发人员可以通过日志了解服务器的软件&#xff0c;硬件信息&#xff0c;检查配置过程中的错误以及错误发生的原因。通常分析日志可以了解服务器的负荷&#xff0c;性能安全性&#xff0c;从而及时…