Redux 入門教程(三):React-Redux 的用法

阮一峰發表於2016-09-21

前兩篇教程介紹了 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 元件的例子。


const Title =
  value => <h1>{value}</h1>;

因為不含有狀態,UI 元件又稱為"純元件",即它純函式一樣,純粹由引數決定它的值。

二、容器元件

容器元件的特徵恰恰相反。

  • 負責管理資料和業務邏輯,不負責 UI 的呈現
  • 帶有內部狀態
  • 使用 Redux 的 API

總之,只要記住一句話就可以了:UI 元件負責 UI 的呈現,容器元件負責管理資料和邏輯。

你可能會問,如果一個元件既有 UI 又有業務邏輯,那怎麼辦?回答是,將它拆分成下面的結構:外面是一個容器元件,裡面包了一個UI 元件。前者負責與外部的通訊,將資料傳給後者,由後者渲染出檢視。

React-Redux 規定,所有的 UI 元件都由使用者提供,容器元件則是由 React-Redux 自動生成。也就是說,使用者負責視覺層,狀態管理則是全部交給它。

三、connect()

React-Redux 提供connect方法,用於從 UI 元件生成容器元件。connect的意思,就是將這兩種元件連起來。


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

上面程式碼中,TodoList是 UI 元件,VisibleTodoList就是由 React-Redux 通過connect方法自動生成的容器元件。

但是,因為沒有定義業務邏輯,上面這個容器元件毫無意義,只是 UI 元件的一個單純的包裝層。為了定義業務邏輯,需要給出下面兩方面的資訊。

(1)輸入邏輯:外部的資料(即state物件)如何轉換為 UI 元件的引數

(2)輸出邏輯:使用者發出的動作如何變為 Action 物件,從 UI 元件傳出去。

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


import { connect } from 'react-redux'

const VisibleTodoList = connect(
  mapStateToProps,
  mapDispatchToProps
)(TodoList)

上面程式碼中,connect方法接受兩個引數:mapStateToPropsmapDispatchToProps。它們定義了 UI 元件的業務邏輯。前者負責輸入邏輯,即將state對映到 UI 元件的引數(props),後者負責輸出邏輯,即將使用者對 UI 元件的操作對映成 Action。

四、mapStateToProps()

mapStateToProps是一個函式。它的作用就是像它的名字那樣,建立一個從(外部的)state物件到(UI 元件的)props物件的對映關係。

作為函式,mapStateToProps執行後應該返回一個物件,裡面的每一個鍵值對就是一個對映。請看下面的例子。


const mapStateToProps = (state) => {
  return {
    todos: getVisibleTodos(state.todos, state.visibilityFilter)
  }
}

上面程式碼中,mapStateToProps是一個函式,它接受state作為引數,返回一個物件。這個物件有一個todos屬性,代表 UI 元件的同名引數,後面的getVisibleTodos也是一個函式,可以從state算出 todos 的值。

下面就是getVisibleTodos的一個例子,用來算出todos


const getVisibleTodos = (todos, filter) => {
  switch (filter) {
    case 'SHOW_ALL':
      return todos
    case 'SHOW_COMPLETED':
      return todos.filter(t => t.completed)
    case 'SHOW_ACTIVE':
      return todos.filter(t => !t.completed)
    default:
      throw new Error('Unknown filter: ' + filter)
  }
}

mapStateToProps會訂閱 Store,每當state更新的時候,就會自動執行,重新計算 UI 元件的引數,從而觸發 UI 元件的重新渲染。

mapStateToProps的第一個引數總是state物件,還可以使用第二個引數,代表容器元件的props物件。


// 容器元件的程式碼
//    <FilterLink filter="SHOW_ALL">
//      All
//    </FilterLink>

const mapStateToProps = (state, ownProps) => {
  return {
    active: ownProps.filter === state.visibilityFilter
  }
}

使用ownProps作為引數後,如果容器元件的引數發生變化,也會引發 UI 元件重新渲染。

connect方法可以省略mapStateToProps引數,那樣的話,UI 元件就不會訂閱Store,就是說 Store 的更新不會引起 UI 元件的更新。

五、mapDispatchToProps()

mapDispatchToPropsconnect函式的第二個引數,用來建立 UI 元件的引數到store.dispatch方法的對映。也就是說,它定義了哪些使用者的操作應該當作 Action,傳給 Store。它可以是一個函式,也可以是一個物件。

如果mapDispatchToProps是一個函式,會得到dispatchownProps(容器元件的props物件)兩個引數。


