ReactRouter的實現方法

Posted on 2021-01-25 by WalkonNet

ReactRouter的實現

ReactRouter是React的核心組件，主要是作為React的路由管理器，保持UI與URL同步，其擁有簡單的API與強大的功能例如代碼緩沖加載、動態路由匹配、以及建立正確的位置過渡處理等。

描述

React Router是建立在history對象之上的，簡而言之一個history對象知道如何去監聽瀏覽器地址欄的變化，並解析這個URL轉化為location對象，然後router使用它匹配到路由，最後正確地渲染對應的組件，常用的history有三種形式： Browser History、Hash History、Memory History。

Browser History

Browser History是使用React Router的應用推薦的history，其使用瀏覽器中的History對象的pushState、replaceState等API以及popstate事件等來處理URL，其能夠創建一個像https://www.example.com/path這樣真實的URL，同樣在頁面跳轉時無須重新加載頁面，當然也不會對於服務端進行請求，當然對於history模式仍然是需要後端的配置支持，用以支持非首頁的請求以及刷新時後端返回的資源，由於應用是個單頁客戶端應用，如果後臺沒有正確的配置，當用戶在瀏覽器直接訪問URL時就會返回404，所以需要在服務端增加一個覆蓋所有情況的候選資源，如果URL匹配不到任何靜態資源時，則應該返回同一個index.html應用依賴頁面，例如在Nginx下的配置。

location / {
 try_files $uri $uri/ /index.html;
}

Hash History

Hash符號即#原本的目的是用來指示URL中指示網頁中的位置，例如https://www.example.com/index.html#print即代表example的index.html的print位置，瀏覽器讀取這個URL後，會自動將print位置滾動至可視區域，通常使用<a>標簽的name屬性或者<div>標簽的id屬性指定錨點。
通過window.location.hash屬性能夠讀取錨點位置，可以為Hash的改變添加hashchange監聽事件，每一次改變Hash，都會在瀏覽器的訪問歷史中增加一個記錄，此外Hash雖然出現在URL中，但不會被包括在HTTP請求中，即#及之後的字符不會被發送到服務端進行資源或數據的請求，其是用來指導瀏覽器動作的，對服務器端沒有效果，因此改變Hash不會重新加載頁面。
ReactRouter的作用就是通過改變URL，在不重新請求頁面的情況下，更新頁面視圖，從而動態加載與銷毀組件，簡單的說就是，雖然地址欄的地址改變瞭，但是並不是一個全新的頁面，而是之前的頁面某些部分進行瞭修改，這也是SPA單頁應用的特點，其所有的活動局限於一個Web頁面中，非懶加載的頁面僅在該Web頁面初始化時加載相應的HTML、JavaScript、CSS文件，一旦頁面加載完成，SPA不會進行頁面的重新加載或跳轉，而是利用JavaScript動態的變換HTML，默認Hash模式是通過錨點實現路由以及控制組件的顯示與隱藏來實現類似於頁面跳轉的交互。

Memory History

Memory History不會在地址欄被操作或讀取，這就可以解釋如何實現服務器渲染的，同時其也非常適合測試和其他的渲染環境例如React Native，和另外兩種History的一點不同是我們必須創建它，這種方式便於測試。

const history = createMemoryHistory(location);

實現

我們來實現一個非常簡單的Browser History模式與Hash History模式的實現，因為H5的pushState方法不能在本地文件協議file://運行，所以運行起來需要搭建一個http://環境，使用webpack、Nginx、Apache等都可以，回到Browser History模式路由，能夠實現history路由跳轉不刷新頁面得益與H5提供的pushState()、replaceState()等方法以及popstate等事件，這些方法都是也可以改變路由路徑，但不作頁面跳轉，當然如果在後端不配置好的情況下路由改編後刷新頁面會提示404，對於Hash History模式，我們的實現思路相似，主要在於沒有使用pushState等H5的API，以及監聽事件不同，通過監聽其hashchange事件的變化，然後拿到對應的location.hash更新對應的視圖。

<!-- Browser History -->
<!DOCTYPE html>
<html lang="en">

<head>
 <meta charset="UTF-8">
 <title>Router</title>
</head>

<body>
 <ul>
  <li><a href="/home" rel="external nofollow" >home</a></li>
  <li><a href="/about" rel="external nofollow" >about</a></li>
  <div id="routeView"></div>
 </ul>
