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

 更新时间:2019年06月19日 09:27:45   作者:liyiyang  
这篇文章主要介绍了yii2 在控制器中验证请求参数的使用方法,本文通过实例代码给大家介绍的非常详细,具有一定的参考借鉴价值,需要的朋友可以参考下

写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 在控制器中验证请求参数的使用方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对脚本之家网站的支持!
如果你觉得本文对你有帮助,欢迎转载,烦请注明出处,谢谢!

相关文章

  • php 字符串中的\n换行符无效、不能换行的解决方法

    php 字符串中的\n换行符无效、不能换行的解决方法

    这篇文章主要介绍了php 字符串中的换行符无效、不能换行的解决方法,实际上是PHP的双引号和单引号的使用问题,需要的朋友可以参考下
    2014-04-04
  • PHP用Session实现用户登陆功能

    PHP用Session实现用户登陆功能

    Session 是存储在服务器端的会话,相对安全,并且不像 Cookie 那样有存储长度限制。由于 Session 是以文本文件形式存储在服务器端的,所以不怕远程用户修改 Session 内容。这篇文章主要介绍了PHP用Session实现用户登陆功能,需要的朋友可以参考下
    2022-12-12
  • Laravel 微信小程序后端搭建步骤详解

    Laravel 微信小程序后端搭建步骤详解

    这篇文章主要介绍了Laravel 微信小程序后端搭建步骤详解,文中通过示例代码介绍的非常详细,对大家的学习或者工作具有一定的参考学习价值,需要的朋友们下面随着小编来一起学习学习吧
    2019-11-11
  • 浅析get与post的一些特殊情况

    浅析get与post的一些特殊情况

    这篇文章主要介绍了get与post的一些特殊情况,需要的朋友可以参考下
    2014-07-07
  • YII使用url组件美化管理的方法

    YII使用url组件美化管理的方法

    这篇文章主要介绍了YII使用url组件美化管理的方法,结合实例形式较为详细的分析了urlManager组件的具体功能及相关使用技巧,需要的朋友可以参考下
    2015-12-12
  • Zend Framework入门应用实例详解

    Zend Framework入门应用实例详解

    这篇文章主要介绍了Zend Framework入门应用,结合实例形式详细讲述了Zend Framework应用的创建步骤、相关命令、控制器及视图文件代码实现技巧,需要的朋友可以参考下
    2016-12-12
  • 以PHP代码为实例详解RabbitMQ消息队列中间件的6种模式

    以PHP代码为实例详解RabbitMQ消息队列中间件的6种模式

    这篇文章主要介绍了以PHP代码为实例详解RabbitMQ消息队列中间件的6种模式,有需要的朋友可以借鉴参考下,希望能够有所帮助,祝大家多多进步,早日升职加薪
    2023-05-05
  • Laravel中间件实现原理详解

    Laravel中间件实现原理详解

    这篇文章主要介绍了Laravel中间件实现原理,较为详细的分析了Laravel中间件的概念、原理及相关方法与使用技巧,需要的朋友可以参考下
    2016-10-10
  • ThinkPHP 3使用OSS的方法

    ThinkPHP 3使用OSS的方法

    这篇文章主要介绍了ThinkPHP 3使用OSS的方法,非常不错,具有一定的参考借鉴借鉴,需要的朋友可以参考下
    2018-07-07
  • Ajax实时验证用户名/邮箱等是否已经存在的代码打包

    Ajax实时验证用户名/邮箱等是否已经存在的代码打包

    一个网站采用Ajax技术,不仅可以改善网站的用户体验性,而且大大节约了宝贵的带宽,减轻了服务器负荷(不再需要交互整个网页内容,而是局部)。
    2011-12-12

最新评论