const mapDispatchToProps = (
  dispatch,
  ownProps
) => {
  return {
    onClick: () => {
      dispatch({
        type: 'SET_VISIBILITY_FILTER',
        filter: ownProps.filter
      });
    }
  };
}

從上面程式碼可以看到,mapDispatchToProps作為函式,應該返回一個物件,該物件的每個鍵值對都是一個對映,定義了 UI 元件的引數怎樣發出 Action。

如果mapDispatchToProps是一個物件,它的每個鍵名也是對應 UI 元件的同名引數,鍵值應該是一個函式,會被當作 Action creator ,返回的 Action 會由 Redux 自動發出。舉例來說,上面的mapDispatchToProps寫成物件就是下面這樣。


const mapDispatchToProps = {
  onClick: (filter) => {
    type: 'SET_VISIBILITY_FILTER',
    filter: filter
  };
}

六、<Provider> 元件

connect方法生成容器元件以後,需要讓容器元件拿到state物件,才能生成 UI 元件的引數。

一種解決方法是將state物件作為引數,傳入容器元件。但是,這樣做比較麻煩,尤其是容器元件可能在很深的層級,一級級將state傳下去就很麻煩。

React-Redux 提供Provider元件,可以讓容器元件拿到state


import { Provider } from 'react-redux'
import { createStore } from 'redux'
import todoApp from './reducers'
import App from './components/App'

let store = createStore(todoApp);

render(
  <Provider store={store}>
    <App />
  </Provider>,
  document.getElementById('root')
)

上面程式碼中,Provider在根元件外面包了一層,這樣一來,App的所有子元件就預設都可以拿到state了。

它的原理是React元件的context屬性,請看原始碼。


class Provider extends Component {
  getChildContext() {
    return {
      store: this.props.store
    };
  }
  render() {
    return this.props.children;
  }
}

Provider.childContextTypes = {
  store: React.PropTypes.object
}

上面程式碼中,store放在了上下文物件context上面。然後,子元件就可以從context拿到store,程式碼大致如下。


class VisibleTodoList extends Component {
  componentDidMount() {
    const { store } = this.context;
    this.unsubscribe = store.subscribe(() =>
      this.forceUpdate()
    );
  }

  render() {
    const props = this.props;
    const { store } = this.context;
    const state = store.getState();
    // ...
  }
}

VisibleTodoList.contextTypes = {
  store: React.PropTypes.object
}

React-Redux自動生成的容器元件的程式碼,就類似上面這樣,從而拿到store

七、例項:計數器

我們來看一個例項。下面是一個計數器元件,它是一個純的 UI 元件。


class Counter extends Component {
  render() {
    const { value, onIncreaseClick } = this.props
    return (
      <div>
        <span>{value}</span>
        <button onClick={onIncreaseClick}>Increase</button>
      </div>
    )
  }
}

上面程式碼中,這個 UI 元件有兩個引數:valueonIncreaseClick。前者需要從state計算得到,後者需要向外發出 Action。

接著,定義valuestate的對映,以及onIncreaseClickdispatch的對映。


function mapStateToProps(state) {
  return {
    value: state.count
  }
}

function mapDispatchToProps(dispatch) {
  return {
    onIncreaseClick: () => dispatch(increaseAction)
  }
}

// Action Creator
const increaseAction = { type: 'increase' }

然後,使用connect方法生成容器元件。


const App = connect(
  mapStateToProps,
  mapDispatchToProps
)(Counter)

然後,定義這個元件的 Reducer。


// Reducer
function counter(state = { count: 0 }, action) {
  const count = state.count
  switch (action.type) {
    case 'increase':
      return { count: count + 1 }
    default:
      return state
  }
}

最後,生成store物件,並使用Provider在根元件外面包一層。


import { loadState, saveState } from './localStorage';

const persistedState = loadState();
const store = createStore(
  todoApp,
  persistedState
);

store.subscribe(throttle(() => {
  saveState({
    todos: store.getState().todos,
  })
}, 1000))

ReactDOM.render(
  <Provider store={store}>
    <App />
  </Provider>,
  document.getElementById('root')
);

完整的程式碼看這裡

八、React-Router 路由庫

使用React-Router的專案,與其他專案沒有不同之處,也是使用ProviderRouter外面包一層,畢竟Provider的唯一功能就是傳入store物件。


const Root = ({ store }) => (
  <Provider store={store}>
    <Router>
      <Route path="/" component={App} />
    </Router>
  </Provider>
);

(完)

相關文章