React Router 6

React Router 6 快速上手

概述

1. React Router 以三个不同的包发布到 npm 上，它们分别为：

   1. react-router: 路由的核心库，提供了很多的：组件、钩子。
   2. react-router-dom: 包含react-router所有内容，并添加一些专门用于 DOM 的组件，例如 <BrowserRouter>等 。
   3. react-router-native: 包括react-router所有内容，并添加一些专门用于ReactNative的API，例如:<NativeRouter>等。

2. 与React Router 5.x 版本相比，改变了什么？

   1. 内置组件的变化：移除<Switch/> ，新增 <Routes/>等。

   2. 语法的变化：component={About} 变为 element={<About/>}等。

   3. 新增多个hook：useParams、useNavigate、useMatch等。

   4. 官方明确推荐函数式组件了！！！

      ……

Component

<BrowserRouter>

1. 说明：<BrowserRouter>用于包裹整个应用。

2. 示例代码：

   import React from "react";
   import ReactDOM from "react-dom";
   import { BrowserRouter } from "react-router-dom";
   
   ReactDOM.render(
     <BrowserRouter>
       {/* 整体结构（通常为App组件） */}
     </BrowserRouter>,root
   );

<HashRouter>

1. 说明：作用与<BrowserRouter>一样，但<HashRouter>修改的是地址栏的hash值。
2. 备注：6.x版本中<HashRouter>、<BrowserRouter> 的用法与 5.x 相同。

<Routes/> 与 <Route/>

1. v6版本中移出了先前的<Switch>，引入了新的替代者：<Routes>。

2. <Routes> 和 <Route>要配合使用，且必须要用<Routes>包裹<Route>。

3. <Route> 相当于一个 if 语句，如果其路径与当前 URL 匹配，则呈现其对应的组件。

4. <Route caseSensitive> 属性用于指定：匹配时是否区分大小写（默认为 false）。

5. 当URL发生变化时，<Routes>都会查看其所有子<Route> 元素以找到最佳匹配并呈现组件 。

6. <Route> 也可以嵌套使用，且可配合useRoutes()配置 “路由表” ，但需要通过 <Outlet> 组件来渲染其子路由。

7. 示例代码：

   <Routes>
       /*path属性用于定义路径，element属性用于定义当前路径所对应的组件*/
       <Route path="/login" element={<Login />}></Route>
   
   		/*用于定义嵌套路由，home是一级路由，对应的路径/home*/
       <Route path="home" element={<Home />}>
          /*test1 和 test2 是二级路由,对应的路径是/home/test1 或 /home/test2*/
         <Route path="test1" element={<Test/>}></Route>
         <Route path="test2" element={<Test2/>}></Route>
   		</Route>
   	
   		//Route也可以不写element属性, 这时就是用于展示嵌套的路由 .所对应的路径是/users/xxx
       <Route path="users">
          <Route path="xxx" element={<Demo />} />
       </Route>
   </Routes>

<Link>

1. 作用: 修改URL，且不发送网络请求（路由链接）。

2. 注意: 外侧需要用<BrowserRouter>或<HashRouter>包裹。

3. 示例代码：

   import { Link } from "react-router-dom";
   
   function Test() {
     return (
       <div>
       	<Link to="/路径">按钮</Link>
       </div>
     );
   }

<NavLink>

1. 作用: 与<Link>组件类似，且可实现导航的“高亮”效果。

2. 示例代码：

   // 注意: NavLink默认类名是active，下面是指定自定义的class
   
   //自定义样式
   <NavLink
       to="login"
       className={({ isActive }) => {
           console.log('home', isActive)
           return isActive ? 'base one' : 'base'
       }}
   >login</NavLink>
   
   /*
   	默认情况下，当Home的子组件匹配成功，Home的导航也会高亮，
   	当NavLink上添加了end属性后，若Home的子组件匹配成功，则Home的导航没有高亮效果。
   */
   <NavLink to="home" end >home</NavLink>

<Navigate>

1. 作用：只要<Navigate>组件被渲染，就会修改路径，切换视图。

2. replace属性用于控制跳转模式（push 或 replace，默认是push）。

3. 示例代码：

   import React,{useState} from 'react'
   import {Navigate} from 'react-router-dom'
   
   export default function Home() {
   	const [sum,setSum] = useState(1)
   	return (
   		<div>
   			<h3>我是Home的内容</h3>
   			{/* 根据sum的值决定是否切换视图 */}
   			{sum === 1 ? <h4>sum的值为{sum}</h4> : <Navigate to="/about" replace={true}/>}
   			<button onClick={()=>setSum(2)}>点我将sum变为2</button>
   		</div>
   	)
   }

