Express-Validator 6.4.0 消毒链(Sanitization Chain)API详解-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00424/article/details/148488057

Express-Validator 6.4.0 消毒链(Sanitization Chain)API详解

express-validator 项目地址: https://gitcode.com/gh_mirrors/exp/express-validator

在Web开发中，数据消毒(Sanitization)是确保应用程序安全的重要环节。Express-Validator提供了强大的消毒链API，帮助开发者轻松处理用户输入数据。本文将深入解析消毒链的工作原理和使用方法。

什么是消毒链？

消毒链是Express-Validator中的中间件机制，它允许开发者对请求数据应用一系列消毒操作。这些操作会按照添加顺序依次执行，修改原始数据字段的值。

const { body } = require('express-validator');
app.get('/', body('trimMe').trim(), (req, res, next) => {
  // 如果req.body.trimMe原本是"  something "
  // 消毒后的值将变为"something"
  console.log(req.body.trimMe);
});

标准消毒方法

Express-Validator内置了validator.js提供的所有标准消毒方法，包括但不限于：

trim()：去除字符串两端的空白字符
toInt()：将字符串转换为整数
toFloat()：将字符串转换为浮点数
normalizeEmail()：标准化电子邮件地址
escape()：转义HTML特殊字符

这些方法可以直接在消毒链上调用，为开发者提供了开箱即用的数据消毒能力。

自定义消毒方法

除了标准方法外，Express-Validator还允许开发者创建自定义消毒逻辑：

`.customSanitizer()`

这个方法允许你定义自己的消毒逻辑，非常适合处理特殊业务场景。

const { param } = require('express-validator');
app.get('/object/:id', param('id').customSanitizer((value, { req }) => {
  return req.query.type === 'user' ? ObjectId(value) : Number(value);
}), objectHandler)

参数说明：

value：当前字段的值
req：Express请求对象
location：字段位置(body, params等)
path：字段路径

注意事项：

自定义消毒器必须同步返回值
可以访问请求上下文，实现更复杂的逻辑

高级使用方法

`.run(req)`方法

.run()方法允许你以命令式的方式运行消毒链，这在某些特殊场景下非常有用。

const { check } = require('express-validator');
app.post('/create-post', async (req, res, next) => {
  // 消毒前：
  // req.body.content = ' hey your forum is amazing! <script>runEvilFunction();</script>    ';
  
  await check('content').escape().trim().run(req);

  // 消毒后：
  // req.body.content = 'hey your forum is amazing! &lt;script&gt;runEvilFunction();&lt;/script&gt;';
});

使用场景：

需要在路由处理函数中动态决定是否消毒
需要根据条件应用不同的消毒链

`.toArray()`方法

这个方法特别适合处理可能为数组或单个值的字段，确保最终得到的是数组形式。

app.post('/', [body('checkboxes').toArray()], (req, res, next) => {
  // ['foo', 'bar]  => ['foo', 'bar']
  // 'foo'          => ['foo']
  // undefined      => []
  console.log(req.body.checkboxes);
});

典型应用：