nodejs文件上传处理模块formidable

本文转自http://itbilu.com/nodejs/npm/NkGKcF14.html

 在web开发中，经常遇到处理文件上传的情况。而express框架在4.0版本后就不在支持req.files接收上传文件，对于文件上传，需要加multipart格式数据处理的中间件。multipart数据处理中间件有：busboy, multer, formidable, multiparty, connect-multiparty, pez等。本站使用了formidable插件，比较简单易用。
formidable是一个用于处理文件、图片、视频等数据上传的模块，支持GB级上传数据处理，支持多种客户端数据提交。有极高的测试覆盖率，非常适合在生产环境中使用。

安装

formidable是一个轻量级的应用包，可以不依赖于express等框架单独使用，也可以集成到exress框架中使用。安装命令如下： 

[plain]  view plain  copy

1. npm install formidable@latest  

 使用

在nodejs原生环境中使用formidable。 

[javascript]  view plain  copy

1. var formidable = require('formidable'),  
2.     http = require('http'),  
3.     util = require('util');  
4.   
5. //用http模块创建一个http服务端   
6. http.createServer(function(req, res) {  
7.   if (req.url == '/upload' && req.method.toLowerCase() === 'post') {  
8.     // 处理上传的文件  
9.     var form = new formidable.IncomingForm();  
10.    
11.     form.parse(req, function(err, fields, files) {  
12.       res.writeHead(200, {'content-type': 'text/plain'});  
13.       res.write('received upload:\n\n');  
14.       res.end(util.inspect({fields: fields, files: files}));  
15.     });  
16.    
17.     return;  
18.   }  
19.    

 上传后，响应结果如下 

[javascript]  view plain  copy

1. received upload:  
2.   
3. { fields: { title: 'title的内容' },  
4.   files:      //所有type="file"类型的数据对象  
5.    { upload:   
6.       { domain: null,  
7.         _events: {},  
8.         _maxListeners: 10,  
9.         size: 41966,             //文件大小  
10.         path: '/var/folders/1k/86kq55_n4_q2tckwz9mb5wyr0000gn/T/upload_ecbf965abc1e14c2ffc86875c2f5eaa8',   //文件保存路径  
11.         name: 'avatar.jpg',     //上传前的文件名  
12.         type: 'image/jpeg',    //文件类型  
13.         hash: null,  
14.         lastModifiedDate: Sat May 16 2015 10:38:57 GMT+0800 (CST),  
15.         _writeStream: [Object] } } }  

 常用API

创建一个incoming form实例 

[javascript]  view plain  copy

1. var form = new formidable.IncomingForm()  

 设置incoming form fields（fileds指除type="file"外的其它接收数据）编码 

[javascript]  view plain  copy

1. form.encoding = 'utf-8';  

设置文件接收后保存的文件夹。此文件夹一般为上传后的临时文件夹，上传后调用 fs.rename()对文件进行移动及重命名。默认保存路径为os.tmpDir() 

[javascript]  view plain  copy

1. form.uploadDir = "/my/dir";  

设置上传后文件是否使用原扩展名，默认值为false。如果希望保存到form.uploadDir中的文件使用原扩展名时，需要将此项设置为true 

[javascript]  view plain  copy

1. form.keepExtensions = false;  

 'multipart'或'urlencoded'类型的请求在formidable都支持，可通过上传文件的type属性查看文件类型 

[javascript]  view plain  copy

1. form.type  

 设置上传文件的大小，默认值为2M 

[javascript]  view plain  copy

1. form.maxFieldsSize = 2 * 1024 * 1024;  

 设置最大可接收字段数，用于防止内存溢出，默认值为1000 

[javascript]  view plain  copy

1. form.maxFields = 1000;  

 是否对上传文件进行hash较验，可设置为'sha1' 或 'md5' 

[javascript]  view plain  copy

1. form.hash = false;  

在express中使用formidable

在express框架中使用formidable，需要一个接收文件提交的路由。以下示例为一个接收用户头像提交的路由

[javascript]  view plain  copy

1. router.post("/user/avatar", user.avatar);  

 路由对应的接收提交数据的方法

[javascript]  view plain  copy

1. //设置头像  
2. exports.avatar = function(req, res, next) {  
3.     var form = new formidable.IncomingForm();  
4.     form.uploadDir = path.join(__dirname, 'tmp');   //文件保存的临时目录为当前项目下的tmp文件夹  
5.     form.maxFieldsSize = 1 * 1024 * 1024;  //用户头像大小限制为最大1M    
6.     form.keepExtensions = true;        //使用文件的原扩展名  
7.     form.parse(req, function (err, fields, file) {  
8.         var filePath = '';  
9.         //如果提交文件的form中将上传文件的input名设置为tmpFile，就从tmpFile中取上传文件。否则取for in循环第一个上传的文件。  
10.         if(file.tmpFile){  
11.             filePath = file.tmpFile.path;  
12.         } else {  
13.             for(var key in file){  
14.                 if( file[key].path && filePath==='' ){  
15.                     filePath = file[key].path;  
16.                     break;  
17.                 }  
18.             }  
19.         }  
20.         //文件移动的目录文件夹，不存在时创建目标文件夹  
21.         var targetDir = path.join(__dirname, 'upload');  
22.         if (!fs.existsSync(targetDir)) {  
23.             fs.mkdir(targetDir);  
24.         }  
25.         var fileExt = filePath.substring(filePath.lastIndexOf('.'));  
26.         //判断文件类型是否允许上传  
27.         if (('.jpg.jpeg.png.gif').indexOf(fileExt.toLowerCase()) === -1) {  
28.             var err = new Error('此文件类型不允许上传');  
29.             res.json({code:-1, message:'此文件类型不允许上传'});  
30.         } else {  
31.             //以当前时间戳对上传文件进行重命名  
32.             var fileName = new Date().getTime() + fileExt;  
33.             var targetFile = path.join(targetDir, fileName);  
34.             //移动文件  
35.             fs.rename(filePath, targetFile, function (err) {  
36.                 if (err) {  
37.                     console.info(err);  
38.                     res.json({code:-1, message:'操作失败'});  
39.                 } else {  
40.                     //上传成功，返回文件的相对路径  
41.                     var fileUrl = '/upload/' + fileName;  
42.                     res.json({code:0, fileUrl:fileUrl});  
43.                 }  
44.             });  
45.         }  
46.     });  
47. }