[💻 코드스테이츠 FE 44기]Proxy

✔️ 시작

Proxy, CORS 에러를 해결에 대해 학습하고 실습을 진행했다.

---

📍 배운 것

✔️ CORS 정책이 필요한 이유

다른 도메인에서 API를 요청해서 사용할 수 있게 해 주려면 CORS 설정이 필요하다.

실제 서비스가 되는 상용 앱을 운영 중인 경우, 구축한 클라이언트 뒤의 서버와 연결되어 있는 DB에는 라이브 데이터(live data)가 쌓일 것이다.

라이브 데이터는 민감성이 높은 데이터들이 위주이기 때문에 보안이 무엇보다 중요하다.
서비스 및 프로젝트가 모든 출처의 접근을 허락하게 될 경우 보안성이 낮아지고, 해킹의 위험에 그대로 노출하게 된다.

즉, 모든 도메인을 허용해서는 안 되고, 특정 도메인을 허용하도록 구현해야 한다.

• 프론트엔드 개발자 : 백엔드 개발자에게 프론트엔드 개발 서버 도메인을 허용해 달라고 요청을 해야 한다.
• 백엔드 개발자 : 응답 헤더에 필요한 값들을 담아서 전달 해줘야한다.

서버에서 적절한 응답 헤더를 받지 못하면 브라우저에서 에러가 발생하기 때문이다.

CORS

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

출처(origin)

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

라이브 데이터(live data)

• 실제 서비스되고 있는 앱의 데이터베이스(Data Base, DB)에 적재되고 있는 데이터
• 유저 및 상품, 결제 등 다양한 정보들을 예로 들 수 있다.

✔️ Proxy

• React 라이브러리, 혹은 Webpack Dev Server에서 제공하는 proxy 기능을 사용하면 CORS 정책을 우회할 수 있다.
• 응답 헤더를 받을 필요 없이 브라우저는 React 앱으로 데이터를 요청하고, 해당 요청을 백엔드로 전달하게 된다.
• React 앱이 서버로부터 받은 응답 데이터를 다시 브라우저로 전달하는 방법을 쓰기 때문에 브라우저는 CORS 정책을 위반했는지 모른다. (브라우저를 proxy 기능을 통해 속이는 것)

[proxy 적용 전 흐름.png]

[proxy 적용 전 흐름.png]을 보면 proxy를 적용해 브라우저를 속이기 전 흐름이다.

• 개발한 React 앱에서 브라우저 쪽으로 요청을 보낸다.(프론트엔드)
• 브라우저는 서버 쪽으로 리소스를 요청하게 된다.(백엔드)
  - 이 때 접근 권한이 있는지(출처가 같은지 확인)한다.
• 백엔드 서버는 정상적으로 200 OK 응답을 브라우저에게 보낸다.
• 브라우저는 받은 리소스 및 응답과 함께 출처가 같은지 확인한다.
  - 출처가 다른 경우 응답을 파기(CORS Error)
  - 출처가 같은 경우 응답을 파기하지 않고 다시 프론트엔드 쪽으로 응답을 보내준다.

[proxy 적용 후 흐름.png]

[proxy 적용 후 흐름.png]를 보면 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는 보통 맨 밑에 작성을 해 금방 찾을 수 있도록 한다.
	"proxy" : "우회할 API 주소"
}

• proxy는 보통 맨 밑에 작성을 해 금방 찾을 수 있도록 한다.

//기존의 fetch, 혹은 axios를 통해 요청하던 부분에서 도메인 부분을 제거
export async function getAllfetch() {

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

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

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

- React Proxy 사용법

webpack dev server에서 제공하는 proxy는 전역적인 설정이기 때문에, 종종 해당 방법이 충분히 적용되지 않는 경우가 생기기도 한다.

그런 경우 수동으로 proxy를 적용해줘야 하는 경우가 있다.
(http-proxy-middleware 라이브러리를 사용)

npm install http-proxy-middleware --save

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

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 기능을 사용할 때와 동일하다.

과제 진행

webpack dev server proxy, React Proxy 두 가지 방법으로 실습을 진행했다.

webpack dev server proxy은 기존 배웠던 내용과 동일했다.
React Proxy는 client에서 작업해 주면된다.

2가지 서버와 연결되어야 해서 이부분을 어떻게 작성해야 하는지 헤맸었다.

정말 단순하게 동일하게 작성 해 경로, 도메인 부분만 변경해 주면된다.

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

module.exports = function(app) {
  app.use(
    '/api', 
    createProxyMiddleware({
      target: 'http://localhost:3080', 
      changeOrigin: true, 
    })
  );

  app.use(
    '/api2', 
    createProxyMiddleware({
      target: 'http://localhost:3070', 
      changeOrigin: true, 
    })
  );
};

이후 컴포넌트 작업 후 서버를 api, api2경로로 가서
npm run dev로 실행해 주면 된다.

http://localhost:3080의 books와
http://localhost:3070의 todos가 잘 나오는 걸 확인할 수 있다.

(중간 중간 내용은 테스트 하느라... 저렇게 됐다)

---

✏️ 마치며

CORS 에러를 해결 방법에 대해 학습하고 실습하는 시간을 가졌다.

왜 proxy를 사용해야하고 어떤식으로 작성을 해야하는지 알 수 있었다.

글로 공부한는거 보다 실습을 통해 진행하니 더 잘 이해 할 수 있었다.