Serializacja Jacksona: ignoruj ​​puste wartości (lub null)

Obecnie używam jackson 2.1.4 i mam problemy z ignorowaniem pól podczas konwertowania obiektu na ciąg JSON.

Oto moja klasa, która działa jako obiekt do konwersji:

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;
    }
}
}

A oto jak to konwertuję:

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())

Oto wynik:

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

Jak mogę uniknąć tych wartości null? Chcę tylko pobrać wymagane informacje w celu „subskrypcji”!

Oto dokładnie wynik, którego szukam:

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

Próbowałem też @JsonInclude (Include.NON_NULL) i ustawiłem wszystkie moje zmienne na null, ale to też nie działało! Dzięki za pomoc!

Masz adnotację w niewłaściwym miejscu - musi znajdować się na zajęciach, a nie w polu. to znaczy:

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

Jak zauważono w komentarzach, w wersjach poniżej 2.x składnia tej adnotacji jest następująca:

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

Inną opcją jest ObjectMapperbezpośrednia konfiguracja , po prostu dzwoniąc mapper.setSerializationInclusion(Include.NON_NULL);

(dla porządku, myślę, że popularność tej odpowiedzi wskazuje, że ta adnotacja powinna mieć zastosowanie w poszczególnych polach, @fasterxml)

Możesz także ustawić opcję globalną:

objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

Możesz także spróbować użyć

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)

jeśli masz do czynienia z jacksonem z wersją poniżej 2+ (1.9.5) to testowałem to bez problemu możesz użyć tej adnotacji nad klasą. Nie dla określonych dla atrybutów, tylko dla dekleracji klas.

Musisz dodać import com.fasterxml.jackson.annotation.JsonInclude;

Dodaj

@JsonInclude(JsonInclude.Include.NON_NULL)

na szczycie POJO

Jeśli masz zagnieżdżone POJO, to

@JsonInclude(JsonInclude.Include.NON_NULL)

trzeba dodać wszystkie wartości.

UWAGA: JAXRS (Jersey) automatycznie obsługuje ten scenariusz 2.6 i nowsze.

Dla jackson 2.x

@JsonInclude(JsonInclude.Include.NON_NULL)

tuż przed polem.

Ostatnio miałem podobny problem z wersją 2.6.6.

@JsonInclude(JsonInclude.Include.NON_NULL)

Używanie powyższej adnotacji na poziomie pola lub klasy nie działało zgodnie z oczekiwaniami. POJO było zmienne, gdy stosowałem adnotację. Kiedy zmieniłem zachowanie POJO na niezmienne, adnotacja zadziałała magicznie.

Nie jestem pewien, czy jego nowa wersja lub poprzednie wersje tej biblioteki zachowywały się podobnie, ale dla 2.6.6 z pewnością musisz mieć Immutable POJO, aby adnotacja działała.

objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

Powyższa opcja wymieniona w różnych odpowiedziach dotyczących ustawiania włączenia serializacji w ObjectMapper bezpośrednio na poziomie globalnym również działa, ale wolę kontrolować ją na poziomie klasy lub pola.

Więc jeśli chcesz, aby wszystkie pola puste były ignorowane podczas serializacji JSON, użyj adnotacji na poziomie klasy, ale jeśli chcesz, aby tylko kilka pól w klasie było ignorowanych, użyj ich na tych określonych polach. W ten sposób jest bardziej czytelny i łatwy w utrzymaniu, jeśli chcesz zmienić zachowanie dla określonej odpowiedzi.

Możesz też użyć GSON [ https://code.google.com/p/google-gson/ ], gdzie te puste pola zostaną automatycznie usunięte.

SampleDTO.java

public class SampleDTO {

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

    // getters/setters
}

Test.java

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));
    }
}

WYNIK:

{"isLoggedIn":false}

Użyłem gson-2.2.4

Poniższy kod może pomóc, jeśli chcesz wykluczyć typ boolowski z serializacji:

@JsonInclude(JsonInclude.Include.NON_ABSENT)