详解Redux的connect方法

上面一篇文章，我们只是从Demo的角度讲解了Redux，对于connect的部分，我们只是一笔带过。

那么我们这篇文章同样是基于上一篇文章中的Demo，来从实战的角度来详细讲解下connect方法。

connect方法声明如下：

connect([mapStateToProps], [mapDispatchToProps], [mergeProps],[options])

作用：连接 React 组件与 Redux store。

连接操作不会改变原来的组件类，反而返回一个新的已与 Redux store 连接的组件类。

参数

[mapStateToProps(state, [ownProps]): stateProps] (Function): 如果定义该参数，组件将会监听 Redux store 的变化。任何时候，只要 Redux store 发生改变，mapStateToProps 函数就会被调用。该回调函数必须返回一个纯对象，这个对象会与组件的 props 合并。如果你省略了这个参数，你的组件将不会监听 Redux store。如果指定了该回调函数中的第二个参数 ownProps，则该参数的值为传递到组件的 props，而且只要组件接收到新的 props，mapStateToProps 也会被调用。

[mapDispatchToProps(dispatch, [ownProps]): dispatchProps] (Object or Function): 如果传递的是一个对象，那么每个定义在该对象的函数都将被当作 Redux action creator，而且这个对象会与 Redux store 绑定在一起，其中所定义的方法名将作为属性名，合并到组件的 props 中。如果传递的是一个函数，该函数将接收一个 dispatch 函数，然后由你来决定如何返回一个对象，这个对象通过 dispatch 函数与 action creator 以某种方式绑定在一起（提示：你也许会用到 Redux 的辅助函数 bindActionCreators()）。如果你省略这个 mapDispatchToProps 参数，默认情况下，dispatch 会注入到你的组件 props 中。如果指定了该回调函数中第二个参数 ownProps，该参数的值为传递到组件的 props，而且只要组件接收到新 props，mapDispatchToProps 也会被调用。

[mergeProps(stateProps, dispatchProps, ownProps): props] (Function): 如果指定了这个参数，mapStateToProps() 与 mapDispatchToProps() 的执行结果和组件自身的 props 将传入到这个回调函数中。该回调函数返回的对象将作为 props 传递到被包装的组件中。你也许可以用这个回调函数，根据组件的 props 来筛选部分的 state 数据，或者把 props 中的某个特定变量与 action creator 绑定在一起。如果你省略这个参数，默认情况下返回 Object.assign({}, ownProps, stateProps, dispatchProps) 的结果。

[options] (Object) 如果指定这个参数，可以定制 connector 的行为。

[pure = true] (Boolean): 如果为 true，connector 将执行 shouldComponentUpdate 并且浅对比 mergeProps 的结果，避免不必要的更新，前提是当前组件是一个“纯”组件，它不依赖于任何的输入或 state 而只依赖于 props 和 Redux store 的 state。默认值为 true。

[withRef = false] (Boolean): 如果为 true，connector 会保存一个对被包装组件实例的引用，该引用通过 getWrappedInstance() 方法获得。默认值为 false

返回值

根据配置信息，返回一个注入了 state 和 action creator 的 React 组件。

静态属性

WrappedComponent (Component): 传递到 connect() 函数的原始组件类。

静态方法

组件原来的静态方法都被提升到被包装的 React 组件。

实例方法

getWrappedInstance(): ReactComponent

仅当 connect() 函数的第四个参数 options 设置了 { withRef: true } 才返回被包装的组件实例。

备注：

1、 函数将被调用两次。第一次是设置参数，第二次是组件与 Redux store 连接：connect(mapStateToProps, mapDispatchToProps, mergeProps)(MyComponent)。

2、 connect 函数不会修改传入的 React 组件，返回的是一个新的已与 Redux store 连接的组件，而且你应该使用这个新组件。

3、 mapStateToProps 函数接收整个 Redux store 的 state 作为 props，然后返回一个传入到组件 props 的对象。该函数被称之为 selector。

=====================我是华丽丽的分割线=========================

我们开始通过代码来讲解。

[javascript] view plain copy

1. export default connect(mapStateToProps,mapDispatchToProps,mergeProps)(AddTodo);  

1、mapStateToProps

这个函数的作用是确定哪些 Redux 全局的 state 是我们组件想要通过 props 获取的？

方法一：

//把整个state都返回，不建议这么做

[javascript] view plain copy

1. const mapStateToProps = (state)=> state;  

方法二：

//将state的部分返回

[javascript] view plain copy

1. const mapStateToProps = (state)=>{  
2.   return {  
3.     num:state.num ,  
4.     text:state.text,  
5.   }  
6. }  

2、mapDispatchToProps

这个方法的作用是确定 哪些 action 创建函数是我们想要通过 props 获取的？

如果你省略这个 mapDispatchToProps 参数，默认情况下，dispatch 会注入到你的组件 props 中。

这也就是我们上一篇文章为什么可以直接从props中获取dispatch。

我们先来看看我们的Action，定义了3个Action

[javascript] view plain copy

1. export const addTodo = (num) => {  
2.   return {  
3.     type: 'INCREMENT',  
4.     num: num,  
5.   }  
6. }  
7.   
8. export const decTodo = (num) => {  
9.   return {  
10.     type: 'DECREMENT',  
11.     num: num,  
12.   }  
13. }  
14.   
15. export const updateText = (text) => {  
16.   return {  
17.     type: 'TEXT_UPDATE',  
18.     text: text,  
19.   }  
20. }  

我们引入action 的方式有2种

方法一：

[javascript] view plain copy

1. import { addTodo,decTodo,updateText } from '../actions’  

方法二：

//es5 不支持

[javascript] view plain copy

1. import * as actionCreators from '../actions';  

我们需要导入 bindActionCreators

[javascript] view plain copy

1. import { bindActionCreators } from 'redux';  

定义mapDispatchToProps函数也有2种方法

方法一：

[javascript] view plain copy

1. const mapDispatchToProps = (dispatch)=>{  
2.   return bindActionCreators(actionCreators,dispatch);  
3.   
4.    return {  
5.      addTodo:bindActionCreators({ addTodo }, dispatch),  
6.      decTodo:bindActionCreators({ decTodo }, dispatch),  
7.      updateText:bindActionCreators({ updateText }, dispatch)  
8.   }  
9. }  

方法二：

[javascript] view plain copy

1. const mapDispatchToProps = (dispatch)=>{  
2.   // 此处直接返回，我们也可以设置一个key  
3.   //  actions:bindActionCreators(actionCreators,dispatch);  
4.    
5.   return bindActionCreators(actionCreators,dispatch);  
6. }  

3、mergeProps

[javascript] view plain copy

1. function mergeProps(stateProps, dispatchProps, ownProps) {  
2.   return Object.assign({}, ownProps, stateProps, dispatchProps);  
3. }  

如果你省略这个参数，默认情况下返回 Object.assign({}, ownProps, stateProps, dispatchProps) 的结果。

通常情况下，我们都需要修改这个函数。

那么我们的View也需要变动

[javascript] view plain copy

1. <TouchableHighlight style={styles.itemView} underlayColor="red" onPress={()=>this.props.addTodo(1)}>  
2.     <Text style={styles.itemText}>  
3.       点击我就+1  
4.     </Text>  
5. </TouchableHighlight>  

此时：

[javascript] view plain copy

1. onPress={()=>{dispatch(addTodo(1))}}  

变为

[javascript] view plain copy

1. onPress={()=>this.props.addTodo(1)}  

从props中获取Action（addTodo）。

这样你也就基本了解Redux的connect方法做什么事情了吧。

参考：http://cn.redux./docs/react-redux/api.html