Browse Source

更新了 state 文档

更新了 state 文档
基于英文文档 v0.6.2
Quan Hong 9 years ago
parent
commit
b28acd7f2a
1 changed files with 124 additions and 22 deletions
  1. 124 22
      docs/zh-cn/state.md

+ 124 - 22
docs/zh-cn/state.md

@@ -1,52 +1,154 @@
-# State
+# State 和 Getters
 
 
 ### 单状态树
 ### 单状态树
 
 
-Vuex 使用 **单状态树(single state tree)** —— 也就是单个对象包含整个应用的状态。这使得我们能够方便地定位某一部分特定的状态,在 debugging 的过程中也能轻易地取得当前应用的状态快照(snapshots)。
+Vuex 使用 **单状态树(single state tree)** - 也就是单个对象包含整个应用的状态 and serves as the "single source of truth". This also means usually you will have only one store for each application. 单状态树使得我们能够直截了当地定位某一部分特定的状态,在 debug 的过程中也能轻易地取得当前应用状态的快照(snapshots)。
 
 
 单状态树和模块化并不冲突 —— 在往后的章节里我们会讨论如何将状态管理分离到各个子模块中。
 单状态树和模块化并不冲突 —— 在往后的章节里我们会讨论如何将状态管理分离到各个子模块中。
 
 
-### 在 Vue 组件中获得 Vuex State
+### 在 Vue 组件中获得 Vuex 状态
 
 
-和 Vue 实例中的 `data` 对像一样,`state` 对象一旦进入 Vuex store,就会被 Vue.js 改造成响应式对象(参见 [Vue.js 响应系统](http://vuejs.org/guide/reactivity.html))。因此,要让 Vuex store 的 state 来驱动 Vue 组件的渲染,只需要简单地在一个计算属性中返回 `store.state` 中需要的部分即可
+我们如何在我们的 Vue 组件中展示状态呢?由于 Vuex 的状态存储是动态的,从 store 中读取状态最简单的方法就是在计算属性[computed property](http://vuejs.org/guide/computed.html)中返回某个状态
 
 
 ``` js
 ``` js
-// 一个 Vue 组件模块内部
+// 在 Vue 组件定义时
+computed: {
+  count: function () {
+    return store.state.count
+  }
+}
+```
 
 
-// 引入一个 vuex store 实例
-import store from './store'
+每当 `store.state.count` 变化的时候, 都会使得计算属性重新计算,并且触发相关联的 DOM 更新。
 
 
-export default {
-  computed: {
-    message () {
-      return store.state.message
+然而,这种模式导致组件依赖全局状态。这导致测试单个组件和多个实例共享一套组件变得困难。在大型应用中,我们也许需要把状态从根组件『注入』到每一个子组件中。下面便是如何实现:
+
+1. 安装 Vuex 并且将您的根组件引入 store:
+
+  ``` js
+  import Vue from 'vue'
+  import Vuex from 'vuex'
+  import store from './store'
+  import MyComponent from './MyComponent'
+
+  // 重要,告诉 Vue 组件如何处理 Vuex 相关的配置
+  
+  Vue.use(Vuex)
+
+  var app = new Vue({
+    el: '#app',
+    // 使用 "store" 来配置,并会在全部的子组件中注入状态
+    store,
+    components: {
+      MyComponent
+    }
+  })
+  ```
+
+  通过在根实例中注册 `store`,store 会注入到根组件下全部的子组件中,并且可以通过 `this.$store` 获得。然而我们很少这么做,因为我们需要真实的引用它。
+
+2. 在子组件中,在 `vuex.getters` 配置中通过 **getter** 来读取状态:
+
+  ``` js
+  // MyComponent.js
+  export default {
+    template: '...',
+    data () { ... },
+    // 这里是我们从 store 取回状态的位置
+    vuex: {
+      getters: {
+        // 一个状态的 getter 函数,将会将 `store.state.count` 绑定为 `this.count`
+        count: function (state) {
+          return state.count
+        }
+      }
     }
     }
   }
   }
+  ```
+
+  请关注特别的 `vuex` 部分。在这里我们指定该组件将会从 store 读取什么状态。对于每一个属性名,我们指定一个 getter 函数,这个只接受一个包含全部状态的 state 状态树作为唯一的参数,然后选择并返回一部分状态,或者根据状态得出的计算属性。返回的结果会像计算属性一样将属性名注入到组件上。
+
+  大多数情况下,"getter" 函数可以通过 ES2015 的剪头函数来简洁的实现:
+
+  ``` js
+  vuex: {
+    getters: {
+      count: state => state.count
+    }
+  }
+  ```
+
+### getter 函数必须是纯函数
+
+所有的 Vuex getter 函数,必须是纯函数 [pure functions](https://en.wikipedia.org/wiki/Pure_function) - 他们传入整个状态树,返回一些完全基于传入窗台的值。这让组件更容易测试、组合和更高效。这也意味着 **在 getter 函数中不能依赖 this**。
+
+如果你确实需要使用 `this`,例如基于组件本身或者传入的状态来计算属性,你可以在计算属性中单独计算这些属性:
+
+``` js
+vuex: {
+  getters: {
+    currentId: state => state.currentId
+  }
+},
+computed: {
+  isCurrent () {
+    return this.id === this.currentId
+  }
 }
 }
 ```
 ```
 
 
