请求参数校验

1.前言

本小节主要介绍如何使用 ThinkPHP 提供的 Validate 验证器，它可以在控制器接收参数之前验证参数，若参数不合符业务要求，就会返回相应的错误提示，在实际工作中，数据校验的是一项必不可少的工作，数据的严格校验可能减少很多不必要的代码执行，这从某种层面来说减少了服务器压力，从安全角度来说，数据校验能避免某些不必要的 BUG，比如对手机号码的校验，能有效地阻止后期发送短信失败导致的 BUG能有效地防止 XSS、SQL注入等攻击。

2.新建验证器类

这里以之前添加学生接口为例，该接口入参需要 学生姓名(name)、年龄(age)、身份证号(id_number)，首先新建一个 app\Validate 目录，然后在该目录下新建一个 StudentValidate 类，代码如下：

<?php

namespace app\Validate;


use think\Validate;

class StudentValidate extends Validate
{

}

如下图所示：

3.设置字段验证规则

字段的验证规则可以在 protected $rule 中设置如下规则：

    /**
     * 设置字段验证规则
     * @var string[]
     */
    protected $rule = [
        'name' => 'require|max:5',
        'age' => 'number|between:1,120',
        'id_number' => 'require|in:18',
    ];

如下图所示：

4.设置不满足规则的提示语

若想要设置不满足验证规则字段的错误提示语，可在 protected $message 中设置如下内容：

    /**
     * 设置不满足字段要求的提示语
     * @var string[]
     */
    protected $message = [
        'name.require' => '学生姓名不能为空',
        'name.max' => '学生姓名长度不能超过5',
        'age.number' => '学生年龄必须是数字',
        'age.between' => '学生年龄值必须是1-120之间',
        'id_number.require' => '学生身份证号不能为空',
        'id_number.in' => '学生身份证号必须是18位'
    ];

如下图所示：

5.设置验证场景

若想要在不同场景下验证不同的字段，可在 protected $scene 总设置如下内容：

    /**
     * 设置验证场景
     * @var string[][]
     */
    protected $scene = [
        'add-student' => ['name', 'age', 'id_number'],
        'edit-student' => ['name', 'age']
    ];

如下图所示：

6.在控制器中调用验证器

可以在学生添加接口的控制器中增加如下内容：

validate(StudentValidate::class)->scene('add-student')->check($this->request->param());

如下图所示：

Tips： 其中 validate() 是一个框架提供的一个辅助函数，scene('add-student') 表示验证场景是 add-student，$this->request->param() 表示接口传入的参数。

7.请求接口验证

在 postman 中请求上述接口，如下图是缺少学生 name 字段提示的错误：

学生 name 字段超过长度提示如下：

8.内置验证规则表

下面列出 ThinkPHP 提供的内置验证规则：

9.小结

本小节主要介绍如何使用 ThinkPHP 提供的 Validate 验证器，它可以帮助快速有效地验证请求数据的有效性和正确性，另外还列举了不同场景下内置的字段验证规则，需要注意的是上面学生身份证号码的验证可以使用 isCard。

Tips： 代码仓库：https://gitee.com/love-for-poetry/tp6