Плагины

Попробовать этот урок на Scrimba

Хранилища Vuex принимают параметр plugins , который экспонирует хуки для каждой мутации. Плагин Vuex — это просто функция, которая получает хранилище в качестве единственного аргумента:

const myPlugin = (store) => {
  // called when the store is initialized
  store.subscribe((mutation, state) => {
    // called after every mutation.
    // The mutation comes in the format of `{ type, payload }`.
  })
}

И может быть использован так:

const store = createStore({
  // ...
  plugins: [myPlugin]
})

Применение мутаций внутри плагинов

Плагины не могут напрямую мутировать состояние — подобно компонентам, они могут только вызывать изменения, применяя мутации.

Применяя мутации, плагин может использоваться для синхронизации источника данных с хранилищем. Например, для синхронизации источника данных WebSocket с хранилищем (это просто пример, на самом деле функция createWebSocketPlugin может принимать дополнительные параметры для более сложных задач):

export default function createWebSocketPlugin (socket) {
  return (store) => {
    socket.on('data', data => {
      store.commit('receiveData', data)
    })
    store.subscribe(mutation => {
      if (mutation.type === 'UPDATE_DATA') {
        socket.emit('update', mutation.payload)
      }
    })
  }
}

const plugin = createWebSocketPlugin(socket)

const store = createStore({
  state,
  mutations,
  plugins: [plugin]
})

Создание снимков состояния

Иногда плагину может потребоваться получить «снимки» состояния и сравнить состояние после мутации со состоянием до мутации. Для этого необходимо выполнить глубокую копию объекта состояния:

const myPluginWithSnapshot = (store) => {
  let prevState = _.cloneDeep(store.state)
  store.subscribe((mutation, state) => {
    let nextState = _.cloneDeep(state)

    // compare `prevState` and `nextState`...

    // save state for next mutation
    prevState = nextState
  })
}

Плагины, которые создают снимки состояния, должны использоваться только во время разработки. При использовании webpack или Browserify мы можем позволить нашим инструментам сборки сделать это за нас:

const store = createStore({
  // ...
  plugins: process.env.NODE_ENV !== 'production'
    ? [myPluginWithSnapshot]
    : []
})

Плагин будет использоваться по умолчанию. Для производства вам понадобится DefinePlugin для webpack или envify для Browserify, чтобы преобразовать значение process.env.NODE_ENV !== 'production' в false для финальной сборки.

Встроенный плагин регистрации

Vuex поставляется с плагином регистрации для распространённого использования при отладке:

import { createLogger } from 'vuex'

const store = createStore({
  plugins: [createLogger()]
})

Функция createLogger принимает несколько параметров:

const logger = createLogger({
  collapsed: false, // auto-expand logged mutations
  filter (mutation, stateBefore, stateAfter) {
    // returns `true` if a mutation should be logged
    // `mutation` is a `{ type, payload }`
    return mutation.type !== "aBlocklistedMutation"
  },
  actionFilter (action, state) {
    // same as `filter` but for actions
    // `action` is a `{ type, payload }`
    return action.type !== "aBlocklistedAction"
  },
  transformer (state) {
    // transform the state before logging it.
    // for example return only a specific sub-tree
    return state.subTree
  },
  mutationTransformer (mutation) {
    // mutations are logged in the format of `{ type, payload }`
    // we can format it any way we want.
    return mutation.type
  },
  actionTransformer (action) {
    // Same as mutationTransformer but for actions
    return action.type
  },
  logActions: true, // Log Actions
  logMutations: true, // Log mutations
  logger: console, // implementation of the `console` API, default `console`
})

Файл регистрации также может быть включён непосредственно с помощью тега <script>, и функция createVuexLogger будет глобально экспонирована.

Обратите внимание, что плагин регистрации создаёт снимки состояния, поэтому используйте его только во время разработки.

API композиции

Строгий режим