[Project] 2차 프로젝트 - ResponseDTO의 특정 필드 JSON 응답에서 제외시키기

@JsonIgnore 주요 사용 목적

1. JSON 직렬화 과정에서 필드 제외
• 객체를 JSON으로 변환할 때 특정 필드를 포함하고 싶지 않을 때 사용합니다. 예를 들어, 비밀번호와 같은 민감한 정보는 클라이언트에게 노출하지 않도록 설정할 수 있습니다.

2. JSON 역직렬화 과정에서 필드 제외
• 클라이언트로부터 JSON 데이터를 받을 때 특정 필드는 무시하고 싶을 때 사용합니다. 예를 들어, 클라이언트가 값을 변경할 수 없게 하기 위해, 역직렬화 시 특정 필드의 값은 무시할 수 있습니다.

사용 방법

1. 필드에 적용

java
코드 복사
import com.fasterxml.jackson.annotation.JsonIgnore;

public class User {
    private String username;

    @JsonIgnore
    private String password; // 비밀번호 필드를 제외

    // getters and setters
}

2. 메서드에 적용

java
코드 복사
import com.fasterxml.jackson.annotation.JsonIgnore;

public class User {
    private String username;
    private String password;

    @JsonIgnore
    public String getPassword() { // getter에 @JsonIgnore 적용
        return password;
    }

    // getters and setters
}

3. 역직렬화에서 무시

java
코드 복사
import com.fasterxml.jackson.annotation.JsonIgnore;

public class User {
    private String username;

    @JsonIgnore // 이 필드는 역직렬화 시 무시됨
    private String password;

    // getters and setters
}

@JsonIgnore 관련 추가 애노테이션

• @JsonIgnoreProperties: 클래스 단위에서 특정 필드들을 무시할 때 사용합니다. 여러 필드를 한 번에 무시하고 싶을 때 유용합니다.

java
코드 복사
@JsonIgnoreProperties({"password", "email"})
public class User {
    private String username;
    private String password;
    private String email;

    // getters and setters
}

위 코드에서는 password와 email 필드가 JSON 변환에서 무시됩니다.

• @JsonIgnoreType: 특정 타입 전체를 무시하고 싶을 때 사용합니다. 이 타입에 속하는 모든 객체가 직렬화 과정에서 무시됩니다.

java
코드 복사
@JsonIgnoreType
public class SensitiveData {
    // 이 클래스는 직렬화/역직렬화 과정에서 완전히 무시됨
}

사용 시 주의사항

• @JsonIgnore를 사용하면 해당 필드나 메서드는 직렬화와 역직렬화 모두에서 제외됩니다. 만약 직렬화에서만 제외하고, 역직렬화에서는 사용하고 싶다면, 대신 @JsonProperty(access = JsonProperty.Access.WRITE_ONLY) 같은 애노테이션을 고려할 수 있습니다.

java
코드 복사
@JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
private String password;

이 경우, password는 클라이언트로부터 값을 받을 수 있지만, JSON 응답에서는 제외됩니다.

정리