Jackson: come prevenire la serializzazione sul campo

Ho una classe di entità con un campo password:

class User {
    private String password;

    //setter, getter..
}

Voglio che questo campo venga ignorato durante la serializzazione. Ma dovrebbe essere ancora in grado di serializzare. Questo è necessario, in modo che il client possa inviarmi una nuova password, ma non è in grado di leggere quella corrente.

Come realizzo questo con Jackson?

Puoi contrassegnarlo come @JsonIgnore.

Con 1.9, puoi aggiungere @JsonIgnoreper getter, @JsonPropertyper setter, per renderlo deserializzato ma non serializzato.

Illustrando ciò che StaxMan ha affermato, questo funziona per me

private String password;

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

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

Il modo più semplice è annotare i tuoi getter e setter.

Ecco l'esempio originale modificato per escludere la password di testo normale, ma poi annotare un nuovo metodo che restituisce il campo password come testo crittografato.

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 partire da Jackson 2.6 , una proprietà può essere contrassegnata come sola lettura o sola scrittura. È più semplice che hackerare le annotazioni su entrambi gli accessori e conserva tutte le informazioni in un unico posto:

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

A parte @JsonIgnore, ci sono un paio di altre possibilità:

• Usa le viste JSON per filtrare i campi in modo condizionale (per impostazione predefinita, non utilizzato per la deserializzazione; in 2.0 sarà disponibile ma è possibile utilizzare una vista diversa su serializzazione, deserializzazione)
• @JsonIgnoreProperties in classe può essere utile

transientè la soluzione per me. Grazie! è nativo di Java ed evita di aggiungere un'altra annotazione specifica per il framework.

Ci si dovrebbe chiedere perché si desidera un metodo getter pubblico per la password. Hibernate, o qualsiasi altro framework ORM, funzionerà con un metodo getter privato. Per verificare se la password è corretta, è possibile utilizzare

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

Jackson ha una classe chiamata SimpleBeanPropertyFilter che aiuta a filtrare i campi durante la serializzazione e la deserializzazione; non a livello globale. Penso che sia quello che volevi.

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

    //setter, getter..
}

Quindi nel tuo codice:

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

Ciò impedirà che il passwordcampo venga serializzato. Inoltre sarai in grado di deserializzare i passwordcampi così come sono. Assicurati solo che non vengano applicati filtri sull'oggetto ObjectMapper.

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

imposta variabile come

@JsonIgnore

Ciò consente alla variabile di essere ignorata dal serializzatore json