Today I Learn...
어제의 CI/CD에 이어서 오늘은 Proxy에 대한 내용을 블로깅한다.
아자아자 화이팅~~!! 💪
Proxy
💡 개념학습
📌 CORS 정책이 필요한 이유
브라우저에서 API를 요청 할 때, 아래 조건으로만 데이터 접근 가능
➡️ 브라우저의 현재 주소와 API의 주소의 도메인이 일치
➡️ 다른 도메인에서 API를 요청해서 사용 할 수 있게 해주려면 CORS 설정이 필요
CORS :
교차 출처 리소스 공유(Cross-Origin Resource Sharing)는 추가 HTTP 헤더를 사용하여, 한 출처에서 실행 중인 웹 애플리케이션이 다른 출처의 선택한 자원에 접근할 수 있는 권한을 부여하도록 브라우저에 알려주는 체제
출처 :
웹 콘텐츠의 출처(origin)는 접근할 때 사용하는 URL의스킴(프로토콜),호스트(도메인),포트로 정의된다.
스킴,호스트,포트가 모두 일치하는 경우 같은 출처를 가졌다고 말한다.
일부 작업은 동일 출처 콘텐츠로 제한되나, CORS를 통해 제한을 해제할 수 있다.
로컬 환경에서 개발한 실제 서비스 및 프로젝트의 클라이언트에서 서버의 API로 요청하게 되면, 포트로 요청하는 것이 차단된다.
❗️ 개발한 서비스가 모든 출처의 접근을 허락한다면 나중에 큰 문제가 될 수 있다.
만약 실제 서비스 되는 상용 앱을 운영 중이라면, 구축한 클라이언트 뒤의 서버와 연결되어 있는 DB에는 라이브 데이터(live data)가 쌓일 것이다.
라이브 데이터(live data) :
실제 서비스되고 있는 앱의 데이터베이스(DB)에 적재되고 있는 데이터를 의미
(예. 유저 및 상품, 결제 등 다양한 정보들)
이런 라이브 데이터는 민감성이 높은 데이터들이 위주이기 때문에 보안이 아주 아주 중요하다!
그러나 서비스 및 프로젝트가 모든 출처의 접근을 허락한다면 이러한 보안성이 현저히 낮아지고, 해킹의 위험에 그대로 노출되게 된다.
그렇기 때문에 모든 도메인을 허용해서는 안 되고, 특정 도메인을 허용하도록 구현해야 한다.
프론트엔드 개발자가 백엔드 개발자에게 프론트엔드 개발 서버 도메인을 허용해달라고 요청을 해야하고, 백엔드 개발자는 응답 헤더에 필요한 값들을 담아서 전달을 해줘야 한다.
📌 Proxy
그러나 이런 과정 없이 React 라이브러리, 혹은 Webpack Dev Server에서 제공하는 proxy 기능을 사용하면 CORS 정책을 우회할 수 있다.
별도의 응답 헤더를 받을 필요 없이 브라우저는 React 앱으로 데이터를 요청하고, 해당 요청을 백엔드로 전달하게 된다.
여기서 React 앱이 서버로부터 받은 응답 데이터를 다시 브라우저로 전달하는 방법을 쓰기 때문에 브라우저는 CORS 정책을 위반한지 모르게 된다.
➡️ 브라우저를 proxy 기능을 통해 속이는 것
proxy 적용 전 흐름
1️⃣ 프론트엔드가 개발한 React 앱에서 브라우저 쪽으로 요청
2️⃣ 브라우저는 백엔드(서버) 쪽으로 리소스를 요청
3️⃣ 이때 접근 권한이 있는지, 즉 출처가 같은지 확인
4️⃣ 백엔드 서버는 정상적으로 200 OK 응답을 브라우저에게 보냄
5️⃣ 브라우저는 받은 리소스 및 응답과 함께 출처가 같은지 아닌지 확인
➡️ 출처가 다르다면 응답을 파기(CORS Error)
➡️ 출처가 같다면 프론트엔드 쪽으로 응답을 보냄
proxy 적용 후 흐름
1️⃣ React 앱에서 브라우저를 통해 API를 요청
2️⃣ proxy를 통해 백엔드 서버로 요청을 우회하여 보냄
3️⃣ 백엔드 서버는 응답을 React 앱으로 보냄
4️⃣ React 앱은 받은 응답을 백엔드 서버 대신 브라우저에게 전달
➡️ 출처가 같아지기 때문에 브라우저는 이 사실을 눈치 채지 못하고 허용
💡 proxy 사용법
📌 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 주소"
}proxy는 보통 맨 밑에 작성을 해 금방 찾을 수 있도록 하는게 포인트!
그리고 기존의 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, //대상 서버 구성에 따라 호스트 헤더가 변경되도록 설정하는 부분
})
);
};기존의 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(() => {
...
})
}