[Deploy] Proxy

Hyun Jin·2023년 4월 4일

Proxy cors http-proxy-middleware

1. CORS 정책이 필요한 이유

모든 브라우저는 기본적으로 SOP 정책을 사용하고 있음
SOP(Same-Origin Policy, 동일출처정책) : 스킴(프로토콜), 호스트(도메인), 포트가 모두 같아야 동일한 출처로 판단함.
SOP 정책으로 인해 다른 출처의 리소스를 사용할 때 출처가 같지 않으면 CORS 에러가 발생하게 됨.(CORS 를 사용하면 접근 권한을 얻을 수 있음)
CORS(Cross-Origin Resource Sharing, 교차 출처 리소스 공유) : 추가 HTTP 헤더를 사용하여, 한 출처에서 실행 중인 웹 애플리케이션이 다른 출처의 선택한 자원에 접근할 수 있는 권한을 부여하도록 브라우저에 알려주는 체제
일부 작업은 동일 출처 콘텐츠로 제한되나, CORS 를 통해 제한을 해제할 수 있음
원래는 특정 도메인만을 허용하도록 구현해야 함(프론트→백엔드로 프론트 개발서버 도메인 허용 요청, 백엔드→프론트로 응답헤더에 필요한 값들을 담아서 전달해줘야 함)
CORS 설정을 통해 서버의 응답 헤더에 ‘Access-Control-Allow-Origin’을 작성하면 접근 권한을 얻을 수 있습니다.

2. Proxy

정석적인 접근권한 부여 없이 React 라이브러리, 혹은 Webpack Dev Server에서 제공하는 proxy 기능을 사용하여 CORS 정책을 우회하는 방법.
별도의 응답 헤더를 받을 필요 없이 브라우저는 React 앱으로 데이터를 요청하고, 해당 요청을 백엔드로 전달하게 됨
이때 eact 앱이 서버로부터 받은 응답 데이터를 다시 브라우저로 전달하는 방법을 쓰기 때문에 브라우저는 CORS 정책을 위반한지 모르게 됨.

3. Proxy 사용법

1. webpack dev server proxy

CRA 를 통해 만든 리액트 프로젝트에서는 package.json 에서 "proxy" 값을 설정하여 쉽게 적용할 수 있음

하지만 API 주소가 한곳인 경우에 사용

...
"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 주소"
}

package.json 에 proxy 주소를 추가해 준 후(string 만 사용 가능, 콤마나 공백이 더 들어가는 것에도 예민하니 주의할 것.) 기존의 요청에서 도메인 부분을 제거함

export async function getAllfetch() {

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

export async function getAllfetch() {

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

2. React Proxy 사용법

webpack dev server 에서 제공하는 proxy는 전역적인 설정이기 때문에, 종종 해당 방법이 충분히 적용되지 않는 경우가 생기기도 합니다. 그래서 수동으로 proxy를 적용해줘야 하는 경우가 있는데, 이때는 http-proxy-middleware 라이브러리를 사용해야 합니다.
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를 통해 요청하던 부분에서 도메인 부분을 제거

export async function getAllfetch() {

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

export async function getAllfetch() {

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