前往小程序,Get更优阅读体验!
立即前往
首页
学习
活动
专区
工具
TVP
发布
社区首页 >专栏 >使用express-validator对你的Express应用的用户数据进行验证

使用express-validator对你的Express应用的用户数据进行验证

作者头像
用户1515472
发布2019-07-24 14:29:36
2.7K0
发布2019-07-24 14:29:36
举报

开发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
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的其中一个目标的字段,则可以使用对应的方法bodycookieheaderparamquerybody

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,只不过是返回一个处理链,理所当然有类似的sanitizeBodysanitizeCookiesanitizeParamsanitizeQuerybuildSanitizeFunction。(注意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);
本文参与 腾讯云自媒体分享计划,分享自作者个人站点/博客。
如有侵权请联系 cloudcommunity@tencent.com 删除

本文分享自 作者个人站点/博客 前往查看

如有侵权,请联系 cloudcommunity@tencent.com 删除。

本文参与 腾讯云自媒体分享计划  ,欢迎热爱写作的你一起参与!

评论
登录后参与评论
0 条评论
热度
最新
推荐阅读
目录
  • check部分
    • check(field[, message])
      • oneOf(validationChains[, message])
        • validationResult(req)
          • buildCheckFunction(locations)
          • filter部分
            • matchedData(req[, options])
              • sanitize(fields)
                • customSanitizer(sanitizer)
                相关产品与服务
                消息队列 TDMQ
                消息队列 TDMQ (Tencent Distributed Message Queue)是腾讯基于 Apache Pulsar 自研的一个云原生消息中间件系列,其中包含兼容Pulsar、RabbitMQ、RocketMQ 等协议的消息队列子产品,得益于其底层计算与存储分离的架构,TDMQ 具备良好的弹性伸缩以及故障恢复能力。
                领券
                问题归档专栏文章快讯文章归档关键词归档开发者手册归档开发者手册 Section 归档