天天看點

React-redux架構之connect()與Provider元件 用法講解react-reduxUI 元件容器元件connect()mapStateToProps()mapDispatchToProps()<Provider> 元件執行個體:計數器

react-redux

在react-redux 架構中,給我提供了兩個常用的API來配合Redux架構的使用,其實在我們的實際項目開發中,我們完全可以不用react-redux架構,但是如果使用此架構,就如虎添翼了。

我們來簡單聊聊這兩個常用的API

  • connect()
  • Provider 元件

React-Redux 将所有元件分成兩大類:UI 元件(presentational component)和容器元件(container component)。

UI 元件

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 元件的一個單純的包裝層。為了定義業務邏輯,需要給出下面兩方面的資訊。

  • 輸入邏輯:外部的資料(即state對象)如何轉換為 UI 元件的參數
  • 輸出邏輯:使用者發出的動作如何變為 Action 對象,從 UI 元件傳出去。

是以,connect方法的完整 API 如下。

import { connect } from 'react-redux'

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

上面代碼中,connect方法接受兩個參數:mapStateToProps和mapDispatchToProps。它們定義了 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()

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

如果mapDispatchToProps是一個函數,會得到dispatch和ownProps(容器元件的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 元件有兩個參數:value和onIncreaseClick。前者需要從state計算得到,後者需要向外發出 Action。      

接着,定義value到state的映射,以及onIncreaseClick到dispatch的映射。

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')
);