Node 在 Controller 层如何进行数据校验

时间 2020-08-30

标签 node controller 如何进行数据校验繁體版

原文原文链接

本文收录于 GitHub 山月行博客: shfshanyue/blog，内含我在实际工做中碰到的问题、关于业务的思考及在全栈方向上的学习javascript

前端工程化系列

Node进阶系列

幽默风趣的后端程序员通常自嘲为 CURD Boy。CURD, 也就是对某一存储资源的增删改查，这彻底是面向数据编程啊。php

真好呀，面向数据编程，每每会对业务理解地更加透彻，从而写出更高质量的代码，造出更少的 BUG。既然是面向数据编程那更须要避免脏数据的出现，增强数据校验。不然，难道要相信前端的数据校验吗，毕竟前端数据校验直达用户，是为了 UI 层更友好的用户反馈。html

数据校验层

后端因为重业务逻辑以及待处理各类数据，以至于分红各类各样的层级，以我经历过的后端项目就有分为 Controller、Service、Model、Helper、Entity 等各类命名的层，五花八门。但这里确定有一个层称为 Controller，站在后端最上层直接接收客户端传输数据。前端

因为 Controller 层是服务器端中与客户端数据交互的最顶层，秉承着 Fail Fast 的原则，肩负着数据过滤器的功能，对于不合法数据直接打回去，如同秦琼与尉迟恭门神般威严。java

数据校验同时衍生了一个半文档化的副产品，你只须要看一眼数据校验层，便知道要传哪些字段，都是些什么格式。node

如下都是常见的数据校验，本文讲述如何对它们进行校验：git

required/optional
基本的数据校验，如 number、string、timestamp 及值须要知足的条件
复杂的数据校验，如 IP、手机号、邮箱与域名

const body = {
  id,
  name,
  mobilePhone,
  email
}

山月接触过一个没有数据校验层的后端项目，if/else 充斥在各类层级，万分痛苦，分分钟向重构。程序员

JSON Schema

JSON Schema 基于 JSON 进行数据校验格式，并附有一份规范 json-schema.org，目前 (2020-08) 最新版本是 7.0。各类服务器编程语言都对规范进行了实现，如 go、java、php 等，固然伟大的 javascript 也有，如不温不火的 ajv。github

如下是校验用户信息的一个 Schema，可见语法复杂与繁琐:正则表达式

{
  "$schema": "http://json-schema.org/draft-04/schema#",
  "title": "User",
  "description": "用户信息",
  "type": "object",
  "properties": {
    "id": {
      "description": "用户 ID",
      "type": "integer"
    },
    "name": {
      "description": "用户姓名",
      "type": "string"
    },
    "email": {
      "description": "用户邮箱",
      "type": "string",
      "format": "email",
      "maxLength": 20
    },
    "mobilePhone": {
      "description": "用户手机号",
      "type": "string",
      "pattern": "^(?:(?:\+|00)86)?1[3-9]\d{9}$",
      "maxLength": 15
    }
  },
  "required": ["id", "name"]
}

对于复杂的数据类型校验，JSON Schema 内置了如下 Format，方便快捷校验

Dates and times
Email addresses
Hostnames
IP Addresses
Resource identifiers
URI template
JSON Pointer
Regular Expressions

对于不在内置 Format 中的手机号，使用 ajv.addFormat 可手动添加 Format

ajv.addFormat('mobilePhone', (str) => /^(?:(?:\+|00)86)?1[3-9]\d{9}$/.test(str));

Joi

joi 自称最强大的 JS 校验库，在 github 也斩获了一万六颗星星。相比 JSON Schema 而言，它的语法更加简洁而且功能强大。

The most powerful data validation library for JS

完成相同的校验，仅须要更少的代码，并可以完成更增强大的校验。如下仅作示例，更多示例请前往文档。

const schema = Joi.object({
  id: Joi.number().required(),
  name: Joi.number().required(),
  email: Joi.string().email({ minDomainSegments: 2, tlds: { allow: ['com', 'net'] } }),
  mobilePhone: Joi.string().pattern(/^(?:(?:\+|00)86)?1[3-9]\d{9}$/),

  password: Joi.string().pattern(/^[a-zA-Z0-9]{3,30}$/),
  // 与 password 相同的校验
  repeatPassword: Joi.ref('password'),
})
  // 密码与重复密码须要同时发送
  .with('password', 'repeat_password');
  // 邮箱与手机号提供一个便可
  .xor('email', 'mobilePhone')

数据校验与路由层集成

因为数据直接从路由传递，所以 koajs 官方基于 joi 实现了一个 joi-router，前置数据校验到路由层，对前端传递来的 query、body 与 params 进行校验。

joi-router 也同时基于 co-body 对前端传输的各类 content-type 进行解析及限制。如限制为 application/json，也可在必定程度上防止 CSRF 攻击。

const router = require('koa-joi-router');
const public = router();

public.route({
  method: 'post',
  path: '/signup',
  validate: {
    header: joiObject,
    query: joiObject,
    params: joiObject,
    body: joiObject,
    maxBody: '64kb',
    output: { '400-600': { body: joiObject } },
    type: 'json',
    failure: 400,
    continueOnError: false
  },
  pre: async (ctx, next) => {
    await checkAuth(ctx);
    return next();
  },
  handler: async (ctx) => {
    await createUser(ctx.request.body);
    ctx.status = 201;
  },
});

正则表达式与安全正则表达式

山月在一次排查性能问题时发现，一条 API 竟在数据校验层耗时太久，这是我不曾想到的。而问题根源在于不安全的正则表达式，那什么叫作不安全的正则表达式呢？

好比下边这个能把 CPU 跑挂的正则表达式就是一个定时炸弹，回溯次数进入了指数爆炸般的增加。

能够参考文章浅析 ReDos 原理与实践

const safe = require('safe-regex')
const re = /(x+x+)+y/

// 能跑死 CPU 的一个正则
re.test('xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxx')

// 使用 safe-regex 判断正则是否安全
safe(re)   // false

数据校验，针对的大可能是字符串校验，也会充斥着各类各样的正则表达式，保证正则表达式的安全至关紧要。safe-regex 可以发现哪些不安全的正则表达式。

总结

Controller 层须要进行统一的数据校验，能够采用 JSON Schema (Node 实现 ajv) 与 Joi
JSON Schema 有官方规范及各个语言的实现，但语法繁琐，可以使用校验功能更为强大的 Joi
进行字符串校验时，注意不安全的正则引发的性能问题