FastApi下载文件

记得之前我们讲过生成excel文件的事情,那么如何把服务器生成的excel文件正确发送给用户呢?

今天我们就来说说在FastApi中如何正确让用户下载到想要的文件。

基本流程

其实文件下载的场景还是挺多的,比如我想要拿到我这个用户最近10天创建的测试用例数据,那么我们服务端应该怎么做呢?

  1. 根据条件筛选出正确的数据
  2. 处理数据,生成对应的目标格式文件,比如csv,xlsx等等
  3. 返回http响应,其中指定response的内容和类型

温馨提示

现在假设我们已经完成了之前的步骤,并且生成了一个临时文件

需要注意的是,临时文件的名字为了确保唯一性,最好是用时间戳+随机字符串,或者懒一点可以用uuid

这里为了方便,我就编写一个简便的方法:

import time
import random random_str = list("abcdefgh")
random.shuffle(random_str)
filename = f"{time.time_ns()}_{''.join(random_str)}"

取当前时间戳(精确到纳秒),这时候还是有可能会有同一请求发生,所以我们再用random.shuffle对我们想要加的字符串进行随机排序(打乱顺序)。

这样一来,文件重名的概率就小了非常多,如果要严谨的话,可以把字符串放长点,但是文件名也会拖很长。

记得一定要保存这个随机的文件名,并且加上文件后缀哈~!

FastApi怎么做呢

其实文件也是HTTP的响应之一,只不过它相对特殊。

在FastApi中,响应有Response和FileResponse等多种,我们暂时看Response和FileResponse即可。

Response是我们常见的类型,当然fastapi比较友好,你如果return 一个字典,会默认将之转换为JSON Response。

但当你要设置返回的http状态码,那就需要去操作这个Response对象了。

我们常见的比如403 forbidden,401未认证,都可以用Response来实现。


那么对于FileResponse,我们怎么用呢?

其实用法比较简单,我们来看实战:

from fastapi import FastAPI
from starlette.responses import FileResponse app = FastAPI(name="monitor") @app.get("/download")
async def download():
# 处理完毕文件以后,生成了文件路径
filename = "你要下载的文件路径.xls"
return FileResponse(
filename, # 这里的文件名是你要发送的文件名
filename="lol.exe", # 这里的文件名是你要给用户展示的下载的文件名,比如我这里叫lol.exe
)

这样,前端页面提供一个a标签,href地址填对应的接口地址就好了。

<!DOCTYPE html>
<html>
<head>
<title>测试</title>
</head>
<body>
<!-- 这个地址用你的host:port加上接口地址-->
<a href="http://localhost:7777/download">下载文件</a>
</body>
</html>

等等 好像少了点啥

我们这个生成的文件虽然说都是随机的,没啥影响。但是如果一直有人生成,那不删除真的大丈夫吗?

所以我们得考虑下怎么删除文件~

  • 理所当然认为try finally

    答案是行不通的,因为finally的内容会在return之前进行。如果这时候你删除了文件,那么Response就返回不了文件了,会报错。

    还好我们FastApi原生提供了background功能,幕后工作人员会在执行完毕之后进行一些暗箱操作

    所以我们可以这么改动:

from starlette.background import BackgroundTask

        return FileResponse(
filename,
filename="application.xls",
background=BackgroundTask(lambda: os.remove(filename)),
)

使用background接受一个参数BackgroundTask,里面参数是一个无参方法:

lambda: os.remove(filename)

也就是删除这个文件的方法。

最后

flask的相关文件下载可以看博主几年前写的文章,原理都通用。

https://www.cnblogs.com/we8fans/p/7107353.html

