Validate

EasySwoole 提供了自带基础的验证类，默认在控制器中带有一个validate方法，如果希望用其他的方法或者是工具去做检验，可以在子类控制器中重写该方法，从而实现用其他工具进行校验

::: warning 验证器类: EasySwoole\Validate\Validate :::

基础使用

  1. <?php
  2. use EasySwoole\Validate\Validate;
  4. $data = [
  5.     'name' => 'blank',
  6.     'age'  => 25
  7. ];
  9. $valitor = new Validate();
  10. $valitor->addColumn('name', '名字不为空')->required('名字不为空')->lengthMin(10,'最小长度不小于10位');
  11. $bool = $valitor->validate($data);
  12. var_dump($bool?"true":$valitor->getError()->__toString());
  14. /* 结果：
  15.  string(26) "最小长度不小于10位"
  16. */

控制器中封装使用

  1. namespace App\HttpController;
  2. use EasySwoole\Http\Message\Status;
  3. use EasySwoole\Validate\Validate;
  4. use EasySwoole\Http\AbstractInterface\Controller;
  6. class BaseController extends Controller
  7. {
  9.     protected function onRequest(?string $action): ?bool
  10.     {
  11.         $ret =  parent::onRequest($action);
  12.         if($ret === false){
  13.             return false;
  14.         }
  15.         $v = $this->validateRule($action);
  16.         if($v){
  17.             $ret = $this->validate($v);
  18.             if($ret == false){
  19.                 $this->writeJson(Status::CODE_BAD_REQUEST,null,"{$v->getError()->getField()}@{$v->getError()->getFieldAlias()}:{$v->getError()->getErrorRuleMsg()}");
  20.                 return false;
  21.             }
  22.         }   
  23.         return true;
  24.     }
  26.     protected function validateRule(?string $action):?Validate
  27.     {
  29.     }
  30. }

::: warning 我们定义了一个带有validateRule方法的基础控制器。 :::

  1. namespace App\HttpController;
  4. use App\HttpController\Api\BaseController;
  5. use EasySwoole\Validate\Validate;
  7. class Common extends BaseController
  8. {
  10.     function sms()
  11.     {
  12.         $phone = $this->request()->getRequestParam('phone');
  14.     }
  16.     protected function validateRule(?string $action): ?Validate
  17.     {
  18.         $v = new Validate();
  19.         switch ($action){
  20.             case 'sms':{
  21.                 $v->addColumn('phone','手机号')->required('不能为空')->length(11,'长度错误');
  22.                 $v->addColumn('verifyCode','验证码')->required('不能为空')->length(4,'长度错误');
  23.                 break;
  24.             }
  25.         }
  26.         return $v;
  27.     }
  28. }

::: warning 在需要验证的控制器方法中，我们给对应的action添加对应的校验规则，即可实现自动校验，这样控制器方法即可安心实现逻辑。 :::

方法列表

获取Error：

  1. function getError():?EasySwoole\Validate\Error

给字段添加规则：

1.1.9版本到目前

  • string name 字段key
  • string alias 别名
  • string reset 重置规则
  1. public function addColumn(string $name, ?string $alias = null,bool $reset = false):EasySwoole\Validate\Rule

1.1.0版本到1.1.8版本

  • string name 字段key
  • string alias 别名
  1. public function addColumn(string $name, ?string $alias = null):EasySwoole\Validate\Rule

1.0.1版本

  • string name 字段key
  • string errorMsg 错误信息
  • string alias 别名
  1. public function addColumn(string $name,?string $errorMsg = null,?string $alias = null):EasySwoole\Validate\Rule

1.0.0版本

  • string name 字段key
  • string alias 别名
  • string errorMsg 错误信息
  1. public function addColumn(string $name,?string $alias = null,?string $errorMsg = null):EasySwoole\Validate\Rule

返回一个Rule对象可以添加自定义规则。

数据验证：

  • array data 数据
  1. function validate(array $data)

验证规则类

