如何使用 Laravel 框架的 validator

Laravel Validation

Laravel’s base controller class use a ValidatesRequests trait

app/Http/routes.php :

Route::get(‘post/create’, ‘PostController@create’);

Route::post(‘post’, ‘PostController@store’);

Controller

namespace App\Http\Controllers;

use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class PostController extends Controller
{
/**
* Show the form to create a new blog post.
*
* @return Response
*/
public function create()
{
return view('post.create');
}

/**
 * Store a new blog post.
 *
 * @param  Request  $request
 * @return Response
 */
public function store(Request $request)
{
    // Validate and store the blog post...
}

}

// 直接在 store 方法中，使用 base controller 中的 validatesRequests trait

public function store(Request $request)
{
$this->validate($request, [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);

}
只需给 validate 方法，传送 HTTP request 与需要验证规则即可。
注意，如果验证失败，自动生成默认的提示。验证通过，控制器就会自动往下执行。

第一个验证规则失败，就停止继续往下验证，对该属性适应 bail 规则：

$this->validate($request,[
‘title’ => ‘bail | required | unique:posts|max:255’,
‘body’ => ‘required’
]);

上面的代码执行时，如果 title 在 required 规则验证没通过，那么 unique 规则将不再被验证。
验证规则会被按照指定的顺序来校验。

对嵌套属性使用验证规则补充说明

如果 HTTP request 包含有嵌套参数，你可以再验证规则中使用 “.” 语法来指定需要校验的参数，如：

$this->validate($request, [
‘title’ => ‘required|unique:post|max:255’,
‘author.name’ => ‘required’,
‘author.description’ => ‘required’,
]);

展示验证后生成的错误提示

如前面提及到的，如果参数校验不通过， Laravel 会自动重定向到来源 URL。另外，所有的验证错误就会被自动存入到 session 中。

不需要在 GET 路由中将错误信息绑定，Laravel 会自己检测 session，如果有错误就自动绑定到视图中。
$errors 变量是 Illuminate\Support\MessageBag 的实例。

在这个例子中，验证不通过，用户将会被重定向到控制器的 create 方法。我们就可以在视图中展示错误。

Create Post

@if (count($errors) > 0)

@foreach ($errors->all() as $error)

• {{ $error }}

@endforeach

@endif

自定义错误消息提醒格式

自定义验证不通过的错误消息，可以通过在基础控制器(base controller)重写 formatValidationErrors。
必须要先在文件顶部，引入 Illuminate\Contracts\Validation\Validator 类：

namespace App\Http\Controllers;

use Illuminate\Foundation\Bus\DispatchesJobs;
use Illuminate\Contracts\Validation\Validator;
use Illuminate\Routing\Controller as BaseController;
use Illuminate\Foundation\Validation\ValidatesRequests;

abstract class Controller extends BaseController
{
use DispatchesJobs, ValidatesRequests;

/**
 * {@inheritdoc}
 */
protected function formatValidationErrors(Validator $validator)
{
    return $validator->errors()->all();
}

}

AJAX 请求与参数验证

上面例子，是针对使用表单(form)来传送数据给应用，大部分应用使用的是 AJAX 请求。

在一个 AJAX 请求中，使用 validate 方法，Laravel 将不会生成重定向响应。相反，Laravel 会生成一个包含验证错误提示的 JSON 响应。该响应会以 422 HTTP 状态码来发送回去给客户端。

校验输入字段的数组为数组格式

验证在每一个数组中的输入字段是唯一的，只需要

$validator = Validator::make($request->all(), [
'person..email' => 'email|unique:users',
'person..first_name' => 'required_with:person.*.last_name',
]);

同样，在文件中，当你指定验证提示时，可以使用 * 字符。

'custom' => [
'person.*.email' => [
'unique' => 'Each person must have a unique e-mail address',
]
],

自己创建验证器

不想要使用 ValidatesRequests trait’s validate 方法，你可以通过使用 Validator facade 来创建一个 validator 实例。make 方法将会生成一个新的验证器实例。

namespace App\Http\Controllers;

use Validator;
use Illuminate\Http\Request;
use App\Http\Controllers\Controller;

class PostController extends Controller
{
/**
* Store a new blog post.
*
* @param Request $request
* @return Response
*/
public function store(Request $request)
{
$validator = Validator::make($request->all(), [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
]);

    if ($validator->fails()) {
        return redirect('post/create')
                    ->withErrors($validator)
                    ->withInput();
    }

    // Store the blog post...
}

}

make 方法，第一参数是需要校验的数据，第二个参数是对数据进行校验的规则。

验证失败之后，可以使用 withErrors 方法来将错误提示存入会话中。同时，$errors 变量可以再跳转后，视图中使用。
withErrors 方法接收一个 validator, 一个 MessageBag，或一个 PHP 数组。

命名错误提示

单个页面有多个表单，你就会想要对错误提示命名，这样你可以指定接收处理某个指定表单的错误信息。
只要传送一个名字作为 withErrors 的第二个参数即可。

return redirect(‘register’)->withErrors($validator, ‘login’);

视图中通过 $errors 变量，来使用 MessageBag 实例：

{{ $errors->login->first(‘email’) }}

验证后提供的回调处理

validator 允许你指定回调函数，在验证完成之后就执行。这可以使你更容易进行深入的校验，甚至可以添加更多的错误提示。

只需要使用 validator 实例的 after 方法即可。

$validator = Validator::make(...);

$validator->after(function($validator) {
if ($this->somethingElseIsInvalid()) {
$validator->errors()->add('field', 'Something is wrong with this field!');
}
});

if ($validator->fails()) {
//
}

---

---

表单请求验证

为了应对更加复杂的验证场景，或许你会想要创建一个“ form request”。表单请求就是，自定义包含有验证逻辑的请求类。

使用 make:request Artisan 命令行命令 make:request，即可创建一个表单请求类：

php make make:request StoreBlogPostRequest

生成的类放置在 app/Http/Requests 目录。让我们添加几个验证规则到 rules 方法中：

public function rules()
{
return [
'title' => 'required|unique:posts|max:255',
'body' => 'required',
];
}

要怎么样才能让验证规则执行呢？所有你需要的就是，在对应的控制器方法中指定 request (type-hint the request on your controller method)。在控制器方法被调用前，输入的表单请求会先被验证，这就意味着你不需要将控制器代码与数据校验代码混在一起了。

public function store(StoreBlogPostRequest $request)
{
// The incoming request is valid...
}

验证失败，会有重定向响应，使用用户返回到来源 URL。错误提示会被保存到 session，可以直接在视图中进行使用展示。

如果请求是 AJAX， 返回 JSON 格式的验证错误提示，响应的HTTP状态码为 422 。

表单请求授权

表单请求类中，有 authorise 方法。在这个方法里面，你可以判断授权用户是否有权限去更新一个指定的资源。
如：一名用户想要更新一篇文章的评论，那需要检查他们是否就是该评论的所有者。

代码：

public function authorize()
{
$commentId = $this->route('comment');

return Comment::where('id', $commentId)
              ->where('user_id', Auth::id())->exists();

}

通过使用 route 方法来访问在路由中定义的 URI 参数，例如：{comment} 参数定义如下：

Route::post(‘comment/{comment}’);

如果 authorise 方法返回 false，状态码为 403 的响应会自动返回，控制器方法将不会被执行。

如果你想要，在应用的其他部分使用用户授权验证逻辑，只需要在 authorize 方法中返回 true 就好了。

自定义错误提示格式

如果你想要自定义验证失败后的错误提醒，只需要在 request 基类(App\Http\Requests\Request)中重写 formatErrors 方法。记得要在类文件顶部引入 Illuminate\Contracts\Validation\Validator。

protected function formatErrors(Validator $validator)
{
return $validator->errors()->all();
}

自定义错误提示内容

在表单请求类(app/Http/Requests/LightPostRequest.php)中，重写 message 方法。该方法必须要返回一个属性/规则对，与对应的错误的消息。

public function messages()
{
return [
'title.required' => 'A title is required',
'body.required' => 'A message is required',
];
}

使用错误提示信息

通过调用 Validator 实例的 errors 方法，你就可以使用 Illuminate\Support\MessageBag 实例，该实例提供一系列的便捷方法来操作错误提示信息。

使用一个字段的第一条错误信息

提取一个指定字段的第一条错误信息，使用 first 方法“

$message = $validator->error();

echo $message->first(‘email’);

提取一个字段的所有错误信息

$message->get(“email”);

foreach ($messages->get('email') as $message) {
//
}

提取所有字段的错误信息

$message->all();

foreach ($messages->all() as $message) {
//
}

判断某个字段时候存在错误信息

if ($messages->has('email')) {
//
}

通过一个格式来提取错误提示

echo $message->first(‘email’, ‘

:message

’);

通过一个格式提取所有错误提示

foreach($message->all(‘

:message

’) as $message) {

}