<Outlet>

1. 当<Route>产生嵌套时，渲染其对应的后续子路由。

2. 示例代码：

   //根据路由表生成对应的路由规则
   const element = useRoutes([
     {
       path:'/about',
       element:<About/>
     },
     {
       path:'/home',
       element:<Home/>,
       children:[
         {
           path:'news',
           element:<News/>
         },
         {
           path:'message',
           element:<Message/>,
         }
       ]
     }
   ])
   
   //Home.js
   import React from 'react'
   import {NavLink,Outlet} from 'react-router-dom'
   
   export default function Home() {
   	return (
   		<div>
   			<h2>Home组件内容</h2>
   			<div>
   				<ul className="nav nav-tabs">
   					<li>
   						<NavLink className="list-group-item" to="news">News</NavLink>
   					</li>
   					<li>
   						<NavLink className="list-group-item" to="message">Message</NavLink>
   					</li>
   				</ul>
   				{/* 指定路由组件呈现的位置 */}
   				<Outlet />
   			</div>
   		</div>
   	)
   }

Hooks

useRoutes()

1. 作用：根据路由表，动态创建<Routes>和<Route>。

2. 示例代码：

   //路由表配置：src/routes/index.js
   import About from '../pages/About'
   import Home from '../pages/Home'
   import {Navigate} from 'react-router-dom'
   
   export default [
   	{
   		path:'/about',
   		element:<About/>
   	},
   	{
   		path:'/home',
   		element:<Home/>
   	},
   	{
   		path:'/',
   		element:<Navigate to="/about"/>
   	}
   ]
   
   //App.jsx
   import React from 'react'
   import {NavLink,useRoutes} from 'react-router-dom'
   import routes from './routes'
   
   export default function App() {
   	//根据路由表生成对应的路由规则
   	const element = useRoutes(routes)
   	return (
   		<div>
   			......
         {/* 注册路由 */}
         {element}
   		  ......
   		</div>
   	)
   }

useNavigate()

1. 作用：返回一个函数用来实现编程式导航。

2. 示例代码：

   import React from 'react'
   import {useNavigate} from 'react-router-dom'
   
   export default function Demo() {
     const navigate = useNavigate()
     const handle = () => {
       //第一种使用方式：指定具体的路径
       navigate('/login', {
         replace: false,
         state: {a:1, b:2}
       }) 
       //第二种使用方式：传入数值进行前进或后退，类似于5.x中的 history.go()方法
       navigate(-1)
     }
     
     return (
       <div>
         <button onClick={handle}>按钮</button>
       </div>
     )
   }

useParams()

1. 作用：回当前匹配路由的params参数，类似于5.x中的match.params。

2. 示例代码：

   import React from 'react';
   import { Routes, Route, useParams } from 'react-router-dom';
   import User from './pages/User.jsx'
   
   function ProfilePage() {
     // 获取URL中携带过来的params参数
     let { id } = useParams();
   }
   
   function App() {
     return (
       <Routes>
         <Route path="users/:id" element={<User />}/>
       </Routes>
     );
   }

useSearchParams()

1. 作用：用于读取和修改当前位置的 URL 中的查询字符串。

2. 返回一个包含两个值的数组，内容分别为：当前的seaech参数、更新search的函数。

3. 示例代码：

   import React from 'react'
   import {useSearchParams} from 'react-router-dom'
   
   export default function Detail() {
   	const [search,setSearch] = useSearchParams()
   	const id = search.get('id')
   	const title = search.get('title')
   	const content = search.get('content')
   	return (
   		<ul>
   			<li>
   				<button onClick={()=>setSearch('id=008&title=哈哈&content=嘻嘻')}>点我更新一下收到的search参数</button>
   			</li>
   			<li>消息编号：{id}</li>
   			<li>消息标题：{title}</li>
   			<li>消息内容：{content}</li>
   		</ul>
   	)
   }

useLocation()

1. 作用：获取当前 location 信息，对标5.x中的路由组件的location属性。

2. 示例代码：

   import React from 'react'
   import {useLocation} from 'react-router-dom'
   
   export default function Detail() {
   	const x = useLocation()
   	console.log('@',x)
     // x就是location对象: 
   	/*
   		{
         hash: "",
         key: "ah9nv6sz",
         pathname: "/login",
         search: "?name=zs&age=18",
         state: {a: 1, b: 2}
       }
   	*/
   	return (
   		<ul>
   			<li>消息编号：{id}</li>
   			<li>消息标题：{title}</li>
   			<li>消息内容：{content}</li>
   		</ul>
   	)
   }
   
     

