[java] Jackson을 활용한 검증(Validation)과 오류 처리

18 Dec 2023

java

Jackson 라이브러리는 Java 객체와 JSON 데이터 간의 변환을 쉽게 처리할 수 있는 유용한 도구입니다. Java에서 JSON 데이터를 처리할 때, 자주 발생하는 시나리오 중 하나는 데이터를 검증하고, 유효하지 않을 경우 오류를 처리하는 것입니다. 이를 위해서 Jackson 라이브러리를 활용하여 JSON 데이터를 Java 객체로 변환하는 과정에서 검증과 오류 처리를 수행할 수 있습니다.

JSON 데이터 검증

Jackson을 사용하여 JSON 데이터를 Java 객체로 변환할 때, 데이터의 유효성을 검사하는 것은 매우 중요합니다. 이를 위해 Jackson은 다양한 방법을 제공합니다. 예를 들어, Java Bean Validation을 사용하여 JSON 데이터를 변환하기 전에 유효성을 검사할 수 있습니다.

다음은 Jackson을 사용하여 JSON 데이터를 Java 객체로 변환하고 검증을 수행하는 간단한 예제입니다.

import com.fasterxml.jackson.databind.ObjectMapper;
import javax.validation.Validation;
import javax.validation.Validator;

public class JsonValidationExample {
    public static void main(String[] args) throws Exception {
        String json = "{\"name\":\"John\",\"age\":30}";
        ObjectMapper mapper = new ObjectMapper();
        
        // JSON 데이터를 Java 객체로 변환
        Person person = mapper.readValue(json, Person.class);
        
        // Java Bean Validation을 사용하여 유효성 검사
        Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
        Set<ConstraintViolation<Person>> violations = validator.validate(person);
        if (!violations.isEmpty()) {
            // 유효성 검사에 실패한 경우 오류 처리
            for (ConstraintViolation<Person> violation : violations) {
                System.out.println(violation.getMessage());
            }
        } else {
            // 유효성 검사에 성공한 경우 추가 로직 수행
            System.out.println("Validation passed");
        }
    }
}

위 예제에서는 Person 클래스에 name과 age 필드가 정의되어 있으며, 이를 기반으로 JSON 데이터를 Java 객체로 변환하고 유효성을 검사합니다.

오류 처리

JSON 데이터의 유효성 검사를 통해 오류가 발생할 경우, 적절한 오류 처리를 수행해야 합니다. Jackson은 유효성 검사에 실패한 경우 예외를 던집니다. 이 예외를 적절하게 처리하여 클라이언트에게 응답을 제공하거나, 로깅을 수행할 수 있습니다.

다음은 Jackson을 사용하여 JSON 데이터를 Java 객체로 변환하고 오류 처리를 수행하는 예제입니다.

import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.exc.InvalidFormatException;
import javax.validation.ConstraintViolation;
import javax.validation.Validation;
import javax.validation.Validator;
import java.util.Set;

public class JsonErrorHandlingExample {
    public static void main(String[] args) {
        String json = "{\"name\":\"John\",\"age\":\"thirty\"}";
        ObjectMapper mapper = new ObjectMapper();
        
        try {
            Person person = mapper.readValue(json, Person.class);
            
            // 유효성 검사
            Validator validator = Validation.buildDefaultValidatorFactory().getValidator();
            Set<ConstraintViolation<Person>> violations = validator.validate(person);
            if (!violations.isEmpty()) {
                for (ConstraintViolation<Person> violation : violations) {
                    System.out.println(violation.getMessage());
                }
            } else {
                System.out.println("Validation passed");
            }
        } catch (InvalidFormatException e) {
            // JSON 데이터가 유효하지 않은 경우 처리
            System.out.println("Invalid JSON format: " + e.getMessage());
        } catch (Exception e) {
            // 기타 예외 처리
            System.out.println("Error occurred: " + e.getMessage());
        }
    }
}

위 예제에서는 JSON 데이터의 age 필드가 유효하지 않은 형식을 갖고 있으므로, InvalidFormatException이 발생합니다. 이를 적절히 처리하여 클라이언트에게 오류 응답을 제공하거나, 로깅을 수행할 수 있습니다.

Jackson을 활용하여 JSON 데이터의 검증과 오류 처리를 효과적으로 수행할 수 있습니다. 이를 통해 안정적이고 신뢰할 수 있는 애플리케이션을 개발할 수 있습니다.

참고 자료: