23/11/19 TIL __ Joi 를 활용한 유효성 검사 feat. Joi를 사용하는 이유

 

 

🧐 상황

 

개인과제에서 에러처리와 더불어 시도해 본게 있다.

유효성 검사를 해주는 좋은 라이브러리들이 있다고 해서 다양한 라이브러리들 중  Joi를 시도해 봤다.

Joi를 시도한 이유는 많이 사용하는 라이브러리  때문이였다.

 

 

하지만 Joi 외에도 다양한 validation 라이브러리가 존재한다. 

Joi	스키마를 정의하여, 데이터 객체의 유효성을 검사한다.
express-validator	Express 웹 프레임 워크에 특화. 주로 HTTP 요청의 데이터의 유효성을 검증한다.
Validator.js	문자열 유효성 검사에 특화.

 

 

express-validator도 다뤄보고 싶지만, 오늘은 Joi에 대해서만 다뤄보겠다.

 

 

 

 

🐣액션

 

먼저 Joi를 사용하려면 라이브러리를 설치해야 한다. 

npm i joi

 

 

 

나의 경우 joi를 다른 파일로 구분해서 사용했다.

그래서  JoiValidation.js 파일을 만들고, 그 안에서 설치한 joi를 require 해왔다.

 

아래는 Joi 공식문서에서 가져온 내용에 주석을 첨부한 코드이다.

const Joi = require('joi');

const schema = Joi.object({
    username: Joi.string()
        .alphanum()
        .min(3)
        .max(30)
        .required(),  // required()는 필수로 적어야 하는 컬럼에만 적어주자.

    password: Joi.string()
        .pattern(new RegExp('^[a-zA-Z0-9]{3,30}$')),

    repeat_password: Joi.ref('password'),  //ref()를 이용해 참조하고 있는 데이터와 동일한지 검증할 수 있다.

    email: Joi.string()
        .email({ minDomainSegments: 2, tlds: { allow: ['com', 'net'] } })
})


try { 
	// Joi에서 제공하는 validateAsync를 이용해 해당 스키마를 검증할 수 있다.
    const value = await schema.validateAsync({ username: 'abc', birth_year: 1994 });
}
catch (err) { 

}

 

 

음 별거 없네 하고 작성을 시작했지만, 예상하지 못한 난관이 있었다.

각 상황에 따라 에러메세지 처리를 어떻게 해줘야 할지 막막했다. 

 

if문으로 에러처리를 해야할까 고민했지만,

그럼 joi를 사용하는 이유가 없는 듯 했다.

 

 

Joi error message 라고 검색하자 스텍오버플로우 에서 원하는 답을 얻을 수 있었다.

아래는 참고한 답변이다.

const Joi = require('@hapi/joi');

const joiSchema = Joi.object({
  a: Joi.string()
    .min(2)
    .max(10)
    .required()
    .messages({
      'string.base': `"a" should be a type of 'text'`,
      'string.empty': `"a" cannot be an empty field`,
      'string.min': `"a" should have a minimum length of {#limit}`,
      'any.required': `"a" is a required field`
    })
});

const validationResult = joiSchema.validate({ a: 2 }, { abortEarly: false });
console.log(validationResult.error); // expecting ValidationError: "a" should be a type of 'text'

 

 위에서 보다싶이

.massages({})를 이용해, error가 났을 경우 어떤 메세지를 보여줄지 처리를 해주면 되는것 같다.

 

 

위에 적혀있는 'string.min' 같은 문자는 어디서 나온건지 궁금해, 에러가 난 경우 res.send(err)를 보내봤다.

아래는 출력 결과이다.

{
  "_original": {
    "nick_name": "방어w22wss회",
    "email": "",
    "password": "123123",
    "passwordRe": "123123",
    "birth_date": "1995-06-24",
    "address": "dd"
  },
  "details": [
    {
      "message": "\"email\" is not allowed to be empty",
      "path": [
        "email"
      ],
      "type": "string.empty",
      "context": {
        "label": "email",
        "value": "",
        "key": "email"
      }
    }
  ]
}

 

보니 err.details[0].type의 내용물을 적어주고, 그것에 해당하는 메세지를 리턴하는 듯 했다.

 

 

그럼 try에서 validateAsync()를 해주고, 에러가 난 경우  catch(err)로 넘어오면서,

res.json으로  해당 메세지를 보내주면 될것 같아 시도해 봤다.

 

 

그리고,

원하는 대로 결과가 잘 출력이 되었다!!!

 

 

 

아래는 실제로 구현한 Joi를 활용한 회원가입 유효성 검사 코드이다.

const Joi = require('joi');

//회원가입 유효성 검사
const registerValidation = async (req, res, next) => {
	const schema = Joi.object({
		nick_name: Joi.string().min(2).max(30).required().messages({
			'string.empty': '닉네임을 입력해 주세요.'
		}),
		email: Joi.string()
			.email({ minDomainSegments: 2, maxDomainSegments: 2, tlds: { allow: ['com', 'net'] } })
			.required()
			.messages({
				'string.email': '이메일을 확인해 주세요.',
				'string.empty': '이메일을 입력해 주세요'
			}),
		password: Joi.string().min(6).required().messages({
			'string.empty': '비밀번호를 입력해 주세요',
			'string.min': '비밀번호는 6자리 이상이여야 합니다.'
		}),
		passwordRe: Joi.any().valid(Joi.ref('password')).required().messages({
			'any.only': '비밀번호가 일치하지 않습니다.'
		}),
		birth_date: Joi.date().allow('').iso().min('1-1-1920').max('1-1-2021').messages({
			'date.format': '1920 ~ 2020 출생자만 입력이 가능합니다. (년-월-일 형식).'
		}),
		address: Joi.string().allow('')
	});
	try {
		await schema.validateAsync(req.body);
		next();
	} catch (err) {
		const message = err.details[0].message;
		res.status(400).json({ message });
		next(err);
	}
};

module.exports = registerValidation

 

 

 

🐣 느낀점

 

 

Joi를 사용하면 편하다고 하는 이유를 이제 이해할 수 있게 되었다.

영어권이라면 훨씬 편했겠지만, 한국에 살고있기 때문에, 커스텀 메세지를 적어야 했던 점은 약간 아쉬웠다.

그래도 일괄적으로 관리가 가능하고, 보기 편했다.

또한 값 입력에 대한 형식 유효성 검사는 Joi만 관리하는 하나의 파일 안에서 구동되기 때문에, 관리가 편하다고 느껴졌다.

 

 

다른 validation라이브러리는 어떨지 궁금하다. 

다음에 기회가 된다면  express-validator를 사용해 보고 싶다.

 

 

 

 

 

참고한 사이트

https://stackoverflow.com/questions/48720942/node-js-joi-how-to-display-a-custom-error-messages

Node.js + Joi how to display a custom error messages?

 

https://joi.dev/api/?v=17.9.1

joi.dev

https://velog.io/@kwontae1313/joi%EB%9D%BC%EC%9D%B4%EB%B8%8C%EB%9F%AC%EB%A6%AC-%EC%9C%A0%ED%9A%A8%EC%84%B1%EA%B2%80%EC%82%AC

joi라이브러리 유효성검사