FastApi下载文件的更多相关文章

  1. Java下载文件(流的形式)

    @RequestMapping("download") @ResponseBody public void download(HttpServletResponse respons ...

  2. 使用批处理文件在FTP服务器 上传下载文件

    1.从ftp服务器根目录文件夹下的文件到指定的文件夹下 格式:ftp -s:[配置文件] [ftp地址] 如:ftp -s:c:\vc\ftpconfig.txt   192.168.1.1 建立一个 ...

  3. 通过form表单的形式下载文件。

    在项目中遇到问题,要求动态拼接uri下载文件.但是由于项目的安全拦截导致window.location.href 和 window.open等新建窗口的方法都不行. 无意间百度到了通过form表单来下 ...

  4. SecureCRT上传和下载文件

    SecureCRT上传和下载文件(下载默认目录) SecureCR 下的文件传输协议有ASCII .Xmodem .Ymodem .Zmodem ASCII:这是最快的传输协议,但只能传送文本文件. ...

  5. HTTP 错误 404.3 – Not Found 由于扩展配置问题而无法提供您请求的页面。如果该页面是脚本,请添加处理程序。如果应下载文件,请添加 MIME 映射。

    今天,在vs2013中新建了一个placard.json文件,当我用jq读取它的时候,去提示404,直接在浏览器访问这个文件,提示: HTTP 错误 404.3 – Not Found 由于扩展配置问 ...

  6. FTP下载文件失败

    这几天的定时任务下载文件的脚本失败了. 于是手工执行测试,发现报550 Permission denied. Passive mode refused. 意思就是被动模式下,没有权限获取文件. 解决方 ...

  7. 如何使用FileZilla上传和下载文件

    一.使用FileZilla上传文件 1 打开 FileZilla 按照如下图所示,填写远程 Linux 的 IP ,用户名,密码,还有端口号(默认22) 2 选中左边需要上传的文件,然后拖到右边,等待 ...

  8. 开发板tftp下载文件

    搭建过程: 1.安装相关软件包:tftpd(服务端),tftp(客户端),xinetd sudo apt-get install tftpd tftp xinetd 2.建立配置文件(蓝色的目录是可以 ...

  9. Linux上传下载文件快捷命令

    远程链接Linux(如SecrueCRT),要上传文件很下载文件到Linux服务器,只需要使用sz或者rz命令即可快速下载和上传文件了. 使用方法: 1.首先确保Linux服务器系统中安装了lrzsz ...

随机推荐

  1. 鸿蒙内核源码分析(工作模式篇) | CPU是韦小宝,七个老婆 | 百篇博客分析OpenHarmony源码 | v36.04

    百篇博客系列篇.本篇为: v36.xx 鸿蒙内核源码分析(工作模式篇) | CPU是韦小宝,七个老婆 | 51.c.h .o 硬件架构相关篇为: v22.xx 鸿蒙内核源码分析(汇编基础篇) | CP ...

  2. "错误: 找不到或无法加载主类"解决办法

    前言:记上次一个找了个把小时的问题(很烦这些配置) 原因: 从svn下checkOut的项目 在application的配置的输出class路径为main,而class文件路径是在项目名的根路径下,所 ...

  3. ❤️【Python从入门到精通】(二十六)用Python的PIL库(Pillow)处理图像真的得心应手❤️

    您好,我是码农飞哥,感谢您阅读本文,欢迎一键三连哦. 本篇重点介绍Python处理图像的标准库PIL库,处理图像真的的很方便. 干货满满,建议收藏,需要用到时常看看. 小伙伴们如有问题及需要,欢迎踊跃 ...

  4. T-SQL——数据透视和逆透视

    目录 0. 测试数据集及说明 0.1 准备测试数据 0.2 对一维表和二维表理解 1. 透视转换 1.1 使用标准SQL进行数据透视 1.2 使用T-SQL中pivot函数进行数据透视 1.3 关于 ...

  5. Unity——对象池管理

    Unity对象池管理 一.Demo展示 二.逻辑 在游戏中会出现大量重复的物体需要频繁的创建和销毁:比如子弹,敌人,成就列表的格子等: 频繁的创建删除物体会造成很大的开销,像这种大量创建重复且非持续性 ...

  6. Ysoserial Commons Collections2分析

    Ysoserial Commons Collections2分析 About Commons Collections2 CC2与CC1不同在于CC2用的是Commons Collections4.0; ...

  7. DOS命令和快捷键

  8. Kali安装OWASP

    我是2019版的kali,里面并没有自带OWASP工具,因为OWASP不再更新的因素,所以新版kali将它移除了  安装OWASP apt-get install zaproxy #以下都是安装软件时 ...

  9. vue3.x相对于vue2.x生命周期改动

    vue3.x已经正式发布了,部分小伙伴已经用了vue3.x开发,部分小伙伴还在观望中,下面是两个影响比较大的改动 1.beforeDestroy和destroyed不能用了. 这个应该是vue2.x项 ...

  10. 谜语人队 Scrum Meeting 博客汇总

    项目 内容 课程主页 2021春季软件工程(罗杰 任健) 作业要求地址 Alpha阶段:团队项目-每日例会报告Beta阶段:团队项目-每日例会报告 团队博客主页 谜语人队 一.Alpha阶段 第一次例 ...