proxy

Cors 정책의 필요성

CORS

교차 출처 리소스 공유(Cross-Origin Resource Sharing, CORS)는 추가 HTTP 헤더를 사용하여, 한 출처에서 실행 중인 웹 애플리케이션이 다른 출처의 선택한 자원에 접근할 수 있는 권한을 부여하도록 브라우저에 알려주는 체제입니다.

출처

웹 콘텐츠의 출처(origin)는 접근할 때 사용하는 URL의 스킴(프로토콜), 호스트(도메인), 포트로 정의됩니다. 두 객체의 스킴, 호스트, 포트가 모두 일치하는 경우 같은 출처를 가졌다고 말합니다. 일부 작업은 동일 출처 콘텐츠로 제한되나, CORS를 통해 제한을 해제할 수 있습P니다.

Proxy

그러나 위의 정석적인 과정 없이 React 라이브러리, 혹은 Webpack Dev Server에서 제공하는 proxy 기능을 사용하면 CORS 정책을 우회할 수 있습니다. 이는 별도의 응답 헤더를 받을 필요 없이 브라우저는 React 앱으로 데이터를 요청하고, 해당 요청을 백엔드로 전달하게 됩니다. 여기서 React 앱이 서버로부터 받은 응답 데이터를 다시 브라우저로 전달하는 방법을 쓰기 때문에 브라우저는 CORS 정책을 위반했는지 모르게 됩니다. 브라우저를 proxy 기능을 통해 속이는 것입니다.

proxy를 적용해 브라우저를 속이기 전 흐름입니다. 프론트엔드에서 개발한 React 앱에서 브라우저 쪽으로 요청을 보냅니다. 그러면 브라우저는 백엔드, 즉 서버 쪽으로 리소스를 요청하게 됩니다. 이때 접근 권한이 있는지, 즉 출처가 같은지 확인하는데 이때 백엔드 서버는 정상적으로 200 OK 응답을 브라우저에게 보냅니다. 마지막으로 브라우저는 받은 리소스 및 응답과 함께 출처가 같은지 아닌지 확인하게 되는데, 이때 출처가 다르다면 응답을 파기(CORS Error) 하고, 출처가 같다면 응답을 파기하지 않고 다시 프론트엔드 쪽으로 응답을 보내주는 것입니다.

proxy를 적용해 브라우저를 속인 후 흐름입니다. React 앱에서 브라우저를 통해 API를 요청할 때, proxy를 통해 백엔드 서버로 요청을 우회하여 보내게 됩니다. 그러면 백엔드 서버는 응답을 React 앱으로 보내고, React 앱은 받은 응답을 백엔드 서버 대신 브라우저에게 전달합니다. 이렇게 되면 출처가 같아지기 때문에 브라우저는 이 사실을 눈치채지 못하고 허용하게 됩니다.

Proxy 사용법

webpack dev server proxy

webpack dev server의 proxy를 사용하게 되면, 브라우저 API를 요청할 때 백엔드 서버에 직접적으로 요청을 하지 않고, 현재 개발서버의 주소로 우회 요청을 하게 됩니다. 그러면 웹팩 개발 서버에서 해당 요청을 받아 그대로 백엔드 서버로 전달하고, 백엔드 서버에서 응답한 내용을 다시 브라우저 쪽으로 반환합니다.

웹팩 개발서버의 proxy 설정은 원래 웹팩 설정을 통해서 적용을 하지만, CRA를 통해 만든 리액트 프로젝트에서는 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(() => {
			...
		})
}

React Proxy 사용법

webpack dev server에서 제공하는 proxy는 전역적인 설정이기 때문에, 종종 해당 방법이 충분히 적용되지 않는 경우가 생기기도 합니다. 그래서 수동으로 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,
    }),
  );
};

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

실습

webpackProxy

// proxy 서버를 백엔드의 서버 dns와 동일하게 작성
{
......
],
    "development": [
      "last 1 chrome version",
      "last 1 firefox version",
      "last 1 safari version"
    ]
  },
  "proxy": "http://localhost:3080/"
}

동일하지 않다면 위와 같은 애러가 발생합니다.

// services.js
import axios from 'axios';
export const getAllBooks = async () => {
  let response;
  try {
    response = await axios('/api/books');
    console.log(response);
  } catch (e) {
    console.error(e);
  }
  return await response.data;
};
 
export const createBook = async data => {
  const response = await axios.post('/api/book', {
    headers: { 'Content-Type': 'application/json' },
    body: data,
  });
  console.log(response);
  return await response.data;
};

React Proxy

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

이를 통해 두 개의 서버를 하나의 proxy서버를 통해 접근할 수 있게 됩니다.

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

Reference

https://github.com/chimurai/http-proxy-middleware