taro使用 Redux官方教程

在 Taro 中可以自由地使用 React 生态中非常流行的数据流管理工具 Redux 来解决复杂项目的数据管理问题。而为了更方便地使用 Redux ，Taro 提供了与 react-redux API 几乎一致的包 @tarojs/redux 来让开发人员获得更加良好的开发体验。

下文中示例代码均在 taro-redux-sample

首先请安装 redux 、 @tarojs/redux 和 @tarojs/redux-h5，以及一些需要用到的 redux 中间件

$ yarn add redux @tarojs/redux @tarojs/redux-h5 redux-thunk redux-logger
# 或者使用 npm
$ npm install --save redux @tarojs/redux @tarojs/redux-h5 redux-thunk redux-logger

随后可以在项目 src 目录下新增一个 store 目录，在目录下增加 index.js 文件用来配置 store，按自己喜好设置 redux 的中间件，例如下面例子中使用 redux-thunk 和 redux-logger 这两个中间件

// src/store/index.js
import { createStore, applyMiddleware } from 'redux'
import thunkMiddleware from 'redux-thunk'
import { createLogger } from 'redux-logger'
import rootReducer from '../reducers'
 
const middlewares = [
thunkMiddleware,
createLogger()
]
 
export default function configStore () {
const store = createStore(rootReducer, applyMiddleware(...middlewares))
return store
}

接下来在项目入口文件 app.js 中使用 @tarojs/redux 中提供的 Provider 组件将前面写好的 store 接入应用中

// src/app.js
import Taro, { Component } from '@tarojs/taro'
import { Provider } from '@tarojs/redux'
 
import configStore from './store'
import Index from './pages/index'
 
import './app.scss'
 
const store = configStore()
 
class App extends Component {
render() {
return (
<Provider store={store}>
{this.props.children}
</Provider>
)
}
}
 
Taro.render(<App />, document.getElementById('app'))

 

然后就可以开始使用了。如 redux 推荐的那样，可以增加

• constants 目录，用来放置所有的 action type 常量
• actions 目录，用来放置所有的 actions
• reducers 目录，用来放置所有的 reducers

例如我们要开发一个简单的加、减计数器功能

新增 action type

// src/constants/counter.js
export const ADD = 'ADD'
export const MINUS = 'MINUS'

新增 reducer 处理

// src/reducers/counter.js

import { ADD, MINUS } from '../constants/counter'
 
const INITIAL_STATE = {
num: 0
}
 
export default function counter (state = INITIAL_STATE, action) {
switch (action.type) {
case ADD:
return {
...state,
num: state.num + 1
}
case MINUS:
return {
...state,
num: state.num - 1
}
default:
return state
}
}

// src/reducers/index.js
import { combineReducers } from 'redux'
import counter from './counter'
 
export default combineReducers({
counter
})

 

新增 action 处理

// src/actions/counter.js

import {
ADD,
MINUS
} from '../constants/counter'
 
export const add = () => {
return {
type: ADD
}
}
export const minus = () => {
return {
type: MINUS
}
}
 
// 异步的 action
export function asyncAdd () {
return dispatch => {
setTimeout(() => {
dispatch(add())
}, 2000)
}
}

 

最后，我们可以在页面（或者组件）中进行使用，我们将通过 tarojs/redux 提供的 connect 方法将 redux 与我们的页面进行连接

// src/pages/index/index.js

import Taro, { Component } from '@tarojs/taro'
import { View, Text } from '@tarojs/components'
import { connect } from '@tarojs/redux'
import './index.scss'
 
import { add, minus, asyncAdd } from '../../actions/counter'
 
@connect(({ counter }) => ({
counter
}), (dispatch) => ({
add () {
dispatch(add())
},
dec () {
dispatch(minus())
},
asyncAdd () {
dispatch(asyncAdd())
}
}))
class Index extends Component {
config = {
navigationBarTitleText: '首页'
}
 
render () {
return (
<View className='todo'>
<Button className='add_btn' onClick={this.props.add}>+</Button>
<Button className='dec_btn' onClick={this.props.dec}>-</Button>
<Button className='dec_btn' onClick={this.props.asyncAdd}>async</Button>
<View>{this.props.counter.num}</View>
</View>
)
}
}
 
