23/11/22 TIL __ express validator 사용기

 

 

🏞️   상황

팀과제를 진행하면서, 유효성 검사 라이브러리를 이번에는 express validator를 사용하기로 했다.

지난번 개인과제때 joi를 사용해 봤는데 굳이 다른 라이브러리를 사용한 이유는,

아무래도 express 환경에서는 express validator가 효율이 좋다는 말이 있어서 사용해 보고 싶었다.

 

처음 사용하는 라이브러리다 보니 공부가 필요했고, 시간이 좀 걸렸다. 

joi랑은 사용법이 좀 달랐다.

 

 

 

 

🐣   express validator 

 

 

일단 공식문서와 많은 블로그들을 뒤져가며 다양한 사용법들을 보았다.

보통 router 의 미들웨어로 넣어주던데, 나는 따로 미들웨어로 빼고 싶어서 좀더 찾아봤다. 

그게 좀 더 보기 편할듯 해서 다른 파일에 두려고 했던것!

 

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

// 요청이 들어오는 시점에서 데이터를 검증
app.post('/register', [
  body('username').isLength({ min: 3, max: 30 }).isAlphanumeric().notEmpty(),
  body('email').isEmail().notEmpty(),
  body('password').isLength({ min: 3, max: 30 }).notEmpty(),
], (req, res) => {
  const errors = validationResult(req);
  if (!errors.isEmpty()) {
    // 에러 처리 로직
    return res.status(400).json({ errors: errors.array() });
  }
  // 유효성 검증을 통과한 경우 데이터 처리 로직
  // ...
});

 

 

보통은 이런식으로 사용하지만, 나는 따로 빼고싶었기 때문에 아래와 같이 사용했다.

한개의 변수에 배열을 담는데,  body().isEamil() 과 같은 유효성 검사하는 애들을 담아두고, 가장 마지막에 함수를 넣어둔다.

그 함수는 에러를 잡아서 메세지를 보여주는 역할을 한다. 

만들어둔 변수를  exports 해서 router의 미들웨어로 넣어준다. 

 

아래는 실제로 작성한 코드의 일부분이다. 

 

validator.js 

const errorMsgMiddleware = (req, res, next) => {
	const errors = validationResult(req);
	if (errors.isEmpty()) {
		return next();
	}
	res.render('blank', { message: errors.array()[0].msg });
};

const registerValidator = [
	body('name')
		.notEmpty()
		.trim()
		.withMessage(`이름을 입력해 주세요`)
		.custom(value => {
			if (/\s/.test(value)) {
				throw new Error('이름에 공백을 포함할 수 없습니다');
			}
			return true;
		}),

	body('email')
		.notEmpty()
		.withMessage('이메일을 입력해 주세요')
		.isEmail()
		.normalizeEmail()
		.withMessage('이메일을 확인해 주세요'),

	body('password')
		.notEmpty()
		.withMessage('비밀번호를 입력해 주세요')
		.isLength({ min: 6 }, { max: 10 })
		.withMessage('비밀번호를 6자리 이상 입력해 주세요')
		.custom(value => {
			if (/\s/.test(value)) {
				throw new Error('비밀번호에 공백을 포함할 수 없습니다');
			}
			return true;
		}),

	body('passwordRe')
		.custom((value, { req }) => {
			if (value !== req.body.password) {
				throw new Error('비밀번호를 확인해 주세요');
			}
			return true;
		})
		.withMessage('비밀번호를 확인해 주세요'),

	body('description').default('안녕하세요!'),
	errorMsgMiddleware,
];

 

 

사용하면서 express validator와 joi중 어떤게 더 효율적인지 느껴보고 싶었지만, 

아쉽게도 전혀 느끼질 못했다.

다만 두개의 차이를 찾아보니

joi는 스키마 단계에서 유효성 검사를 진행하는 방식이고, 

express validator는 미들웨어 단계에서 유효성 검사를 진행하는 방식으로 많이 쓰인다.

 

 

차이를 크게 느끼지 못했던 이유중 하나는

나는 joi 를 스키마 단계에서 유효성 검사를 진행하지 않고, 미들웨어로 빼서 진행했는데 

이 부분때문에 더 비슷하게 느껴졌던 것 같다. 

 

 

 

 

 

아래는 joi를 스키마 단계에서 유효성 검사를 하는 예시이다. 

const Joi = require('joi');

// 사용자(User) 테이블의 스키마
const userSchema = Joi.object({
  username: Joi.string().alphanum().min(3).max(30).required(),
  email: Joi.string().email().required(),
  password: Joi.string().pattern(new RegExp('^[a-zA-Z0-9]{3,30}$')).required(),
  // 추가 필드 및 규칙들...
});

// 게시물(Post) 테이블의 스키마
const postSchema = Joi.object({
  title: Joi.string().required(),
  content: Joi.string().required(),
  authorId: Joi.number().required(), // 예를 들어 사용자 ID로 매핑되는 외래키
  // 추가 필드 및 규칙들...
});

// 댓글(Comment) 테이블의 스키마
const commentSchema = Joi.object({
  content: Joi.string().required(),
  postId: Joi.number().required(), // 예를 들어 게시물 ID로 매핑되는 외래키
  userId: Joi.number().required(), // 예를 들어 사용자 ID로 매핑되는 외래키
  // 추가 필드 및 규칙들...
});

// 위에서 정의한 스키마를 이용하여 유효성 검사를 수행할 수 있습니다.
// 예를 들어, 사용자 생성 시 유효성 검사를 수행하는 라우트 핸들러
app.post('/users', (req, res) => {
  const { error, value } = userSchema.validate(req.body);
  if (error) {
    return res.status(400).json({ error: error.details[0].message });
  }
  // 유효성 검사 통과 시, 사용자 생성 로직 수행...
});

// 게시물 생성 시 유효성 검사를 수행하는 라우트 핸들러
app.post('/posts', (req, res) => {
  const { error, value } = postSchema.validate(req.body);
  if (error) {
    return res.status(400).json({ error: error.details[0].message });
  }
  // 유효성 검사 통과 시, 게시물 생성 로직 수행...
});

// 댓글 생성 시 유효성 검사를 수행하는 라우트 핸들러
app.post('/comments', (req, res) => {
  const { error, value } = commentSchema.validate(req.body);
  if (error) {
    return res.status(400).json({ error: error.details[0].message });
  }
  // 유효성 검사 통과 시, 댓글 생성 로직 수행...
});

 

 

 

 

둘다 사용해 보니, 개인적으로 joi가 더 보기 편하다고 느껴졌다.

속도 차이는 실제로 체감하기에는 없었다.

다음에는  joi를 스키마 방식으로 사용해 봐야겠다.

 

 

 

 

참고한 사이트

https://express-validator.github.io/docs/api/validation-chain/#optional

ValidationChain | express-validator