从 Vuex 0.6.x 迁移到 1.0

Vuex 2.0 已经发布了,但是这份指南只涵盖迁移到 1.0?这是打错了吗?此外,似乎 Vuex 1.0 和 2.0 也同时发布。这是怎么回事?我该用哪一个并且哪一个兼容 Vue 2.0 呢?

Vuex 1.0 和 2.0 如下:

然而它们的目标用户稍微有所不同。

Vuex 2.0 从根本上重新设计并且提供简洁的 API,用于帮助正在开始一个新项目的用户,或想要用客户端状态管理前沿技术的用户。此迁移指南不涵盖 Vuex 2.0 相关内容,因此如果你想了解更多,请查阅 Vuex 2.0 文档

Vuex 1.0 主要是向下兼容,所以升级只需要很小的改动。推荐拥有大量现存代码库的用户,或只想尽可能平滑升级 Vue 2.0 的用户。这份指南致力促进这一过程,但仅包括迁移说明。完整使用指南请查阅 Vuex 1.0 文档

带字符串 property 路径的 store.watch 替换

store.watch 现在只接受函数。因此,下面例子你需要替换:

store.watch('user.notifications', callback)

为:

store.watch(
  // 当返回结果改变...
  function (state) {
    return state.user.notifications
  },
  // 执行回调函数
  callback
)

这帮助你更加完善的控制那些需要监听的响应式 property。

升级方法

在代码库运行迁移工具,查找在 store.watch 中使用字符串作为第一个参数的事例。

Store 的事件触发器移除

store 实例不再暴露事件触发器 (event emitter) 接口 (onoffemit)。如果你之前使用 store 作为全局的 event bus,迁移说明相关内容请查阅此章节

为了替换正在使用观察 store 自身触发事件的这些接口,(例如:store.on('mutation', callback)),我们引入新的方法 store.subscribe。在插件中的典型使用方式如下:

var myPlugin = store => {
  store.subscribe(function (mutation, state) {
    // Do something...
  })
}

更多信息请查阅插件文档的示例。

升级方式

在代码库运行迁移工具,查找使用了 store.on, store.off, store.emit 的事例。

中间件替换

中间件被替换为插件。插件是接收 store 作为仅有参数的基本函数,能够监听 store 中的 mutation 事件:

const myPlugins = store => {
  store.subscribe('mutation', (mutation, state) => {
    // Do something...
  })
}

更多详情,请查阅插件文档

升级方法

在代码库运行迁移工具,查找使用了 middlewares 选项的事例。