使用express-validator對你的Express應用的用戶數據進行驗證

開發(fā)web應用時,我們總是需要對用戶的數據進行驗證,這包括客戶端的驗證以及服務端的驗證党远,僅僅依靠客戶端的驗證是不可靠的,畢竟我們不能把所有的用戶都當成是普通用戶富弦,繞過客戶端的驗證對于部分用戶來說并不是什么難事沟娱,因此所有數據應該在服務端也進行一次驗證。Express應用可以通過express-validator進行數據驗證腕柜,這樣就不必自己煩瑣的為每一個數據單獨寫驗證程序(過來人告訴你這感覺簡直糟透了)济似。

通過一個簡單的例子讓我們來看看express-validator的便捷矫废,讓用戶上傳一些數據,表單如下:


最簡單的服務端代碼如下:

var express = require('express');
var bodyParser = require('body-parser');
var expressValidator = require('express-validator');
var check = require('express-validator/check').check;
var validationResult = require('express-validator/check').validationResult;
var app = express();

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({extended:false}));

app.get('/', function(req, res) {
   res.sendFile('index.html', {root:'./test'});
});

app.post('/data', [
    check('email')
        .isEmail()
        .withMessage('must be an email'),
    check('username')
        .isLength({min:6})
        .withMessage('ust be at least 6 chars long')
],function(req, res) {
    var errors = validationResult(req);
    if(!errors.isEmpty()) {
        return res.json({errors: errors.mapped()});
    }
    res.json({msg:'success'});
});

app.listen(4000);

當用戶上傳數據之后會在服務端對用戶的用戶名和郵箱進行驗證砰蠢,當數據不符合時蓖扑,錯誤信息顯示如下:


image.png

從上面的例子中可以看到對數據的驗證錯誤可以隨時獲取,從而進行處理台舱。
validationResult方法獲取捕獲的錯誤律杠,mapped()方法獲取具體的錯誤信息。

