請求參數(shù)校驗

1.前言

本小節(jié)主要介紹如何使用 ThinkPHP 提供的 Validate 驗證器，它可以在控制器接收參數(shù)之前驗證參數(shù)，若參數(shù)不合符業(yè)務(wù)要求，就會返回相應(yīng)的錯誤提示，在實際工作中，數(shù)據(jù)校驗的是一項必不可少的工作，數(shù)據(jù)的嚴格校驗可能減少很多不必要的代碼執(zhí)行，這從某種層面來說減少了服務(wù)器壓力，從安全角度來說，數(shù)據(jù)校驗?zāi)鼙苊饽承┎槐匾?BUG，比如對手機號碼的校驗，能有效地阻止后期發(fā)送短信失敗導(dǎo)致的 BUG能有效地防止 XSS、SQL注入等攻擊。

2.新建驗證器類

這里以之前添加學(xué)生接口為例，該接口入?yún)⑿枰?學(xué)生姓名(name)、年齡(age)、身份證號(id_number)，首先新建一個 app\Validate 目錄，然后在該目錄下新建一個 StudentValidate 類，代碼如下：

<?php

namespace app\Validate;


use think\Validate;

class StudentValidate extends Validate
{

}

如下圖所示：

3.設(shè)置字段驗證規(guī)則

字段的驗證規(guī)則可以在 protected $rule 中設(shè)置如下規(guī)則：

    /**
     * 設(shè)置字段驗證規(guī)則
     * @var string[]
     */
    protected $rule = [
        'name' => 'require|max:5',
        'age' => 'number|between:1,120',
        'id_number' => 'require|in:18',
    ];

如下圖所示：

4.設(shè)置不滿足規(guī)則的提示語

若想要設(shè)置不滿足驗證規(guī)則字段的錯誤提示語，可在 protected $message 中設(shè)置如下內(nèi)容：

    /**
     * 設(shè)置不滿足字段要求的提示語
     * @var string[]
     */
    protected $message = [
        'name.require' => '學(xué)生姓名不能為空',
        'name.max' => '學(xué)生姓名長度不能超過5',
        'age.number' => '學(xué)生年齡必須是數(shù)字',
        'age.between' => '學(xué)生年齡值必須是1-120之間',
        'id_number.require' => '學(xué)生身份證號不能為空',
        'id_number.in' => '學(xué)生身份證號必須是18位'
    ];

如下圖所示：

5.設(shè)置驗證場景

若想要在不同場景下驗證不同的字段，可在 protected $scene 總設(shè)置如下內(nèi)容：

    /**
     * 設(shè)置驗證場景
     * @var string[][]
     */
    protected $scene = [
        'add-student' => ['name', 'age', 'id_number'],
        'edit-student' => ['name', 'age']
    ];

如下圖所示：

6.在控制器中調(diào)用驗證器

可以在學(xué)生添加接口的控制器中增加如下內(nèi)容：

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

如下圖所示：

Tips： 其中 validate() 是一個框架提供的一個輔助函數(shù)，scene('add-student') 表示驗證場景是 add-student，$this->request->param() 表示接口傳入的參數(shù)。

7.請求接口驗證

在 postman 中請求上述接口，如下圖是缺少學(xué)生 name 字段提示的錯誤：

學(xué)生 name 字段超過長度提示如下：

8.內(nèi)置驗證規(guī)則表

下面列出 ThinkPHP 提供的內(nèi)置驗證規(guī)則：

9.小結(jié)

本小節(jié)主要介紹如何使用 ThinkPHP 提供的 Validate 驗證器，它可以幫助快速有效地驗證請求數(shù)據(jù)的有效性和正確性，另外還列舉了不同場景下內(nèi)置的字段驗證規(guī)則，需要注意的是上面學(xué)生身份證號碼的驗證可以使用 isCard。

Tips： 代碼倉庫：https://gitee.com/love-for-poetry/tp6