在Koa.js中实现文件上传的接口功能


Posted in Javascript onOctober 08, 2019

文件上传是一个基本的功能,每个系统几乎都会有,比如上传图片、上传Excel等。 那么在Node Koa应用中如何实现一个支持文件上传的接口呢? 本文从环境准备开始、最后分别用 Postman 和一个HTML页面来测试。

01—环境准备

首先当然是要初始化一个Koa项目了,安装 Koa、koa-router 即可。

npm install koa koa-router

设置图片上传目录,把图片上传到指定的目录中,在 app 路径下新建 public 文件夹,目录结构如下:

koa-upload/

--app

----public

------uploads

----index.js

--package.json

编写 index.js

const koa = require('koa')
const app = new koa()
router.post('/upload', ctx => {
  ctx.body = 'koa upload demo'
})
app.use(router.routes());
app.listen(3000, () => {
  console.log('启动成功')
  console.log('http://localhost:3000')
});

然后启动,确保这一步没有问题。

02—使用 koa-body 中间件获取上传的文件

koa-body 支持文件、json、form格式的请求体,安装 koa-body

  npm install koa-body

设置 koaBody 配置参数,index.js

const koa = require('koa')
const koaBody = require('koa-body')
const path = require('path')
const app = new koa()
app.use(koaBody({
  // 支持文件格式
  multipart: true,
  formidable: {
    // 上传目录
    uploadDir: path.join(__dirname, 'public/uploads'),
    // 保留文件扩展名
    keepExtensions: true,
  }
}));

... ...

接下来完善 /upload 路由,获取文件,然后直接返回文件路径

router.post('/upload', ctx => {
  const file = ctx.request.files.file
  ctx.body = { path: file.path }
})

这样我们其实已经可以进行文件上传,并把文件上传到 public/uploads 中了,我们用 Postman 来测试一下。

打开 Postman,输入 http://localhost:3001/upload ,选择 POST 方法,并且选择文件用 Body 来传输,并且选择 form-data 格式,然后在 KEY 中选择 file类型。

在Koa.js中实现文件上传的接口功能

然后就可以选择图片进行上传了,上传成功后就可以看到 uploads 文件夹下有一个图片了,并且输出了图片的路径。

03—使用 koa-static 中间件生成图片链接

直接返回图片的本地路径在实际上是没什么用的,我们应该返回一个http链接的图片地址,点击地址就可以查看图片。

借助 koa-static 中间件可以帮助我们生成一个静态服务,它指定一个文件夹,文件夹下所有的文件都可以通过 http服务来访问。

安装: npm install koa-static 并注册到 app 上,我们把他注册在 koaBody 中间件的前面,把 public 设置为静态文件目录。

const koaStatic = require('koa-static')
... ...
app.use(koaStatic(path.join(__dirname, 'public')))

启动程序,这样 public 下的文件就可以使用HTTP服务来打开了,我们可以打开之前上传的图片: http://localhost:3001/uploads/upload_65c1d26e5a47870cf4011aad1243fce0.png ,可以在浏览器中直接显示了。

然后我们改造一下 upload 路由的实现,让它生成图片链接返回给客户端

router.post('/upload', ctx => {
  const file = ctx.request.files.file
  const basename = path.basename(file.path)
  ctx.body = { "url": `${ctx.origin}/uploads/${basename}` }
})

basename 可以拿到文件的文件名和扩展名,ctx.origin 拿到服务器的域名,即诸如 localhost:3001,但我们不能写死。

再用 Postman 测试一下,即可看到返回的 图片URL了,点击可以直接打开。

在Koa.js中实现文件上传的接口功能

04—编写前端页面上传文件

前面我们用 Postman 模拟了上传文件进行测试,虽然可以高效的测试我们编写的后端接口,但是我们前端有些同学可能通常更熟悉前端页面的方式测试,那么我们来写一个表单页面来测试。

在 public 中新建 upload.html 文件作为测试页面。

<form action="/upload" method="POST" enctype="multipart/form-data">
  <input type="file" name="file">
  <button type="submit">上传</button>
</form>

这是传统的表单提交,我们实际工作中这样的代码可能已经不常见了,action 就是我们的提交到的接口,enctype="multipart/form-data" 就是指定上传文件格式。 input 的 name 属性一定要等于file,因为我们接受的字段名是 file。

然后我们用HTTP服务打开这个页面: http://localhost:3001/upload.html ,因为我们整个 public 目录已经是一个静态HTTP服务目录了,里面的所有文件都可以通过HTTP访问。

