Redux React-Redux 的用法


为了方便使用,Redux 的作者封装了一个 React 专用的库 React-Redux,本文主要介绍它。

这个库是可以选用的。实际项目中,你应该权衡一下,是直接使用 Redux,还是使用 React-Redux。后者虽然提供了便利,但是需要掌握额外的 API,并且要遵守它的组件拆分规范。

一、UI 组件

React-Redux 将所有组件分成两大类:UI 组件(presentational component)和容器组件(container component)。

UI 组件有以下几个特征。

  • 只负责 UI 的呈现,不带有任何业务逻辑
  • 没有状态(即不使用this.state这个变量)
  • 所有数据都由参数(this.props)提供
  • 不使用任何 Redux 的 API

下面就是一个 UI 组件的例子。

  1. const Title =
  2. value => <h1>{value}</h1>;

因为不含有状态,UI 组件又称为"纯组件",即它纯函数一样,纯粹由参数决定它的值。

二、容器组件

容器组件的特征恰恰相反。

  • 负责管理数据和业务逻辑,不负责 UI 的呈现
  • 带有内部状态
  • 使用 Redux 的 API

总之,只要记住一句话就可以了:UI 组件负责 UI 的呈现,容器组件负责管理数据和逻辑。

你可能会问,如果一个组件既有 UI 又有业务逻辑,那怎么办?回答是,将它拆分成下面的结构:外面是一个容器组件,里面包了一个UI 组件。前者负责与外部的通信,将数据传给后者,由后者渲染出视图。

React-Redux 规定,所有的 UI 组件都由用户提供,容器组件则是由 React-Redux 自动生成。也就是说,用户负责视觉层,状态管理则是全部交给它。

三、connect()

React-Redux 提供connect方法,用于从 UI 组件生成容器组件。connect的意思,就是将这两种组件连起来。

  1. import { connect } from 'react-redux'
  2. const VisibleTodoList = connect()(TodoList);

上面代码中,TodoList是 UI 组件,VisibleTodoList就是由 React-Redux 通过connect方法自动生成的容器组件。

但是,因为没有定义业务逻辑,上面这个容器组件毫无意义,只是 UI 组件的一个单纯的包装层。为了定义业务逻辑,需要给出下面两方面的信息。

(1)输入逻辑:外部的数据(即state对象)如何转换为 UI 组件的参数

(2)输出逻辑:用户发出的动作如何变为 Action 对象,从 UI 组件传出去。

因此,connect方法的完整 API 如下。

  1. import { connect } from 'react-redux'
  2.  
  3. const VisibleTodoList = connect(
  4. mapStateToProps,
  5. mapDispatchToProps
  6. )(TodoList)

上面代码中,connect方法接受两个参数:mapStateToPropsmapDispatchToProps。它们定义了 UI 组件的业务逻辑。前者负责输入逻辑,即将state映射到 UI 组件的参数(props),后者负责输出逻辑,即将用户对 UI 组件的操作映射成 Action。

四、mapStateToProps()

mapStateToProps是一个函数。它的作用就是像它的名字那样,建立一个从(外部的)state对象到(UI 组件的)props对象的映射关系。

作为函数,mapStateToProps执行后应该返回一个对象,里面的每一个键值对就是一个映射。请看下面的例子。

  1. const mapStateToProps = (state) => {
  2. return {
  3. todos: getVisibleTodos(state.todos, state.visibilityFilter)
  4. }
  5. }

上面代码中,mapStateToProps是一个函数,它接受state作为参数,返回一个对象。这个对象有一个todos属性,代表 UI 组件的同名参数,后面的getVisibleTodos也是一个函数,可以从state算出 todos 的值。

下面就是getVisibleTodos的一个例子,用来算出todos

  1. const getVisibleTodos = (todos, filter) => {
  2. switch (filter) {
  3. case 'SHOW_ALL':
  4. return todos
  5. case 'SHOW_COMPLETED':
  6. return todos.filter(t => t.completed)
  7. case 'SHOW_ACTIVE':
  8. return todos.filter(t => !t.completed)
  9. default:
  10. throw new Error('Unknown filter: ' + filter)
  11. }
  12. }

mapStateToProps会订阅 Store,每当state更新的时候,就会自动执行,重新计算 UI 组件的参数,从而触发 UI 组件的重新渲染。

mapStateToProps的第一个参数总是state对象,还可以使用第二个参数,代表容器组件的props对象。

  1. // 容器组件的代码
  2. // <FilterLink filter="SHOW_ALL">
  3. // All
  4. // </FilterLink>
  5.  
  6. const mapStateToProps = (state, ownProps) => {
  7. return {
  8. active: ownProps.filter === state.visibilityFilter
  9. }
  10. }

使用ownProps作为参数后,如果容器组件的参数发生变化,也会引发 UI 组件重新渲染。

connect方法可以省略mapStateToProps参数,那样的话,UI 组件就不会订阅Store,就是说 Store 的更新不会引起 UI 组件的更新。

五、mapDispatchToProps()

mapDispatchToPropsconnect函数的第二个参数,用来建立 UI 组件的参数到store.dispatch方法的映射。也就是说,它定义了哪些用户的操作应该当作 Action,传给 Store。它可以是一个函数,也可以是一个对象。

