超超详细ReactRouter v6版本的基本使用

先附上官网的地址：react-router-v6 · GitHub Topics · GitHub

一.概述

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

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

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

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

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

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

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

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

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

      ......

---

二.Component

1.

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

import React from "react";
import ReactDOM from "react-dom";
import { BrowserRouter } from "react-router-dom";

ReactDOM.render(
  
    {/* 整体结构（通常为App组件） */}
  
);

---

2.

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

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

---

3. 与

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

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

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

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

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

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

    /*path属性用于定义路径，element属性用于定义当前路径所对应的组件*/
    }>

		/*用于定义嵌套路由，home是一级路由，对应的路径/home*/
    }>
       /*test1 和 test2 是二级路由,对应的路径是/home/test1 或 /home/test2*/
      }>
      }>
	
	
		//Route也可以不写element属性, 这时就是用于展示嵌套的路由 .所对应的路径是/users/xxx
    
       } />
    

---

4.

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

2. 注意: 外侧需要用或包裹。

3. v6版本不需要带父级路由路径 

import { Link } from "react-router-dom";

function Test() {
  return (
    

    	按钮
    
  );
}

---

5.

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

2. v6版本不需要带父级路由路径 。

  例如：v6版本中标题实现高亮：

 *  NavLink属性className接收一个函数，函数参数为对象，有个属性为isActive

 *  如果isActive为true，意味被选中，可以自定义添加样式

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

//自定义样式
 {
        console.log('home', isActive)
        return isActive ? 'base one' : 'base'
    }}
>login

/*
	默认情况下，当Home的子组件匹配成功，Home的导航也会高亮，
	当NavLink上添加了end属性后，若Home的子组件匹配成功，则Home的导航没有高亮效果。
*/
home

---

6.

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

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

import React,{useState} from 'react'
import {Navigate} from 'react-router-dom'

export default function Home() {
	const [sum,setSum] = useState(1)
	return (
		

			
我是Home的内容
			{/* 根据sum的值决定是否切换视图 */}
			{sum === 1 ? 
sum的值为{sum}
 : }
			setSum(2)}>点我将sum变为2
		
	)
}

---

7.

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

//根据路由表生成对应的路由规则
const element = useRoutes([
  {
    path:'/about',
    element:
  },
  {
    path:'/home',
    element:,
    children:[
      {
        path:'news',
        element:
      },
      {
        path:'message',
        element:,
      }
    ]
  }
])

//Home.js
import React from 'react'
import {NavLink,Outlet} from 'react-router-dom'

export default function Home() {
	return (
		

			
Home组件内容
			

				

					

						News
					
					

						Message
					
				
				{/* 指定路由组件呈现的位置 */}
				
			
		
	)
}

---

三.Hooks

1. useRoutes()

1. 作用：使用useRoutes创建路由表，useRoutes接收数组生成路由表。根据路由表，动态创建和。

//路由表配置：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:
	},
	{
		path:'/home',
		element:
	},
	{
		path:'/',
		element:
	}
]

//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 (
		

			......
      {/* 注册路由 */}
      {element}
		  ......
		
	)
}

---

2. useNavigate()

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

2. Header为非路由组件，在v5版本通过withRouter()高阶函数包装成新的路由组件才能调用location，history和match的方法，但在v6版本中只需要调用useNaviage()这个hooks也可以实现跳转需求：

     navigate(1) 为前进一步

     navigate(-1) 为后退一步

  通过useNavigate()返回的参数navigate是一个函数：

    * 第一个参数为跳转的路径，第二个参数为option配置对象，目前只支持两个属性

    * 如果携带params和search参数，只支持在第一个参数进行拼接

        -params参数  `login/${a}/${b}`

        -search参数  `login?a=${a}&b=${b}`

    *  而携带state，直接在第二个参数进行配置即可 

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 (
    

      按钮
    
  )
}

---

3. useParams()

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

2. 携带params参数，需要在定规则的时候进行占位

3. 使用useParams获取父组件的数据

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 (
    
      }/>
    
  );
}

---

4. useSearchParams()

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

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

3. 携带search参数，不需要在定规则的时候进行占位

4. 使用useSearchParams获取父组件的数据

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 (
		

			

				setSearch('id=008&title=哈哈&content=嘻嘻')}>点我更新一下收到的search参数
			
			
消息编号：{id}
			
消息标题：{title}
			
消息内容：{content}
		
	)
}

---

5. useLocation()

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

2. 使用state进行传参，对useLocation返回的对象进行解构赋值即可，同时不需要占位

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 (
		

			
消息编号：{id}
			
消息标题：{title}
			
消息内容：{content}
		
	)
}

---

6. useMatch()

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

}/>
登录

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 (
  	

      
Login
    
  )
}

---

7. useInRouterContext()

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

ReactDOM.render(
    // App处于路由组件上下文中，而Demo组件没有处于上下文
    

        
        
            
        
    
, document.getElementById('root'))

---

8. useNavigationType()

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

2. 返回值：POP、PUSH、REPLACE。

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

---

9. useOutlet()

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

2. 示例代码：

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

---

10.useResolvedPath()

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

console.log('useResolvedPath',useResolvedPath('/user?id=001&name=tom#qws'))
 //输出：{pathname: "/user", search: "?id=001&name=tom", hash: "#qws"}