在Koa.js中实现文件上传的接口功能

选择文件,点击上传,上传成功后可以看到返回了文件地址

在Koa.js中实现文件上传的接口功能

总结

以上所述是小编给大家介绍的在Koa.js中实现文件上传的接口功能,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对三水点靠木网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

Javascript 相关文章推荐
Javascript事件热键兼容ie|firefox
Dec 30 Javascript
利用jQuery实现可输入搜索文字的下拉框
Oct 23 Javascript
js实现跟随鼠标移动且带关闭功能的图片广告实例
Feb 26 Javascript
纯JavaScript实现的分页插件实例
Jul 14 Javascript
jQuery CSS3自定义美化Checkbox实现代码
May 12 Javascript
jquery判断类型是不是number类型的实例代码
Oct 07 Javascript
JS禁止查看网页源代码的实现方法
Oct 12 Javascript
js/jquery控制页面动态加载数据 滑动滚动条自动加载事件的方法
Feb 08 Javascript
微信小程序开发animation心跳动画效果
Aug 16 Javascript
js 显示日期时间的实例(时间过一秒加1)
Oct 25 Javascript
node.js express捕获全局异常的三种方法实例分析
Dec 27 Javascript
js实现整体缩放页面适配移动端
Mar 31 Javascript
vue-cli和v-charts实现可视化图表过程解析
Oct 08 #Javascript
vue路由传参页面刷新参数丢失问题解决方案
Oct 08 #Javascript
vux-scroller实现移动端上拉加载功能过程解析
Oct 08 #Javascript
深入学习Vue nextTick的用法及原理
Oct 08 #Javascript
jQuery 筛选器简单操作示例
Oct 02 #jQuery
jQuery 查找元素操作实例小结
Oct 02 #jQuery
JavaScript 作用域实例分析
Oct 02 #Javascript
You might like
解析PHP无限级分类方法及代码
2013/06/21 PHP
解析isset与is_null的区别
2013/08/09 PHP
PHP调用wsdl文件类型的接口代码分享
2014/11/19 PHP
如何在HTML 中嵌入 PHP 代码
2015/05/13 PHP
PHP中使用OpenSSL生成证书及加密解密
2017/02/05 PHP
Lumen timezone 时区设置方法(慢了8个小时)
2018/01/20 PHP
10个实用的脚本代码工具
2010/05/04 Javascript
javascript实现数独解法
2015/03/14 Javascript
浅谈jQuery中setInterval()方法
2015/07/07 Javascript
JS模仿腾讯图片站的图片翻页按钮效果完整实例
2016/06/21 Javascript
Vue.js每天必学之计算属性computed与$watch
2016/09/05 Javascript
浅谈jQuery hover(over, out)事件函数
2016/12/03 Javascript
深入解析Vue 组件命名那些事
2017/07/18 Javascript
javaScript 连接打印机,打印小票的实例
2017/12/29 Javascript
JS实现求5的阶乘示例
2019/01/21 Javascript
详解Vue中的Props与Data细微差别
2020/03/02 Javascript
Python版微信红包分配算法
2015/05/04 Python
python利用tkinter实现屏保
2019/07/30 Python
python字符串下标与切片及使用方法
2020/02/13 Python
python通用读取vcf文件的类(复制粘贴即可用)
2020/02/29 Python
Keras 快速解决OOM超内存的问题
2020/06/11 Python
matplotlib subplot绘制多个子图的方法示例
2020/07/28 Python
Python用摘要算法生成token及检验token的示例代码
2020/12/01 Python
Python3爬虫ChromeDriver的安装实例
2021/02/06 Python
使用canvas生成含有微信头像的邀请海报没有微信头像问题
2019/10/29 HTML / CSS
中国最大的潮流商品购物网站:YOHO!BUY有货
2017/01/07 全球购物
支教自我鉴定
2014/01/18 职场文书
幼儿园运动会入场词
2014/02/10 职场文书
《长江之歌》教学反思
2014/04/17 职场文书
产品设计开发计划书
2014/05/07 职场文书
冲出亚马逊观后感
2015/06/03 职场文书
工作态度怎么写
2015/06/25 职场文书
给校长的建议书作文400字
2015/09/14 职场文书
意外事故赔偿协议书
2016/03/22 职场文书
Redis Cluster集群动态扩容的实现
2021/07/15 Redis
SQL实现LeetCode(180.连续的数字)
2021/08/04 MySQL