【16】基础知识：React路由 - React Router 6

一、概述

了解

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

1、react-router：路由的核心库，提供了很多的组件、钩子。

2、react-router-dom：包含 react-router 所有内容，并添加一些专门用于 DOM 的组件，例如 等。

3、react-router-native：包括 react-router 所有内容，并添加一些专门用于 ReactNative 的API，例如 等。

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

1、内置组件的变化：移除 ，新增 等。

2、语法的变化：component={About} 变为 element={}等。

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

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

…

二、Component

1、

（1）说明： 用于包裹整个应用。

（2）示例代码：

/* 入口文件 */
import React from 'react'
import ReactDOM from 'react-dom/client'
import { BrowserRouter } from 'react-router-dom'

ReactDOM.createRoot(document.getElementById('root')).render(
  <BrowserRouter>
     {/* 整体结构（通常为App组件） */}
  </BrowserRouter>
)
1
2
3
4
5
6
7
8
9
10

2.

（1）说明：作用与 一样，但 修改的是地址栏的 hash 值。

（2）备注：6.x 版本中 、 的用法与 5.x 相同。

3、 与

（1）v6 版本中移出了先前的 ，引入了新的替代者： 。

（2） 和 要配合使用，且必须要用 包裹 。

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

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

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

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

（7）示例代码：

<Routes>
	/* path 属性用于定义路径，element 属性用于定义当前路径所对应的组件 */
	<Route path="/login" element={ />}>Route>
	
	/* 用于定义嵌套路由，home 是一级路由，对应的路径 /home */
	<Route path="home" element={ />}>
		/* test1 和 test2 是二级路由，对应的路径是/home/test1 或 /home/test2 */
		<Route path="test1" element={ />}>Route>
		<Route path="test2" element={ />}>Route>
	Route>
	
	// Route 也可以不写 element 属性，这时就是用于展示嵌套的路由，所对应的路径是/users/xxx
    <Route path="users">
    	<Route path="xxx" element={ />} />
    Route>
Routes>
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

4、

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

（2）注意：外侧需要用 或 包裹。

（3）示例代码：

import { Link } from 'react-router-dom'
   
function Test() {
	return (
		<div>
			<Link to="/路径">按钮</Link>
		</div>
     )
}
1
2
3
4
5
6
7
8
9

5、

（1）作用：与 组件类似，且可实现导航的 “高亮” 效果。

（2）示例代码：

注意，NavLink 默认类名是 active，下面是指定自定义的 class

<NavLink
	to="login"
	className={ ({ isActive }) => { isActive ? 'base selected' : 'base' }
>login</NavLink>
1
2
3
4

默认情况下，当 Home 的子组件匹配成功，Home 的导航也会高亮；

当 Home 的 NavLink 上添加了 end 属性后，若 Home 的子组件匹配成功，Home的导航不会高亮。

<NavLink to="/home" end >Home</NavLink>
1

6、

（1）作用：只要 组件被渲染，就会修改路径，切换视图。

（2） replace 属性用于控制跳转模式，默认值为 true（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>我是Home组件内容</div>
			{/* 根据sum的值决定是否切换视图：只要  组件被渲染，就会修改路径，切换视图 */}
			{ sum == 2 ? <Navigate to="/about" /> : <div>当前sum的值是：{sum}</div> }	
			<button onClick={() => setSum(2)}>点我将sum变为2</button>
		</>
	)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15

7、

（1）当 产生嵌套时，渲染其对应的后续子路由。

（2）示例代码：

src/routes/index.js

import { Navigate } from 'react-router-dom'
import About from '../pages/About'
import Home from '../pages/Home'
import Message from '../pages/Message'
import News from '../pages/News'

