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;

结语

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