[React] #9 리액트 라우터로 SPA 개발하기

SPA

SPA는 Single Page Application의 약어로, 말 그대로 한 개의 페이지로 이루어진 애플리케이션을 의미한다. 페이지로 구성된 웹 애플리케이션을 만들 때 페이지별로 컴포넌트들을 분리해가면서 프로젝트를 관리하기 위해 필요한 것이 바로 라우팅 시스템이다.

 

기존에는 사용자가 다른 페이지로 이동할 때마다 새로운 html을 받아 오고, 페이지를 로딩할 때마다 서버에서 CSS, JS, 이미지 파일 등의 리소스를 전달받아 브라우저 화면에 보여주었다. 사용자 인터랙션이 별로 없는 정적인 페이지에서는 이러한 방식이 적합하지만, 사용자 인터랙션이 많고 다양한 정보를 제공하는 모던 웹 애플리케이션에서는 적합하지 않다.

 

SPA의 경우 html을 한 번만 받아와서 웹 애플리케이션을 실행시킨 후, 그 이후에는 필요한 데이터만 받아와서 화면에 업데이트 해준다. 기술적으로는 한 페이지만 존재하는 것이지만, 사용자가 경험하기에는 여러 페이지가 존재하는 것처럼 느껴질 수 있다. 리액트 라우터와 같은 라우팅 시스템 통해 사용자 브라우저 주소창의 경로에 따라 알맞는 페이지를 보여지게 되는데, 이때 링크를 눌러서 다른 페이지로 이동할 때 서버에 다른 페이지의 html을 새로 요청하는 것이 아니라, 브라우저의 History API를 사용하여 브라우저 주소창의 값만 변경하고 기존에 페이지에 띄웠던 웹 애플리케이션은 그대로 유지하면서 라우팅 설정에 따라 또다른 페이지를 보여주게 된다.

전통적인 웹 페이지

 

SPA

 

여기서 다른 주소에 다른 화면을 보여 주는 것을 라우팅이라고 한다. 리액트 라이브러리 자체에 이 기능이 내장되어 있지는 않아서 브라우저의 API를 직접 사용하여 관리하거나, 라이브러리를 사용하여 구현할 수 있다. 리액트 라우팅 라이브러리는 리액트 라우터(react-router), 리치 라우터(reach-router), Next.js 등이 있다.

 

리액트 라우터

1. 리액트 라우터 설치

yarn add react-router-dom

2. 프로젝트에 라우터 적용

src/index.js 파일에서 react-router-dom에 내장되어 있는 BrowserRouter 컴포넌트를 사용하여 <App /> 컴포넌트를 감싸준다. 이 컴포넌트는 웹 애플리케이션에 HTML5의 History API를 사용하여 페이지를 새로고침하지 않고도 주소를 변경하고, 현재 주소 경로에 관련된 정보를 props로 쉽게 조회하거나 사용할 수 있도록 해준다.

import { BrowserRouter } from ‘react-router-dom‘;

ReactDOM.render(
  <BrowserRouter>
    <App />
  </BrowserRouter>,
  document.getElementById(‘root‘)
);

3. 페이지 컴포넌트 만들기

리액트 라우터를 통해 여러 페이지로 구성될 웹 애플리케이션을 만들기 위해 각 페이지에서 사용할 컴포넌트를 만든다.

4. Route 컴포넌트로 특정 경로에 컴포넌트 연결

사용자의 브라우저 주소 경로에 따라 우리가 원하는 컴포넌트를 보여주기 위해 Route 라는 컴포넌트를 통해 라우트를 설정해준다. Route 컴포넌트에 어떤 경로에 어떤 컴포넌트를 보여줄지 정의해주면 경로에 따라 다른 컴포넌트를 보여줄 수 있다.

<Route path="주소 규칙" element={컴포넌트} />

이때 Route 컴포넌트는 Routes 컴포넌트 내부에서 사용되어야 한다. App.js에 위와 같은 형태로 작성한 Route 컴포넌트를  작성해주고, 그 컴포넌트들을 Routes 컴포넌트로 감싸준다.

// App.js

function App() {
  return (
    <Routes>
      <Route path="/" element={<Home />} />
      <Route path="/about" element={<About />} />
    </Routes>
	);
}
export default App;

 

Link 컴포넌트

Link 컴포넌트는 클릭하면 다른 주소로 이동시켜주는 컴포넌트이다. 일반 웹 애플리케이션에서는 a 태그를 사용하여 페이지를 전환하는데, 리액트 라우터를 사용할 때는 해당 태그를 직접 사용하면 안 된다. 이 태그는 페이지를 전환하는 과정에서 페이지를 새로 불러오기 때문에 애플리케이션이 가지고 있던 상태들을 모두 날려 버리게 된다. 렌더링된 컴포넌트들이 모두 사라지고 다시 처음부터 렌더링하게 되는 것이다.

 

