Java에서 @JsonIgnoreProperties로 JSON 객체의 여러 속성을 한 번에 무시하는 방법

Jackson 라이브러리의 @JsonIgnoreProperties 어노테이션은 클래스의 여러 속성(property) 또는 필드(field)를 목록으로 지정하여 한꺼번에 무시할 수 있게 해주는 기능입니다. 각 필드 위에 일일이 어노테이션을 붙이는 대신, 클래스 선언부 바로 위에 이 어노테이션을 배치하면 해당 클래스 전체에 일괄 적용됩니다.

이 어노테이션은 직렬화(Serialization) 시에는 지정된 속성을 JSON 출력에서 제외하고, 역직렬화(Deserialization) 시에는 JSON에 포함된 해당 속성 값을 무시하므로 민감한 정보를 숨기거나 불필요한 데이터를 걸러낼 때 유용합니다.

문법(Syntax)

@Target(value={ANNOTATION_TYPE, TYPE, METHOD, CONSTRUCTOR, FIELD})
@Retention(value=RUNTIME)
public @interface JsonIgnoreProperties

예제(Example)

아래 예제에서는 Customer 클래스의 id와 address 두 속성을 무시하도록 설정했습니다.

import java.io.*;
import com.fasterxml.jackson.annotation.*;
import com.fasterxml.jackson.databind.*;

public class JsonIgnorePropertiesTest {
   public static void main(String[] args) throws IOException {
      Customer customer = new Customer("120", "Ravi", "Hyderabad");
      System.out.println(customer);
      ObjectMapper mapper = new ObjectMapper();
      String jsonString = mapper.writeValueAsString(customer);
      System.out.println("JSON: " + jsonString);
      System.out.println("---------");
      jsonString = "{\"id\":\"130\",\"name\":\"Rahul\", \"address\":\"Mumbai\"}";
      System.out.println("JSON: " + jsonString);
      customer = mapper.readValue(jsonString, Customer.class);
      System.out.println(customer);
   }
}

// Customer 클래스
@JsonIgnoreProperties({"id", "address"})
class Customer {
   private String id;
   private String name;
   private String address;

   public Customer() {
   }

   public Customer(String id, String name, String address) {
      this.id = id;
      this.name = name;
      this.address = address;
   }

   public String getId() {
      return id;
   }

   public String getName() {
      return name;
   }

   public String getAddress() {
      return address;
   }

   @Override
   public String toString() {
      return "Customer [id=" + id + ", name=" + name + ", address=" + address + "]";
   }
}

실행 결과(Output)

Customer [id=120, name=Ravi, address=Hyderabad]
JSON: {"name":"Ravi"}
---------
JSON: {"id":"130","name":"Rahul", "address":"Mumbai"}
Customer [id=null, name=Rahul, address=null]

추가 팁: 알 수 없는 속성 무시하기

@JsonIgnoreProperties는 특정 속성을 지정하는 것 외에도 ignoreUnknown 옵션을 함께 사용할 수 있습니다. 이 옵션을 true로 설정하면 JSON 데이터에 존재하지만 Java 클래스에는 정의되어 있지 않은 알 수 없는 속성이 있어도 역직렬화 과정에서 오류(UnrecognizedPropertyException)가 발생하지 않고 자동으로 건너뜁니다.

@JsonIgnoreProperties(ignoreUnknown = true)
class Customer {
   // ...
}

외부 API 응답처럼 구조가 자주 변경될 수 있는 JSON을 다룰 때는 ignoreUnknown = true 옵션을 활용하면 코드의 안정성을 크게 높일 수 있습니다.