写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; } }
内容版权声明:除非注明,否则皆为本站原创文章。