express-validator是基于validator.js的竞惋,express-validator也類似將API分為check和filter兩個部分(關于validator.js的使用可以參考使用validator.js對字符串數據進行驗證

check部分

check(field[, message])

field是一個字符串或者是一個數組柜去,message是驗證不通過的錯誤信息,返回驗證鏈(鏈式調用)

check方法默認會驗證req.body拆宛、req.cookies嗓奢、req.headers、req.params浑厚、req.query中的字段股耽,如果有相同字段,其中一個不通過就會顯示錯誤信息瞻颂。

如將以上例子的post地址新增一個名為email的query則錯誤信息如下:



注意location的值豺谈。

如果需要單獨驗證req.body、req.cookies贡这、req.headers茬末、req.params、req.query的其中一個目標的字段盖矫,則可以使用對應的方法body丽惭、cookieheader辈双、param责掏、querybody湃望、

oneOf(validationChains[, message])

validationChains是驗證鏈組成的數組换衬,如果驗證鏈至少有一條通過則不顯示錯誤。

var express = require('express');
var bodyParser = require('body-parser');
var expressValidator = require('express-validator');
var check = require('express-validator/check').check;
var oneOf = require('express-validator/check').oneOf;
var validationResult = require('express-validator/check').validationResult;
var app = express();

app.use(bodyParser.json());
app.use(bodyParser.urlencoded({extended:false}));

app.get('/', function(req, res) {
   res.sendFile('index.html', {root:'./test'});
});

app.post('/data', oneOf([
    check('email')
        .isEmail()
        .withMessage('must be an email'),
    check('username')
        .isLength({min:6})
        .withMessage('ust be at least 6 chars long')
]),function(req, res) {
    var errors = validationResult(req);
    if(!errors.isEmpty()) {
        return res.json({errors: errors.mapped()});
    }
    res.json({msg:'success'});
});

app.listen(4000);

validationResult(req)

獲取驗證的結果是否通過

buildCheckFunction(locations)

從指定的locaation中構建check证芭,locations是body瞳浦、cookies、headers废士、params叫潦、query一個或者幾個組成的數組,相當于指定位置的字段進行驗證(請不要忘記check方法會對這5個部分都進行驗證)

var buildCheckFunction = require('express-validator/check').buildCheckFunction;
var checkBodyAndQuery = buildCheckFunction(['body','query']);

filter部分

matchedData(req[, options])

獲取check的字段數據官硝,也就是獲取上文例子出現的錯誤信息中的value字段值矗蕊,options為一個json對象短蜕,允許的字段為

{
    onlyValidData:true,
    locations:[]
}

onlyValidData顯然就是是否僅僅獲取驗證的字段值,默認為true傻咖,locations就是指定位置朋魔。

app.post('/data', [
    check('email')
        .isEmail()
        .withMessage('must be an email'),
    check('username')
        .isLength({min:6})
        .withMessage('ust be at least 6 chars long')
],function(req, res) {
    var queryData = matchedData(req, {locations: ['query']});
    var bodyData = matchedData(req, {locations: ['body']});
    console.log(queryData);
    console.log(bodyData);
    var errors = validationResult(req);
    if(!errors.isEmpty()) {
        return res.json({errors: errors.mapped()});
    }
    res.json({msg:'success'});
});

sanitize(fields)

類似于check,只不過是返回一個處理鏈没龙,理所當然有類似的sanitizeBody铺厨、sanitizeCookie缎玫、sanitizeParam硬纤、sanitizeQuerybuildSanitizeFunction赃磨。(注意req.headers在這里不適用)

customSanitizer(sanitizer)

進行自定義處理程序

除此之外筝家,express-validator保留了版本3的作為express中間件的使用方式。

var express = require('express');
var expressValidator = require('express-validator');

app.use(expressValidator({
    errorFormatter: function(param, message, value) {
        return {
            param: param,
            message: message,
            value: value
        }
    },
    customValidators: {
        isEmail: function(value) {
            return /\w+([-+.]\w+)*@\w+([-.]\w+)*\.\w+([-.]\w+)*/.test(value);
        },
        isString: function(value) {
            return typeof value === 'string';
        },
        isObject: function(value) {
            return (typeof value === 'object' && !Array.isArray(value));
        },
        isArray: function(value){
            return Array.isArray(value);
        },
        isBoolean: function(value) {
            return value === true || value === false;
        },
        custom: function(value, callback) {
            if(typeof value !== 'undefined') {
                callback(value);
                return true;
            } else {
                return false;
            }
        }
    }
}));

可以在使用use加載中間件的時候自定義第三方驗證方法和處理方法邻辉。

驗證數據時的使用方式如下:

req.checkBody('email', '郵件格式不正確').isEmail();
req.checkBody('password', '密碼不能小于6位').isLength(6);
最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
  • 序言:七十年代末溪王,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子值骇,更是在濱河造成了極大的恐慌莹菱,老刑警劉巖,帶你破解...
    沈念sama閱讀 218,546評論 6 507
  • 序言:濱河連續(xù)發(fā)生了三起死亡事件吱瘩,死亡現場離奇詭異道伟,居然都是意外死亡,警方通過查閱死者的電腦和手機使碾,發(fā)現死者居然都...
    沈念sama閱讀 93,224評論 3 395
  • 文/潘曉璐 我一進店門蜜徽,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人票摇,你說我怎么就攤上這事拘鞋。” “怎么了矢门?”我有些...
    開封第一講書人閱讀 164,911評論 0 354
  • 文/不壞的土叔 我叫張陵盆色,是天一觀的道長。 經常有香客問我祟剔,道長隔躲,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 58,737評論 1 294
  • 正文 為了忘掉前任峡扩,我火速辦了婚禮蹭越,結果婚禮上,老公的妹妹穿的比我還像新娘教届。我一直安慰自己响鹃,他們只是感情好驾霜,可當我...
    茶點故事閱讀 67,753評論 6 392
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著买置,像睡著了一般粪糙。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發(fā)上忿项,一...
    開封第一講書人閱讀 51,598評論 1 305
  • 那天蓉冈,我揣著相機與錄音,去河邊找鬼轩触。 笑死寞酿,一個胖子當著我的面吹牛,可吹牛的內容都是我干的脱柱。 我是一名探鬼主播伐弹,決...
    沈念sama閱讀 40,338評論 3 418
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼榨为!你這毒婦竟也來了惨好?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 39,249評論 0 276
  • 序言:老撾萬榮一對情侶失蹤随闺,失蹤者是張志新(化名)和其女友劉穎日川,沒想到半個月后,有當地人在樹林里發(fā)現了一具尸體矩乐,經...
    沈念sama閱讀 45,696評論 1 314
  • 正文 獨居荒郊野嶺守林人離奇死亡龄句,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 37,888評論 3 336
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發(fā)現自己被綠了绰精。 大學時的朋友給我發(fā)了我未婚夫和他白月光在一起吃飯的照片撒璧。...
    茶點故事閱讀 40,013評論 1 348
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖笨使,靈堂內的尸體忽然破棺而出卿樱,到底是詐尸還是另有隱情,我是刑警寧澤硫椰,帶...
    沈念sama閱讀 35,731評論 5 346
  • 正文 年R本政府宣布繁调,位于F島的核電站,受9級特大地震影響靶草,放射性物質發(fā)生泄漏蹄胰。R本人自食惡果不足惜,卻給世界環(huán)境...
    茶點故事閱讀 41,348評論 3 330
  • 文/蒙蒙 一奕翔、第九天 我趴在偏房一處隱蔽的房頂上張望裕寨。 院中可真熱鬧,春花似錦、人聲如沸宾袜。這莊子的主人今日做“春日...
    開封第一講書人閱讀 31,929評論 0 22
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽庆猫。三九已至认轨,卻和暖如春,著一層夾襖步出監(jiān)牢的瞬間月培,已是汗流浹背嘁字。 一陣腳步聲響...
    開封第一講書人閱讀 33,048評論 1 270
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留杉畜,地道東北人纪蜒。 一個月前我還...
    沈念sama閱讀 48,203評論 3 370
  • 正文 我出身青樓,卻偏偏與公主長得像寻行,于是被迫代替她去往敵國和親霍掺。 傳聞我的和親對象是個殘疾皇子匾荆,可洞房花燭夜當晚...
    茶點故事閱讀 44,960評論 2 355

推薦閱讀更多精彩內容