关于react.js:升级-React-Router-v6-指南

前言

近期实现了公司新我的项目的开发，相干的技术栈都用到了最新版本，react router 也应用了 v6 的版本，所以借这个机会本人再梳理下 react router v5 与 v6 的区别，以及 v6 一些新个性。而在原有我的项目还是应用老版本 react router 的状况下，不太倡议急着间接降级，可能存在较多的改变。

本文也会同步在我的 Github 博客

v5 降级 v6 指南

<Switch>全副换成<Routes>

v5

<BrowserRouter>
  <Menu />

  <Switch>
    <Route component={Home} path="/home"></Route>
    <Route component={List} path="/list"></Route>
    <Route component={Detail} path="/detail"></Route>
    <Route component={Category} path="/category"></Route>
  </Switch>
</BrowserRouter>

// Category.tsx
<Switch>
  <Route component={CategoryA} path="/category/a"></Route>
  <Route component={CategoryB} path="/category/b"></Route>
</Switch>

Switch 组件作用：渲染第一个被 location 匹配到的并且作为子元素的 <Route> 或者 <Redirect>，它仅仅只会渲染一个门路

v6

<BrowserRouter>
  <Menu />

  <Routes>
    <Route element={<Home />} path="/home"></Route>
    <Route element={<List />} path="/list"></Route>
    <Route element={<Detail />} path="/detail"></Route>
    <Route element={<Category />} path="/category">
      {/* children 写法嵌套子路由，path 是相对路径 */}
      <Route element={<CategoryA />} path="a"></Route>
      <Route element={<CategoryB />} path="b"></Route>
    </Route>
  </Routes>
</BrowserRouter>

与  Switch  相比，Routes  的次要长处是:

• Routes 内的所有 <Route> 和 <Link>的 path 反对绝对路由（如果以 / 结尾的则是相对路由）。这使得 <Route path> 和 <Link to> 中的代码更精简、更可预测
• 路由基于最佳 path 匹配的，而不是按程序遍历抉择的
• 路由能够嵌套在同一个中央而不用扩散在不同的组件中

留神：

• 不能认为 Routes 作为 Switch 的替代品。Switch 性能是匹配惟一的 Route 组件但它自身是可选的，可应用 Route 组件而不应用 Switch 组件。但只有应用 Route 组件则 v6 的 Routes 组件是必选的，Routes 必须套在最外层才能够应用 Route 组件，否则会报错。

Route 组件属性

Route 的 render 或 component 改为  element

// v5
<Route component={Home} path="/home"></Route>
// v6
<Route element={<Home />} path="/home"></Route>

简化 path 格局，只反对两种动静占位符

• :id  动静参数
• *  通配符，只能在 path 的 开端 应用，如 users/*

v6 path的正确写法：

/groups
/groups/admin
/users/:id
/users/:id/messages
/files/*
/files/:id/*

v6 path谬误的写法

/users/:id? // ? 不满足下面两种格局
/tweets/:id(\d+) // 有正则表达式，不满足
/files/*/cat.jpg
/files-*

路由匹配的辨别大小写开启  caseSensitive

caseSensitive，用于正则匹配 path 时是否开启 ignore 模式，即匹配时是否疏忽大小写

<Routes caseSensitive>

所有门路匹配都会疏忽 URL 上的尾部斜杠

新增 Outlet 组件

作用：通常用于渲染子路由，相似插槽的作用，用于匹配子路由的 element

export default function Category() {
  return (
    <div>
      <div>
        <Link to="a"> 跳转 CategoryA</Link>
      </div>
      <div>
        <Link to="b"> 跳转 CategoryB</Link>
      </div>

      {/* 主动匹配子路由的渲染 */}
      <Outlet />
    </div>
  )
}

Link 组件属性

to 属性有无 / 与以后 URL 的区别

在 v5 中，如果 to 没有以 / 结尾的话会充斥不确定性，这取决于以后的 URL。

比方以后 URL 是/category, <Link to="a"> 会渲染成 <a href="/a">；而以后 URL 如果是 /category/，那么又会渲染成 <a href="/category/a">。

在 v6 中，无论以后 URL 是  /category  还是  /category/，<Link to="a">  都会渲染成  <a href='/category/a'>，即疏忽 URL 上的尾部斜杠对立规定解决。