-我们并不需要建立任何监听器或者用一个 API 去建立组件和 store 之间的联系 - Vue 的响应式系统会确保界面的自动更新。唯一要记住的是,**在计算属性里,必须通过 `store.state.xxx` 引用 state**。不要在计算属性外部存放 state 的引用。
+### getter 函数可以返回派生状态
 
 
-> Flux 相关:这里计算属性的用法可以和 Redux 的 [`mapStateToProps`](https://github.com/rackt/react-redux/blob/master/docs/api.md#connectmapstatetoprops-mapdispatchtoprops-mergeprops-options) 以及 NuclearJS 的 [getters](https://optimizely.github.io/nuclear-js/docs/04-getters.html) 做类比。
+Vuex 状态的 getter 函数返回的属性是自动计算的,这就意味着你能够动态(并且高效)地计算派生属性。例如,下面的例子中,我们有一个包含了全部消息的 `messages` 数组,和一个代表用户当前正在浏览的消息索引的 `currentThreadID`。我们想要展示给用户一个根据当前索引过滤后的消息列表:
+
+``` js
+vuex: {
+  getters: {
+    filteredMessages: state => {
+      return state.messages.filter(message => {
+        return message.threadID === state.currentThreadID
+      })
+    }
+  }
+}
+```
 
 
-你可能会问为什么我们不直接用 `data` 去绑定 state,我们看以下例子:
+因为 Vue.js 计算属性是自动缓存的,且只有一个动态的依赖改变的时候才会重新计算,所以你不必担心 getter 函数会在每次状态树改变的时候调用一次。
+
+### 在多组件中共享 getter 函数
+
+正如你所见,getter 函数 `filteredMessages` 在多个组件中都很有用。这种情况下,在多组件中共享 getter 函数就是很好的办法:
+
+``` js
+// getters.js
+export function filteredMessages (state) {
+  return state.messages.filter(message => {
+    return message.threadID === state.currentThreadID
+  })
+}
+```
 
 
 ``` js
 ``` js
+// 在组件中...
+import { filteredMessages } from './getters'
+
 export default {
 export default {
-  data () {
-    return {
-      message: store.state.message
+  vuex: {
+    getters: {
+      filteredMessages
     }
     }
   }
   }
 }
 }
 ```
 ```
 
 
-因为 `data` 函数不追踪任何响应式依赖, 我们得到的仅仅是一个对 `store.state.message` 的静态引用。即使之后 state 被改变,组件也无法知道它的改变。而计算属性则不同,它在求值时会自动跟踪依赖,因此当状态改变时会自动触发更新。
+因为 getter 函数是纯函数,多组件共享的时候 getter 函数可以高效的缓存:当依赖状态改变的时候,在使用 getter 函数的全部组件中只重新计算一次。
+
+> Flux 参考: Vuex 的 getter 函数可以大致类比成 Redux 中的 [`mapStateToProps`](https://github.com/rackt/react-redux/blob/master/docs/api.md#connectmapstatetoprops-mapdispatchtoprops-mergeprops-options). 然而, 由于 Vue 的计算可以缓存的计算机制,getter 函数要比 `mapStateToProps` 更加高效,因此更加和 [reselect](https://github.com/reactjs/reselect)相似。
 
 
-### 组件不允许直接改变 state
+### 组件不允许直接改 state 中的状态
 
 
-使用只读的计算属性有一个好处就是,能更好的遵守 **组件不允许直接改变 store state** 的准则。由于我们希望每一次状态的变动都意图清晰且可被跟踪,因此所有的全局状态变动都必须在 store 的 mutation handlers 当中执行。
+有一点很重要,需要注意,就是**组件永远都不应该直接修改 Vuex store 中的 state 状态**。因为我们想要每个状态的改变都清晰并且可追踪,所有的 Vuex 状态改变必须在 store 中的 mutation 中进行。
 
 
-为了践行这条准则,在 [严格模式](strict.md) 中如果在 mutation handlers 外部改变 Vuex store state,Vuex 会抛出错误。
+为了保持这个规则,在严格模式([Strict Mode](strict.md))下,如果 store 中一个状态在 mutation 外进行修改,Vuex 会跑出错误。
 
 
-根据这条准则,我们的 Vue 组件处理的事情就很少了:它们只需要通过只读的计算属性和 store 内部的 state 建立联系,而改变 state 的唯一方法就是调用 **actions**. 组件依然能在必要时拥有和操作自己的本地状态,但我们再也不需要在组件里包含任何与全局状态相关的逻辑了。
+有了这一规则,我们的 Vue 组件现在少了很多职能:这势必让 Vuex 中 store 变得只读,组件唯一影响 state 的方法就是触发 **mutations**(我们接下来就讨论)。必要情况下,组件仍然能够拥有和操作自己的状态,但是我们不再在独立的组件中放置任何请求数据或者改变全局状态的逻辑。这些操作全部都集中在 Vuex 相关的文件中,这样能够让大型应用更容易理解和保持规范