Home

Awesome

Redux 中文文档

在线 Gitbook 地址:http://camsong.github.io/redux-in-chinese/

英文原版:http://rackt.github.io/redux/

翻译正在进行中,加入我们

Redux 是 JavaScript 状态容器,提供可预测化的状态管理。

可以让你构建一致化的应用,运行于不同的环境(客户端、服务器、原生应用),并且易于测试。不仅于此,它还提供 超爽的开发体验,比如有一个时间旅行调试器可以编辑后实时预览

Redux 除了和 React 一起用外,还支持其它界面库。
它体小精悍(只有2kB)且没有任何依赖。

评价

“Love what you’re doing with Redux”
Jing Chen,Flux 作者

“I asked for comments on Redux in FB's internal JS discussion group, and it was universally praised. Really awesome work.”
Bill Fisher,Flux 作者

“It's cool that you are inventing a better Flux by not doing Flux at all.”
André Staltz,Cycle 作者

开发经历

Redux 的开发最早开始于我在准备 React Europe 演讲热加载与时间旅行的时候,当初的目标是创建一个状态管理库,来提供最简化 API,但同时做到行为的完全可预测,因此才得以实现日志打印,热加载,时间旅行,同构应用,录制和重放,而不需要任何开发参与。

启示

Redux 由 Flux 演变而来,但受 Elm 的启发,避开了 Flux 的复杂性。
不管你有没有使用过它们,只需几分钟就能上手 Redux。

安装

安装稳定版:

npm install --save redux

多数情况下,你还需要使用 React 绑定库开发者工具

npm install --save react-redux
npm install --save-dev redux-devtools

要点

应用中所有的 state 都以一个对象树的形式储存在一个单一的 store 中。
惟一改变 state 的办法是触发 action,一个描述发生什么的对象。
为了描述 action 如何改变 state 树,你需要编写 reducers

就是这样!

import { createStore } from 'redux';

/**
 * 这是一个 reducer,形式为 (state, action) => state 的纯函数。
 * 描述了 action 如何把 state 转变成下一个 state。
 *
 * state 的形式取决于你,可以是基本类型、数组、对象、
 * 甚至是 Immutable.js 生成的数据结构。惟一的要点是
 * 当 state 变化时需要返回全新的对象,而不是修改传入的参数。
 *
 * 下面例子使用 `switch` 语句和字符串来做判断,但你可以写帮助类(helper)
 * 根据不同的约定(如方法映射)来判断,只要适用你的项目即可。
 */
function counter(state = 0, action) {
  switch (action.type) {
  case 'INCREMENT':
    return state + 1;
  case 'DECREMENT':
    return state - 1;
  default:
    return state;
  }
}

// 创建 Redux store 来存放应用的状态。
// API 是 { subscribe, dispatch, getState }。
let store = createStore(counter);

// 可以手动订阅更新,也可以事件绑定到视图层。
store.subscribe(() =>
  console.log(store.getState())
);

// 改变内部 state 惟一方法是 dispatch 一个 action。
// action 可以被序列化,用日记记录和储存下来,后期还可以以回放的方式执行
store.dispatch({ type: 'INCREMENT' });
// 1
store.dispatch({ type: 'INCREMENT' });
// 2
store.dispatch({ type: 'DECREMENT' });
// 1

你应该把要做的修改变成一个普通对象,这个对象被叫做 action,而不是直接修改 state。然后编写专门的函数来决定每个 action 如何改变应用的 state,这个函数被叫做 reducer

如果你以前使用 Flux,那么你只需要注意一个重要的区别。Redux 没有 Dispatcher 且不支持多个 store。相反,只有一个单一的 store 和一个根级的 reduce 函数(reducer)。随着应用不断变大,你应该把根级的 reducer 拆成多个小的 reducers,分别独立地操作 state 树的不同部分,而不是添加新的 stores。这就像一个 React 应用只有一个根级的组件,这个根组件又由很多小组件构成。

用这个架构开发计数器有点杀鸡用牛刀,但它的美在于做复杂应用和庞大系统时优秀的扩展能力。由于它可以用 action 追溯应用的每一次修改,因此才有强大的开发工具。如录制用户会话并回放所有 action 来重现它。

文档

示例

如果你是 NPM 新手,创建和运行一个新的项目有难度,或者不知道上面的代码应该放到哪里使用,请下载 simplest-redux-example 这个示例,它是一个集成了 React、Browserify 和 Redux 的最简化的示例项目。

交流

打开 Slack,加入 Reactiflux 中的 #redux 频道。

感谢

加入翻译

非常感谢你的关注,如果你也想为 Redux 推广贡献一份力量,欢迎加入我们一起翻译。目前翻译工作还没有完成,校对工作更是才刚刚开始。你可以按照以下的步骤进行认领提交。在认领之前,你需要先到 fork 一份代码,建议使用 Markdown 类编辑器开启横向双列模式,

认领制度

你应该在翻译之前进行翻译认领来保证没有人和你重复工作。很简单,只要在 contributes.md 中找到或者加入你想翻译的文章的资料,

加入:

work_in_progress: true
contributor: +your_github_acount+

之后,发个 pull request 过来就代表你成功的占到了一个坑,你可以开始慢慢的翻译自己的文章了。

你可以在 contributor 一栏中加入自己的 github 用户名,以便其他人可以联系到你。另外如果你占坑太久你的占位可能会被取消。尽量在半个月内完成你的工作。

翻译约定

约定翻译的名词

为了免除误解,这些词第一次出现时可以用 () 来显示原文。

英文中文
plain object普通对象
manage管理
compose组合
action creatoraction 创建函数
dispatch发起
note注意/须知
hold维持
state shapestate 结构
handle处理
boilerplate样板代码
normalized范式化
function函数?
composition合成
helper utility辅助工具
this won’t work这样做行不通
this will work这样做行得通
tips小贴士
create创建
flag标记位

保留不译的名词

前端开发常用的专有名词,在不造成读者理解困难的情况下,尽量保持原汁原味。

英文说明
action动作
reducer-
store-
middleware中间件
dispatcher分发器
state状态
state tree状态树
props属性
UI用户界面
monkeypatch-
currying柯里化

与原文同步机制

TBD

翻译流程

一、fork 本 repo

二、如果是新翻译章节,应参照对应的原文进行翻译;如果是校对则直接修改

三、翻译时启动 watch 来实时看结果

npm run watch

打开:localhost:4000

四、提交并发 Pull Request

五、fork 后的 repo 如何同步本 repo?

// 添加 upstream 源,只需执行一次
git remote add upstream git@github.com:camsong/redux-in-chinese.git
// 拉取远程代码
git pull upstream master
// 更新 fork 仓库
git push origin master

更多参考:https://help.github.com/articles/syncing-a-fork/

建议与反馈

欢迎任何建议!直接开一个 github issues 就可以了。