export default [
  {
    path: '/about',
    element: <About />
  },
  {
    path: '/home',
    element: <Home />,
    children: [
      {
        path: 'message',
        element: <Message />
      },
      {
        path: 'news',
        element: <News />
      }
    ]
  },
  {
    path: '/',
    element: <Navigate to="/about" />
  }
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30

Home.jsx

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="/home/news">News</NavLink>
					</li>
					<li>
						<NavLink className="list-group-item" to="message">Message</NavLink>
					</li>
				</ul>
				{/* 指定路由组件呈现的位置 */}
				<Outlet />
			</div>
		</div>
	)
}

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

三、Hooks

1、useRoutes()

（1）作用：根据路由表，动态创建 和 。

（2）示例代码：

路由表配置文件：src/routes/index.js

import { Navigate } from 'react-router-dom'
import About from '../pages/About'
import Home from '../pages/Home'

export default [
  {
    path: '/about',
    element: <About />
  },
  {
    path: '/home',
    element: <Home />
  },
  {
    path: '/',
    element: <Navigate to="/about" />
  }
]
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18

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>
  )
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16

2、useNavigate()

（1）作用：返回一个函数用来实现编程式路由导航。

（2）示例代码：

import React from 'react'
import { useNavigate } from 'react-router-dom'

export default function Demo() {
	const navigate = useNavigate()
	
	const handle = () => {
		// 第一种使用方式：指定具体的路径（login中通过 useLocation hooks 接收）
		navigate('/login', {
			replace: false,
			state: { a:1, b:2 }
		})
       
       // 第二种使用方式：传入数值进行前进或后退，类似于 5.x 中的 history.go() 方法
       navigate(-1)
	}
     
	return (
		<div>
			<button onClick={handle}>按钮</button>
		</div>
	)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23

3、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 App() {
	return (
		<Routes>
			<Route path="users/:id" element={<User />}/>
		</Routes>
     )
}

   
function ProfilePage() {
	// 获取 URL 中携带过来的 params 参数
	let { id } = useParams()
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17

4、useSearchParams()

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

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

（3）示例代码：

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

export default function Detail() {
  // 函数式组件中通过 useSearchParams hooks 接收 路由的 search 类型参数
  // search.get(key) 获取对应参数值；setSearch 更新接收到的 search 参数
  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>
  )
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22

5、useLocation()

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

（2）示例代码：

import React from 'react'
import { useLocation} from 'react-router-dom'

export default function Detail() {
  // 了解：函数式组件使用 this.props.location.search 形式
  const x = useLocation()
  console.log('@', x)
  // x 就是 location 对象
  /* {
  	hash: "",
  	key: "7yc2y2l9",
  	pathname: "/home/message/detail",
  	search: "?id=008&title=%E5%93%88%E5%93%88&content=%E5%98%BB%E5%98%BB",
  	state: null
  } */

  return (
    <ul>
      <li>消息编号：{id}</li>
      <li>消息标题：{title}</li>
      <li>消息内容：{content}</li>
    </ul>
  )
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

6、useMatch()

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

（2） 示例代码：

接收 search 类型的路由参数

<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>
	)
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24

接收 state 类型的路由参数

// { id: item.id, title: item.title, content: item.content }}>{item.title}

import React from 'react'
import { useLocation } from 'react-router-dom'

export default function Detail() {
  // 函数式组件中通过 useLocation hooks 接收 路由的 state 类型参数
  console.log('@', useLocation())
  // 双重结构赋值
  const { state: { id, title, content } } = useLocation()

  return (
    <ul>
      <li>消息编号：{id}</li>
      <li>消息标题：{title}</li>
      <li>消息内容：{content}</li>
    </ul>
  )
}
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19

7、useInRouterContext()

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

8、useNavigationType()

（1）作用：返回当前的导航类型（用户是如何来到当前页面的）。

（2）返回值：POP、PUSH、REPLACE。

（3）备注：POP 是指在浏览器中直接打开了这个路由组件（刷新页面）。

9、useOutlet()

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

2. 示例代码：

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

10、useResolvedPath()

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

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

console.log('@@', useResolvedPath('/user?id=001&name=tom#qwe'))
// 输入 @@ {pathname: '/user', search: '?id=001&name=tom', hash: '#qwe'}
1
2
3
4