export default Index

connect 方法接受两个参数 mapStateToProps 与 mapDispatchToProps

• mapStateToProps，函数类型，接受最新的 state 作为参数，用于将 state 映射到组件的 props
• mapDispatchToProps，函数类型，接收 dispatch() 方法并返回期望注入到展示组件的 props 中的回调方法

#Hooks

#在 Redux 中使用 Hooks

使用 hooks 的基本设置和使用 connect 的设置是一样的，你需要设置你的 store，并把你的应用放在 Provider 组件中。

const store = configreStore(rootReducer)
 
class App extends Components {
render () {
return (
<Provider store={store}>
<Index />
</Provider>
)
}
}

在这样的情况下，你就可以使用 taro-redux 提供的 Hooks API 在函数式组件中使用。

#useSelector

const result : any = useSelector(selector : Function, equalityFn? : Function)

useSelector 允许你使用 selector 函数从一个 Redux Store 中获取数据。

Selector 函数大致相当于 connect 函数的 mapStateToProps 参数。Selector 会在组件每次渲染时调用。useSelector 同样会订阅 Redux store，在 Redux action 被 dispatch 时调用。

但 useSelector 还是和 mapStateToProps 有一些不同：

• 不像 mapStateToProps 只返回对象一样，Selector 可能会返回任何值。
• 当一个 action dispatch 时，useSelector 会把 selector 的前后返回值做一次浅对比，如果不同，组件会强制更新。
• Selector 函数不接受 ownProps 参数。但 selector 可以通过闭包访问函数式组件传递下来的 props。

#使用案例

基本使用：

import Taro, { Components } from '@tarojs/taro'
import { useSelector } from '@tarojs/redux'
 
export const CounterComponent = () => {
const counter = useSelector(state => state.counter)
return <View>{counter}</View>
}

使用闭包决定如何 select 数据：

export const TodoListItem = props => {
const todo = useSelector(state => state.todos[props.id])
return <View>{todo.text}</View>
}

 

#进阶使用

你还可以访问 react-redux 文档 了解如何使用 reselect 缓存 selector。

#useDispatch

const dispatch = useDispatch()

这个 Hook 返回 Redux store 的 dispatch 引用。你可以使用它来 dispatch actions。

#使用案例

import Taro, { Components } from '@tarojs/taro'
import { useDispatch } from '@tarojs/redux'
 
export const CounterComponent = ({ value }) => {
const dispatch = useDispatch()
 
return (
<View>
<Text>{value}</Text>
<Button onClick={() => dispatch({ type: 'increment-counter' })}>
Increment counter
</Button>
</View>
)
}

当我们使用 dispatch 传递回调到一个子组件时，推荐使用 useCallback 把回调缓存起来，因为组件可能因为引用改变而重新渲染。

// CounterComponent.js

export const CounterComponent = ({ value }) => {
const dispatch = useDispatch()
const incrementCounter = useCallback(
() => dispatch({ type: 'increment-counter' }),
[dispatch]
)
 
return (
<View>
<Text>{value}</Text>
<MyIncrementButton onIncrement={incrementCounter} />
</View>
)
}
 
// IncrementButton.js
const MyIncrementButton = ({ onIncrement }) => (
<Button onClick={onIncrement}>Increment counter</Button>
)
 
export default Taro.memo(MyIncrementButton)

#useStore

const store = useStore()

useStore 返回一个 store 引用和 Provider 组件引用完全一致。

这个 hook 可能并不经常使用。useSelector 大部分情况是你的第一选择，如果需要替换 reducers 的情况下可能会使用到这个 API。

#使用案例

import Taro, { Components } from '@tarojs/taro'
import { useStore } from '@tarojs/redux'
 
export const CounterComponent = ({ value }) => {
const store = useStore()
 
// EXAMPLE ONLY! Do not do this in a real app.
// The component will not automatically update if the store state changes
return <div>{store.getState()}</div>
}