Laravel 모델 이벤트로 빠른 시작

Laravel 모델 이벤트를 사용하면 모델 수명 주기의 여러 주요 지점을 모니터링하고 모델이 저장되거나 삭제되는 것을 방지할 수도 있습니다. Laravel 모델 이벤트 문서는 후크를 사용하여 해당 이벤트를 관련 이벤트 유형과 연결하는 방법에 대한 개요를 제공하지만 이 문서의 주요 초점은 이벤트 및 리스너의 구성 및 설정과 몇 가지 추가 세부 사항입니다.

이벤트 개요

Eloquent에는 후크를 사용하여 연결하고 모델에 사용자 정의 기능을 추가할 수 있는 많은 이벤트가 있습니다. 모델은 다음 이벤트로 시작됩니다.

retrieved

creating

created

updating

updated

saving

saved

deleting

deleted

restoring

restored

문서에서 배울 수 있습니다. 구현되면 모델의 기본 클래스에 들어가서 구현 방법을 확인할 수도 있습니다.

기존 모델이 데이터베이스에서 검색되면 검색된 이벤트가 트리거됩니다. 새 모델이 처음 저장되면 생성 및 생성 이벤트가 실행됩니다. 데이터베이스에 이미 존재하는 모델에서 save 메소드가 호출되면 업데이트/업데이트 이벤트가 트리거됩니다. 그럼에도 불구하고 두 경우 모두 저장/저장 이벤트가 실행됩니다.

문서는 모델 이벤트에 대한 좋은 개요를 제공하고 후크를 사용하여 이벤트를 연결하는 방법을 설명합니다. 그러나 초보자이거나 후크를 사용하여 이벤트 리스너를 이러한 사용자 정의 모델 이벤트와 연결하는 방법에 익숙하지 않은 경우 다음을 자세히 읽어보세요. 이 기사.

이벤트 등록

모델에서 이벤트를 연결하려면 가장 먼저 해야 할 일은 $dispatchesEvents 속성을 사용하여 이벤트 객체를 등록하는 것입니다. 이 속성은 결국 HasEvents::fireCustomModelEvent()를 통해 트리거됩니다. 이 메소드는 fireModelEvent() 메소드를 통해 호출됩니다. 원래 fireCustomModelEvent() 메서드는 대략 다음과 같습니다.

/**
 * 为给定的事件触发一个自定义模型。
 *
 * @param  string  $event
 * @param  string  $method
 * @return mixed|null
 */
protected function fireCustomModelEvent($event, $method)
{
    if (! isset($this->dispatchesEvents[$event])) {
        return;
    }
    $result = static::$dispatcher->$method(new $this->dispatchesEvents[$event]($this));
    if (! is_null($result)) {
        return $result;
    }
}

삭제와 같은 일부 이벤트를 감지하여 해당 이벤트가 false를 반환할지 여부를 확인한 다음 작업을 종료합니다. 예를 들어, 이 후크를 사용하여 일부 감지를 수행하고 사용자가 생성되거나 삭제되는 것을 방지할 수 있습니다.

AppUser 모델을 예로 사용하여 모델 이벤트를 구성하는 방법은 다음과 같습니다.

protected $dispatchesEvents = [
    'saving' => \App\Events\UserSaving::class,
];

artisan make:event 명령을 사용하여 이 이벤트를 생성할 수 있지만 기본적으로 다음과 같이 끝납니다.

<?php
namespace App\Events;
use App\User;
use Illuminate\Queue\SerializesModels;
class UserSaving
{
    use SerializesModels;
    public $user;
    /**
     *  创建一个新的事件实例
     *
     * @param \App\User $user
     */
    public function __construct(User $user)
    {
        $this->user = $user;
    }
}

Us 이 이벤트는 저장 이벤트 중에 User 모델 인스턴스에 액세스할 수 있도록 공개 $user 속성을 제공합니다.

이를 작동시키기 위해 해야 할 다음 일은 이 이벤트에 대한 실제 리스너를 설정하는 것입니다. 모델의 트리거 시간을 설정합니다. 사용자 모델이 저장 이벤트를 트리거하면 리스너가 호출됩니다.

이벤트 리스너 만들기

이제 사용자 모델을 정의하고 이벤트 리스너를 등록하여 실행되는 저장 이벤트를 수신합니다. 모델 관찰자를 사용하여 이 작업을 빠르게 수행할 수 있었지만 개별 이벤트 트리거에 대한 이벤트 리스너를 구성하는 과정을 안내하고 싶습니다.

이벤트 리스너는 Laravel의 다른 이벤트 리스너와 같습니다. handler() 메소드는 AppEventsUserSaving 이벤트 클래스의 인스턴스를 수신합니다.

수동으로 생성하거나 php artisan make:listener 명령을 사용할 수 있습니다. 그럼에도 불구하고 다음과 같은 리스너 클래스를 생성하게 됩니다.

