egg-downloader: 扩展 一个 egg 方法 ctx.downloader(), 用于文件下载
发布于 2 年前 作者 zzzs 2541 次浏览 来自 分享

egg-downloader: 扩展 一个 egg 方法 ctx.downloader(), 用于文件下载。

github: https://github.com/zzzs/egg-downloader

花絮

本来取名为egg-downloader,npm publish时提示包名不允许(npm上并没有egg-download这个包),无奈改为egg-downloader

背景

由于自己实现下载文件功能时,经常按以下步骤: 1 检查文件 2 【可选】设置下载文件名 3 【可选】设置头部信息 重复操作做的多了自然想封装下来方便调用,遵循渐进式开发思维,故把这些步骤封装成插件。

以下是具体描述

Features

ctx.downloader用于提供文件下载的功能,支持三个参数,ctx.download(file, [name], [header])

  • file: 必选,文件路径
  • name: 可选,下载文件名(包含后缀)
  • header: 可选,附加头信息, 并且header会改为全部小写(感谢天猪的建议:egg 推荐 header 全部小写,会有一定的性能提升)。

如果 file 是个不带路径的文件,将默认视为下载 app/public/file 。

Example

// {app_root}/controller/home.js
const Controller = require('egg').Controller;
class HomeController extends Controller {
  async index() {
    // 下载为 package.json
    this.ctx.downloader('./package.json');
    
    // 下载为 new-name.json
    // this.ctx.downloader('package.json', 'new-name.json');
    
    // 下载为 new-name.json, header: X-Token: 123
    // this.ctx.downloader('package.json', 'new-name.json', { 'x-token': '123' });
  }
}
module.exports = HomeController;

结语

这次这个小玩样儿比较简单,如有问题或有优化的点,欢迎提出。

9 回复

赞。看了下源码,几个建议:

  • fs.accessSync 永远不要用 Sync 方法,另外, access 其实可以用回 exists
  • 可以引入 mz 这个包,this.ctx.downloader 改为 async 的
  • header 首字母大小写是没意义的,HTTP 规范里面是不区分大小写的。另外 egg 推荐 header 全部小写,会有一定的性能提升。
  • 默认的 header 可以设置下,如放到 config 里面,https://github.com/eggjs/examples/blob/master/download/app/controller/index.js#L19
  • 不必要的一些文件可以删除,如 config 和 lock 文件

@atian25 非常感谢!已经全部修改提交。 之前也是因为官网上 exists 废弃了,所以使用了 access, 这里感谢推荐 mz

关于 header 默认设置,已经参考建议设置了,不过我是将 header 设置放在了 this.ctx.attachment('xxx') 之前,如下

  this.ctx.set('content-type', 'application/octet-stream');
  this.ctx.attachment(filename);

因为如果 header 设置在后的话,已知的文件类型也会被设置为 application/octet-stream

@zzzs 之前废弃,后面反馈太多了,又恢复了

@atian25 soga, 涨知识了,谢谢:)

@zzzs 刚看了下,还是废弃了,Stability: 0 - Deprecated: Use fs.stat() or fs.access() instead.

@atian25 嗯,一般我都是看官网的,还以为不是最新的呢。那应该是以前恢复过,node api变化太快,搞不好后面又恢复了😂

@zzzs 我们一般直接用 mz,即使废弃掉的话,在里面 patch 下就好了,对使用者无感知

@atian25 egg的默认的长连接时长是多少呢?找了很久没有看到。

@tong3jie 就是 node 默认的 2 分钟,我们没改,https://nodejs.org/api/http.html#http_server_settimeout_msecs_callback

有需要可以在 app.js 里面修改 app.server.setTimeout(),但大部分情况下,你应该回去审视你们的设计是否不合理,很少会存在一个 http 请求要超过 2 分钟的。

回到顶部