Nodejs文件上傳

筆者用nodejs作項目時須要用到文件上傳的功能,在網上搜索了不少教程,找到了一個express的中間件,用於處理multipart/form-data類型的表單數據,能夠很方便的將表單中的文件數據保存到服務器。html

介紹

  multer是一個node.js文件上傳中間件,它是在 busboy的基礎上開發的,上傳的表單數據必須是multipart/form-data類型,否則會報錯。   node

簡單的用法

定義存儲器

  Multer做爲express的一箇中間件,咱們能夠很方便的自定義上傳的文件目錄以及保存的文件名。先看一個最簡單的用法,demo1地址git

var express = require('express');
var multer = require('multer');
var app = express();

var upload = multer({
    storage: multer.diskStorage({
        destination: function (req, file, cb) {
            cb(null, './uploads/');
        },
        filename: function (req, file, cb) {
            //file.originalname上傳文件的原始文件名
            var changedName = (new Date().getTime())+'-'+file.originalname;
            cb(null, changedName);
        }
    })
});複製代碼

  咱們先建立了一個upload對象,這個對象中destination函數用來定義上傳文件的存儲的文件夾;filename函數用來修改上傳文件存儲到服務器的文件名稱,這裏咱們咱們加上一個時間戳簡單區分一下。這兩個函數都是經過回調函數來實現的。每次上傳的時候這兩個函數都會調用一次,若是是多個文件上傳,那個這兩個函數就調用屢次,調用順序是先調用destination,而後調用filename。github

  在兩個函數中都會有一個file對象,表示當前上傳的文件對象,有如下幾個屬性:express

  • fieldname:上傳的字段名
  • originalname:上傳的文件名
  • encoding:文件的編碼類型
  • mimetype:文件的MIME類型

附:一些經常使用的MIME類型json

定義路由回調

//單個文件上傳
app.post('/upload/single',upload.single('singleFile'),(req,res)=>{
    console.log(req.file);
    res.json({
        code: '0000',
        type:'single',
        originalname: req.file.originalname
    })
});

//多個文件上傳
app.post('/upload/multer',upload.array('multerFile'),(req,res)=>{
    console.log(req.files);
    let fileList = [];
    req.files.map((elem)=>{
        fileList.push({
            originalname: elem.originalname
        })
    });
    res.json({
        code: '0000',
        type:'multer',
        fileList:fileList
    });
});複製代碼

  在express中定義路由的回調函數時,把定義好了的upload對象做爲中間件添加進去。若是是單個文件就用single方法,若是是多個文件就用array方法,這兩個方法都須要傳一個頁面上定義好的字段名。數組

  在路由的回調函數中,request對象已經有了file屬性(單個文件上傳)或files屬性(多個文件上傳),files屬性是一個數組,數組的每個對象都有如下屬性:服務器

  • fieldname:上傳的字段名
  • originalname:上傳的文件名
  • encoding:文件的編碼類型
  • mimetype:文件的MIME類型
  • destination:存儲的目錄(和destination回調函數中的目錄名一致)
  • filename:保存的文件名(和filename回調函數中的文件名一致)
  • path:保存的相對路徑
  • size:文件的大小(單位:字節byte)

  咱們能夠發如今路由的回調函數中的file對象比diskStorage中的file對象多了幾個屬性,這是由於在diskStorage中文件尚未保存,只能知道文件的大體屬性;而路由的回調函數文件已經在服務器上保存好了,文件的保存路徑以及文件的大小都是已知的。markdown

混合上傳

  有時候咱們可能須要用字段名來對上傳的文件進行一下劃分,好比說上傳多個圖片的時候可能有身份證還有頭像。雖然能夠分開放到兩個接口中,可是會產生其餘一系列的麻煩事。multer支持對圖片進行字段名的劃分。demo3地址app

