React Router 6 快速上手
1.概述
React Router 以三个不同的包发布到 npm 上,它们分别为:
react-router: 路由的核心库,提供了很多的:组件、钩子。
react-router-dom: 包含react-router所有内容,并添加一些专门用于 DOM 的组件,例如 等 。
react-router-native: 包括react-router所有内容,并添加一些专门用于ReactNative的API,例如:等。
与React Router 5.x 版本相比,改变了什么?
1、内置组件的变化:移除
2、语法的变化:component={About} 变成 element={}
3、新增多个hook:useParams、useNavigate、useMatch
4、官方声明推荐函数式组件
…
一、路由模式选者
首先在入口文件index.js用BrowserRouter把App组件包裹住,代表用的是BrowserRouter,还有一种模式是hashRouter
二、一级路由 ----- 路由的基本使用 NavLink 、 Link、Routes、 Route:
Route必须由Routes包裹住,不包裹会报错,原来的Switch包裹是为了解决一直向下匹配的问题,用Routes包裹后也不存在这个问题
另外,Route的component={About}改成了 element={}
2.Component
1. <BrowserRouter>
- 说明:
<BrowserRouter>
用于包裹整个应用。 - 示例代码:
import React from "react";
import ReactDOM from "react-dom";
import { BrowserRouter } from "react-router-dom";
ReactDOM.render(
<BrowserRouter>
{/* 整体结构(通常为App组件) */}
</BrowserRouter>,root
);
- HashRouter
说明:作用与BrowserRouter一样,但HashRouter修改的是地址栏的hash值。
备注:6.x版本中HashRouter、BrowserRouter的用法与 5.x 相同。 - Routes 与 Route
v6版本中移出了先前的Switch,引入了新的替代者:Routes。
Routes和Route要配合使用,且必须要用Routes包裹Route。
Route相当于一个 if 语句,如果其路径与当前 URL 匹配,则呈现其对应的组件。
Route 的caseSensitive 属性用于指定:匹配时是否区分大小写(默认为 false)。
当URL发生变化时,都会查看其所有子 元素以找到最佳匹配并呈现组件 。
也可以嵌套使用,且可配合useRoutes()配置 “路由表” ,但需要通过 组件来渲染其子路由。
示例代码:
<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>
4. <Link>
- 作用: 修改URL,且不发送网络请求(路由链接)。
- 注意: 外侧需要用
<BrowserRouter>
或<HashRouter>
包裹。 - 示例代码:
import { Link } from "react-router-dom";
function Test() {
return (
<div>
<Link to="/路径">按钮</Link>
</div>
);
}
5. <Navigate>
路由重定向 Navigate
当没有匹配任何路由的情况下,会有警告:No routes matched location “/”
5版本的重定向是使用Redirect:
6版本用Navigate组件,他有以下特性:
- 作用:只要
<Navigate>
组件被渲染,就会修改路径,切换视图。 - 有一个replace属性,默认为false,为push模式,如果为true,就是replace模式(不会留下历史记录)即
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 (
<div>
<h3>我是Home的内容</h3>
{/* 根据sum的值决定是否切换视图 */}
{sum === 1 ? <h4>sum的值为{sum}</h4> : <Navigate to="/about" replace={true}/>}
<button onClick={()=>setSum(2)}>点我将sum变为2</button>
</div>
)
}
6. <Outlet>
router6的路由表统一在routes文件下配置,那么子路由就需要一个槽位来指定子路由显示的位置
,这个标签是outlet,相当于vue中的router-view,
- 当
<Route>
产生嵌套时,渲染其对应的后续子路由。 - 示例代码:
//根据路由表生成对应的路由规则
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>
)
}
3.Hooks(Router5.0之后出现的)
1. useRoutes()
- 作用:根据路由表,动态创建
<Routes>
和<Route>
。 - 示例代码
//路由表配置: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>
)
}
2. 编程式导航useNavigate()
在router5中,普通组件想使用路由里的location、match、history,需要用withRouter(组件)加工一下,但router6不需要,可以直接用钩子函数就可以使用router的任何东西, router5中使用useHistory
- 作用:返回一个函数用来实现编程式导航。
- 示例代码:
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>
)
}
3. 路由传参useParams()
- 作用:回当前匹配路由的
params
参数,类似于5.x中的match.params
。 - 示例代码:
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>
);
}
4. 路由传参useSearchParams()
- 作用:用于读取和修改当前位置的 URL 中的查询字符串。
- 返回一个包含两个值的数组,内容分别为:当前的seaech参数、更新search的函数。
- 示例代码:
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>
)
}
5. useLocation()
- 作用:获取当前 location 信息,对标5.x中的路由组件的
location
属性。 - 示例代码:
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>
)
}
或者使用标签传递参数
<Link to="detail" state={{ id: m.id, title: m.title, content: m.content }}>{m.title}</Link>
6. useMatch()
- 作用:返回当前匹配信息,对标5.x中的路由组件的
match
属性。 - 示例代码:
<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>
)
}
7. useInRouterContext()
作用:如果组件在 的上下文中呈现,则 useInRouterContext 钩子返回 true,否则返回 false。
8. useNavigationType()
作用:返回当前的导航类型(用户是如何来到当前页面的)。
返回值:POP、PUSH、REPLACE。
备注:POP是指在浏览器中直接打开了这个路由组件(刷新页面)。
9. useOutlet()
作用:用来呈现当前组件中渲染的嵌套路由。
示例代码:
const result = useOutlet()
console.log(result)
// 如果嵌套路由没有挂载,则result为null
// 如果嵌套路由已经挂载,则展示嵌套的路由对象
10.useResolvedPath()
- 作用:给定一个 URL值,解析其中的:path、search、hash值。
6和5的区别
1、v6版本移除了Switch,用Routes替代
2、Routes和Route要配合使用,必须用Routes包裹Route
3、Route相当于if语句,如果与当前URL匹配,就呈现对应组件
4、Route的属性caseSensitive用于指定:匹配时是否区分大小写,默认为false
5、当URL发生变化时,Routes都会查其所有子Route以找到最佳匹配并呈现其页面
6、也可以嵌套使用,且可配合useRoutes()配置’路由表’,但需要通过 组件来渲染子路由
<Switch>
<Route path="/about/one" element={<One />}></Route>
<Route path="/about/two" element={<Two />}></Route>
<Route path="/about/three" element={<Three />}></Route>
<Switch />*/}
6中父组件声明子路由
<Routes>
<Route path="one" element={<One />}></Route>
<Route path="two" element={<Two />}></Route>
<Route path="three" element={<Three />}></Route>
</Routes>
注意这里,如果嵌套路由写在父路由里,那么注意区分与react5的区别。在react-router5中。父路由的匹配
/about不可以省略
,就是子路由的路由前缀不能省略,在react-router6中,App.js中,如果子组件所在Route不没有写在父组件所在Route里的话,那么父组件所在的 Route的path中要写/*
。但是如果子组件和父组件所在Route都在同一个js里,那么父组件所在的 Route的path中写不写/*
都行。
下面这段话是在6中在父组件中声明了子组件的话,App.js中父组件所在的 Route的path中不写*
会出现的警告:
router.ts:11 You rendered descendant <Routes> (or called `useRoutes()`) at "/about" (under <Route path="/about">)
but the parent route path has no trailing "*". This means if you navigate deeper, the parent won't match anymore and therefore the child routes will never render.
Please change the parent <Route path="/about"> to <Route path="/about/*">
react-router之onEnter和onLeave
在这里我们介绍一下路由的onEnter和onLeave,顾名思义,分别是路由进入之前和路由离开之前,我们可以在这段时间内做一些处理。比如下面这个例子
<Route path="/home" component={App} onEnter={(nexState,replace)=>{
if(nexState.location.pathname!=='/'){
var sid = UtilsMoudle.getSidFromUrl(nexState);
if(!sid){
replace("/")
}else{
console.log(sid);
}
}
}}>
</Route>
上述代码是onEnter的一个简单应用,从上面的示例可以看出nextState参数为即将跳转的url地址,replace可以替换掉原来的地址。上述代码中,如果要跳转的url地址中可以获取参数sid,则打印出来,然后跳转,如果没有则直接跳转到根目录。
这是一个很好的方法,但是有一个缺点,如果我在代码处理中是采用异步的方式来请求数据,然后判断完成以后再进行跳转,就会出现问题,这时就用到onEnter的第三个参数:callback
<Route path="/home" component={App} onEnter={(nexState,replace,cb)=>{
if(nexState.location.pathname!=='/'){
UtilsMoudle.getSidFromUrl(nexState,sid=>{
if(!sid){
replace("/")
}else{
console.log(sid);
}
cb();
});
}else{
cb();
}
}}>
</Route>
我们修改了一下之前的代码,加入第三个参数cb,当有这个参数时,如果不执行cb函数,则不会跳转,有了这个就很方便了,我们只需要在异步回调函数中调用即可。
对于onLeave的使用和onEnter相似,在此就不在赘述。其功效为即将离开此url之前触发,假设有A,B两个url,在A的url上有onLeave,在B上有onEnter,则离开A时先触发A的onLeave函数,然后触发B的onEnter函数。
React-router3与React-router4的区别
先说一下React-router4的使用
要想使用React-router4,需要引入两个东西,
React-router和React-router-dom
React-router:React-router提供了一些router的核心api,包括Router, Route, Switch等,但是它不能直接进行Dom操作
React-router-dom:所以React-router-dom顾名思义就是进行React-router的dom操作了,提供的api有BrowserRouter, Route, Link等
最后,其实写这么多也只是复习一下小编React-router4的区别,现在开始来说区别
在V3中:
1、集中式 router,没有React-router-dom(对应下1)
2、通过 (使用 {props.children} )嵌套,实现 Layout 和 page 嵌套(对应下2)
3、Layout 和 page 组件 是作为 router 的一部分()
4、Dom操作是将整个Router进行操作的(对应下3)
5、V3 中的 routers 规则是 exclusive,只能匹配一个路径(对应下4)
6、在路由嵌套中,重复的页面容易都有一个重复的组件,这会导致不必要的请求,会重复消耗多余的流量(对应下5)
在V4中:
1、从React-router-dom中引入了BrowserRouter或HashRouter
2、当 route 匹配时,子组件会被渲染到 书写的地方
3、进行Dom操作的是应用程序本身,而不是整个Router
4、V3 中的 routers 规则是 exact ,多个 可以同时匹配和呈现
5、match 对象为我们提供了 match.params,match.path,和 match.url 等属性,解决了重复输入,重复渲染