🚀JSON 직렬화 & 역직렬화 시 자주 발생하는 이슈 5가지

📌 1. null 값이 JSON에 포함되는 문제

💥 이슈

객체의 필드 값이 null일 경우, JSON 응답에도 null 필드가 포함됨.
불필요한 데이터가 포함되어 API 응답 크기가 증가함.

✅ 해결 방법

Jackson의 @JsonInclude(JsonInclude.Include.NON_NULL)을 사용하여 null 필드를 제거할 수 있음.

📝 예제 코드

import com.fasterxml.jackson.annotation.JsonInclude;
import com.fasterxml.jackson.databind.ObjectMapper;

class Person {
    public String name;

    @JsonInclude(JsonInclude.Include.NON_NULL) // null 값 제외
    public String nickname;

    public Person(String name, String nickname) {
        this.name = name;
        this.nickname = nickname;
    }
}

public class JsonNullExample {
    public static void main(String[] args) throws Exception {
        Person person = new Person("홍길동", null);
        ObjectMapper objectMapper = new ObjectMapper();
        String jsonString = objectMapper.writeValueAsString(person);
        System.out.println(jsonString); // {"name":"홍길동"}
    }
}

📌 2. JSON 필드명과 Java 필드명이 다를 때 역직렬화 오류

💥 이슈

JSON 키 이름과 Java 객체 필드명이 다르면 역직렬화 실패 (MismatchedInputException 발생)

✅ 해결 방법

@JsonProperty("json_key")을 사용하여 JSON 필드명을 Java 객체의 필드명과 매핑.

📝 예제 코드

import com.fasterxml.jackson.annotation.JsonProperty;

class User {
    @JsonProperty("user_name") // JSON 필드명을 Java 필드와 매핑
    public String name;

    public User() {} // 기본 생성자 필요
}

public class JsonPropertyExample {
    public static void main(String[] args) throws Exception {
        String jsonString = "{\"user_name\":\"홍길동\"}";
        ObjectMapper objectMapper = new ObjectMapper();
        User user = objectMapper.readValue(jsonString, User.class);
        System.out.println(user.name); // 홍길동
    }
}

📌 3. 기본 생성자 없음 (역직렬화 실패)

💥 이슈

JSON을 객체로 변환할 때, 기본 생성자가 없으면 역직렬화가 실패함.
com.fasterxml.jackson.databind.exc.InvalidDefinitionException 발생.

✅ 해결 방법

기본 생성자를 반드시 추가.

📝 예제 코드

class Employee {
    public String name;
    public int age;

    // 기본 생성자 없으면 역직렬화 오류 발생!
    public Employee() {}

    public Employee(String name, int age) {
        this.name = name;
        this.age = age;
    }
}

📌 4. 날짜(Date, LocalDate) 포맷 문제

💥 이슈

Date 또는 LocalDateTime을 JSON으로 변환할 때, 사람이 읽기 어려운 timestamp(숫자)로 변환됨.
API에서 날짜를 yyyy-MM-dd 형식으로 응답받고 싶을 때 불편함.

✅ 해결 방법

@JsonFormat을 사용하여 날짜 포맷을 지정.

📝 예제 코드

import com.fasterxml.jackson.annotation.JsonFormat;
import java.time.LocalDate;

class Order {
    @JsonFormat(shape = JsonFormat.Shape.STRING, pattern = "yyyy-MM-dd")
    public LocalDate orderDate;

    public Order(LocalDate orderDate) {
        this.orderDate = orderDate;
    }
}

📌 JSON 변환 결과

{"orderDate": "2025-03-10"}

📌 5. Lombok과 Jackson 충돌 (@Data vs @Getter / @Setter)

💥 이슈

Lombok의 @Data 어노테이션은 equals()와 hashCode()를 자동 생성하여 직렬화 시 예상치 못한 동작을 유발할 수 있음.
JSON에 포함되지 않아야 할 필드가 직렬화될 수도 있음.

✅ 해결 방법

@Getter, @Setter만 사용하거나 @JsonIgnoreProperties(ignoreUnknown = true) 추가.

📝 예제 코드

import com.fasterxml.jackson.annotation.JsonIgnoreProperties;
import lombok.Getter;
import lombok.Setter;

@Getter
@Setter
@JsonIgnoreProperties(ignoreUnknown = true) // JSON에 없는 필드는 무시
class Product {
    private String name;
}

🎯 결론

1. @JsonInclude(JsonInclude.Include.NON_NULL) → null 필드 제외
2. @JsonProperty("json_key") → JSON 필드명과 Java 필드명 맞춤
3. 기본 생성자 추가 → 역직렬화 필수
4. @JsonFormat → 날짜 포맷 지정
5. @JsonIgnoreProperties(ignoreUnknown = true) → Lombok과의 충돌 방지

🎯 이슈 방지 체크리스트 (Markdown 형식)

이슈	해결 방법
null 값 포함 문제	@JsonInclude(JsonInclude.Include.NON_NULL)
JSON 필드명 불일치	@JsonProperty("json_key")
기본 생성자 없음	기본 생성자 추가
날짜 포맷 문제	@JsonFormat(pattern = "yyyy-MM-dd")
Lombok & Jackson 충돌	@JsonIgnoreProperties(ignoreUnknown = true)