一个没有技术含量的 validation 验证层轮子

给大家分享一个轮子 form-request-validation,无耻求star。 github地址

目的

开发这个轮子的目的是为一些比较老旧的项目,或者一些没有请求验证层的项目可以更便捷的进行数据验证,而不需要用很多的 if 去判断,而且还能清晰的把一些基本验证和业务代码分离开来,使得代码结构更加的清晰,易于维护。

安装

$ composer require slpcode/form-request-validation -vvv

构建验证层的用法

该轮子有两个比较重要的类 FormRequestValidator,FormRequest主要是用来被继承的,用于自行搭建一个验证层,内部默认会对请求的$_GET, $_POST,$_FILES数据进行验证,如果请求传递的数据是json并且请求头为json请求头,那么会对json数据进行验证。用法和Laravel的表单验证一样,因为这个轮子是基于laravel的 illuminate/validation 的。

<?php

use Slpcode\FormRequestValidation\FormRequest;

class TestRequest extends FormRequest
{
    /**
     * 设置验证规则.
     *
     * @return array
     */
    protected function rules()
    {
        return [
            'name' => 'required|max:20',
            'age' => 'required|min:6',
        ];
    }

    /**
     * 设置验证错误信息.
     *
     * @return array
     */
    protected function messages()
    {
        return [
            'name.required' => '名字不能为空',
            'name.max' => '名字不能超过20位'
        ];
    }

    /**
     * 自定义字段名称.
     *
     * @return array
     */
    protected function attributes()
    {
        return [];
    }
}
<?php 

// 进行验证,如果验证不通过则会抛出 Slpcode\FormRequestValidation\Exceptions\ValidationException 异常
// 通过后返回request实例
(new TestRequest)->check();

Validator用法

也可以使用validator对象直接操作验证,这种方法是单纯的进行数据验证,需要自己传递要验证的数据到该Validator实例的make方法

<?php

// 直接创建验证器对象的用法
$validator = \Slpcode\FormRequestValidation\Validator::getInstance();

//验证
$rules = [
    'name' => 'required|min:5|max:20',
    'age' => 'required|max:2',
    ///...
];
$data = [
    ///...
];
// 可选
// 自定义错误消息
$messages = [

    'name.required' => '名称不能为空',
    //...
]; 
// 可选
// 自定义属性名称
$attributes = [
    'name' => '用户名',
    'age' => '年龄',
];
$validatorObj = $validator->make($data, $rules, $messages, $attributes);
//判断验证是否通过
if ($validatorObj->fails()) {
   //未通过
   //输出错误消息
   dd($validatorObj->messages()->all());
} else {

}

扩展验证

FormRequest扩展验证

默认带的验证方式也许不能满足我们业务的需求,所以需要扩展验证,我们可以自己建立一个验证基类,例如:BaseRequest,然后继承
\Slpcode\FormRequestValidation\FormRequest,然后我们其它的验证类再继承这个BaseRequest即可。

<?php
class BaseRequest extends \Slpcode\FormRequestValidation\FormRequest
{
    public function extend()
    {
        $this->getValidator()->extend('mobile', function ($attribute, $value, $parameters, $validator) {
            return preg_match("/^1[3,4,5,6,7,8,9]{1}[0-9]{9}$/", $value);
        }, ':attribute 格式不正确');
    }
}

// 使用扩展的mobile
class TestRequest extends BaseRequest
{
    /**
     * 设置验证规则.
     *
     * @return array
     */
    protected function rules()
    {
        return [
            'phone' => 'required|mobile',
        ];
    }
}
Validator扩展验证
$validator = \Slpcode\FormRequestValidation\Validator::getInstance();
$validator->extend(
    'mobile', 
    function ($attribute, $value, $parameters, $validator) {
         return preg_match("/^1[3,4,5,6,7,8,9]{1}[0-9]{9}$/", $value);
    },
    ':attribute 格式不正确'
);

语言包设置

默认内置了英文(en)和中文(zh-CN)两种语言包 语言列表可以从这里拿 https://github.com/caouecs/Laravel-lang

FormRequest语言包设置
<?php
class BaseRequest extends \Slpcode\FormRequestValidation\FormRequest
{
    protected $translation_path = __DIR__ . '/lang';
    protected $translation_locale = 'en';
}

// 或
(new TestRequest)->setLang('en', '语言包路径');
Validator语言包设置
<?php
// 内部有两种语言包 en 和 zh-CN
$validator = \Slpcode\FormRequestValidation\Validator::getInstance('en', '语言包路径');

Thanks

如果需要完全无依赖版本,推荐overtrue大神的 https://github.com/overtrue/validation

欢迎各种建议,Thanks

本作品采用《CC 协议》,转载必须注明作者和本文链接
讨论数量: 0
(= ̄ω ̄=)··· 暂无内容!

讨论应以学习和精进为目的。请勿发布不友善或者负能量的内容,与人为善,比聪明更重要!