Jackson 직렬화 : 빈 값 무시 (또는 null)


138

현재 jackson 2.1.4를 사용하고 있으며 객체를 JSON 문자열로 변환 할 때 필드를 무시하는 데 문제가 있습니다.

변환 할 객체로 작동하는 클래스는 다음과 같습니다.

public class JsonOperation {

public static class Request {
    @JsonInclude(Include.NON_EMPTY)
    String requestType;
    Data data = new Data();

    public static class Data {
        @JsonInclude(Include.NON_EMPTY)
        String username;
        String email;
        String password;
        String birthday;
        String coinsPackage;
        String coins;
        String transactionId;
        boolean isLoggedIn;
    }
}

public static class Response {
    @JsonInclude(Include.NON_EMPTY)
    String requestType = null;
    Data data = new Data();

    public static class Data {
        @JsonInclude(Include.NON_EMPTY)
        enum ErrorCode { ERROR_INVALID_LOGIN, ERROR_USERNAME_ALREADY_TAKEN, ERROR_EMAIL_ALREADY_TAKEN };
        enum Status { ok, error };

        Status status;
        ErrorCode errorCode;
        String expiry;
        int coins;
        String email;
        String birthday;
        String pictureUrl;
        ArrayList <Performer> performer;
    }
}
}

그리고 그것을 변환하는 방법은 다음과 같습니다.

ObjectMapper mapper = new ObjectMapper();
mapper.setVisibility(PropertyAccessor.FIELD, Visibility.ANY);

JsonOperation subscribe = new JsonOperation();

subscribe.request.requestType = "login";

subscribe.request.data.username = "Vincent";
subscribe.request.data.password = "test";


Writer strWriter = new StringWriter();
try {
    mapper.writeValue(strWriter, subscribe.request);
} catch (JsonGenerationException e) {
    // TODO Auto-generated catch block
    e.printStackTrace();
} catch (JsonMappingException e) {
    // TODO Auto-generated catch block
    e.printStackTrace();
} catch (IOException e) {
    // TODO Auto-generated catch block
    e.printStackTrace();
}

Log.d("JSON", strWriter.toString())

출력은 다음과 같습니다.

{"data":{"birthday":null,"coins":null,"coinsPackage":null,"email":null,"username":"Vincent","password":"test","transactionId":null,"isLoggedIn":false},"requestType":"login"}

이러한 null 값을 피하려면 어떻게해야합니까? "구독"목적으로 만 필요한 정보를 얻고 싶습니다!

내가 찾는 결과는 다음과 같습니다.

{"data":{"username":"Vincent","password":"test"},"requestType":"login"}

또한 @JsonInclude (Include.NON_NULL) 시도하고 모든 변수를 null로 설정했지만 작동하지 않았습니다! 도와 주셔서 감사합니다!


답변:


247

잘못된 위치에 주석이 있습니다. 필드가 아니라 클래스에 있어야합니다. 즉 :

@JsonInclude(Include.NON_NULL) //or Include.NON_EMPTY, if that fits your use case 
public static class Request {
  // ...
}

주석에서 언급했듯이 2.x 이하 버전에서이 주석의 구문은 다음과 같습니다.

@JsonSerialize(include = JsonSerialize.Inclusion.NON_NULL) // or JsonSerialize.Inclusion.NON_EMPTY

다른 옵션은 ObjectMapper간단히 전화를 걸어 직접 구성 하는 것입니다 mapper.setSerializationInclusion(Include.NON_NULL);

(기록을 위해이 답변의 인기는이 주석 필드별로 적용 되어야 함을 나타냅니다 . @ fasterxml)


include.NON_NULL 주석을 작동시키는 방법이 실제로 있습니까? 아니면 NON_EMTPY? 어느 것이 null인지 알기 때문에 상황에 따라 다릅니다. 직렬화 / 역 직렬화하려는 모든 객체에 대해 동일한 "JsonOperation"클래스를 사용하고 있으며 상황에 따라 사용해야하는 변수 만 초기화하고 있습니다. 이 작업을 수행하는 것이 좋은 방법입니까 아니면 필요한 변수 만 포함하는 여러 클래스를 수행해야합니다 (널 / 빈 변수가 없으므로 주석을 사용할 필요가 없습니다)
Shinnyx

26
구문이 최신 버전에서 @JsonSerialize (include = JsonSerialize.Inclusion.NON_NULL) 및 @JsonSerialize (include = JsonSerialize.Inclusion.NON_EMPTY)로 변경되었습니다. null이 아닌 값과 비어 있지 않은 것이 모두 필요한 경우 @JsonSerialize (include = JsonSerialize .Inclusion.NON_DEFAULT)
Maciej

