Jackson: jak zapobiec serializacji pola

Mam klasę encji z polem hasła:

class User {
    private String password;

    //setter, getter..
}

Chcę, aby to pole zostało pominięte podczas serializacji. Ale nadal powinien być w stanie DEserialize. Jest to potrzebne, aby klient mógł wysłać mi nowe hasło, ale nie może odczytać obecnego.

Jak mam to osiągnąć z Jacksonem?

Możesz oznaczyć to jako @JsonIgnore.

W wersji 1.9 możesz dodać @JsonIgnoredla getter, @JsonPropertydla setter, aby deserializował, ale nie serializował.

Ilustrując to, co powiedział StaxMan, działa to dla mnie

private String password;

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

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

Najłatwiejszym sposobem jest dodanie adnotacji do metod pobierających i ustawiających.

Oto oryginalny przykład zmodyfikowany w celu wykluczenia hasła w postaci zwykłego tekstu, ale następnie dodaj adnotację do nowej metody, która po prostu zwraca pole hasła jako zaszyfrowany tekst.

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

Począwszy od Jacksona 2.6 , właściwość może być oznaczona jako tylko do odczytu lub do zapisu. Jest to prostsze niż hakowanie adnotacji w obu akcesoriach i utrzymuje wszystkie informacje w jednym miejscu:

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

Oprócz tego @JsonIgnoreistnieje kilka innych możliwości:

• Użyj widoków JSON, aby odfiltrować pola warunkowo (domyślnie nie jest używany do deserializacji; w wersji 2.0 będzie dostępny, ale możesz użyć innego widoku podczas serializacji, deserializacji)
• @JsonIgnoreProperties na zajęciach może być przydatne

transientjest rozwiązaniem dla mnie. dzięki! jest natywny dla języka Java i pozwala uniknąć dodawania kolejnej adnotacji specyficznej dla platformy.

Należy zapytać, dlaczego chcesz mieć publiczną metodę pobierania hasła. Hibernate lub jakikolwiek inny framework ORM zrobi z prywatną metodą pobierającą. Aby sprawdzić, czy hasło jest poprawne, możesz użyć

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

Jackson ma klasę o nazwie SimpleBeanPropertyFilter, która pomaga filtrować pola podczas serializacji i deserializacji; nie globalnie. Myślę, że tego chciałeś.

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

    //setter, getter..
}

Następnie w swoim kodzie:

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

Zapobiegnie passwordto serializacji pola. Będziesz także mógł deserializować passwordpola w obecnej postaci. Upewnij się tylko, że na obiekcie ObjectMapper nie zastosowano żadnych filtrów.

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

ustaw zmienną jako

@JsonIgnore

Dzięki temu zmienna może zostać pominięta przez serializator json