使用 Mobx

自 1.2.0-beta.1 开始支持

Mobx 为复杂项目中状态管理提供了一种简单高效的机制；Taro 提供了 @tarojs/mobx 来让开发人员在使用Mobx的过程中获得更加良好的开发体验。

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

首先请安装 mobx 、 @tarojs/mobx 、 @tarojs/mobx-h5 和 @tarojs/mobx-rn

$ yarn add mobx @tarojs/mobx @tarojs/mobx-h5 @tarojs/mobx-rn
# 或者使用 npm
$ npm install --save mobx @tarojs/mobx @tarojs/mobx-h5 @tarojs/mobx-rn

随后可以在项目 src 目录下新增一个 store/counter.js 文件

// src/store/counter.js
import { observable } from 'mobx'

const counterStore = observable({
  counter: 0,
  counterStore() {
    this.counter++
  },
  increment() {
    this.counter++
  },
  decrement() {
    this.counter--
  },
  incrementAsync() {
    setTimeout(() => {
      this.counter++
    }, 1000)
  }
})

export default counterStore

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

// src/app.js
import Taro, { Component } from '@tarojs/taro'
import { Provider } from '@tarojs/mobx'
import Index from './pages/index'

import counterStore from './store/counter'

import './app.scss'

const store = {
  counterStore
}

class App extends Component {

  config = {
    pages: [
      'pages/index/index'
    ],
    window: {
      backgroundTextStyle: 'light',
      navigationBarBackgroundColor: '#fff',
      navigationBarTitleText: 'WeChat',
      navigationBarTextStyle: 'black'
    }
  }

  componentDidMount () {}

  componentDidShow () {}

  componentDidHide () {}

  componentDidCatchError () {}

  render () {
    return (
      <Provider store={store}>
        <Index />
      </Provider>
    )
  }
}

Taro.render(<App />, document.getElementById('app'))

然后，我们在页面中可通过 @tarojs/mobx 提供的 inject 以及 observer 方法将 mobx 与我们的页面进行关联

// src/pages/index/index.js
import Taro, { Component } from '@tarojs/taro'
import { View, Button, Text } from '@tarojs/components'
import { observer, inject } from '@tarojs/mobx'

import './index.scss'

@inject('counterStore')
@observer
class Index extends Component {

  config = {
    navigationBarTitleText: '首页'
  }

  componentWillMount () { }

  componentWillReact () {
    console.log('componentWillRect')
  }

  componentDidMount () { }

  componentWillUnmount () { }

  componentDidShow () { }

  componentDidHide () { }

  increment = () => {
    const { counterStore } = this.props
    counterStore.increment()
  }

  decrement = () => {
    const { counterStore } = this.props
    counterStore.decrement()
  }

  incrementAsync = () => {
    const { counterStore } = this.props
    counterStore.incrementAsync()
  }

  render () {
    const { counterStore: { counter } } = this.props
    return (
      <View className='index'>
        <Button onClick={this.increment}>+</Button>
        <Button onClick={this.decrement}>-</Button>
        <Button onClick={this.incrementAsync}>Add Async</Button>
        <Text>{counter}</Text>
      </View>
    )
  }
}

export default Index

上例中 Provider、inject、 observer的使用方式基本上与mobx-react 保持了一致，但也有以下几点需要注意：

  • Provider不支持嵌套，即全局只能存在一个Provider
  • 在 mobx-react中，可通过以下方式设置store：
  <Provider store1={xxxx} store2={xxxx}>
    <XXX />
  </Provider>

而在@tarojs/mobx中，我们需要使用以下方式设置：

  const store = {
    store1: xxxx,
    store2: xxxx
  }
  <Provider store={store}>
    <XXX />
  </Provider>
  • inject、 observer 不能在stateless组件上使用
  • observer 不支持任何参数
  • 按照以下方式使用 inject 时，不能省略observer的显式调用：
  @inject((stores, props) => ({
    counterStore: stores.counterStore
  }))
  @observer //这个不能省略

注意事项：

  • 在Component的render方法中，如果需要使用一个observable 对象（该例中为counter），您需要：
  const { counterStore: { counter } } = this.props
  return (
     <Text>{counter}</Text>
  )

而非：

  const { counterStore } = this.props
  return (
     <Text>{counterStore.counter}</Text>
  )
  • 自1.2.0-beta.5后，propTypes已从taro-mobx、taro-mobx-h5、taro-mobx-rn中剥离，如需使用，请单独进行安装：
  $ yarn add @tarojs/mobx-prop-types
  # 或者使用 npm
  $ npm install --save @tarojs/mobx-prop-types

propTypes 使用与mobx-react 一致