Jackson: cómo prevenir la serialización de campo

Tengo una clase de entidad con un campo de contraseña:

class User {
    private String password;

    //setter, getter..
}

Quiero que este campo se omita durante la serialización. Pero aún debería ser capaz de DESserializar. Esto es necesario para que el cliente pueda enviarme una nueva contraseña, pero no pueda leer la actual.

¿Cómo logro esto con Jackson?

Puedes marcarlo como @JsonIgnore.

Con 1.9, puede agregar @JsonIgnorepara getter, @JsonPropertypara setter, para deserializar pero no serializar.

Ilustrando lo que StaxMan ha declarado, esto funciona para mí

private String password;

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

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

La manera fácil es anotar sus captadores y establecedores.

Aquí está el ejemplo original modificado para excluir la contraseña de texto sin formato, pero luego anotar un nuevo método que solo devuelve el campo de contraseña como texto cifrado.

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 de Jackson 2.6 , una propiedad se puede marcar como de solo lectura o escritura. Es más simple que hackear las anotaciones en ambos accesos y mantiene toda la información en un solo lugar:

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

Aparte de @JsonIgnore, hay un par de otras posibilidades:

• Use las Vistas JSON para filtrar los campos condicionalmente (de forma predeterminada, no se usa para la deserialización; en 2.0 estará disponible, pero puede usar una vista diferente en la serialización, deserialización)
• @JsonIgnoreProperties en clase puede ser útil

transientEs la solución para mí. ¡Gracias! es nativo de Java y evita que agregue otra anotación específica del marco.

Debería preguntarse por qué querría un método de obtención público para la contraseña. Hibernate, o cualquier otro marco ORM, funcionará con un método getter privado. Para verificar si la contraseña es correcta, puede usar

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

Jackson tiene una clase llamada SimpleBeanPropertyFilter que ayuda a filtrar campos durante la serialización y deserialización; No globalmente. Creo que eso es lo que querías.

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

    //setter, getter..
}

Luego en tu 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);

Esto evitará que el passwordcampo se serialice. También podrá deserializar los passwordcampos tal como están. Solo asegúrese de que no se apliquen filtros en el objeto ObjectMapper.

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

establecer variable como

@JsonIgnore

Esto permite que json serializer omita la variable