升级到React-Router-v6

前言

近期完成了公司新项目的开发,相关的技术栈都用到了最新版本,react router 也使用了 v6 的版本,所以借这个机会自己再梳理下 react router v5 与 v6 的区别,以及 v6 一些新特性。而在原有项目还是使用老版本 react router 的情况下,不太建议急着直接升级,可能存在较多的改动。

v5 升级 v6 指南

全部换成

v5


  

  
    
    
    
    
  


// Category.tsx

  
  

Switch 组件作用:渲染第一个被 location 匹配到的并且作为子元素的 或者 ,它仅仅只会渲染一个路径

v6


  

  
    } path="/home">
    } path="/list">
    } path="/detail">
    } path="/category">      {/* children 写法嵌套子路由,path是相对路径 */}      } path="a">
      } path="b">
    
  

Switch 相比,Routes 的主要优点是:

  • Routes 内的所有 的 path 支持相对路由(如果以/开头的则是绝对路由)。这使得 中的代码更精简、更可预测
  • 路由基于最佳 path 匹配的,而不是按顺序遍历选择的
  • 路由可以嵌套在同一个地方而不必分散在不同的组件中

注意:

  • 不能认为 Routes 作为 Switch 的替代品。Switch 功能是匹配唯一的 Route 组件但它本身是可选的,可使用Route组件而不使用Switch组件。但只要使用Route组件则 v6 的Routes组件是必选的, Routes 必须套在最外层才可以使用Route组件,否则会报错。

Route 组件属性

Routerendercomponent 改为 element

// v5

// v6
} path="/home">

简化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 模式,即匹配时是否忽略大小写


所有路径匹配都会忽略 URL 上的尾部斜杠

新增 Outlet 组件

作用:通常用于渲染子路由,类似插槽的作用,用于匹配子路由的 element

export default function Category() {
  return (
    
跳转 CategoryA
跳转 CategoryB
{/* 自动匹配子路由的渲染 */}
) }

Link 组件属性

to 属性有无 / 与当前 URL 的区别

在 v5 中,如果 to 没有以 / 开头的话会充满不确定性,这取决于当前的 URL。

比如当前 URL 是/category, 会渲染成 ; 而当前 URL 如果是 /category/,那么又会渲染成

在 v6 中,无论当前 URL 是 /category 还是 /category/ 都会渲染成 ,即忽略 URL 上的尾部斜杠统一规则处理。

to 属性支持相对位置与'..' 和'.'等写法

  • 当前页面:CategoryA
  • 当前url:/category/a
  • {/* /list */} 跳转到list页面
  • {/* /category/b */} 跳转到category/b页面
  • {/* /category/a */} 跳转到当前路由

直接传 state 属性

// v5:


// v6:

新增 target 属性

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

NavLink

  • 属性名改为了
  • 移除activeStyleactiveClassName属性
 ({ color: isActive ? 'green' : 'blue' })}
>
  Messages

移除Redirect重定向组件

移除的主要原因是不利于 SEO

// v5


// v6 使用 Navigate 组件替代
} />

新增 useNavigate 代替 useHistory

函数组件可以使用useHistory获取history对象,用来做页面跳转导航

参考React实战视频讲解:进入学习

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

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

  return (
    
{ history.push('/list') }} > 编程式路由跳转list页面
) } // v6 import { useNavigate } from 'react-router-dom' export default function Menu() { const navigate = useNavigate() return (
{ navigate('/list') // 等价于 history.push }} > 编程式路由跳转list页面
) }

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

//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使用必须在里面
  • 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:  },
    { path: '/list', element:  },
  ])

  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 (
    
{ setSearchParams({ name: 'jacky' }) }} > 当前页面:Detail 点我设置url查询参数为name=jacky
) }

不支持

在老版本中,Prompt组件可以实现页面关闭的拦截,但它在 v6 版本还暂不支持,如果想 v5 升级 v6 就要考虑清楚了。

// v5

总结

v5 和 v6 在使用层面的区别总结:

  • 全部换成
  • Route 新特性变更

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

你可能感兴趣的:(react.js)