laravel5.1のサービスプロバイダについて調べてみた(カスタムバリデーターをサービスプロバイダで実装しようとしたけど、上手くいかなかったのでデフォルトのapp/Providers/AppServiceProvider.phpに記述した)

admin

9年前

質問その１、そもそも、サービスプロバイダって何？
回答その１、一言でいうとクラスです(必ずServiceProviderクラスを継承する)。何らかに機能(サービス)を提供してくれるので、この名称らしい。

質問その２、ただのクラスとは、何が違うのか？
回答その２、laravelの機能はサービス・プロバイダー単位でまとまっているので、laravelに機能追加したい場合には同じ形式にする必要がある！(ライブラリーや関数と同じ考え方)

質問その３、具体的に、どうやって作るのか？
回答その３、コマンドラインから、例によってartisanで作る

php artisan make:provider 好きな名前ServiceProvider
具体例)
php artisan make:provider PasswordValidateServiceProvider

質問その４、app/Providers/PasswordValidateServiceProvider.phpが生成されたけど、この後はどうすれば…。
回答その４、laravelで使えるように登録する！ config/app.phpに登録しないと、プロジェクトに追加しても利用出来ない！

'providers' => [
    // これで正しいと思うけど、laravelに認識されていないっぽい
    'App\Providers\PasswordValidateServiceProvider',
]

'providers' => [

// これで正しいと思うけど、laravelに認識されていないっぽい

'App\Providers\PasswordValidateServiceProvider',

]

質問その５、クラス内に、registerとbootという２種類のメソッドがあるけど、何？
回答その５、どちらも初期化処理。registerメソッドは必須。bootメソッドはオプションなので、実は無くてもOK。register -> bootの順で実行される。

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class PasswordValidateServiceProvider extends ServiceProvider
{
    /**
     * Bootstrap the application services.
     *
     * @return void
     */
    public function boot()
    {
        //
    }

    /**
     * Register the application services.
     *
     * @return void
     */
    public function register()
    {
        //
    }
}

<?php

namespace App\Providers;

use Illuminate\Support\ServiceProvider;

class PasswordValidateServiceProvider extends ServiceProvider

{

/**

* Bootstrap the application services.

* @return void

public function boot()

{

}

/**

* Register the application services.

* @return void

public function register()

{

}

質問その６、具体的に、何を記述すればいいのか？
回答その６、基本的には各サービスの初期化処理を行う。例えばカスタムバリデーター(入力チェック)は、以下の様な感じ。

    public function boot()
    {
        $this->app['validator']->resolver(function($translator, $data, $rules, $messages) {
            return new App\CustomValidator($translator, $data, $rules, $messages);
        });
    }

public function boot()

{

$this->app['validator']->resolver(function($translator, $data, $rules, $messages) {

return new App\CustomValidator($translator, $data, $rules, $messages);

});

}

上記のカスタムバリデーターの実装クラス(appフォルダ直下に自分で作る)

<?php

namespace App;

class CustomValidator extends \Illuminate\Validation\Validator
{

    /**
     * @param $attribute
     * @param $value
     * @param $parameters
     * @return int
     */
    public function validateJpZipCode($attribute, $value, $parameters)
    {
        return preg_match("/^[0-9\-]{7,8}+$/i", $value);
    }
    
}

<?php

namespace App;

class CustomValidator extends \Illuminate\Validation\Validator

{

/**

* @param $attribute

* @param $value

* @param $parameters

* @return int

public function validateJpZipCode($attribute, $value, $parameters)

{

return preg_match("/^[0-9\-]{7,8}+$/i", $value);

}

質問その７、エラーメッセージは、どこに記述すればいいのか？
回答その７、エラーメッセージは、resource/lang/ja/validation.phpで定義する(無くても動作はする)

    'custom' => [     
        'postal_code' => [
            'jp_zip_code' => ':attributeを正しく入力して下さい',
        ],        
    ],

'custom' => [

'postal_code' => [

'jp_zip_code' => ':attributeを正しく入力して下さい',

質問その８、実際に使うには？
回答その８、標準のvalidateの指定と全く同じ。

        $rules = [       
           'username' => ['required'], 
           'postal_code' => ['required', 'JpZipCode'],       
      
        ];         
        
        // 問題があったら、元ページに戻る
        $this->validate($request, $rules);

$rules = [

'username' => ['required'],

'postal_code' => ['required', 'JpZipCode'],

];

// 問題があったら、元ページに戻る

$this->validate($request, $rules);

質問その９、Method [validateJpZipCode] does not exist.とか、そんなvalidate無いよ！ってエラーが出るんだけど…。
回答その９、ここでつまづいた…。config/app.phpが上手く登録されていない？
最初からある、app/Providers/AppServiceProviderのbootに記述したら上手くいったので、とりあえずこれで実装する！

全体的な流れ
config/app.phpに登録→PasswordValidateServiceProvider->regbootister()で、CustomValidatorクラスが読み込まれる(ここで、ようやくvalidateJpZipCodeというカスタムバリデーターが登場！)
実際には、上記だと上手くいかなかったのでデフォルトのapp/Providers/AppServiceProvider.phpを利用した
※独自サービスプロバイダを作らなくていいので楽だけど、処理が多くなったら分割すべき

参考URL:Laravel4, 5 カスタムバリデートの実装

関連記事