Link 컴포넌트를 사용하여 페이지를 전환하면 페이지를 새로 불러오지 않고 애플리케이션은 그대로 유지한 상태에서 HTML5 History API를 사용하여 페이지의 주소만 변경해준다. 

 

<Link to="주소">링크 이름</Link>

 

URL 파라미터와 쿼리스트링

페이지 주소를 정의할 때 유동적인 값 사용을 가능하게 해준다. URL 파라미터는 주소의 경로에 유동적인 값을 넣는 형태이고, 쿼리스트링은 주소 뒷부분에 ? 문자열 이후에 key=value로 값을 정의하며 & 로 구분을 하는 형태이다. 주로 URL 파라미터는 ID 또는 이름을 사용하여 특정 데이터를 조회할 때 사용하고, 쿼리스트링은 키워드 검색, 페이지네이션, 정렬 방식 등 데이터 조회에 필요한 옵션을 전달할 때 사용한다.

 

1. URL 파라미터 (ex. /profile/velopert)

URL 파라미터는 useParams라는 Hook을 사용하여 객체 형태로 조회할 수 있다. URL 파라미터의 이름은 라우트 설정을 할 때 Route 컴포넌트의 path props를 통해 설정한다.

// Profile.js
import { useParams } from 'react-router-dom';

const params = useParams();
const profile = data[params.username];

// App.js
<Route path="/profiles/:username" element={<Profile />} />

URL 파라미터는  /profiles/:username  과 같이 경로에  : 를 사용하여 설정한다. 만약 URL 파라미터가 여러 개인 경우엔  /profiles/:username/:field  와 같은 형태로 설정할 수 있다.

 

2. 쿼리스트링 (ex. articles?**page=1&keyword=react)

쿼리스트링을 사용할 때는 URL 파라미터와 달리 Route 컴포넌트를 사용할 때 별도로 설정해야 하는 것이 없다. 

import { useLocation } from 'react-router-dom';

const About = () => {
  const location = useLocation();

  return (
    <div>
      <h1>소개</h1>
      <p>리액트 라우터를 사용해 보는 프로젝트입니다.</p>
      <p>쿼리스트링: {location.search}</p>
    </div>
  );
};

export default About;

여기서 useLocation 이라는 Hook은 location 객체를 반환하여 현재 사용자가 보고 있는 페이지의 정보를 제공해준다. 객체에는 다음과 같은 값들이 있다.

- pathname : 현재 주소의 경로 (쿼리스트링 제외)

- search : 맨 앞의 ? 문자를 포함한 쿼리스트링 값

- hash : 주소의 # 문자열 뒤의 값 (주로 History API가 지원되지 않는 구형 브라우저에서 클라이언트 라우팅을 사용할 때 쓰는 해시 라우터에 사용된다.)

- state : 페이지로 이동할 때 임의로 넣을 수 있는 상태값

- key : location 객체의 고유값으로 초기에는 default이며 페이지가 변경될 때마다 고유의 값이 생성된다.

 

http://localhost:3000/about?detail=true&mode=1  라는 주소에서 현재 쿼리스트링 값은 ?detail=true&mode=1 이 된다. 이 문자열에서 ?를 지우고, & 문자로 분리한 뒤 key와 value를 파싱하는 작업을 해야 하는데, useSearchParams 라는 Hook을 통해 간편하게 할 수 있다. useSerachParam는 배열 타입의 값을 반환하며, 첫 번째 원소는 쿼리파라미터를 조회하거나 수정하는 메서드들이 담긴 객체를 반환한다. get 메서드를 통해 특정 쿼리파라미터를 조회할 수 있고, set 메서드를 통해 특정 쿼리파라미터를 업데이트할 수 있다. 만약 조회시에 쿼리파라미터가 존재하지 않는다면 null로 조회된다. 두 번째 원소는 쿼리파라미터를 객체 형태로 업데이트 할 수 있는 함수를 반환한다.

쿼리파라미터를 사용할 때 주의할 점은 쿼리파라미터를 조회할 때 값이 무조건 문자열 타입이어야 한다는 것이다. 즉 true 또는 false 값을 넣게 된다면 값을 비교할 때 반드시 'true'와 같이 따옴표로 감싸서 비교를 해야 하고, 숫자를 다루게 될 때는 parseInt를 사용하여 숫자 타입으로 변환을 해야 한다.

 

중첩된 라우트

중첩된 라우트와 Outlet 컴포넌트를 사용하면 페이지끼리 공톡적으로 보여줘야 하는 레이아웃이 있을 때 유용하게 사용할 수 있다. 예를 들어 게시글 목록 페이지에서 게시글 하나를 선택했을 때 게시글 페이지가 게시글 목록 하단에 나오도록 할 수 있다. 아래와 같이 중첩된 라우트 형태로 라우트를 설정해준다.

