[ Proxy ] CORS Error를 React에서 해결하는 방법

Proxy에 대해 알아보자

---

Proxy는 CORS 정책을 우회할 수 있는 React 라이브러리, 혹은 Webpack Dev Server에서 제공하는 기능입니다.

 

이 기능이 필요한 이유를 알려면 CORS 정책이 필요한 이유를 먼저 알아야 합니다.

 

CORS 정책이 필요한 이유가 뭘까요 ?

proxy 적용 전 흐름

브라우저에서 API를 요청할 때는 브라우저의 현재 주소와 API 주소의 도메인이 일치해야만 데이터를 접근할 수 있습니다. 만약 다른 도메인에서 API를 요청해서 사용할 수 있게 하려면 CORS 설정이 필요합니다.
로컬 환경에서 개발한 앱은 기본적으로 localhost:3000 으로 시작합니다.
그러나, 나중에 로컬 환경에서 개발한 실제 서비스 및 프로젝트의 클라이언트에서 서버의 API로 요청하게 되면,이 포트로 요청하는 것이 차단됩니다.
실제로 개발한 서비스 및 프로젝트가 모든 출처의 접근을 허락한다면 이는 후에 큰 문제로 야기될 수 있습니다.
만약 서비스 및 프로젝트가 모든 출처의 접근을 허락한다면 이러한 보안성이 현저히 낮아지고, 해킹의 위험에 그대로 노출되게 됩니다.
그렇기 때문에 모든 도메인을 허용해서는 안되고, 특정 도메인을 허용하도록 구현해야 합니다.
또한, 프론트엔드 개발자는 백엔드 개발자에게 프론트엔드 개발 서버 도메인을 허용해달라고 요청을 해야하고,
백엔드 개발자는 응답 헤더에 필요한 값들을 담아서 전달 해줘야 합니다.
서버에서 적절한 응답 헤더를 받지 못하면 브라우저에서 에러가 발생하기 때문입니다.

그러나 이런 정석적인 과정 없이 CORS 정책을 우회할 수 있게 해주는 것이 Proxy 기능입니다.

Proxy

proxy 적용 후 흐름

Proxy 기능은 별도의 응답 헤더를 받을 필요 없이 브라우저는 React 앱으로 데이터를 요청하고, 해당 요청을 백엔드로 전달하게 되는데, 여기서 React 앱이 서버로부터 받은 응답 데이터를 다시 브라우저로 전달하는 방법을 쓰기 때문에 브라우저는 CORS 정책을 위반했는지 모르게 됩니다. 브라우저를 proxy 기능을 통해 속이는 것 입니다.

Proxy 사용법

1. webpack dev server proxy

• 전역적인 설정

웹팩 개발서버의 proxy 설정은 원래 웹팩 설정을 통해서 적용을 하지만, CRA를 통해 만든 리액트 프로젝트에서는 package.json 에서 "proxy" 값을 설정하여 쉽게 적용할 수 있도록 구성되어 있습니다.

 

package.json 에서 "proxy" 값을 설정

...
"browserslist": {
    "production": [
      ">0.2%",
      "not dead",
      "not op_mini all"
    ],
    "development": [
      "last 1 chrome version",
      "last 1 firefox version",
      "last 1 safari version"
    ]
  },
	"proxy" : "우회할 API 주소"
}

기존의 fetch, 혹은 axios를 통해 요청하던 부분에서 도메인 부분을 제거

export async function getAllfetch() {

    const response = await fetch('우회할 api주소/params');
    .then(() => {
			...
		})
}

export async function getAllfetch() {

    const response = await fetch('/params');
    .then(() => {
			...
		})
}

위의 방법이 충분히 적용되지 않는 경우에는 수동으로  Proxy를 적용해줘야 한다.

수동으로 Proxy를 적용하는 방법을 알아보자.

2. React Proxy 사용법

http-proxy-middleware 라이브러리 설치

npm install http-proxy-middleware --save

React App의 src 파일 안에서 setupProxy.js 파일을 생성, 파일 안에 아래 코드 작성

const { createProxyMiddleware } = require('http-proxy-middleware');

module.exports = function(app) {
  app.use(
    '/api', //proxy가 필요한 path prameter를 입력합니다.
    createProxyMiddleware({
      target: 'http://localhost:5000', //타겟이 되는 api url를 입력합니다.
      changeOrigin: true, //대상 서버 구성에 따라 호스트 헤더가 변경되도록 설정하는 부분입니다.
    })
  );
};

기존의 fetch, 혹은 axios를 통해 요청하던 부분에서 도메인 부분을 제거

(webpack dev server에서 제공하는 proxy 기능을 사용할 때와 동일)

export async function getAllfetch() {

    const response = await fetch('우회할 api주소/params');
    .then(() => {
			...
		})
}

export async function getAllfetch() {

    const response = await fetch('/params');
    .then(() => {
			...
		})
}