useMatch()

1. 作用：返回当前匹配信息，对标5.x中的路由组件的match属性。

2. 示例代码：

   <Route path="/login/:page/:pageSize" element={<Login />}/>
   <NavLink to="/login/1/10">登录</NavLink>
   
   export default function Login() {
     const match = useMatch('/login/:x/:y')
     console.log(match) //输出match对象
     //match对象内容如下：
     /*
     	{
         params: {x: '1', y: '10'}
         pathname: "/LoGin/1/10"  
         pathnameBase: "/LoGin/1/10"
         pattern: {
         	path: '/login/:x/:y', 
         	caseSensitive: false, 
         	end: false
         }
       }
     */
     return (
     	<div>
         <h1>Login</h1>
       </div>
     )
   }

useInRouterContext()

​ 作用：如果组件在 <Router> 的上下文中呈现，则 useInRouterContext 钩子返回 true，否则返回 false。

useNavigationType()

1. 作用：返回当前的导航类型（用户是如何来到当前页面的）。
2. 返回值：POP、PUSH、REPLACE。
3. 备注：POP是指在浏览器中直接打开了这个路由组件（刷新页面）。

useOutlet()

1. 作用：用来呈现当前组件中渲染的嵌套路由。

2. 示例代码：

   const result = useOutlet()
   console.log(result)
   // 如果嵌套路由没有挂载,则result为null
   // 如果嵌套路由已经挂载,则展示嵌套的路由对象

useResolvedPath()

1. 作用：给定一个 URL值，解析其中的：path、search、hash值。

React Router 6使用总结

概述

React Router v6 大量使用React hooks。官方明确推荐函数式组件了。

Routes是以前 Switch 组件的升级版，它包括相对路由和链接、自动路由排名、嵌套路由和布局等功能。

component重命名为element。

v6的<Routes>元素下的所有<Route path>和<Link to>值都是自动相对于它们的父路由渲染的，而且忽略当前URL中的尾部斜杠。头部斜杠代变绝对路径。

中小型项目嵌套路由可集中显示，在需要显示的地方使用<Outlet />作为占位符。

若分别显示，具有后代路由（在其他组件中定义）的路由在其路径中使用尾随* 。

“默认子路由”：index（不写path）表示索引路由共享父路径。这就是重点——它没有路径。

“未找到”路由：path='*'表示路径都不匹配时。具有最弱的优先级。

v6 提供了 Navigate 组件，以前版本中的Redirect组件也消失了。

/**
 *  根组件(函数式)
 */
export default function App() {
    return (
        <Routes>
            <Route path='login' element={<Login />}></Route>
            <Route path='/' element={<Admin />}>
                <Route index element={<Home />} />
                <Route path='category' element={<Category />} />
                <Route path='product' element={<Product />}>
                    <Route index element={<ProductHome />} />
                    <Route path='detail' element={<ProductDetail />} />
                    <Route path='addupdate' element={<ProductAddUpdate />} />
                </Route>
                <Route path='user' element={<User />} />
                <Route path='role' element={<Role />} />
                <Route path="charts-bar" element={<Bar />} />
                <Route path="charts-pie" element={<Pie />} />
                <Route path="charts-line" element={<Line />} />    
            </Route>
            {/* 以上路径都不匹配时 */}
            <Route path='*' element={<NotFound />} />
        </Routes>

    )
}
/**
 * 后台管理的路由组件
 *  */
export default function Admin() {
    const user = memoryUtils.user
    // 如果内存没有存储user ==> 当前没有登陆
    if (!user || !user._id) {
        // 自动跳转到登陆(在render()中) Navigate替代Redirect
        return <Navigate to='/login' />
    }
    return (
        ...     
        <Outlet />{/* 占位符 */}
    	...

    )

}

v6 无法直接访问history实例，将useHistory更改为 useNavigate（兼容性和体验）。

useNavigate返回一个函数用来实现编程式导航。navigate('/', { replace: true })

传入数值进行前进或后退，类似于5.x中的 history.go()方法 navigate(-1)

v5:withRouter高阶组件:包装非路由组件, 返回一个新的组件，新的组件向非路由组件传递3个属性: history/location/match

v6:非路由组件使用useLocation也可得到location对象，withRouter不再使用。useLocation().pathname得到当前路径名。

const location =useLocation();
const path = location.pathname;

