基于 Laravel 封装参数校验

基于 Laravel 8.x 封装参数校验层

创建代码块文件

namespace App\Verify;


use App\enum\GenderEnum;
use App\Exceptions\ParametersException;
use App\Rules\MobilePhone;
use Illuminate\Support\Facades\Validator;
use Illuminate\Validation\Rule;

trait VerifyRequestInput
{
    /**
     * 验证ID
     * @param $key
     * @param  null  $default
     * @return mixed|null
     * @throws ParametersException
     */
    public function verifyId($key, $default = null)
    {
        return $this->verifyData($key, $default, 'integer|digits_between:1,20');
    }

    /**
     * 验证整数
     * @param $key
     * @param  null  $default
     * @return mixed|null
     * @throws ParametersException
     */
    public function verifyInteger($key, $default = null)
    {
        return $this->verifyData($key, $default, 'integer');
    }

    /**
     * 验证字符串
     * @param $key
     * @param  null  $default
     * @return mixed|null
     * @throws ParametersException
     */
    public function verifyString($key, $default = null)
    {
        return $this->verifyData($key, $default, 'string');
    }

    /**
     * 验证布尔值
     * @param $key
     * @param  null  $default
     * @return mixed|null
     * @throws ParametersException
     */
    public function verifyBoolean($key, $default = null)
    {
        return $this->verifyData($key, $default, 'boolean');
    }

    /**
     * 验证枚举
     * @param $key
     * @param  null  $default
     * @param  array  $enum
     * @return mixed|null
     * @throws ParametersException
     */
    public function verifyEnum($key, $default = null, array $enum = [])
    {
        return $this->verifyData($key, $default, Rule::in($enum));
    }

    /**
     * 验证排序 升序|降序
     * @param $key
     * @param  string  $default
     * @return mixed|null
     * @throws ParametersException
     */
    public function verifySortValues($key, string $default = 'desc')
    {
        return $this->verifyData($key, $default, Rule::in(['desc', 'asc']));
    }

    /**
     * 验证性别
     * @param $key
     * @param  null  $default
     * @return mixed|null
     * @throws ParametersException
     */
    public function verifyGenderValues($key, $default = null)
    {
        return $this->verifyData($key, $default, Rule::in([GenderEnum::UNKNOWN, GenderEnum::MAN, GenderEnum::WOMAN]));
    }

    /**
     * 分页每页数量限制
     * @param $key
     * @param  int  $default
     * @return mixed|null
     * @throws ParametersException
     */
    public function verifyPerPageLimit($key, int $default = 10)
    {
        return $this->verifyData($key, $default, 'integer|max:100');
    }

    /**
     * 验证手机号
     * @param $key
     * @param  null  $default
     * @return mixed|null
     * @throws ParametersException
     */
    public function verifyMobilePhone($key, $default = null)
    {
        return $this->verifyData($key, $default, new MobilePhone());
    }

    /**
     * 参数校验统一处理
     * @param $key
     * @param $default
     * @param $rule
     * @param  array  $message
     * @return mixed
     * @throws ParametersException
     */
    private function verifyData($key, $default, $rule, array $message = [])
    {
        $value = request()->input($key, $default);
        $validator = Validator::make([$key => $value], [$key => $rule], $message);
        if (is_null($default) && is_null($value)) {
            throw new ParametersException("$key 不能为空");
        }
        if ($validator->fails()) {
            throw new ParametersException($validator->errors()->first());
        }
        return $value;
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146

自定义验证规则

namespace App\Rules;

use Illuminate\Contracts\Validation\Rule;

class MobilePhone implements Rule
{
    /**
     * Create a new rule instance.
     *
     * @return void
     */
    public function __construct()
    {
        //
    }

    /**
     * Determine if the validation rule passes.
     *
     * @param  string  $attribute
     * @param  mixed  $value
     * @return bool
     */
    public function passes($attribute, $value)
    {
        return preg_match("/^((13[0-9])|(14[5,7])|(15[0-3,5-9])|(17[0,3,5-8])|(18[0-9])|166|198|199|(147))\d{8}$/", $value);
    }

    /**
     * Get the validation error message.
     *
     * @return string
     */
    public function message()
    {
        return trans('verification.mobile_phone');
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41

创建自定义异常类

namespace App\Exceptions;


use App\util\ResponseCode;
use Exception;

class ParametersException extends Exception
{

    /**
     * ParametersException constructor.
     */
    public function __construct($errmsg = '')
    {
        list($code, $message) = ResponseCode::PARAM_ERROR;
        parent::__construct($errmsg ?: $message, $code);
    }
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

Handler.php 异常类处理返回格式

/**
 * 渲染异常为 HTTP 响应
 * @param  \Illuminate\Http\Request  $request
 * @param  Throwable  $e
 * @return \Symfony\Component\HttpFoundation\Response
 * @throws Throwable
 */
public function render($request, Throwable $e)
{
    if ($e instanceof ParametersException) {
        return response()->json([
            'errno' => $e->getCode(),
            'errmsg' => $e->getMessage()
        ], 400);
    }
    return parent::render($request, $e);
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

控制器调用

// Class中引入代码块
use VerifyRequestInput;

// 必填参数
$id = $this->verifyId('id');

// 设置默认值，非必填参数
$id = $this->verifyId('id', '');
1
2
3
4
5
6
7
8