1
수업 전에 또는 속성이 작동하기 전에 @JsonSerialize (include = Inclusion.NON_NULL)를 사용하십시오.
swan

1
@drewmoore 다시 확인하십시오, @JsonInclude(JsonSerialize.Inclusion.NON_NULL) 해야합니다 @JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)또한 오래된 사용되지 않는 방법입니다. 따라서 "버전 2.x +"가 아닌 "2.x 이하 버전"을 작성해야합니다
WestFarmer

2
2. + 사용@JsonInclude(Include.NON_NULL)
Honghe. Wu

48

전역 옵션을 설정할 수도 있습니다.

objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

15

또한 당신은 사용하려고 할 수 있습니다

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)

2 + (1.9.5) 미만의 버전으로 jackson을 처리하는 경우 테스트 한 경우 클래스 위의 주석을 쉽게 사용할 수 있습니다. 속성에 대해서는 지정되지 않으며 클래스 거부에만 지정됩니다.


2
JsonSerialize의 include 속성은 JsonInclude를 선호하여 더 이상 사용되지 않습니다
fd8s0

2
내가 말했듯이 : 2+ (1.9.5) 이하의 잭슨과 함께
erhanasikoglu

질문은 특정 버전 2.1.4에 대해 묻습니다
fd8s0

14

당신은 추가해야합니다 import com.fasterxml.jackson.annotation.JsonInclude;

더하다

@JsonInclude(JsonInclude.Include.NON_NULL)

POJO 위에

POJO를 중첩 한 경우

@JsonInclude(JsonInclude.Include.NON_NULL)

모든 가치를 더해야합니다.

참고 : JAXRS (Jersey)는이 시나리오 2.6 이상을 자동으로 처리합니다.


이전 org.codehaus.jackson.annotate 패키지를 사용할 때 비슷한 기능이 있습니까?
pkran

예, getter 메소드 예제에 private int id를 추가 할 수 있습니다. @JsonIgnore public int getId () {return id; }
vaquar khan

1
기존 답변과 동일
Karl Richter


2

최근 버전 2.6.6에서 비슷한 문제가 발생했습니다.

@JsonInclude(JsonInclude.Include.NON_NULL)

제출 또는 클래스 수준에서 위의 주석을 사용하는 것이 예상대로 작동하지 않았습니다. 주석을 적용 할 때 POJO를 변경할 수있었습니다. POJO의 동작을 변경할 수 없도록 변경하면 주석이 마술처럼 작동했습니다.

새 버전이 나이 lib의 이전 버전으로 다운 된 동작이 비슷한 지 확실하지 않지만 2.6.6에서는 주석이 작동하도록 변경할 수없는 POJO가 있어야합니다.

objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

전역 수준에서 ObjectMapper에 직렬화 포함을 설정하는 다양한 답변에서 언급 된 위의 옵션도 작동하지만 클래스 또는 파일 수준에서 제어하는 ​​것을 선호합니다.

따라서 JSON 직렬화 중에 모든 null 필드를 무시하려면 클래스 수준에서 주석을 사용하지만 클래스에서 몇 개의 필드 만 무시하려면 해당 필드를 사용하십시오. 이를 통해 특정 응답에 대한 동작을 변경하려는 경우 더 읽기 쉽고 유지 관리가 쉽습니다.


2

또는 GSON [ https://code.google.com/p/google-gson/ ]을 사용하면 이 null 필드가 자동으로 제거됩니다.

SampleDTO.java

public class SampleDTO {

    String username;
    String email;
    String password;
    String birthday;
    String coinsPackage;
    String coins;
    String transactionId;
    boolean isLoggedIn;

    // getters/setters
}

테스트

import com.google.gson.Gson;

public class Test {

    public static void main(String[] args) {
        SampleDTO objSampleDTO = new SampleDTO();
        Gson objGson = new Gson();
        System.out.println(objGson.toJson(objSampleDTO));
    }
}

산출:

{"isLoggedIn":false}

나는 gson-2.2.4를 사용 했다.


-1

부울 형식을 직렬화에서 제외하려는 경우 코드가 다음과 같이 도움이 될 수 있습니다.

@JsonInclude(JsonInclude.Include.NON_ABSENT)

1
기존 답변과 동일
Karl Richter
당사 사이트를 사용함과 동시에 당사의 쿠키 정책개인정보 보호정책을 읽고 이해하였음을 인정하는 것으로 간주합니다.
Licensed under cc by-sa 3.0 with attribution required.