前言
今年3月初发布了react-router v4,相较之前的v3和v2版本做了一个破坏性的升级。遵循一切皆React Component的理念。静态路由变成了动态路由。这里记录下v3项目如何迁移到v4。
项目地址:https://github.com/YutHelloWo...
迁移步骤
对React-Router和Redux同步进行重构
重写路由
代码分割
琐碎的API替换
React-Router和Redux同步
这里我们仍然不使用
react-router-redux
这个库。为了和react-router
v4版本保持一致,react-router-redux
发布了v5.0.0版本,你当然也可以使用它来实现这个功能。
1. 替换依赖包
v3我们引入的是react-router
包,在v4我们只引入react-router-dom
这个包。安装react-router-dom
时会同时安装history
。
package.json
- "react-router": "^3.0.0",+ "react-router-dom": "^4.1.2",
2. 改写对browserHistory的创建和当前location的获取
location.js
// v3 import { browserHistory } from 'react-router' // 获取当前location const initialState = browserHistory.getCurrentLocation()
==>
// v4 import createHistory from 'history/createBrowserHistory' export const history = createHistory() // Get the current location. const initialState = history.location
这里替换的是history,和当前location的获取方法。在v3,browserHistory存在于react-router
中,而v4把history抽离了出来,提供了createBrowserHistory
,createHashHistory
,createMemoryHistory
三种创建history的方法。v4中创建的history导出,在后面会需要用到。
history
API详见: https://github.com/ReactTrain...
3. 对history绑定监听事件,把location的改变同步到Redux的store中
createStore
// v3 import { browserHistory } from 'react-router' import { updateLocation } from './location' store.unsubscribeHistory = browserHistory.listen(updateLocation(store))
updateLocation
用来把location的更新同步到store中。
export const updateLocation = ({ dispatch }) => { return (nextLocation) => dispatch(locationChange(nextLocation)) }
一切似乎都很顺利,接着第一个坑来了
根据history
API提供的
// Listen for changes to the current location. const unlisten = history.listen((location,action) => { // location is an object like window.location console.log(action,location.pathname,location.state) })
修改createStore.js
==>
// v4 import { updateLocation,history } from './location' // 监听浏览器history变化,绑定到store。取消监听直接调用store.unsubscribeHistory() store.unsubscribeHistory = history.listen(updateLocation(store))
接着修改app.js
// v3 // ... import { browserHistory,Router } from 'react-router' // ... <Router history={browserHistory} children={routes} />
==>
// ... import { BrowserRouter,Route } from 'react-router-dom' // ... <BrowserRouter> <div> <Route path='/' component={CoreLayout} /> </div> </BrowserRouter> //...
我们到浏览器中查看,发现URL变化并没有触发updateLocation(store)
,state并没有变化。
What a f**k!
问题出在BrowserRouter
在创建的时候在内部已经引入了一个history
,updateLocation(store)
应该监听的是内部的这个history
。这里贴下BrowserRouter.js的代码
import React from 'react' import PropTypes from 'prop-types' import createHistory from 'history/createBrowserHistory' import { Router } from 'react-router' /** * The public API for a <Router> that uses HTML5 history. */ class BrowserRouter extends React.Component { static propTypes = { basename: PropTypes.string,forceRefresh: PropTypes.bool,getUserConfirmation: PropTypes.func,keyLength: PropTypes.number,children: PropTypes.node } history = createHistory(this.props) render() { return <Router history={this.history} children={this.props.children}/> } } export default BrowserRouter
于是,我们放弃使用BrowserRouter
,而使用Router
。
修改app.js
==>
// v4 import { Router,Route } from 'react-router-dom' //... <Router history={history}> <div> <Route path='/' component={CoreLayout} /> </div> </Router>
这样,这个坑算是填上了。也就完成了history和store之间的同步。
重写路由
v4取消了PlainRoute 中心化配置路由。
Route
是一个react component。
取消了IndexRoute
,通过Switch
来组件提供了相似的功能,当<Switch>
被渲染时,它仅会渲染与当前路径匹配的第一个子<Route>
。
routes/index.js
// v3 //.. export const createRoutes = (store) => ({ path : '/',component : CoreLayout,indexRoute : Home,childRoutes : [ CounterRoute(store),ZenRoute(store),ElapseRoute(store),RouteRoute(store),PageNotFound(),Redirect ] }) //...
==>
// ... const Routes = () => ( <Switch> <Route exact path='/' component={Home} /> <Route path='/counter' component={AsyncCounter} /> <Route path='/zen' component={AsyncZen} /> <Route path='/elapse' component={AsyncElapse} /> <Route path='/route/:id' component={AsyncRoute} /> <Route path='/404' component={AsyncPageNotFound} /> <Redirect from='*' to='/404' /> </Switch> ) export default Routes //
这里路由的定义方式由PlainRoute Object改写成了组件嵌套形式,在PageLayout.js
中插入<Routes />
。
代码分割
v3版本通过
getComponet
和require.ensure
实现代码分割和动态路由。在v4版本,我们新增异步高阶组件,并使用import()
替代require.ensure()
Counter/index.js
// v3 import { injectReducer } from '../../store/reducers' export default (store) => ({ path : 'counter',/* 动态路由 */ getComponent (nextState,cb) { /* 代码分割 */ require.ensure([],(require) => { const Counter = require('./containers/CounterContainer').default const reducer = require('./modules/counter').default /* 将counterReducer注入rootReducer */ injectReducer(store,{ key : 'counter',reducer }) cb(null,Counter) },'counter') } })
首先,新增AsyncComponent.js
import React from 'react' export default function asyncComponent (importComponent) { class AsyncComponent extends React.Component { constructor (props) { super(props) this.state = { component: null,} } async componentDidMount () { const { default : component } = await importComponent() this.setState({ component: component }) } render () { const C = this.state.component return C ? <C {...this.props} /> : null } } return AsyncComponent }
接着,改写Counter/index.js
==>
import { injectReducer } from '../../store/reducers' import { store } from '../../main' import Counter from './containers/CounterContainer' import reducer from './modules/counter' injectReducer(store,reducer }) export default Counter
一旦加载
Counter/index.js
,就会把counterReducer注入到Rudecer中,并加载Counter组件。
琐碎API的替换
this.props.router.push('/')
==>
this.props.history.push('/')
this.props.params.id
==>
this.props.match.params.id
总结
这里可以看出,使用v4替换v3,对于大型项目并不是一件轻松的事情,有许多小坑要踩,这就是社区很多项目仍然使用v2/v3的原因。笔者认为,v4更符合React的组件思想,于是做了一个实践。最后欢迎指正拍砖,捂脸求star 原文链接:https://www.f2er.com/react/303249.html