深入理解express-validator中的Sanitization Chain API-CSDN博客

本文链接：https://blog.csdn.net/gitblog_00240/article/details/148488235

深入理解express-validator中的Sanitization Chain API

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

什么是Sanitization Chain

在express-validator项目中，Sanitization Chain（净化链）是一个强大的中间件工具，专门用于处理和净化传入的请求数据。它允许开发者通过链式调用多个净化器（sanitizer）来对输入数据进行一系列的处理和转换。

Sanitization Chain的核心特点包括：

它是一个中间件，应该传递给Express路由处理器
支持添加多个净化器，这些净化器会按照添加顺序依次执行
能够直接修改请求中的字段值

基本使用示例

让我们看一个简单的例子来理解它的工作方式：

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

在这个例子中，我们创建了一个净化链，对名为'trimMe'的请求体字段应用了trim()净化器，去除了字符串两端的空白字符。

标准净化器

express-validator内置了validator.js提供的所有净化方法，这些被称为"标准净化器"。常用的标准净化器包括：

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

这些净化器可以直接在链式调用中使用，例如：

body('username').trim().escape(),
body('age').toInt(),
body('email').normalizeEmail()

高级功能

除了标准净化器外，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)

自定义净化器接收两个参数：

要净化的字段值
包含请求对象、字段位置和路径的上下文对象

它必须同步返回处理后的新值。

手动执行净化链

.run()方法允许你以命令式的方式执行净化链：

app.post('/create-post', async (req, res, next) => {
  await check('content').escape().trim().run(req);
  // 净化后的内容将存储在req.body.content中
});

这在需要更灵活控制净化流程时特别有用。

转换为数组

.toArray()方法可以将任何值转换为数组：

app.post('/', [body('checkboxes').toArray()], (req, res, next) => {
  // 输入处理示例：
  // ['foo', 'bar]  => ['foo', 'bar']
  // 'foo'          => ['foo']
  // undefined      => []
  console.log(req.body.checkboxes);
});

这对于处理可能以多种形式提交的数组数据特别有用。