欢迎您访问程序员文章站本站旨在为大家提供分享程序员计算机编程知识!
您现在的位置是: 首页  >  IT编程

yii2 在控制器中验证请求参数的使用方法

程序员文章站 2022-05-25 21:45:45
写api接口时一般会在控制器中简单验证参数的正确性。 使用yii只带验证器(因为比较熟悉)实现有两种方式(效果都不佳)。 针对每个请求单独写个 model ,...

写api接口时一般会在控制器中简单验证参数的正确性。

使用yii只带验证器(因为比较熟悉)实现有两种方式(效果都不佳)。

针对每个请求单独写个 model , 定义验证规则并进行验证。 缺点:写好多参数验证的 model 类。

使用  中提到的 $validator->validatevalue() 方法直接验证变量值。缺点:写实例化很多验证器对象。
有么有“一劳永逸”的做法,像在 model 中通过 rules 方法定义验证规则并实现快速验证的呢?有!

使用方法(实现效果)

namespace frontend\controllers\api;
use yii\web\controller;
use common\services\app\paramsvalidateservice;
class articlecontroller extends controller
{
  // 文章列表
  public function actionlist()
  {
    $pvs = new paramsvalidateservice();
    $valid = $pvs->validate(\yii::$app->request->get(), [
      ['category_id', 'required'],
      ['category_id', 'integer'],
      ['keyword', 'string'],
    ]);
    if (!$valid) {
      $this->apierror(1001, $pvs->geterrorsummary(true));
    }
    //...
  }
  // 新增文章
  public function actionpost()
  {
    $pvs = new paramsvalidateservice();
    $valid = $pvs->validate(\yii::$app->request->get(), [
      [['category_id', 'title', 'content'], 'required'],
      ['category_id', 'integer'],
      [['title'], 'string', 'max' => 64],
      [['content'], 'string'],
    ]);
    if (!$valid) {
      $this->apierror(1001, $pvs->geterrorsummary(true));
    }
    //...
  }
  // 文章删除
  public function actiondelete()
  {
    $pvs = new paramsvalidateservice();
    $valid = $pvs->validate(\yii::$app->request->get(), [
      ['article_id', 'required'],
      ['article_id', 'integer'],
    ]);
    if (!$valid) {
      $this->apierror(1001, $pvs->geterrorsummary(true));
    }
    //...
  }
}

实现方法

定义参数验证模型

定义参数验证模型 paramsvalidatemodel ,继承 yii\db\activerecord ,重写 attributes() 方法,主要功能:

  • 验证规则可从对象外部进行设置。
  • 从验证规则中获取可赋值的属性。
<?php
namespace common\models\app;
use yii\db\activerecord;
class paramsvalidatemodel extends activerecord
{
  /**
   * @var array 验证规则
   */
  private $_rules = [];
  private $_attributes = [];
  // 设置验证规则
  public function setrules($rules)
  {
    $this->_rules = $rules;
    foreach ($rules as $item) {
      $this->_attributes = array_unique(array_merge($this->_attributes, (array)$item[0]));
    }
  }
  // 重写获取验证规则
  public function rules()
  {
    return $this->_rules;
  }
  // 设置可用属性列表
  public function attributes()
  {
    return $this->_attributes;
  }
}

定义参数验证服务类

定义参数验证服务类,主要功能有:

  • 设置参数列表和参数规则列表。
  • 使用 参数验证模型 进行验证和存储验证错误消息。
  • 使用魔术方法获取 参数验证模型 中的验证错误消息。
<?php
namespace common\services\app;
use common\models\app\paramsvalidatemodel;
use yii\base\component;
/**
 * class paramsvalidateservice
 * @package common\services\app
 * @method array geterrors(\string $attribute)
 * @method array getfirsterrors()
 * @method array getfirsterror(\string $attribute)
 * @method array geterrorsummary(\boolean $showallerrors)
 */
class paramsvalidateservice extends component
{
  /**
   * @var paramsvalidatemodel 模型
   */
  private $model = null;
  public function init()
  {
    parent::init();
    $this->model = new paramsvalidatemodel();
  }
  /**
   * @param array $data 数据项
   * @param array $rules 验证规则
   * @return bool
   */
  public function validate($data, $rules)
  {
    // 添加验证规则
    $this->model->setrules($rules);
    // 设置参数
    $this->model->load($data, '');
    // 进行验证
    return $this->model->validate();
  }
  public function __call($name, $params)
  {
    if ($this->model->hasmethod($name)) {
      return call_user_func_array([$this->model, $name], $params);
    } else {
      return parent::__call($name, $params);
    }
  }
}

总结

以上所述是小编给大家介绍的yii2 在控制器中验证请求参数的使用方法,希望对大家有所帮助