Wyszukiwanie w witrynie

Jak stworzyć globalną magistralę zdarzeń w Vue 2


Wstęp

Wzorzec magistrali zdarzeń/publikuj-subskrybuj to sposób, aby niepowiązane sekcje aplikacji komunikowały się ze sobą.

System zdarzeń zastosowany w komponentach Vue może być wykorzystany we wzorcu magistrala zdarzeń/publikacja-subskrypcja.

Uwaga: ten samouczek jest specyficzny dla Vue 2. W Vue 3 zalecane.

W tym artykule zastosujesz potężną wbudowaną magistralę zdarzeń Vue.

Wymagania wstępne

Aby ukończyć ten samouczek, będziesz potrzebować:

  • Node.js jest instalowany lokalnie, co możesz zrobić, wykonując instrukcje instalacji Node.js i tworzenia lokalnego środowiska programistycznego.
  • Pewna znajomość używania komponentów Vue.js może być przydatna.

Ten samouczek został zweryfikowany z Node v15.3.0, npm v6.14.9 i vue v2.6.11.

Krok 1 — Konfigurowanie projektu

Na potrzeby tego samouczka zbudujesz z domyślnego projektu Vue wygenerowanego za pomocą @vue/cli.

  1. npx @vue/cli create vue-event-bus-example --default

Spowoduje to skonfigurowanie nowego projektu Vue z domyślnymi konfiguracjami: Vue 2, babel, eslint.

Przejdź do nowo utworzonego katalogu projektu:

  1. cd vue-event-bus-example

Będziesz musiał utworzyć magistralę zdarzeń i wyeksportować ją gdzieś, aby inne moduły i komponenty mogły z niej korzystać. Najpierw utwórz nowy plik. Zaimportuj bibliotekę Vue. Następnie wyeksportuj jego instancję.

import Vue from 'vue';
export const EventBus = new Vue();

W tym samouczku instancja została ustawiona na zmienną EventBus.

Zasadniczo otrzymujesz komponent, który jest całkowicie oddzielony od DOM lub reszty aplikacji. Wszystko, co na nim istnieje, to jego metody instancji.

Teraz, gdy już utworzyłeś magistralę zdarzeń, musisz zaimportować ją do swoich komponentów i wywołać te same metody, których użyłbyś, gdybyś przekazywał komunikaty między komponentami nadrzędnymi i podrzędnymi.

Następnie zastosujmy EventBus.$emit().

Krok 2 — Wysyłanie wydarzeń

Rozważ scenariusz z komponentem, który powiadamia całą aplikację o tym, ile razy został kliknięty, gdy ktoś w niego kliknie.

Uwaga: W tym przykładzie użyto komponentu składającego się z jednego pliku, ale możesz użyć dowolnej metody tworzenia komponentów.

Oto jak można to zaimplementować za pomocą EventBus.$emit(channel: string, payload1: any, ...):

<template>
  <button @click="emitGlobalClickEvent()">{{ clickCount }}</button>
</template>

<script>
import { EventBus } from '@/event-bus';

export default {
  data() {
    return {
      clickCount: 0
    }
  },

  methods: {
    emitGlobalClickEvent() {
      this.clickCount++;
      EventBus.$emit('clicked', this.clickCount);
    }
  }
}
</script>

Ten kod generuje przycisk. Kliknięcie przycisku spowodowałoby wysłanie zdarzenia na kanał (kliknięto) z ładunkiem (clickCount).

Zmodyfikuj App.vue, aby używać tego komponentu.

<template>
  <div id="app">
    <ClickCountButton></ClickCountButton>
  </div>
</template>

<script>
import ClickCountButton from './components/ClickCountButton'

export default {
  name: 'App',
  components: {
    ClickCountButton
  }
}
</script>

Następnie zastosujmy EventBus.$on.

Krok 3 — Odbieranie zdarzeń

Teraz każda inna część Twojej aplikacji może zaimportować magistralę zdarzeń i nasłuchiwać na klikniętym kanale za pomocą EventBus.$on(channel: string, callback(payload1, ...)).

Zastosuj to do swojej aplikacji, modyfikując App.vue:

<script>
import { EventBus } from './event-bus';
import ClickCountButton from './components/ClickCountButton'

export default {
  name: 'App',
  components: {
    ClickCountButton
  }
}

const clickHandler = function(clickCount) {
  console.log(`The button has been clicked ${clickCount} times!`)
}

EventBus.$on('clicked', clickHandler);
</script>

Ten kod tworzy detektor zdarzeń dla klikniętego i rejestruje komunikat w konsoli z liczbą kliknięć przycisku.

Uwaga: jeśli chcesz nasłuchiwać tylko pierwszej emisji zdarzenia, możesz użyć EventBus.$once(channel: string, callback(payload1,...)).

Następnie zastosujmy EventBus.$off.

Krok 4 — Usuwanie detektorów zdarzeń

Możesz wyrejestrować moduł obsługi z klikniętego kanału za pomocą EventBus.$off(channel: string, callback(payload1,...)).

Zastosuj to do swojej aplikacji, modyfikując App.vue:

<script>
import { EventBus } from './event-bus';
import ClickCountButton from './components/ClickCountButton'

export default {
  name: 'App',
  components: {
    ClickCountButton
  }
}

const clickHandler = function(clickCount) {
  console.log(`The button has been clicked ${clickCount} times!`)
}

EventBus.$on('clicked', clickHandler);

EventBus.$off('clicked', clickHandler);
</script>

Podając zdarzenie i wywołanie zwrotne, EventBus.$off usunie słuchacza tylko dla tego konkretnego wywołania zwrotnego.

Uwaga: Możesz także usunąć wszystkich detektorów dla określonego zdarzenia, używając EventBus.$off(clicked) bez argumentu wywołania zwrotnego.

A jeśli naprawdę chcesz usunąć każdego słuchacza z EventBus, niezależnie od kanału, możesz wywołać EventBus.$off() bez żadnych argumentów.

Teraz wykorzystałeś .$emit, .$on i .$off.

Wniosek

W tym samouczku wykorzystałeś potężną wbudowaną magistralę zdarzeń Vue do nasłuchiwania zdarzenia kliknięcia i rejestrowania wiadomości z liczbą kliknięć. Osiągnięto to poprzez wykorzystanie .$emit, .$on i .$off.

Jeśli chcesz dowiedzieć się więcej o Vue.js, sprawdź naszą stronę tematyczną Vue.js, na której znajdziesz ćwiczenia i projekty programistyczne.

Powiązane artykuły: