급행 배송(Routing) 🚂!!
라우팅이란 애플리케이션이 **특정 엔드포인트(URI 또는 경로)**에 대한 클라이언트 요청과 **특정 HTTP 요청 메서드(GET, POST 등)**에 어떻게 응답할지 결정하는 것을 말한다.
아래 모든 설명은 Express 4.x 버전을 기준으로 함.
Express 5.x 버전에서는 많은 것이 달라졌음.
Express 라우팅
애플리케이션은 지정된 경로(엔드포인트)와 HTTP 메서드에 대한 요청을 수신하고, 일치하는 요청을 감지하면 지정된 콜백 함수를 호출한다.
app.METHOD(PATH, HANDLER)
- app는 express의 인스턴스이다.
- METHOD는 소문자로 된 HTTP 요청 메서드이다.
- PATH는 서버상의 경로이다.
- HANDLER는 해당 경로가 일치할 때 실행되는 함수이다.
HANDLER에는 익명함수가 많이 들어가는데 이때, 요청 객체(관례적으로 req), 응답 객체(관례적으로 res) 인자를 받는다.req는 요청할 때, 들어오는 데이터 객체(Input)로써 사용된다.res는 반환할 때, 나가는 데이터 객체(Output)로써 사용된다.
다음은 res 객체 반환 방식이다.
res.download() => 다운로드할 파일을 선택하라는 메시지를 표시한다.
res.end() => 응답 프로세스를 종료한다.
res.json() => JSON 형식의 응답을 보낸다.
res.jsonp() => JSONP를 지원하는 JSON 응답을 전송한다.
res.redirect() => 요청을 리디렉션한다.
res.render() => 뷰 템플릿을 렌더링한다.
res.send() => 다양한 유형의 응답을 보낸다.
res.sendFile() => 파일을 옥텟 스트림으로 전송한다.
res.sendStatus() => 응답 상태 코드를 설정하고 해당 문자열 표현을 응답 본문으로 전송한다.
루트 경로(/), 애플리케이션의 홈페이지에서 GET 메서드를 통해 Hello World!를 출력하는 코드는 다음과 같다.
const express = require('express')
const app = express()
app.get('/', (req, res) => {
res.send('Hello World!')
})
루트 경로(/), 즉 애플리케이션의 홈페이지에 대한 POST 요청에 응답한다.
const express = require('express')
const app = express()
app.post('/', (req, res) => {
res.send('Got a POST request')
})
해당 /user 경로에 대한 PUT 요청에 응답한다.
const express = require('express')
const app = express()
app.put('/user', (req, res) => {
res.send('Got a PUT request at /user')
})
해당 /user 경로에 대한 DELETE 요청에 응답한다.
const express = require('express')
const app = express()
app.delete('/user', (req, res) => {
res.send('Got a DELETE request at /user')
})
app.all()은 모든 HTTP 요청 메소드에 대해 특정 경로에서 미들웨어 함수를 로드하는 특별한 라우팅 방식이다. HTTP 표준에 있는 8가지 메소드 외에도
약 39가지 이상의 모든 HTTP 메서드를 인식한다.
해당 /secret 경로에 대한 모든 HTTP 요청에 응답하고 다음 미들웨어를 호출한다.
app.all('/secret', (req, res, next) => {
console.log('Accessing the secret section ...')
next() // pass control to the next handler
})
기본 라우터
위에서 서술한 내용을 정리해보면 다음과 같다.
/ => root 경로에 대한 요청 감지.
/(아무문자열) => (아무문자열)에 대한 요청 감지.
(예: /about, /random.text)
문자열 패턴
Express.js에서는 문자열 패턴을 기반으로 한 경로를 지정할 수 있다.
아래에 각각의 고유 문자열 패턴이 서술되어 있다.
또한 여기에서 모든 고유 문자열 패턴의 가능성을 확인할 수 있다.
ab?cd => "?" 앞 문자가 있건, 없건 이와 관계없이 감지.
(예: /acd, /abcd)
ab+cd => "+"에 어떤 문자열이 들어가건 관계 없이 감지.
(예: /abcd, /abbbcd, /abxcd, /abRANDOMcd, /ab123cd
ab*cd => 와일드 카드. "*"을 기준으로 모든 하위 접근 요청을 감지.
(예: /abe, /ab/dd/ee/aw, /absdnanwidnwdnwid.html)
ab(cd)?e => "(cd)"를 통해 한 그룹으로 묶고 "?"를 통해 (cd)가 있건 없건 이와 관계없이 감지.
(예: /abe, /abcde)
정규 표현식
Express.js에서는 또한 정규 표현식을 기반으로 한 경로를 설정할 수 있다.
아래에 몇가지 정규표현식 예시가 서술되어 있다.
자세한 가이드는 여기에서 확인 가능하다.
/a/ => "a"라는 글자가 단 하나라도 포함된 모든 항목을 감지.
(예: /a, /dwasdwd, /dwa, /2a)
/.*fly$/ => 단어의 마지막이 "fly"로 끝나는 모든 항목을 감지.
(예: /butterfly, /dragonfly
하지만 /butterflyman, /dragonflyman등과는 불일치)
경로 매개변수
경로 매개변수는 URL에서 해당 위치에 지정된 값을 캡처하는 데 사용되는 명명된 URL 세그먼트이다. 캡처된 값은 req.params 객체에 채워지며, 경로에 지정된 경로 매개변수 이름이 각각의 키로 사용된다.
Route path: /users/:userId/books/:bookId
Request URL: http://localhost:3000/users/34/books/8989
req.params: { "userId": "34", "bookId": "8989" }
아래는 경로 매개변수명을 설정하는 규칙이다.
- 경로 매개변수의 이름은 "단어 문자"
[A-Za-z0-9_]로 구성되어야 한다.--과..은 문자 그대로 해석되므로 경로 매개변수와 함께 유용하게 사용할 수 있다.- 경로 매개변수로 들어오는 값을 더 세밀하게 제어하기 위해,
()안에 정규 표현식을 추가하여 필터링을 넣을 수 있다.
경로 매개변수를 사용하여 경로를 정의하려면 아래와 같이 경로에 경로 매개변수를 지정하기만 하면 된다. 이때, 매개변수명은 위에서 서술한 바와 같이 [A-Za-z0-9_]로 구성되어야만 한다.
app.get('/users/:userId/books/:bookId', (req, res) => {
res.send(req.params)
})
위에서 서술한 바와 같이 --과 ..은 문자 그대로 해석되므로 경로 매개변수와 함께 유용하게 사용할 수 있다.
Route path: /flights/:from-:to
Request URL: http://localhost:3000/flights/LAX-SFO
req.params: { "from": "LAX", "to": "SFO" }
Route path: /plantae/:genus.:species
Request URL: http://localhost:3000/plantae/Prunus.persica
req.params: { "genus": "Prunus", "species": "persica" }
위에서 서술한 바와 같이 경로 매개변수를 조작하기 위해 ()안에 정규 표현식을 적을 수 있다.
정규 표현식은 일반적으로 리터럴 문자열의 일부이므로 모든 "" 문자를
\를 추가하여 이스케이프해야 한다. (예를 들어,\\d+)
Express 4.x에서는 정규 표현식의 문자 "*"이 문자열 패턴으로 등록되어 있어 일반적인 방식으로 해석되지 않는다. "*" 대신 {0,}를 사용하여 해결 가능하다.
아래는 정규표현식 예시이다.
Route path: /user/:userId(\\d+)(매개변수로 숫자만 올 수 있음)
Request URL: http://localhost:3000/user/42
req.params: {"userId": "42"}
(잘못된 예시: req.params: {"userId": "kim"})
모듈화
지금은 코드가 무척 단순하다. 하지만 코드를 적으며 라우터를 공부할 때와는 다르게 실무에서는 코드가 수천 줄이 되기 때문에 마구잡이로 코드를 작성할 순 없다. 그렇기 때문에 app.route()를 통해 같은 경로지만 다른 메서드를 받는 라우터를 묶거나, express.Router를 통해 라우터를 모듈화한다.
app.route()
아래 코드는 /book 경로로 오는 GET, POST, PUT 요청을 한데 모아 묶어놓은 코드이다.
app.route('/book')
.get((req, res) => {
res.send('Get a random book')
})
.post((req, res) => {
res.send('Add a book')
})
.put((req, res) => {
res.send('Update the book')
})
express.Router
express.Router 클래스를 사용하면 모듈식의 마운트 가능한 경로 핸들러를 만들 수 있다. Router 인스턴스는 그 자체로 완전한 미들웨어이자 라우팅 시스템이므로, 종종 미니 앱(mini-app)이라고도 불린다.
다음 예제는 라우터를 모듈로 생성하고, 그 안에 미들웨어 함수를 로드한 뒤 몇 가지 경로를 정의하고, 메인 앱의 특정 경로에 이 라우터 모듈을 마운트하는 방법을 보여준다.
먼저, 앱 디렉토리에 다음과 같은 내용으로 birds.js라는 이름의 라우터 파일을 생성한다.
bird.js
const express = require('express')
const router = express.Router()
// 이 라우터에서만 작동하는 전용 미들웨어
const timeLog = (req, res, next) => {
console.log('Time: ', Date.now())
next()
}
router.use(timeLog)
// 홈 페이지 경로 정의
router.get('/', (req, res) => {
res.send('Birds home page')
})
// about 경로 정의
router.get('/about', (req, res) => {
res.send('About birds')
})
module.exports = router
그 다음, 메인 앱에서 이 라우터 모듈을 불러온다.
mainApp.js
const birds = require('./birds')
// ...
app.use('/birds', birds)
이제 이 앱은 /birds 및 /birds/about에 대한 요청을 처리할 수 있으며, 해당 경로에 특화된 timeLog 미들웨어 함수를 호출할 수 있게 된다.
하지만, 모듈화를 진행할 때, 만약 부모 경로인 /birds에 경로 매개변수(path parameters)가 포함되어 있다면, 기본적으로 하위 라우터에서는 이에 접근할 수 없다.
mainApp.js
app.use('/posts/:postId/comments', commentRouter)
이렇게 /comments의 상위 경로에 매개변수가 있다면,
const router = express.Router()
router.get('/:commentId', (req, res) => {
console.log(req.params.postId) // undefined (부모의 변수를 못 읽음)
console.log(req.params.commentId) // "456" (자기 변수는 잘 읽음)
res.send('댓글 확인')
});
module.exports = router
자기 자신에게 오는 매개변수는 잘 읽지만 상위 경로의 매개변수를 인식하지 못하는 것을 알 수 있다.
이를 해결하기 위해 라우터 생성 시 mergeParams 옵션을 전달하면 변수가 병합되어 하위 라우터에서도 접근이 가능하게 할 수 있다.
const router = express.Router({ mergeParams: true })
// ✅ mergeParams: true 를 설정한 경우
const router = express.Router({ mergeParams: true });
router.get('/:commentId', (req, res) => {
console.log(req.params.postId) // "123" (부모가 받은 값을 공유받음!)
console.log(req.params.commentId) // "456"
res.send(`${req.params.postId}번 게시글의 ${req.params.commentId}번 댓글입니다.`)
})
module.exports = router
마무리
몇가지 주의사항을 적자면, 기본적으로 Express는 위에서부터 아래로 경로를 찾는다.
/* 같은 광범위한 경로는 항상 맨 아래에 두어야 다른 구체적인 경로들이 무시되지 않는다. 항상 하위 경로부터 작성하는 것을 잊지말자.
또한, req.params를 console.log로 찍어보는 습관을 들이면, 내가 짠 패턴이 문자열을 어떻게 쪼개서 가져오는지 바로 확인할 수 있다.