</body>
<script>
 function Router() {
  this.routeView = null; // 組件承載的視圖容器
  this.routes = Object.create(null); // 定義的路由
 }

 // 綁定路由匹配後事件
 Router.prototype.route = function (path, callback) {
  this.routes[path] = () => this.routeView.innerHTML = callback() || "";
 };

 // 初始化
 Router.prototype.init = function(root, rootView) {
  this.routeView = rootView; // 指定承載視圖容器
  this.refresh(); // 初始化即刷新視圖
  root.addEventListener("click", (e) => { // 事件委托到root
   if (e.target.nodeName === "A") {
    e.preventDefault();
    history.pushState(null, "", e.target.getAttribute("href"));
    this.refresh(); // 觸發即刷新視圖
   }
  })
  // 監聽用戶點擊後退與前進
  // pushState與replaceState不會觸發popstate事件
  window.addEventListener("popstate", this.refresh.bind(this), false); 
 };

 // 刷新視圖
 Router.prototype.refresh = function () {
  let path = location.pathname;
  console.log("refresh", path);
  if(this.routes[path]) this.routes[path]();
  else this.routeView.innerHTML = "";
 };

 window.Router = new Router();
 
 Router.route("/home", function() {
  return "home";
 });
 Router.route("/about", function () {
  return "about";
 });

 Router.init(document, document.getElementById("routeView"));

</script>
</html>

<!-- Hash History -->
<!DOCTYPE html>
<html lang="en">

<head>
 <meta charset="UTF-8">
 <title>Router</title>
</head>

<body>
 <ul>
  <li><a href="#/home" rel="external nofollow" >home</a></li>
  <li><a href="#/about" rel="external nofollow" >about</a></li>
  <div id="routeView"></div>
 </ul>
</body>
<script>
 function Router() {
  this.routeView = null; // 組件承載的視圖容器
  this.routes = Object.create(null); // 定義的路由
 }

 // 綁定路由匹配後事件
 Router.prototype.route = function (path, callback) {
  this.routes[path] = () => this.routeView.innerHTML = callback() || "";
 };

 // 初始化
 Router.prototype.init = function(root, rootView) {
  this.routeView = rootView; // 指定承載視圖容器
  this.refresh(); // 初始化觸發
  // 監聽hashchange事件用以刷新
  window.addEventListener("hashchange", this.refresh.bind(this), false); 
 };

 // 刷新視圖
 Router.prototype.refresh = function () {
  let hash = location.hash;
  console.log("refresh", hash);
  if(this.routes[hash]) this.routes[hash]();
  else this.routeView.innerHTML = "";
 };

 window.Router = new Router();
 
 Router.route("#/home", function() {
  return "home";
 });
 Router.route("#/about", function () {
  return "about";
 });

 Router.init(document, document.getElementById("routeView"));

</script>
</html>

分析

我們可以看一下ReactRouter的實現，commit id為eef79d5，TAG是4.4.0，在這之前我們需要先瞭解一下history庫，history庫，是ReactRouter依賴的一個對window.history加強版的history庫，其中主要用到的有match對象表示當前的URL與path的匹配的結果，location對象是history庫基於window.location的一個衍生。
ReactRouter將路由拆成瞭幾個包: react-router負責通用的路由邏輯，react-router-dom負責瀏覽器的路由管理，react-router-native負責react-native的路由管理。
我們以BrowserRouter組件為例，BrowserRouter在react-router-dom中，它是一個高階組件，在內部創建一個全局的history對象，可以監聽整個路由的變化，並將history作為props傳遞給react-router的Router組件，Router組件再會將這個history的屬性作為context傳遞給子組件。

// packages\react-router-dom\modules\HashRouter.js line 10
class BrowserRouter extends React.Component {
 history = createHistory(this.props);

 render() {
 return <Router history={this.history} children={this.props.children} />;
 }
}

接下來我們到Router組件，Router組件創建瞭一個React Context環境，其借助context向Route傳遞context，這也解釋瞭為什麼Router要在所有Route的外面。在Router的componentWillMount中，添加瞭history.listen，其能夠監聽路由的變化並執行回調事件，在這裡即會觸發setState。當setState時即每次路由變化時 -> 觸發頂層Router的回調事件 -> Router進行setState -> 向下傳遞 nextContext此時context中含有最新的location -> 下面的Route獲取新的nextContext判斷是否進行渲染。

// line packages\react-router\modules\Router.js line 10
class Router extends React.Component {
 static computeRootMatch(pathname) {
 return { path: "/", url: "/", params: {}, isExact: pathname === "/" };
 }

 constructor(props) {
 super(props);

 this.state = {
  location: props.history.location
 };

 // This is a bit of a hack. We have to start listening for location
 // changes here in the constructor in case there are any <Redirect>s
 // on the initial render. If there are, they will replace/push when
 // they mount and since cDM fires in children before parents, we may
 // get a new location before the <Router> is mounted.
 this._isMounted = false;
 this._pendingLocation = null;

 if (!props.staticContext) {
  this.unlisten = props.history.listen(location => {
  if (this._isMounted) {
   this.setState({ location });
  } else {
   this._pendingLocation = location;
  }
  });
 }
 }

 componentDidMount() {
 this._isMounted = true;

 if (this._pendingLocation) {
  this.setState({ location: this._pendingLocation });
 }
 }

 componentWillUnmount() {
 if (this.unlisten) this.unlisten();
 }

 render() {
 return (
  <RouterContext.Provider
  children={this.props.children || null}
  value={{
   history: this.props.history,
   location: this.state.location,
   match: Router.computeRootMatch(this.state.location.pathname),
   staticContext: this.props.staticContext
  }}
  />
 );
 }
}

