gh-pages가 SPA를 지원하지 않아 404페이지가 뜰 때

꼼영 🌱·2023년 8월 5일

문제 상황

포트폴리오를 create-react-app으로 만들어서 gh-pages에 배포했는데
루트 페이지에서 버튼을 클릭하여 링크이동을 하면 제대로 작동했지만
직접 이동할 url을 창에 입력하여 이동하면 404페이지가 보였다.

문제 원인

Github Pages에서는 SPA를 지원하지 않는다고 한다.
그래서 기본 URL이 example.site/ 인 경우
example.site/page 와 같은 경로로 직접 이동하거나 새로고침 할 경우 에러가 난다.

해결방법

폭풍🌪 구글링 끝에 아래와 같은 두 가지 방법을 찾았다.

1. BrowerRouter 대신 HashRouter를 사용한다.

function App() {
  return (
    <BrowerRouter basename="/app">
      <Routes>
        <Route path="/" />
      </Routes>
    </HashRouter>
  );
}

function App() {
  return (
    <HashRouter basename="/app">
      <Routes>
        <Route path="/" />
      </Routes>
    </HashRouter>
  );
}

이 방법을 선택하여 HashRouter로 바꿔보았지만 제대로 작동하지 않았다...
버전 문제인가 싶어 router 버전을 6에서 5로 낮추어서도 해보았지만 실패!
HashRouter를 사용하면 url 주소도 지저분해지는 것이 많이 거슬렸다.
example.site#/page 이런식으로 #이 붙게 되더라

2. 404.html를 만들어서 리다이렉션을 한다.

HashRouter로 바꾼 소스를 다시 BrowerRouter로 되돌리고 router도 최신버전으로 셋팅한 다음
아래와 같이 파일을 수정/추가해주었다.

public/index.html (script 추가)

<script type="text/javascript">
      // Single Page Apps for GitHub Pages
      // https://github.com/rafrex/spa-github-pages
      // Copyright (c) 2016 Rafael Pedicini, licensed under the MIT License
      // ----------------------------------------------------------------------
      // This script checks to see if a redirect is present in the query string
      // and converts it back into the correct url and adds it to the
      // browser's history using window.history.replaceState(...),
      // which won't cause the browser to attempt to load the new url.
      // When the single page app is loaded further down in this file,
      // the correct url will be waiting in the browser's history for
      // the single page app to route accordingly.
      (function (l) {
        if (l.search) {
          var q = {};
          l.search
            .slice(1)
            .split("&")
            .forEach(function (v) {
              var a = v.split("=");
              q[a[0]] = a.slice(1).join("=").replace(/~and~/g, "&");
            });
          if (q.p !== undefined) {
            window.history.replaceState(
              null,
              null,
              l.pathname.slice(0, -1) +
                (q.p || "") +
                (q.q ? "?" + q.q : "") +
                l.hash
            );
          }
        }
      })(window.location);
    </script>

public/404.html (파일 추가)

<!DOCTYPE html>
<html>
  <head>
    <meta charset="utf-8" />
    <title>Single Page Apps for GitHub Pages</title>
    <script type="text/javascript">
      // Single Page Apps for GitHub Pages
      // https://github.com/rafrex/spa-github-pages
      // Copyright (c) 2016 Rafael Pedicini,  licensed under the MIT License
      //  ---------------------------------------------- ------------------------
      // This script takes the current url and  converts the path and query
      // string into just a query string, and then  redirects the browser
      // to the new url with only a query string  and hash fragment,
      // e.g. http://www.foo.tld/one/two?a=b& c=d#qwe, becomes
      // http://www.foo.tld/?p=/one/two&  q=a=b~and~c=d#qwe
      // Note: this 404.html file must be at least  512 bytes for it to work
      // with Internet Explorer (it is currently >  512 bytes)

      // If you're creating a Project Pages site  and NOT using a custom domain,
      // then set segmentCount to 1 (enterprise   users may need to set it to > 1).
      // This way the code will only replace the  route part of the path, and not
      // the real directory in which the app  resides, for example:
      //  https://username.github.io/repo-name/one/two?  a=b&c=d#qwe becomes
      // https://username.github.io/repo-name/? p=/one/two&q=a=b~and~c=d#qwe
      // Otherwise, leave segmentCount as 0.
      var segmentCount = 1;

      var l = window.location;
      l.replace(
        l.protocol +
          "//" +
          l.hostname +
          (l.port ? ":" + l.port : "") +
          l.pathname
            .split("/")
            .slice(0, 1 + segmentCount)
            .join("/") +
          "/?p=/" +
          l.pathname
            .slice(1)
            .split("/")
            .slice(segmentCount)
            .join("/")
            .replace(/&/g, "~and~") +
          (l.search ? "&q=" + l.search.slice(1).replace(/&/g, "~and~") : "") +
          l.hash
      );
    </script>
  </head>
  <body></body>
</html>