Jackson: comment empêcher la sérialisation des champs

J'ai une classe d'entité avec un champ de mot de passe:

class User {
    private String password;

    //setter, getter..
}

Je veux que ce champ soit ignoré lors de la sérialisation. Mais il devrait toujours être en mesure de DEsérialiser. Ceci est nécessaire pour que le client puisse m'envoyer un nouveau mot de passe, mais ne puisse pas lire le mot de passe actuel.

Comment puis-je accomplir cela avec Jackson?

Vous pouvez le marquer comme @JsonIgnore.

Avec 1.9, vous pouvez ajouter @JsonIgnorepour getter, @JsonPropertypour setter, pour le désérialiser mais pas le sérialiser.

Illustrant ce que StaxMan a déclaré, cela fonctionne pour moi

private String password;

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

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

Le moyen le plus simple est d'annoter vos getters et setters.

Voici l'exemple original modifié pour exclure le mot de passe en texte brut, mais annoter une nouvelle méthode qui renvoie simplement le champ de mot de passe sous forme de texte chiffré.

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

À partir de Jackson 2.6 , une propriété peut être marquée en lecture ou en écriture seule. C'est plus simple que de pirater les annotations sur les deux accesseurs et de conserver toutes les informations au même endroit:

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

En plus @JsonIgnore, il y a quelques autres possibilités:

• Utilisez les vues JSON pour filtrer les champs de manière conditionnelle (par défaut, non utilisé pour la désérialisation; dans 2.0 sera disponible mais vous pouvez utiliser une vue différente sur la sérialisation, la désérialisation)
• @JsonIgnoreProperties en classe peut être utile

transientest la solution pour moi. Merci! il est natif de Java et vous évite d'ajouter une autre annotation spécifique au framework.

On devrait se demander pourquoi vous voudriez une méthode publique getter pour le mot de passe. Hibernate, ou tout autre framework ORM, fera l'affaire avec une méthode getter privée. Pour vérifier si le mot de passe est correct, vous pouvez utiliser

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

Jackson a une classe nommée SimpleBeanPropertyFilter qui permet de filtrer les champs pendant la sérialisation et la désérialisation; pas globalement. Je pense que c'est ce que tu voulais.

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

    //setter, getter..
}

Puis dans votre code:

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

Cela empêchera le passwordchamp d'être sérialisé. Vous pourrez également désérialiser les passwordchamps tels quels . Assurez-vous simplement qu'aucun filtre n'est appliqué sur l'objet ObjectMapper.

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

définir la variable comme

@JsonIgnore

Cela permet à la variable d'être ignorée par le sérialiseur json