Magento 2 이벤트 목록 및 사용 방법

이 게시물에서는 Magento 2에서 이벤트 를 사용하는 방법을 보여 드리겠습니다. 하지만 먼저 이벤트 와 관찰자 에 대해 이해해야 합니다. Magento 2의 이벤트 및 관찰자 구현은 게시-구독 패턴을 기반으로 합니다. 이벤트 및 관찰자를 사용하여 특정 Magento 이벤트 또는 사용자 정의 이벤트에 대한 응답으로 사용자 정의 코드를 실행할 수 있습니다.

Magento의 이벤트는 무엇입니까?

이벤트 는 특정 작업이 트리거될 때 모듈에 의해 전달됩니다. 자체 이벤트 외에도 Magento를 사용하면 코드에서 전달할 수 있는 고유한 이벤트를 생성할 수 있습니다. 이벤트가 전달되면 해당 이벤트를 감시하도록 구성된 모든 관찰자에게 데이터를 전달할 수 있습니다.

Magento에서 관찰자란 무엇입니까?

관찰자 는 일반적인 동작, 성능에 영향을 미치거나 비즈니스 로직을 변경할 수 있는 특정 유형의 Magento 클래스입니다. 관찰자는 관찰하도록 구성된 이벤트가 이벤트 관리자에 의해 전달될 때마다 실행됩니다.

이제 용어를 이해했으므로 사용하도록 합시다!

1. event.xml 파일 생성

다양한 영역에 대해 event.xml 파일을 생성할 수 있습니다.

• 전역 영역: app/code/Simi/HelloWorld/etc/events.xml
• 프론트엔드 영역: app/code/Simi/HelloWorld/etc/frontend/events.xml
• 관리 영역: app/code/Simi/HelloWorld/etc/adminhtml/events.xml

 <?xml 버전="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <이벤트 이름="my_module_event_before">
        <관찰자 이름="myObserverName" instance="MyCompany\MyModule\Observer\MyObserver" />
    </이벤트>
    <이벤트 이름="my_module_event_after">
        <관찰자 이름="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </이벤트>
</구성>

2. 옵저버 클래스 생성

관찰자를 만들려면 <module-root>/Observer 디렉터리 아래에 클래스 파일을 배치해야 합니다. 관찰자 클래스는 Magento\Framework\Event\ObserverInterface 를 구현하고 실행 기능을 정의해야 합니다.

다음은 기본 관찰자 클래스 구조의 예입니다.

 네임스페이스 MyCompany\MyModule\Observer;

Magento\Framework\Event\ObserverInterface를 사용하십시오.

클래스 MyObserver는 ObserverInterface를 구현합니다.
{
  공개 함수 __construct()
  {
    // 옵저버 초기화 코드...
    // 의존성 주입을 사용하여 이 관찰자가 필요할 수 있는 모든 클래스를 가져올 수 있습니다.
  }

  공개 함수 실행(\Magento\Framework\Event\Observer $observer)
  {
    // 옵저버 실행 코드...
  }
}

관찰자의 강력한 기능 중 하나는 이벤트가 전달될 때 이벤트에 전달된 매개변수를 사용할 수 있다는 것입니다.

다음은 이벤트가 전달될 때 전달된 데이터를 얻는 관찰자의 예입니다.

 네임스페이스 MyCompany\MyModule\Observer;

Magento\Framework\Event\ObserverInterface를 사용하십시오.

클래스 AnotherObserver는 ObserverInterface를 구현합니다.
{
  공개 함수 __construct()
  {
    // 옵저버 초기화 코드...
    // 의존성 주입을 사용하여 이 관찰자가 필요할 수 있는 모든 클래스를 가져올 수 있습니다.
  }

  공개 함수 실행(\Magento\Framework\Event\Observer $observer)
  {
    $myEventData = $observer->getData('myEventData');
    // 추가 관찰자 실행 코드...
  }
}

이벤트 구독

events.xml 파일의 특정 이벤트를 감시하도록 관찰자를 구성할 수 있습니다.

관찰자 xml 요소에는 다음과 같은 속성이 있습니다.

• name (필수) – 이벤트 정의에 대한 관찰자의 이름입니다.
• instance (필수) – 관찰자의 정규화된 클래스 이름입니다.
• disabled – 이 관찰자가 활성 상태인지 여부를 결정합니다. 기본값은 false입니다.
• shared – 클래스의 라이프 스타일을 결정합니다. 기본값은 true입니다.

다음은 특정 이벤트를 시청하도록 관찰자를 할당하는 방법의 예입니다.

 <?xml 버전="1.0"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="urn:magento:framework:Event/etc/events.xsd">
    <이벤트 이름="my_module_event_before">
        <관찰자 이름="myObserverName" instance="MyCompany\MyModule\Observer\MyObserver" />
    </이벤트>
    <이벤트 이름="my_module_event_after">
        <관찰자 이름="myObserverName" instance="MyCompany\MyModule\Observer\AnotherObserver" />
    </이벤트>
</구성>

관찰자 이름은 이벤트 정의별로 고유해야 합니다. 재정의를 피하기 위해 동일한 이벤트 정의에 동일한 이름을 가진 두 개의 관찰자가 있을 수 없습니다.

3. 디스패치 이벤트

Magento\Framework\Event\Manager 클래스를 사용하여 이벤트를 전달할 수 있습니다. 이 클래스는 생성자에서 종속성을 정의하여 종속성 주입을 통해 얻을 수 있습니다.

이벤트를 전달하려면 이벤트 관리자 클래스의 dispatch 함수를 호출하고 관찰자에게 제공하려는 데이터 배열과 함께 전달하려는 이벤트의 이름을 제공합니다.

다음 예제에서는 데이터 배열이 있거나 없는 이벤트를 전달하는 방법을 보여줍니다.

 네임스페이스 MyCompany\MyModule;

Magento\Framework\Event\ManagerInterface를 EventManager로 사용하십시오.

클래스 마이클래스
{
  /**
   * @var 이벤트매니저
   */
  개인 $eventManager;

  공개 함수 __construct(EventManager $eventManager)
  {
    $this->eventManager = $eventManager;
  }

  공공 기능 무언가()
  {
    $eventData = null;
    // 코드...
    $this->eventManager->dispatch('my_module_event_before');
    // $eventData를 설정하는 추가 코드...
    $this->eventManager->dispatch('my_module_event_after', ['myEventData' => $eventData]);
  }
}

Magento 2 이벤트 목록

See also:

Magento 2에서 개발자 모드를 활성화하는 방법

Magento 2에서 제품 이미지 URL을 얻는 방법