目前验证器支持的规则如下

  1. namespace EasySwoole\Validate;
  3. /**
  4.  * 校验规则
  5.  * 请以首字母排序校验方法以便后期维护
  6.  * Class Rule
  7.  * @package EasySwoole\Validate
  8.  */
  9. class Rule
  10. {
  11.     protected $ruleMap = [];
  13.     function getRuleMap(): array
  14.     {
  15.         return $this->ruleMap;
  16.     }
  18.     /**
  19.      * 给定的URL是否可以成功通讯
  20.      * @param null|string $msg
  21.      * @return $this
  22.      */
  23.     function activeUrl($msg = null)
  24.     {
  25.         $this->ruleMap['activeUrl'] = [
  26.             'arg' => null,
  27.             'msg' => $msg
  28.         ];
  29.         return $this;
  30.     }
  32.     /**
  33.      * 给定的参数是否是字母 即[a-zA-Z]
  34.      * @param null|string $msg
  35.      * @return $this
  36.      */
  37.     function alpha($msg = null)
  38.     {
  39.         $this->ruleMap['alpha'] = [
  40.             'arg' => null,
  41.             'msg' => $msg
  42.         ];
  43.         return $this;
  44.     }
  46.     function alphaNum($msg = null)
  47.     {
  48.         $this->ruleMap['alphaNum'] = [
  49.             'arg' => null,
  50.             'msg' => $msg
  51.         ];
  52.         return $this;
  53.     }
  55.     function alphaDash($msg = null)
  56.     {
  57.         $this->ruleMap['alphaDash'] = [
  58.             'arg' => null,
  59.             'msg' => $msg
  60.         ];
  61.         return $this;
  62.     }
  64.     /**
  65.      * 给定的参数是否在 $min $max 之间
  66.      * @param integer $min 最小值 不包含该值
  67.      * @param integer $max 最大值 不包含该值
  68.      * @param null|string $msg
  69.      * @return $this
  70.      */
  71.     function between($min, $max, $msg = null)
  72.     {
  73.         $this->ruleMap['between'] = [
  74.             'msg' => $msg,
  75.             'arg' => [
  76.                 $min, $max
  77.             ]
  78.         ];
  79.         return $this;
  80.     }
  82.     /**
  83.      * 给定参数是否为布尔值
  84.      * @param null|string $msg
  85.      * @return $this
  86.      */
  87.     function bool($msg = null)
  88.     {
  89.         $this->ruleMap['bool'] = [
  90.             'msg' => $msg,
  91.             'arg' => null
  92.         ];
  93.         return $this;
  94.     }
  96.     /**
  97.      * 给定参数是否为小数格式
  98.      * @param null|integer $precision 规定小数点位数 null 为不规定
  99.      * @param null $msg
  100.      * @return $this
  101.      */
  102.     function decimal(?int $precision = null, $msg = null)
  103.     {
  104.         $this->ruleMap['decimal'] = [
  105.             'msg' => $msg,
  106.             'arg' => $precision
  107.         ];
  108.         return $this;
  109.     }
  111.     /**
  112.      * 给定参数是否在某日期之前
  113.      * @param null|string $date
  114.      * @param null|string $msg
  115.      * @return $this
  116.      */
  117.     function dateBefore(?string $date = null, $msg = null)
  118.     {
  119.         $this->ruleMap['dateBefore'] = [
  120.             'msg' => $msg,
  121.             'arg' => $date
  122.         ];
  123.         return $this;
  124.     }
  126.     /**
  127.      * 给定参数是否在某日期之后
  128.      * @param null|string $date
  129.      * @param null|string $msg
  130.      * @return $this
  131.      */
  132.     function dateAfter(?string $date = null, $msg = null)
  133.     {
  134.         $this->ruleMap['dateAfter'] = [
  135.             'msg' => $msg,
  136.             'arg' => $date
  137.         ];
  138.         return $this;
  139.     }
  141.     /**
  142.      * 验证值是否相等
  143.      * @param $compare
  144.      * @param null|string $msg
  145.      * @return $this
  146.      */
  147.     function equal($compare, $msg = null)
  148.     {
  149.         $this->ruleMap['equal'] = [
  150.             'msg' => $msg,
  151.             'arg' => $compare
  152.         ];
  153.         return $this;
  154.     }
  156.     /**
  157.      * 验证值是否一个浮点数
  158.      * @param null|string $msg
  159.      * @return $this
  160.      */
  161.     function float($msg = null)
  162.     {
  163.         $this->ruleMap['float'] = [
  164.             'arg' => null,
  165.             'msg' => $msg
  166.         ];
  167.         return $this;
  168.     }
  170.     /**
  171.      * 调用自定义的闭包验证
  172.      * @param callable $func
  173.      * @param null|string $msg
  174.      * @return $this
  175.      */
  176.     function func(callable $func, $msg = null)
  177.     {
  178.         $this->ruleMap['func'] = [
  179.             'arg' => $func,
  180.             'msg' => $msg
  181.         ];
  182.         return $this;
  183.     }
  185.     /**
  186.      * 值是否在数组中
  187.      * @param array $array
  188.      * @param bool $isStrict
  189.      * @param null|string $msg
  190.      * @return $this
  191.      */
  192.     function inArray(array $array, $isStrict = false, $msg = null)
  193.     {
  194.         $this->ruleMap['inArray'] = [
  195.             'arg' => [ $array, $isStrict ],
  196.             'msg' => $msg
  197.         ];
  198.         return $this;
  199.     }
  201.     /**
  202.      * 是否一个整数值
  203.      * @param null|string $msg
  204.      * @return $this
  205.      */
  206.     function integer($msg = null)
  207.     {
  208.         $this->ruleMap['integer'] = [
  209.             'arg' => null,
  210.             'msg' => $msg
  211.         ];
  212.         return $this;
  213.     }
  215.     /**
  216.      * 是否一个有效的IP
  217.      * @param array $array
  218.      * @param null $msg
  219.      * @return $this
  220.      */
  221.     function isIp($msg = null)
  222.     {
  223.         $this->ruleMap['isIp'] = [
  224.             'arg' => null,
  225.             'msg' => $msg
  226.         ];
  227.         return $this;
  228.     }
  230.     /**
  231.      * 是否不为空
  232.      * @param null $msg
  233.      * @return $this
  234.      */
  235.     function notEmpty($msg = null)
  236.     {
  237.         $this->ruleMap['notEmpty'] = [
  238.             'arg' => null,
  239.             'msg' => $msg
  240.         ];
  241.         return $this;
  242.     }
  244.     /**
  245.      * 是否一个数字值
  246.      * @param null $msg
  247.      * @return $this
  248.      */
  249.     function numeric($msg = null)
  250.     {
  251.         $this->ruleMap['numeric'] = [
  252.             'arg' => null,
  253.             'msg' => $msg
  254.         ];
  255.         return $this;
  256.     }
  258.     /**
  259.      * 不在数组中
  260.      * @param array $array
  261.      * @param bool $isStrict
  262.      * @param null $msg
  263.      * @return $this
  264.      */
  265.     function notInArray(array $array, $isStrict = false, $msg = null)
  266.     {
  267.         $this->ruleMap['notInArray'] = [
  268.             'arg' => [ $array, $isStrict ],
  269.             'msg' => $msg
  270.         ];
  271.         return $this;
  272.     }
  274.     /**
  275.      * 验证数组或字符串的长度
  276.      * @param int $len
  277.      * @param null $msg
  278.      * @return $this
  279.      */
  280.     function length(int $len, $msg = null)
  281.     {
  282.         $this->ruleMap['length'] = [
  283.             'msg' => $msg,
  284.             'arg' => $len
  285.         ];
  286.         return $this;
  287.     }
  289.     /**
  290.      * 验证数组或字符串的长度是否超出
  291.      * @param int $lengthMax
  292.      * @param null $msg
  293.      * @return $this
  294.      */
  295.     function lengthMax(int $lengthMax, $msg = null)
  296.     {
  297.         $this->ruleMap['lengthMax'] = [
  298.             'msg' => $msg,
  299.             'arg' => $lengthMax
  300.         ];
  301.         return $this;
  302.     }
  304.     /**
  305.      * 验证数组或字符串的长度是否达到
  306.      * @param int $lengthMin
  307.      * @param null $msg
  308.      * @return $this
  309.      */
  310.     function lengthMin(int $lengthMin, $msg = null)
  311.     {
  312.         $this->ruleMap['lengthMin'] = [
  313.             'msg' => $msg,
  314.             'arg' => $lengthMin
  315.         ];
  316.         return $this;
  317.     }
  319.     /**
  320.      * 验证数组或字符串的长度是否在一个范围内
  321.      * @param null $msg
  322.      * @return $this
  323.      */
  324.     function betweenLen(int $min, int $max, $msg = null)
  325.     {
  326.         $this->ruleMap['betweenLen'] = [
  327.             'msg' => $msg,
  328.             'arg' => [
  329.                 $min,
  330.                 $max
  331.             ]
  332.         ];
  333.         return $this;
  334.     }
  336.     /**
  337.      * 验证值不大于(相等视为不通过)
  338.      * @param int $max
  339.      * @param null|string $msg
  340.      * @return Rule
  341.      */
  342.     function max(int $max, ?string $msg = null): Rule
  343.     {
  344.         $this->ruleMap['max'] = [
  345.             'arg' => $max,
  346.             'msg' => $msg
  347.         ];
  348.         return $this;
  349.     }
  351.     /**
  352.      * 验证值不小于(相等视为不通过)
  353.      * @param int $min
  354.      * @param null|string $msg
  355.      * @return Rule
  356.      */
  357.     function min(int $min, ?string $msg = null): Rule
  358.     {
  359.         $this->ruleMap['min'] = [
  360.             'arg' => $min,
  361.             'msg' => $msg
  362.         ];
  363.         return $this;
  364.     }
  366.     /**
  367.      * 验证值是合法的金额
  368.      * 100 | 100.1 | 100.01
  369.      * @param integer|null $precision 小数点位数
  370.      * @param string|null  $msg
  371.      * @return Rule
  372.      */
  373.     function money(?int $precision = null, string $msg = null): Rule
  374.     {
  375.         $this->ruleMap['money'] = [
  376.             'arg' => $precision,
  377.             'msg' => $msg
  378.         ];
  379.         return $this;
  380.     }
  382.     /**
  383.      * 设置值为可选参数
  384.      * @return $this
  385.      */
  386.     function optional()
  387.     {
  388.         $this->ruleMap['optional'] = [
  389.             'arg' => null,
  390.             'msg' => null
  391.         ];
  392.         return $this;
  393.     }
  395.     /**
  396.      * 正则表达式验证
  397.      * @param $reg
  398.      * @param null $msg
  399.      * @return $this
  400.      */
  401.     function regex($reg, $msg = null)
  402.     {
  403.         $this->ruleMap['regex'] = [
  404.             'arg' => $reg,
  405.             'msg' => $msg
  406.         ];
  407.         return $this;
  408.     }
  410.     /**
  411.      * 必须存在值
  412.      * @param null $msg
  413.      * @return $this
  414.      */
  415.     function required($msg = null)
  416.     {
  417.         $this->ruleMap['required'] = [
  418.             'arg' => null,
  419.             'msg' => $msg
  420.         ];
  421.         return $this;
  422.     }
  424.     /**
  425.      * 值是一个合法的时间戳
  426.      * @param null $msg
  427.      * @return $this
  428.      */
  429.     function timestamp($msg = null)
  430.     {
  431.         $this->ruleMap['timestamp'] = [
  432.             'arg' => null,
  433.             'msg' => $msg
  434.         ];
  435.         return $this;
  436.     }
  438.     /**
  439.      * 时间戳在某指定日期之前
  440.      * @param string $date 传入任意可被strtotime解析的字符串
  441.      * @param null $msg
  442.      * @return $this
  443.      */
  444.     function timestampBeforeDate($date, $msg = null)
  445.     {
  446.         $this->ruleMap['timestampBeforeDate'] = [
  447.             'arg' => $date,
  448.             'msg' => $msg
  449.         ];
  450.         return $this;
  451.     }
  453.     /**
  454.      * 时间戳在某指定日期之后
  455.      * @param string $date 传入任意可被strtotime解析的字符串
  456.      * @param null $msg
  457.      * @return $this
  458.      */
  459.     function timestampAfterDate($date, $msg = null)
  460.     {
  461.         $this->ruleMap['timestampAfterDate'] = [
  462.             'arg' => $date,
  463.             'msg' => $msg
  464.         ];
  465.         return $this;
  466.     }
  468.     /**
  469.      * 指定时间戳在某时间戳之前
  470.      * @param string|integer $beforeTimestamp 在该时间戳之前
  471.      * @param null $msg
  472.      * @return $this
  473.      */
  474.     function timestampBefore($beforeTimestamp, $msg = null)
  475.     {
  476.         $this->ruleMap['timestampBefore'] = [
  477.             'arg' => $beforeTimestamp,
  478.             'msg' => $msg
  479.         ];
  480.         return $this;
  481.     }
  483.     /**
  484.      * 指定时间戳在某时间戳之后
  485.      * @param string|integer $afterTimestamp 在该时间戳之后
  486.      * @param null $msg
  487.      * @return $this
  488.      */
  489.     function timestampAfter($afterTimestamp, $msg = null)
  490.     {
  491.         $this->ruleMap['timestampAfter'] = [
  492.             'arg' => $afterTimestamp,
  493.             'msg' => $msg
  494.         ];
  495.         return $this;
  496.     }
  498.     /**
  499.      * 值是一个合法的链接
  500.      * @param null $msg
  501.      * @return $this
  502.      */
  503.     function url($msg = null)
  504.     {
  505.         $this->ruleMap['url'] = [
  506.             'arg' => null,
  507.             'msg' => $msg
  508.         ];
  509.         return $this;
  510.     }
  512.     /**
  513.      * 值是一个合法的链接
  514.      * @param null $msg
  515.      * @return $this
  516.      */
  517.     function allDigital($msg = null)
  518.     {
  519.         $this->ruleMap['allDigital'] = [
  520.             'arg' => null,
  521.             'msg' => $msg
  522.         ];
  523.         return $this;
  524.     }
  525. }