🎯 express-validator 라이브러리를 통해 사용자 요청의 유효성을 검증합니다.

📙 Today I Learned

유효성 검사 (Validation)

유효성 검사란 사용자가 입력한 값이 타당한지 확인하는 과정입니다.

express-validator

유효성 검사를 위해 express-validator 패키지를 설치합니다.

$ npm install express-validator

express-validator 속성

• req.body: HTTP 요청의 본문을 의미하며, 객체, 배열 등의 데이터를 포함할 수 있습니다.

• req.params: URL 경로에서 추출된 매개변수를 포함하는 객체입니다.

• req.query: 요청 URL의 쿼리 문자열에서 전달된 데이터를 포함하는 객체입니다.

예제 코드

기본적인 유효성 검사 적용 예시

const express = require('express');
const { query, validationResult } = require('express-validator');
const app = express();

app.use(express.json());
app.get('/hello', query('person').notEmpty(), (req, res) => {
  const result = validationResult(req);
  if (result.isEmpty()) {
    return res.send(`Hello, ${req.query.person}!`);
  }

  res.send({ errors: result.array() });
});

app.listen(3000);

유효성 검사 실패 시 출력되는 에러 예시

{
  "errors": [
    {
      "location": "query",
      "msg": "Invalid value",
      "path": "person",
      "type": "field"
    }
  ]
}

---

코드 실습

POST 요청에서 express-validator 사용

const express = require('express');
const router = express.Router();
const conn = require('../mariadb');
const { body, param, validationResult } = require('express-validator');

// JSON 파싱 미들웨어 ✨router.use()가 아니라 express.json()이 미들웨어✨
router.use(express.json());

// 결과 확인 및 에러 검증 미들웨어 
const validate = (req, res, next) => {
  const err = validationResult(req);

  if (!err.isEmpty()) {
    return res.status(400).json(err.array());
  } else {
    return next();
  }
};

router
  .route('/')
  .post(
    [
      body('userId').notEmpty().isInt().withMessage('숫자 입력 필요'), // 유효성 검증 미들웨어
      body('name').notEmpty().isString().withMessage('문자 입력 필요'),
      validate,
    ],
    (req, res, next) => {
      const { name, userId } = req.body;

      const sql = 'INSERT INTO authors (name, user_id) VALUES(?, ?)';
      const values = [name, userId];
      conn.query(sql, values, (err, results) => {
        if (err) {
          return res.status(400).end();
        }
        res.status(201).json(results);
      });
    }
  )

• body('userId').notEmpty().isInt() → userId가 빈 값이 아니면서 정수인지 확인합니다.

• body('name').notEmpty().isString() → name이 빈 값이 아니면서 문자열인지 확인합니다.

• validate 미들웨어를 사용해 유효성 검사 결과를 확인하고, 실패 시 오류 메시지를 반환합니다.

🤔 미들웨어(Middleware)란?

• 요청(req)과 응답(res) 사이에서 실행되는 함수입니다.
• 다음 미들웨어로 넘어가기 위해서는 next()를 호출해야 합니다.
• next()를 호출하지 않으면 요청이 멈춰버리고, 다음 단계로 진행되지 않습니다.
• 경로 인자를 넣지 않으면 모든 요청에서 실행됩니다.

👉 express 미들웨어 총정리 사이트

---

✏️ 한 줄 회고

express-validator 라이브러리를 사용하여 유효성 검사를 적용시키면서 에러의 모든 경우에 대해 핸들링을 한 덕에 코드가 견고해진 느낌이 들었습니다.