我們在使用時都是使用Router來嵌套Route，所以此時就到Route組件，Route的作用是匹配路由，並傳遞給要渲染的組件props，Route接受上層的Router傳入的context，Router中的history監聽著整個頁面的路由變化，當頁面發生跳轉時，history觸發監聽事件，Router向下傳遞nextContext，就會更新Route的props和context來判斷當前Route的path是否匹配location，如果匹配則渲染，否則不渲染，是否匹配的依據就是computeMatch這個函數，在下文會有分析，這裡隻需要知道匹配失敗則match為null，如果匹配成功則將match的結果作為props的一部分，在render中傳遞給傳進來的要渲染的組件。Route接受三種類型的render props，<Route component>、<Route render>、<Route children>，此時要註意的是如果傳入的component是一個內聯函數，由於每次的props.component都是新創建的，所以React在diff的時候會認為進來瞭一個全新的組件，所以會將舊的組件unmount再re-mount。這時候就要使用render，少瞭一層包裹的component元素，render展開後的元素類型每次都是一樣的，就不會發生re-mount瞭，另外children也不會發生re-mount。

// \packages\react-router\modules\Route.js line 17
class Route extends React.Component {
 render() {
 return (
  <RouterContext.Consumer>
  {context => {
   invariant(context, "You should not use <Route> outside a <Router>");

   const location = this.props.location || context.location;
   const match = this.props.computedMatch
   ? this.props.computedMatch // <Switch> already computed the match for us
   : this.props.path
    ? matchPath(location.pathname, this.props)
    : context.match;

   const props = { ...context, location, match };

   let { children, component, render } = this.props;

   // Preact uses an empty array as children by
   // default, so use null if that's the case.
   if (Array.isArray(children) && children.length === 0) {
   children = null;
   }

   if (typeof children === "function") {
   children = children(props);
   // ...
   }

   return (
   <RouterContext.Provider value={props}>
    {children && !isEmptyChildren(children)
    ? children
    : props.match
     ? component
     ? React.createElement(component, props)
     : render
      ? render(props)
      : null
     : null}
   </RouterContext.Provider>
   );
  }}
  </RouterContext.Consumer>
 );
 }
}

我們實際上我們可能寫的最多的就是Link這個標簽瞭，所以我們再來看一下<Link>組件，我們可以看到Link最終還是創建一個a標簽來包裹住要跳轉的元素，在這個a標簽的handleClick點擊事件中會preventDefault禁止默認的跳轉，所以實際上這裡的href並沒有實際的作用，但仍然可以標示出要跳轉到的頁面的URL並且有更好的html語義。在handleClick中，對沒有被preventDefault、鼠標左鍵點擊的、非_blank跳轉的、沒有按住其他功能鍵的單擊進行preventDefault，然後push進history中，這也是前面講過的路由的變化與頁面的跳轉是不互相關聯的，ReactRouter在Link中通過history庫的push調用瞭HTML5 history的pushState，但是這僅僅會讓路由變化，其他什麼都沒有改變。在Router中的listen，它會監聽路由的變化，然後通過context更新props和nextContext讓下層的Route去重新匹配，完成需要渲染部分的更新。

// packages\react-router-dom\modules\Link.js line 14
class Link extends React.Component {
 handleClick(event, history) {
 if (this.props.onClick) this.props.onClick(event);

 if (
  !event.defaultPrevented && // onClick prevented default
  event.button === 0 && // ignore everything but left clicks
  (!this.props.target || this.props.target === "_self") && // let browser handle "target=_blank" etc.
  !isModifiedEvent(event) // ignore clicks with modifier keys
 ) {
  event.preventDefault();

  const method = this.props.replace ? history.replace : history.push;

  method(this.props.to);
 }
 }

 render() {
 const { innerRef, replace, to, ...rest } = this.props; // eslint-disable-line no-unused-vars

 return (
  <RouterContext.Consumer>
  {context => {
   invariant(context, "You should not use <Link> outside a <Router>");

   const location =
   typeof to === "string"
    ? createLocation(to, null, null, context.location)
    : to;
   const href = location ? context.history.createHref(location) : "";

   return (
   <a
    {...rest}
    onClick={event => this.handleClick(event, context.history)}
    href={href}
    ref={innerRef}
   />
   );
  }}
  </RouterContext.Consumer>
 );
 }
}

每日一題

https://github.com/WindrunnerMax/EveryDay

參考

https://zhuanlan.zhihu.com/p/44548552 https://github.com/fi3ework/blog/issues/21 https://juejin.cn/post/6844903661672333326 https://juejin.cn/post/6844904094772002823 https://juejin.cn/post/6844903878568181768 https://segmentfault.com/a/1190000014294604 https://github.com/youngwind/blog/issues/109 http://react-guide.github.io/react-router-cn/docs/guides/basics/Histories.html

到此這篇關於ReactRouter的實現方法的文章就介紹到這瞭,更多相關ReactRouter的實現內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

ReactRouter的實現方法