React Router 6 快速上手

2023-08-24 09:00:12

1.概述

  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:useParamsuseNavigateuseMatch等。

    4. 官方明確推薦函數式元件了!!!

      ......

2.Component

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

2. <HashRouter>

  1. 說明:作用與<BrowserRouter>一樣,但<HashRouter>修改的是位址列的hash值。
  2. 備註:6.x版本中<HashRouter><BrowserRouter> 的用法與 5.x 相同。

3. <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>
    
  1. 作用: 修改URL,且不傳送網路請求(路由連結)。

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

  3. 範例程式碼:

    import { Link } from "react-router-dom";
    
    function Test() {
      return (
        <div>
        	<Link to="/路徑">按鈕</Link>
        </div>
      );
    }
    
  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>
    

6. <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>
    	)
    }
    

7. <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>
    	)
    }
    
    

3.Hooks

1. 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>
    	)
    }
    
    

2. 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>
      )
    }
    

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 ProfilePage() {
      // 獲取URL中攜帶過來的params引數
      let { id } = useParams();
    }
    
    function App() {
      return (
        <Routes>
          <Route path="users/:id" element={<User />}/>
        </Routes>
      );
    }
    

4. 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>
    	)
    }
    
    

5. 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>
    	)
    }
    
      
    
    
    

6. 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>
      )
    }
    

7. useInRouterContext()

​ 作用:如果元件在 <Router> 的上下文中呈現,則 useInRouterContext 勾點返回 true,否則返回 false。

8. useNavigationType()

  1. 作用:返回當前的導航型別(使用者是如何來到當前頁面的)。
  2. 返回值:POPPUSHREPLACE
  3. 備註:POP是指在瀏覽器中直接開啟了這個路由元件(重新整理頁面)。

9. useOutlet()

  1. 作用:用來呈現當前元件中渲染的巢狀路由。

  2. 範例程式碼:

    const result = useOutlet()
    console.log(result)
    // 如果巢狀路由沒有掛載,則result為null
    // 如果巢狀路由已經掛載,則展示巢狀的路由物件
    

10.useResolvedPath()

  1. 作用:給定一個 URL值,解析其中的:path、search、hash值。