to 属性反对绝对地位与 ’..’ 和 ’.’ 等写法

<ul>
  <li> 以后页面：CategoryA</li>
  <li> 以后 url：/category/a</li>
  <li>
    {/* /list */}
    <Link to="../../list"> 跳转到 list 页面 </Link>
  </li>
  <li>
    {/* /category/b */}
    <Link to="../b"> 跳转到 category/ b 页面 </Link>
  </li>
  <li>
    {/* /category/a */}
    <Link to="."> 跳转到以后路由 </Link>
  </li>
</ul>

间接传 state 属性

// v5:
<Link to={{pathname: "/home", state: state}} />

// v6:
<Link to="/home" state={state} />

新增 target 属性

type HTMLAttributeAnchorTarget = '_self' | '_blank' | '_parent' | '_top' | (string & {})

NavLink

• <NavLink exact>  属性名改为了  <NavLink end>
• 移除 activeStyle、activeClassName 属性

<NavLink
  to="/messages"
- style={{color: 'blue'}}
- activeStyle={{color: 'green'}}
+ style={({isActive}) => ({color: isActive ? 'green' : 'blue'})}
>
  Messages
</NavLink>

移除 Redirect 重定向组件

移除的次要起因是不利于 SEO

// v5
<Redirect from="/404" to="/home" />

// v6 应用 Navigate 组件代替
<Route path="/404" element={<Navigate to="/home" replace />} />

新增 useNavigate 代替 useHistory

函数组件能够应用 useHistory 获取 history 对象，用来做页面跳转导航

// v5
import {useHistory} from 'react-router-dom'

export default function Menu() {const history = useHistory()

  return (
    <div>
      <div
        onClick={() => {history.push('/list')
        }}
      >
        编程式路由跳转 list 页面
      </div>
    </div>
  )
}

// v6
import {useNavigate} from 'react-router-dom'

export default function Menu() {const navigate = useNavigate()

  return (
    <div>
      <div
        onClick={() => {navigate('/list') // 等价于 history.push
        }}
      >
        编程式路由跳转 list 页面
      </div>
    </div>
  )
}

上面再列举其它其它的区别用法

//v5
history.replace('/list')
// v6
navigate('/list', { replace: true})

// v5
history.go(1)
history.go(-1)

// v6
navigate(1)
navigate(-1)

新增 useRoutes 代替 react-router-config

useRoutes 依据路由表生成对应的路由规定

useRoutes应用必须在 <Router> 外面

• react-router-config：用于集中管理路由配置

import {useRoutes} from 'react-router-dom'
import Home from './components/Home'
import List from './components/List'

function App() {
  const element = useRoutes([{ path: '/home', element: <Home />},
    {path: '/list', element: <List />},
  ])

  return element
}

export default App

新增 useSearchParams

v6 提供  useSearchParams  返回一个数组来获取和设置 url 参数

import {useSearchParams} from 'react-router-dom'

export default function Detail() {const [searchParams, setSearchParams] = useSearchParams()

  console.log('getParams', searchParams.get('name'))
  return (
    <div
      onClick={() => {setSearchParams({ name: 'jacky'})
      }}
    >
      以后页面：Detail 点我设置 url 查问参数为 name=jacky
    </div>
  )
}

不反对 <Prompt>

在老版本中，Prompt组件能够实现页面敞开的拦挡，但它在 v6 版本还暂不反对，如果想 v5 降级 v6 就要思考分明了。

// v5
<Prompt
  when={formIsHalfFilledOut}
  message="Are you sure you want to leave?"
/>

总结

v5 和 v6 在应用层面的区别总结：

• <Switch> 全副换成 <Routes>

• Route 新个性变更

  • render 和 component 改为 element，且反对嵌套路由
  • path 反对相对路径；简化 path 格局，只反对两种动静占位符
  • 路由匹配的辨别大小写开启  caseSensitive
  • 所有门路匹配都会疏忽 URL 上的尾部斜杠/
• 新增 Outlet 组件用于渲染匹配到的子路由
• 移除 Redirect 重定向组件，因为不利于 SEO
• 新增 useNavigate 代替 useHistory
• 新增 useRoutes 代替 react-router-config
• 新增 useSearchParams 来获取和设置 url 参数

本文的 Demo 地址

参考文章

• React Router
• upgrade-to-react-router-v6