如果mapDispatchToProps是一个函数,会得到dispatchownProps(容器组件的props对象)两个参数。

  1. const mapDispatchToProps = (
  2. dispatch,
  3. ownProps
  4. ) => {
  5. return {
  6. onClick: () => {
  7. dispatch({
  8. type: 'SET_VISIBILITY_FILTER',
  9. filter: ownProps.filter
  10. });
  11. }
  12. };
  13. }

从上面代码可以看到,mapDispatchToProps作为函数,应该返回一个对象,该对象的每个键值对都是一个映射,定义了 UI 组件的参数怎样发出 Action。

如果mapDispatchToProps是一个对象,它的每个键名也是对应 UI 组件的同名参数,键值应该是一个函数,会被当作 Action creator ,返回的 Action 会由 Redux 自动发出。举例来说,上面的mapDispatchToProps写成对象就是下面这样。

  1. const mapDispatchToProps = {
  2. onClick: (filter) => {
  3. type: 'SET_VISIBILITY_FILTER',
  4. filter: filter
  5. };
  6. }

六、<Provider> 组件

connect方法生成容器组件以后,需要让容器组件拿到state对象,才能生成 UI 组件的参数。

一种解决方法是将state对象作为参数,传入容器组件。但是,这样做比较麻烦,尤其是容器组件可能在很深的层级,一级级将state传下去就很麻烦。

React-Redux 提供Provider组件,可以让容器组件拿到state

  1. import { Provider } from 'react-redux'
  2. import { createStore } from 'redux'
  3. import todoApp from './reducers'
  4. import App from './components/App'
  5.  
  6. let store = createStore(todoApp);
  7.  
  8. render(
  9. <Provider store={store}>
  10. <App />
  11. </Provider>,
  12. document.getElementById('root')
  13. )

上面代码中,Provider在根组件外面包了一层,这样一来,App的所有子组件就默认都可以拿到state了。

它的原理是React组件的context属性,请看源码。

  1. class Provider extends Component {
  2. getChildContext() {
  3. return {
  4. store: this.props.store
  5. };
  6. }
  7. render() {
  8. return this.props.children;
  9. }
  10. }
  11.  
  12. Provider.childContextTypes = {
  13. store: React.PropTypes.object
  14. }

上面代码中,store放在了上下文对象context上面。然后,子组件就可以从context拿到store,代码大致如下。

  1. class VisibleTodoList extends Component {
  2. componentDidMount() {
  3. const { store } = this.context;
  4. this.unsubscribe = store.subscribe(() =>
  5. this.forceUpdate()
  6. );
  7. }
  8.  
  9. render() {
  10. const props = this.props;
  11. const { store } = this.context;
  12. const state = store.getState();
  13. // ...
  14. }
  15. }
  16.  
  17. VisibleTodoList.contextTypes = {
  18. store: React.PropTypes.object
  19. }
React-Redux自动生成的容器组件的代码,就类似上面这样,从而拿到store

七、实例:计数器

我们来看一个实例。下面是一个计数器组件,它是一个纯的 UI 组件。

  1. class Counter extends Component {
  2. render() {
  3. const { value, onIncreaseClick } = this.props
  4. return (
  5. <div>
  6. <span>{value}</span>
  7. <button onClick={onIncreaseClick}>Increase</button>
  8. </div>
  9. )
  10. }
  11. }

上面代码中,这个 UI 组件有两个参数:valueonIncreaseClick。前者需要从state计算得到,后者需要向外发出 Action。

接着,定义valuestate的映射,以及onIncreaseClickdispatch的映射。

  1. function mapStateToProps(state) {
  2. return {
  3. value: state.count
  4. }
  5. }
  6.  
  7. function mapDispatchToProps(dispatch) {
  8. return {
  9. onIncreaseClick: () => dispatch(increaseAction)
  10. }
  11. }
  12.  
  13. // Action Creator
  14. const increaseAction = { type: 'increase' }

然后,使用connect方法生成容器组件。

  1. const App = connect(
  2. mapStateToProps,
  3. mapDispatchToProps
  4. )(Counter)

然后,定义这个组件的 Reducer。

  1. // Reducer
  2. function counter(state = { count: 0 }, action) {
  3. const count = state.count
  4. switch (action.type) {
  5. case 'increase':
  6. return { count: count + 1 }
  7. default:
  8. return state
  9. }
  10. }

最后,生成store对象,并使用Provider在根组件外面包一层。

  1. import { loadState, saveState } from './localStorage';
  2.  
  3. const persistedState = loadState();
  4. const store = createStore(
  5. todoApp,
  6. persistedState
  7. );
  8.  
  9. store.subscribe(throttle(() => {
  10. saveState({
  11. todos: store.getState().todos,
  12. })
  13. }, 1000))
  14.  
  15. ReactDOM.render(
  16. <Provider store={store}>
  17. <App />
  18. </Provider>,
  19. document.getElementById('root')
  20. );
完整的代码看这里

八、React-Router 路由库

使用React-Router的项目,与其他项目没有不同之处,也是使用ProviderRouter外面包一层,毕竟Provider的唯一功能就是传入store对象。

  1. const Root = ({ store }) => (
  2. <Provider store={store}>
  3. <Router>
  4. <Route path="/" component={App} />
  5. </Router>
  6. </Provider>
  7. );