Serialização de Jackson: ignorar valores vazios (ou nulos)

Atualmente, estou usando o jackson 2.1.4 e estou tendo problemas para ignorar campos ao converter um objeto em uma string JSON.

Aqui está minha classe que atua como o objeto a ser convertido:

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

E aqui está como eu o converto:

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

Aqui está a saída:

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

Como posso evitar esses valores nulos? Eu só quero levar as informações necessárias para a finalidade de "assinatura"!

Aqui está exatamente a saída que estou procurando:

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

Eu também tentei @JsonInclude (Include.NON_NULL) e coloquei todas as minhas variáveis ​​em null, mas também não funcionou! Obrigado pela ajuda pessoal!

Você tem a anotação no lugar errado - ela precisa estar na classe, não no campo. ou seja:

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

Conforme observado nos comentários, nas versões abaixo de 2.x, a sintaxe desta anotação é:

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

A outra opção é configurar o ObjectMapperdiretamente, simplesmente chamando mapper.setSerializationInclusion(Include.NON_NULL);

(para o registro, acho que a popularidade desta resposta é uma indicação de que esta anotação deve ser aplicável campo a campo, @fasterxml)

Você também pode definir a opção global:

objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

Além disso, você pode tentar usar

@JsonSerialize(include=JsonSerialize.Inclusion.NON_NULL)

se você está lidando com jackson com a versão abaixo de 2+ (1.9.5), eu testei, você pode facilmente usar esta anotação acima da classe. Não especificado para os atributos, apenas para decleração de classe.

Você precisa adicionar import com.fasterxml.jackson.annotation.JsonInclude;

Adicionar

@JsonInclude(JsonInclude.Include.NON_NULL)

em cima de POJO

Se você aninhou POJO, então

@JsonInclude(JsonInclude.Include.NON_NULL)

precisa adicionar todos os valores.

NOTA: JAXRS (Jersey) lida automaticamente com este cenário 2.6 e acima.

Para jackson 2.x

@JsonInclude(JsonInclude.Include.NON_NULL)

logo antes do campo.

Eu estava tendo um problema semelhante recentemente com a versão 2.6.6.

@JsonInclude(JsonInclude.Include.NON_NULL)

O uso da anotação acima, no nível arquivado ou de classe, não estava funcionando conforme o esperado. O POJO era mutável onde eu estava aplicando a anotação. Quando mudei o comportamento do POJO para ser imutável, a anotação funcionou como mágica.

Não tenho certeza se a nova versão ou as versões anteriores desta lib tiveram um comportamento semelhante, mas para a 2.6.6 certamente você precisa ter o POJO imutável para que a anotação funcione.

objectMapper.setSerializationInclusion(JsonInclude.Include.NON_NULL);

A opção acima mencionada em várias respostas da configuração da inclusão de serialização no ObjectMapper diretamente no nível global também funciona, mas eu prefiro controlá-lo na classe ou no nível arquivado.

Portanto, se você deseja que todos os campos nulos sejam ignorados durante a serialização JSON, use a anotação no nível da classe, mas se desejar que apenas alguns campos sejam ignorados em uma classe, use-os sobre esses campos específicos. Dessa forma, é mais legível e fácil para manutenção, se você quiser alterar o comportamento para obter respostas específicas.

Ou você pode usar o GSON [ https://code.google.com/p/google-gson/ ], onde esses campos nulos serão removidos automaticamente.

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

RESULTADO:

{"isLoggedIn":false}

Eu usei o gson-2.2.4

O código abaixo pode ajudar se você deseja excluir o tipo booleano da serialização:

@JsonInclude(JsonInclude.Include.NON_ABSENT)