Jackson: como impedir a serialização de campo

Eu tenho uma classe de entidade com um campo de senha:

class User {
    private String password;

    //setter, getter..
}

Quero que este campo seja ignorado durante a serialização. Mas ainda deve ser capaz de desserializar. Isso é necessário para que o cliente possa me enviar uma nova senha, mas não consiga ler a atual.

Como faço isso com Jackson?

Você pode marcá-lo como @JsonIgnore.

Com 1.9, você pode adicionar @JsonIgnorepara getter, @JsonPropertypara setter, para desserializar, mas não serializar.

Ilustrando o que o StaxMan afirmou, isso funciona para mim

private String password;

@JsonIgnore
public String getPassword() {
    return password;
}

@JsonProperty
public void setPassword(String password) {
    this.password = password;
}

A maneira mais fácil é anotar seus getters e setters.

Aqui está o exemplo original modificado para excluir a senha de texto sem formatação, mas anote um novo método que apenas retorna o campo da senha como texto criptografado.

class User {

    private String password;

    public void setPassword(String password) {
        this.password = password;
    }

    @JsonIgnore
    public String getPassword() {
        return password;
    }

    @JsonProperty("password")
    public String getEncryptedPassword() {
        // encryption logic
    }
}

A partir do Jackson 2.6 , uma propriedade pode ser marcada como somente leitura ou gravação. É mais simples do que invadir as anotações nos dois acessadores e mantém todas as informações em um só lugar:

public class User {
    @JsonProperty(access = JsonProperty.Access.WRITE_ONLY)
    private String password;
}

Além de @JsonIgnore, existem algumas outras possibilidades:

• Usar exibições JSON para filtrar os campos condicionalmente (por padrão, não usado para desserialização; no 2.0 estará disponível, mas você pode usar uma visualização diferente na serialização, desserialização)
• @JsonIgnoreProperties na aula pode ser útil

transienté a solução para mim. obrigado! é nativo para Java e evita que você adicione outra anotação específica da estrutura.

Deve-se perguntar por que você deseja um método público getter para a senha. O Hibernate, ou qualquer outra estrutura ORM, funcionará com um método getter privado. Para verificar se a senha está correta, você pode usar

public boolean checkPassword(String password){
  return this.password.equals(anyHashingMethod(password));
}

Jackson tem uma classe chamada SimpleBeanPropertyFilter que ajuda a filtrar campos durante a serialização e desserialização; não globalmente. Eu acho que é isso que você queria.

@JsonFilter("custom_serializer")
class User {
    private String password;

    //setter, getter..
}

Então no seu código:

String[] fieldsToSkip = new String[] { "password" };

ObjectMapper mapper = new ObjectMapper();

final SimpleFilterProvider filter = new SimpleFilterProvider();
filter.addFilter("custom_serializer",
            SimpleBeanPropertyFilter.serializeAllExcept(fieldsToSkip));

mapper.setFilters(filter);

String jsonStr = mapper.writeValueAsString(currentUser);

Isso impedirá que o passwordcampo seja serializado. Além disso, você poderá desserializar os passwordcampos como estão. Apenas verifique se não há filtros aplicados ao objeto ObjectMapper.

ObjectMapper mapper = new ObjectMapper();
User user = mapper.readValue(yourJsonStr, User.class);    // user object does have non-null password field

definir variável como

@JsonIgnore

Isso permite que a variável seja ignorada pelo json serializer