//多字段名上傳
let multipleFields = upload.fields([
    {name:'avatar'},
    {name:'gallery', maxCount:3},
]);
app.post('/upload/fields', (req,res)=>{
    multipleFields(req,res,(err) => {
        console.log(req.files);
        if(!!err){
            console.log(err.message);
            res.json({
                code: '2000',
                type: 'field',
                msg:err.message
            })
            return;
        }
        var fileList = [];
        for(let item in req.files){
            var fieldItem = req.files[item];
            fieldItem.map((elem) => {
                fileList.push({
                    fieldname: elem.fieldname,
                    originalname: elem.originalname
                })
            });
        }
        res.json({
            code: '0000',
            type: 'field',
            fileList: fileList,
            msg:''
        })
    });
});複製代碼

  在這邊也有req.files屬性,可是這個屬性並非一個數組,而是一個複雜的對象,這個對象中有多個屬性,每一個屬性名都是一個字段名,每一個屬性下面又是一個數組,數組下面纔是一個個的文件對象,結構大體以下:

{
    "avatar":[{
        fieldname: "",
        originalname: ""
        //...
    }],
    "gallery":[{
        fieldname: "",
        originalname: ""
        //...
    }]
}複製代碼

過濾文件上傳

  在文件上傳時,有時候會上傳一些咱們不須要的文件類型,咱們須要把一些不須要的文件給過濾掉。demo2地址

文件類型過濾

var upload = multer({
    //...其餘代碼
    fileFilter: function(req, file, cb){
        if(file.mimetype == 'image/png'){
            cb(null, true)
        } else {
            cb(null, false)
        }
    }
});複製代碼

  在定義存儲器的時候,新增一個fileFilter函數,用來過濾掉咱們不須要的文件,在回調函數中咱們傳入true/false來表明是否要保存;若是傳了false,那麼destination函數和filename函數也不會調用了。

文件大小和數量過濾

var upload = multer({
    //...其餘代碼
    limits:{
        //限制文件大小10kb
        fileSize: 10*1000,
        //限制文件數量
        files: 5
    }
});複製代碼

  在定義存儲器的時候,新增一個limits對象,用來控制上傳的一些信息,它有如下一些屬性:

  • fieldNameSize:field 名字最大長度,默認值:100 bytes
  • fieldSize:field 值的最大長度,默認值:1MB
  • fields:非文件 field 的最大數量
  • fileSize:在multipart表單中, 文件最大長度 (字節單位)
  • files:在multipart表單中, 文件最大數量
  • parts:在multipart表單中, part傳輸的最大數量(fields + files)

  在這邊咱們把fileSize的值設置得小一點,設爲10kb方便測試看效果,可是若是這個時候會發現有報錯。由於上傳的文件大小很容易就會超過10KB,致使有報錯出現,咱們就須要在路由回調裏對錯誤的狀況進行捕獲。

//單個文件上傳
let singleUpload = upload.single('singleFile');
app.post('/upload/single',(req,res)=>{
    singleUpload(req,res,(err)=>{
        if(!!err){
            console.log(err.message)
            res.json({
                code: '2000',
                type:'single',
                originalname: '',
                msg: err.message
            })
            return;
        }
        if(!!req.file){
            res.json({
                code: '0000',
                type:'single',
                originalname: req.file.originalname,
                msg: ''
            })
        } else {
            res.json({
                code: '1000',
                type:'single',
                originalname: '',
                msg: ''
            })
        }
    });
});

//多個文件上傳
let multerUpload = upload.array('multerFile');
app.post('/upload/multer', (req,res)=>{
    multerUpload(req,res,(err)=>{
        if(!!err){
            res.json({
                code: '2000',
                type:'multer',
                fileList:[],
                msg: err.message
            });
        }
        let fileList = [];
        req.files.map((elem)=>{
            fileList.push({
                originalname: elem.originalname
            })
        });
        res.json({
            code: '0000',
            type:'multer',
            fileList:fileList,
            msg:''
        });
    });
});複製代碼

  全部的demo代碼都在這個倉庫裏。若是以爲寫得還不錯,請關注個人掘金主頁。更多文章請訪問個人博客地址

相關文章
相關標籤/搜索