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>等。
与React Router 5.x 版本相比，改变了什么？
1. 内置组件的变化：移除<Switch/> ，新增 <Routes/>等。
2. 语法的变化：component={About} 变为 element={<About/>}等。
3. 新增多个hook：useParams、useNavigate、useMatch等。
4. 官方明确推荐函数式组件了！！！
  
  ……

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
);

2. `<HashRouter>`

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

3. `<Routes/> 与 <Route/>`

v6版本中移出了先前的<Switch>，引入了新的替代者：<Routes>。
<Routes> 和 <Route>要配合使用，且必须要用<Routes>包裹<Route>。
<Route> 相当于一个 if 语句，如果其路径与当前 URL 匹配，则呈现其对应的组件。
<Route caseSensitive> 属性用于指定：匹配时是否区分大小写（默认为 false）。
当URL发生变化时，<Routes>都会查看其所有子<Route> 元素以找到最佳匹配并呈现组件。
<Route> 也可以嵌套使用，且可配合useRoutes()配置 “路由表” ，但需要通过 <Outlet> 组件来渲染其子路由。
示例代码：

<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. `<NavLink>`

作用: 与<Link>组件类似，且可实现导航的“高亮”效果。
示例代码：

// 注意: 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>

6. `<Navigate>`

作用：只要<Navigate>组件被渲染，就会修改路径，切换视图。
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>
)
}

7. `<Outlet>`

当<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

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

作用：返回一个函数用来实现编程式导航。
示例代码：

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。
示例代码：

// Message组件,传递数据
import React ,{useState}from 'react'
import {Link, Outlet} from 'react-router-dom'
export default function Message() {
    const [message] = useState([
        {id:'001',title:'消息1',content:'我上小学了'},
        {id:'002',title:'消息2',content:'我上中学了'},
        {id:'003',title:'消息3',content:'我上大学了'}
    ])
    return (
    <div>
        <ul>
        {
            message.map((obj)=>{
                return <li key={obj.id}>
                        {/* <Link to='detail>{obj.title}</Link>&nbsp;&nbsp; */}
                        {/* params专递参数 */}
                        <Link to={`detail/${obj.id}/${obj.title}/${obj.content}`}>{obj.title}</Link>&nbsp;&nbsp;
                    </li>
            })
        }
        </ul>
        <hr/>
        {/* 指定路由组件的展示位置 */}
        <Outlet></Outlet>
  </div>
  )
}

// Detail组件接收数据
import React from 'react';
import { useParams, useMatch } from 'react-router-dom';

export default function Detail() {
    // 使用 useParams 钩子来获取路由参数 id、title 和 content
    const { id, title, content } = useParams();

    // 也可以使用 useMatch 钩子来获取路由匹配信息，包括参数
    const match = useMatch('/home/message/detail/:id/:title/:content');
    console.log(match.params); // 打印匹配的参数

    return (
        <div>
            <ul>
                <li>{id}</li>
                <li>{title}</li>
                <li>{content}</li>
            </ul>
        </div>
    );
}

// 路由表中生命接收
export default [
    {
      path:'/about',
      element: <About></About>
    },
    {
      path:'/home',
      element: <Home></Home>,
      children:
      [
        {
          path:'message',
          element:<Message></Message>,
          children:[
            {
              path:'detail/:id/:title/:content',
              element:<Detail></Detail>
            }
          ]
      },
      {
        path:'news',
        element:<News></News>
    },

      ]
    },
    {
      path:'/',
      element: <Navigate></Navigate>
    }
  ]

4. useSearchParams()

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