// src/App.js
<>
  <Route path="/articles" element={<Articles />} >
    <Route path=":id" element={<Article />} />
  </Route>
</>

다음 Articles 컴포넌트에서 리액트 라우터에서 제공하는 Outlet 컴포넌트를 사용해준다. Outlet 컴포넌트는 Route의 cildren으로 들어가는 JSX 엘리먼트를 보여주는 역할을 한다.

import { Link, Outlet } from 'react-router-dom';

const Articles = () => {
  return (
    <div>
      <ul>
        <li>
          <Link to="/articles/1">게시글 1</Link>
        </li>
        <li>
          <Link to="/articles/2">게시글 2</Link>
        </li>
        <li>
          <Link to="/articles/3">게시글 3</Link>
        </li>
      </ul>
      <Outlet />
    </div>
  );
};

export default Articles;

Outlet 컴포넌트가 사용된 자리에 중첩된 라우트가 보여지게 된다.

* index props : Route 컴포넌트의 index props는 path="/"와 동일한 의미를 가진다.

 

리액트 라우터 부가 기능

1. useNavigate

useNavigate는 Link 컴포넌트를 사용하지 않고 다른 페이지로 이동해야 하는 상황에서 사용하는 Hook이다.

// src/Layout.js

import { Outlet, useNavigate } from 'react-router-dom';

const Layout = () => {
  const navigate = useNavigate();

  const goBack = () => {
    // 이전 페이지로 이동
    navigate(-1);
  };

  const goArticles = () => {
    // articles 경로로 이동
    navigate('/articles');
  };

  return (
    <div>
      <header style={{ background: 'lightgray', padding: 16, fontSize: 24 }}>
        <button onClick={goBack}>뒤로가기</button>
        <button onClick={goArticles}>게시글 목록</button>
      </header>
      <main>
        <Outlet />
      </main>
    </div>
  );
};

export default Layout;

navigate 함수를 사용할 때 파라미터를 숫자 타입으로 주면 페이지를 앞으로 가거나 뒤로 갈 수 있다. 예를 들어서 navigate(-1)을 하면 한 번 뒤로 가고, navigate(-2)를 하면 두 번 뒤로 간다. 반대로 navigate(1)을 하면 앞으로 한 번 간다. 물론 뒤로가기를 한 번 한 상태여야 한다.

 

다른 페이지로 이동할 때  replace 라는 옵션을 설정해주면 해당 페이지를 페이지 기록에 남기지 않는다. 예를 들어 Home 페이지에서 About 페이지로 이동한 다음, 게시글 페이지로 이동해서 뒤로가기 버튼을 눌렀을 때,  navigate('/articles', { replace : true })  가 설정되어 있지 않다면 직전 페이지인 About 페이지가 나타나지만 이 옵션이 활성화되어 있다면 그 전의 페이지인 Home 페이지가 나타나게 된다.

 

2. NavLink

NavLink 컴포넌트는 링크에서 사용하는 경로가 현재 라우트의 경로와 일치하는 경우 특정 스타일 또는 CSS 클래스를 적용하는 컴포넌트이다.

const activeStyle = {
  color: 'green',
  fontSize: 21,
};
  
<NavLink
  to="/articles/1"
  style={({ isActive }) => (isActive ? activeStyle : undefined)}
>

 

3. NotFound 페이지

사전에 정의되지 않은 경로에 사용자가 진입했을 때, 즉 페이지를 찾을 수 없을 때 나타날 페이지를 만든다. 그리고 App.js에 아래와 같이 작성한다.

<>
  <Route path="*" element={<NotFound />} />
</>

 *  은 와일드카드 문자로 아무 텍스트를 매칭한다는 뜻이다. 이 라우트 엘리먼트의 상단에 위치하는 라우트들의 규칙을 모두 확인하고, 일치하는 라우트가 없다면 이 라우트가 화면에 나타나게 한다.

 

4. Navigate 컴포넌트

Navigate 컴포넌트는 컴포넌트를 화면에 보여주는 순간 다른 페이지로 이동하고 싶을 때 사용하는 컴포넌트이다. 즉, 페이지를 리다이렉트 하고 싶을 때 사용한다. 예를 들어 사용자의 로그인이 필요한 페이지인데 로그인을 안 했다면 로그인 페이지로 바로 넘어가도록 하는 상황에서 사용할 수 있다.

// Login.js
const Login = () => {
  return <div>로그인 페이지</div>;
};

export default Login;

// MyPage.js
import { Navigate } from 'react-router-dom';

const MyPage = () => {
  const isLoggedIn = false;

  if (!isLoggedIn) {
    return <Navigate to="/login" replace={true} />;
  }

  return <div>마이 페이지</div>;
};

export default MyPage;

 

* react-router-dom v5 → v6

react-router-dom v5 -> v6

 

 

참고 자료 : https://velog.io/@velopert/react-router-v6-tutorial