如何在Koa.js框架下构建文件上传接口？

本文共计1431个文字，预计阅读时间需要6分钟。

文件上传是一个基本功能，几乎每个系统都会具备，例如上传图片、上传Excel等。在Node+Koa应用中，实现支持文件上传的接口如下：

1. 环境准备： - 安装Node.js和Koa - 创建Koa项目，并初始化npm包

2. 实现文件上传接口：javascriptconst Koa=require('koa');const Router=require('koa-router');const multer=require('koa-multer');

const app=new Koa();const router=new Router();

// 配置文件上传存储const storage=multer.diskStorage({ destination: function (req, file, cb) { cb(null, 'uploads/'); // 指定上传文件的存储路径 }, filename: function (req, file, cb) { cb(null, file.originalname); // 使用原始文件名 }});

const upload=multer({ storage: storage });

// 添加上传接口router.post('/upload', upload.single('file'), async (ctx)=> { if (!ctx.file) { ctx.body={ message: '文件未上传' }; return; } ctx.body={ message: '文件上传成功', filePath: ctx.file.path };});

app.use(router.routes()).use(router.allowedMethods());

app.listen(3000, ()=> { console.log('Server is running on http://localhost:3000');});

3. 使用Postman测试接口： - 发送POST请求到 `http://localhost:3000/upload` - 选择文件并上传 - 查看响应结果

这样，我们就实现了一个支持文件上传的接口。

文件上传是一个基本的功能，每个系统几乎都会有，比如上传图片、上传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('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, 'publicimg.558idc.com/uploadfile'), // 保留文件扩展名 keepExtensions: true, } }));

... ...

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

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

这样我们其实已经可以进行文件上传，并把文件上传到 publicimg.558idc.com/uploadfile 中了，我们用 Postman 来测试一下。

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

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

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

直接返回图片的本地路径在实际上是没什么用的，我们应该返回一个localhost:3001img.558idc.com/uploadfile/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}img.558idc.com/uploadfile/${basename}` } })

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

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

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服务打开这个页面： localhost:3001/upload.html ，因为我们整个 public 目录已经是一个静态HTTP服务目录了，里面的所有文件都可以通过HTTP访问。

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

总结

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