// Message传递数据
import React ,{useState}from 'react'
import {Link, Outlet} from 'react-router-dom'
export default function Message() {
    const [message] = useState([
        {id:'001',title:'消息1',content:'我上小学了'},
        {id:'002',title:'消息2',content:'我上中学了'},
        {id:'003',title:'消息3',content:'我上大学了'}
    ])
    return (
    <div>
        <ul>
        {
            message.map((obj)=>{
                return <li key={obj.id}>
                        {/* <Link to='detail>{obj.title}</Link>&nbsp;&nbsp; */}
                        {/* searchparmes传递参数 */}
                        <Link to={`detail/?id=${obj.id}&title=${obj.title}&content=${obj.content}`}>{obj.title}</Link>&nbsp;&nbsp;
                    </li>
            })
        }
        </ul>
        <hr/>
        {/* 指定路由组件的展示位置 */}
        <Outlet></Outlet>
  </div>
  )
}

// Detail组件接收数据
import React from 'react';
import { useSearchParams, useLocation } from 'react-router-dom';

export default function Detail() {
  // 使用 useSearchParams 钩子来获取当前页面的搜索参数
  const [search, setSearch] = useSearchParams();
  // 从搜索参数中获取 id、title 和 content
  const id = search.get('id');
  const title = search.get('title');
  const content = search.get('content');

  // 使用 useLocation 钩子来获取当前页面的位置信息
  const location = useLocation();
  
  console.log(location); // 打印当前页面的位置信息
  console.log(location.pathname); // 打印当前页面的路径名

  return (
    <div>
      <ul>
        <button onClick={() => setSearch('id=004&title=消息4&content=我考上研究生了')}>
          点我更新一下收到的搜索参数
        </button>
        <li>{id}</li>
        <li>{title}</li>
        <li>{content}</li>
      </ul>
    </div>
  );
}

5. useLocation() state传递参数

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

// Message传递数据
import React ,{useState}from 'react'
import {Link, Outlet} from 'react-router-dom'
export default function Message() {
    const [message] = useState([
        {id:'001',title:'消息1',content:'我上小学了'},
        {id:'002',title:'消息2',content:'我上中学了'},
        {id:'003',title:'消息3',content:'我上大学了'}
    ])
    return (
    <div>
        <ul>
        {
            message.map((obj)=>{
                return <li key={obj.id}>
                        {/* <Link to='detail>{obj.title}</Link>&nbsp;&nbsp; */}
                        {/* state传递参数 */}
                        <Link 
                        to='detail' 
                        state={{
                            id:obj.id,
                            title:obj.title,
                            content:obj.content
                        }}>{obj.title}</Link>&nbsp;&nbsp;
                    </li>
            })
        }
        </ul>
        <hr/>
        {/* 指定路由组件的展示位置 */}
        <Outlet></Outlet>
  </div>
  )
}

// Detail接收数据
import React from 'react';
import { useLocation } from 'react-router-dom';

export default function Detail() {
  // 使用 useLocation 钩子获取当前页面的位置信息，其中包含一个 state 对象
  const { state } = useLocation();

  return (
    <div>
      <ul>
        <li>{state.id}</li>       {/* 显示 state 对象中的 id 属性值 */}
        <li>{state.title}</li>    {/* 显示 state 对象中的 title 属性值 */}
        <li>{state.content}</li>  {/* 显示 state 对象中的 content 属性值 */}
      </ul>
    </div>
  );
}

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

作用：如果组件在 <Router> 的上下文中呈现，则 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值。

React Router 6 快速上手

1.概述

2.Component

1. <BrowserRouter>

2. <HashRouter>

3. <Routes/> 与 <Route/>

4. <Link>

5. <NavLink>

6. <Navigate>

7. <Outlet>

3.Hooks

1. useRoutes()

2. useNavigate()

3. useParams()

4. useSearchParams()

5. useLocation() state传递参数

6. useMatch()

7. useInRouterContext()

8. useNavigationType()

9. useOutlet()

10.useResolvedPath()

1. `<BrowserRouter>`

2. `<HashRouter>`

3. `<Routes/> 与 <Route/>`

4. `<Link>`

5. `<NavLink>`

6. `<Navigate>`

7. `<Outlet>`