<?php
namespace App\Listeners;
use App\Events\UserSaving as UserSavingEvent;
class UserSaving
{
    /**
     * 处理事件。
     *
     * @param  \App\Events\UserSavingEvent $event
     * @return mixed
     */
    public function handle(UserSavingEvent $event)
    {
        app(&#39;log&#39;)->info($event->user);
    }
}

방금 리스너에게 전달된 모델을 더 쉽게 검사할 수 있도록 로깅 호출을 추가했습니다. 이를 위해 EventServiceProvider::$listen 속성에 리스너도 등록해야 합니다.

<?php
namespace App\Providers;
use Illuminate\Support\Facades\Event;
use Illuminate\Foundation\Support\Providers\EventServiceProvider as ServiceProvider;
class EventServiceProvider extends ServiceProvider
{
    /**
     * 应用的事件监听器。
     * 
     * @var array
     */
    protected $listen = [
        \App\Events\UserSaving::class => [
            \App\Listeners\UserSaving::class,
        ],
    ];
    // ...
}

이제 모델이 저장 이벤트를 호출하면 등록한 이벤트 리스너도 트리거되고 실행됩니다.

이벤트 수신을 시도해보세요

Tinker 세션을 통해 이벤트 수신 코드를 빠르게 생성할 수 있습니다:

php artisan tinker
>>> factory(\App\User::class)->create();
=> App\User {#794
     name: "Aiden Cremin",
     email: "josie05@example.com",
     updated_at: "2018-03-15 03:57:18",
     created_at: "2018-03-15 03:57:18",
     id: 2,
   }

이벤트와 리스너를 올바르게 등록했다면 laravel.log에서 모델의 JSON 표현식을 볼 수 있어야 합니다. 파일 형식:

[2018-03-15 03:57:18] local.INFO: {"name":"Aiden Cremin","email":"josie05@example.com"}

한 가지 주목할 점은 현재 모델에 Create_at 또는update_at 속성이 없다는 것입니다. 모델에서 save()가 다시 호출되면 로그에 타임스탬프가 있는 새 레코드가 생성됩니다. 새로 생성된 레코드나 기존 레코드에서 저장 이벤트가 트리거되기 때문입니다.

>>> $u = factory(\App\User::class)->create();
=> App\User {#741
     name: "Eloisa Hirthe",
     email: "gottlieb.itzel@example.com",
     updated_at: "2018-03-15 03:59:37",
     created_at: "2018-03-15 03:59:37",
     id: 3,
   }
>>> $u->save();
=> true
>>>

저장 작업 중지

일부 모델 이벤트를 통해 차단 작업을 수행할 수 있습니다. 터무니없는 예를 들자면, 어떤 사용자 모델도 $user->name 속성을 저장하는 것을 허용하지 않는다고 가정해 보겠습니다. 내용은 Paul입니다:

/**
 * 处理事件。
 *
 * @param  \App\Events\UserSaving $event
 * @return mixed
 */
public function handle(UserSaving $event)
{
    if (stripos($event->user->name, 'paul') !== false) {
        return false;
    }
}

Eloquent의 Model::save() 메소드에서는 다음과 같이 반환됩니다. 결과에 따라 저장 중지 여부가 결정됩니다.

public function save(array $options = [])
{
    $query = $this->newQueryWithoutScopes();
    // 如果 "saving" 事件返回 false ，我们将退出保存并返回
    // false，表示保存失败。这为服务监听者提供了一个机会，
    // 当验证失败或者出现其它任何情况，都可以取消保存操作。
    if ($this->fireModelEvent('saving') === false) {
        return false;
    }

이 save()는 모델 수명 주기에서 이벤트를 사용자 정의하고 로그 데이터 기록 또는 작업 예약을 수동적으로 수행하는 방법을 알려주는 좋은 예입니다.

관찰자 사용

여러 이벤트를 듣고 있는 경우 유형별로 그룹화된 이벤트를 저장하려면 관찰자 클래스를 사용하는 것이 더 편리할 수 있습니다. 다음은 Eloquent Observer의 예입니다:

<?php
namespace App\Observers;
use App\User;
class UserObserver
{
    /**
     * 监听 User 创建事件。
     *
     * @param  \App\User  $user
     * @return void
     */
    public function created(User $user)
    {
        //
    }
    /**
     * 监听 User 删除事件。
     *
     * @param  \App\User  $user
     * @return void
     */
    public function deleting(User $user)
    {
        //
    }
}

서비스 제공자 AppServiceProvider의 boot() 메소드에서 관찰자를 등록할 수 있습니다.

/**
 * 运行所有应用服务。
 *
 * @return void
 */
public function boot()
{
    User::observe(UserObserver::class);
}

推荐教程：《Laravel教程》

위 내용은 Laravel 모델 이벤트로 빠른 시작의 상세 내용입니다. 자세한 내용은 PHP 중국어 웹사이트의 기타 관련 기사를 참조하세요!