// location对象
{
    hash: ""
    key: "hvfbi1fy"
    pathname: "/role"
    search: ""
    state: null
}

useRoutes钩子是一个路由API，它允许你使用JavaScript对象而不是React元素来声明和组合路由。

function App() {
  let element = useRoutes([
    // 这些与您提供给 <Route> 的props相同
    { path: "/", element: <Home /> },
    { path: "dashboard", element: <Dashboard /> },
    {
      path: "invoices",
      element: <Invoices />,
      // 嵌套路由使用 children 属性，这也与 <Route> 相同
      children: [
        { path: ":id", element: <Invoice /> },
        { path: "sent", element: <SentInvoices /> },
      ],
    },
    // Not found routes work as you'd expect
    { path: "*", element: <NotFound /> },
  ]);

  // 返回的元素将呈现整个元素层次结构及其所需的所有适当上下文
  return element;
}

Link

标签体内容也是一种特殊的标签属性。

在 v5 中，不以 / 开头的 <Link to> 值是不明确的； 这取决于当前的 URL 是什么。 例如，如果当前 URL 是 /users，则 v5 <Link to="me"> 将呈现 <a href="/me">。 但是，如果当前 URL 有一个结尾斜杠，例如 /users/，则相同的 <Link to="me"> 将呈现 <a href="/users/me">。 这使得很难预测链接的行为方式，因此在 v5 中，我们建议您从根 URL（使用 match.url）构建链接，而不是使用相对的 <Link to> 值。

React Router v6 修复了这种歧义。 在 v6 中，<Link to="me"> 将始终呈现相同的 <a href>，而不管当前的 URL。

例如，在 <Route path="users"> 中呈现的 <Link to="me"> 将始终呈现指向 /users/me 的链接，无论当前 URL 是否具有尾部斜杠。

当您想“向上”链接回父路由时，请在 <Link to> 值中使用前导 .. 段，类似于您在 <a href> 中所做的。

路由参数传递

param参数

• 在Route组件中的path属性中定义路径参数
• 在组件内通过useParams hook访问路径参数

// 定义参数
<BrowserRouter>
    <Routes>
        <Route path='/foo/:id' element={Foo} />
    </Routes>
</BrowserRouter>
// 传递参数
<LinkButton onClick={() => navigate(`foo/${product.id}`)} >
    修改
</LinkButton>
// 提取参数
import { useParams } from 'react-router-dom';
export default function Foo(){
    const params = useParams();
    return (
        <div>
            <h1>{params.id}</h1>
        </div>
    )
}

个人理解：param参数适合传递一个参数时使用。

useMatch()

1. 作用：返回当前匹配信息，对标5.x中的路由组件的match属性。

2. 示例代码：

   <Route path="/login/:page/:pageSize" element={<Login />}/>
   <NavLink to="/login/1/10">登录</NavLink>
   
   export default function Login() {
     const match = useMatch('/login/:x/:y')
     console.log(match) //输出match对象
     //match对象内容如下：
     /*
     	{
         params: {x: '1', y: '10'}
         pathname: "/LoGin/1/10"  
         pathnameBase: "/LoGin/1/10"
         pattern: {
         	path: '/login/:x/:y', 
         	caseSensitive: false, 
         	end: false
         }
       }
     */
     return (
     	<div>
         <h1>Login</h1>
       </div>
     )
   }

search参数&sate参数

Location：这是一个 React Router 特定的对象，它基于内置浏览器的 window.location 对象。

您可以设置location state在<Link>上或navigate上，在下一路由组件中你可以用useLocation来访问它。

useLocation()既可以获得state参数，也可以获得search参数。

<LinkButton onClick={() => navigate('addupdate?name=tom&age=18', { state: product })} >
    修改
</LinkButton>

const isUpdate = location.state
const search = location.search
console.log(search) // ?name=tom&age=18
console.log(isUpdate) // {status: 1, imgs: Array(2), _id: '5e12b97de31bb727e4b0e349', name: '联想ThinkPad 翼4809', desc: '年度重量级新品，X390、T490全新登场 更加轻薄机身设计9', …}

个人理解：state参数适合传js对象。

search参数一般使用useSearchParams()进行获取和修改。

1. 作用：用于读取和修改当前位置的 URL 中的查询字符串。
2. 返回一个包含两个值的数组，内容分别为：当前的seaech参数、更新search的函数。

const [search,setSearch] = useSearchParams()
const age = search.get('age')
const name = search.get('name')

个人理解：search参数适合传可能会被修改的参数。

官方文档

官方博客