[java] Hibernate Validator를 사용하여 유효성 검사 결과를 JSON 형식으로 반환하는 방법은 무엇인가요?

17 Nov 2023

java

먼저, API 요청에서 유효성 검사가 필요한 객체를 받습니다.
Hibernate Validator를 사용하여 해당 객체의 유효성을 검사합니다.
유효성 검사 결과를 담을 DTO(Data Transfer Object) 클래스를 생성합니다. 이 DTO 클래스는 유효성 검사 오류의 정보를 저장할 필드를 가지고 있어야 합니다. 예를 들어, “field”, “message”와 같은 필드를 가질 수 있습니다.
유효성 검사 결과를 담을 리스트를 생성합니다.
만약 유효하지 않은 오류가 있을 경우, 오류 메시지와 해당 필드에 대한 정보를 DTO 객체에 추가합니다.
DTO 객체를 JSON 형식으로 직렬화하여 반환합니다.

다음은 예시 코드입니다:

import org.hibernate.validator.HibernateValidator;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.ArrayList;
import java.util.List;
import java.util.Set;

public class ValidatorExample {
    public static void main(String[] args) {
        // 유효성 검사기를 초기화합니다.
        Validator validator = Validation.byProvider(HibernateValidator.class).configure().buildValidatorFactory().getValidator();

        // 유효성 검사가 필요한 객체를 받습니다.
        YourRequestDTO requestDTO = new YourRequestDTO();

        // 객체의 유효성을 검사합니다.
        Set<ConstraintViolation<YourRequestDTO>> violations = validator.validate(requestDTO);

        // 유효성 검사 결과를 담을 리스트를 생성합니다.
        List<ValidationErrorDTO> errors = new ArrayList<>();

        // 오류가 있을 경우, 오류 정보를 DTO 객체에 추가합니다.
        if (!violations.isEmpty()) {
            for (ConstraintViolation<YourRequestDTO> violation : violations) {
                ValidationErrorDTO error = new ValidationErrorDTO();
                error.setField(violation.getPropertyPath().toString());
                error.setMessage(violation.getMessage());
                errors.add(error);
            }
        }

        // DTO 객체를 JSON 형식으로 변환합니다.
        ObjectMapper mapper = new ObjectMapper();
        String json = "";
        try {
            json = mapper.writeValueAsString(errors);
        } catch (JsonProcessingException e) {
            e.printStackTrace();
        }

        // JSON 형식의 유효성 검사 결과를 반환합니다.
        System.out.println(json);
    }
}

위의 코드에서 YourRequestDTO는 유효성 검사가 필요한 객체를 나타내며, ValidationErrorDTO는 유효성 검사 오류의 정보를 저장할 DTO 클래스입니다. ObjectMapper는 JSON 형식으로 변환하기 위해 Jackson 라이브러리를 사용합니다.

이 예시 코드를 참고하여 Hibernate Validator를 사용하여 유효성 검사 결과를 JSON 형식으로 반환할 수 있습니다.

참고문서:

Hibernate Validator 공식 문서: https://docs.jboss.org/hibernate/stable/validator/reference/en-US/html_single/
Jackson 라이브러리: https://github.com/FasterXML/jackson