Джексон: як запобігти серіалізації поля

У мене є клас сутності з полем пароля:

class User {
    private String password;

    //setter, getter..
}

Я хочу, щоб це поле було пропущено під час серіалізації. Але це все ж має бути в змозі десеріалізувати. Це потрібно, щоб клієнт міг надіслати мені новий пароль, але не зміг прочитати поточний.

Як мені це зробити з Джексоном?

Ви можете позначити його як @JsonIgnore.

З 1.9 ви можете додати @JsonIgnoreдля getter, @JsonPropertyдля сеттера, щоб зробити його деріаріалізованим, але не серіалізувати.

Ілюструючи те, що заявив StaxMan, це працює для мене

private String password;

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

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

Найпростіший спосіб - анотувати ваші жителі та сетери.

Ось оригінальний приклад, модифікований для виключення простого текстового пароля, але потім анотувати новий метод, який просто повертає поле пароля як зашифрований текст.

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

Починаючи з Jackson 2.6 , властивість може бути позначена як лише для читання або для запису. Це простіше, ніж зламати примітки на обох аксесуарах і зберігати всю інформацію в одному місці:

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

Крім цього @JsonIgnore, є ще кілька інших можливостей:

• Використовуйте представлення JSON для умовного фільтрування полів (за замовчуванням не використовується для десеріалізації; в 2.0 буде доступно, але ви можете використовувати інший погляд на серіалізацію, десеріалізацію)
• @JsonIgnoreProperties на уроці може бути корисним

transientце рішення для мене. Дякую! він є рідним для Java і уникає додавання ще однієї рамкової анотації.

Слід запитати, чому ви хочете отримати загальнодоступний метод отримання пароля. Зимова сплячка або будь-яка інша рамка ORM робитиме приватний метод отримання. Щоб перевірити правильність пароля, ви можете використовувати

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

Джексон має клас під назвою SimpleBeanPropertyFilter, який допомагає фільтрувати поля під час серіалізації та десеріалізації; не глобально. Я думаю, що саме цього ти хотів.

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

    //setter, getter..
}

Потім у своєму коді:

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

Це запобіжить passwordсеріалізацію поля. Також ви зможете десаріалізувати passwordполя як є. Просто переконайтесь, що на об’єкт ObjectMapper не застосовуються фільтри.

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

встановити змінну як

@JsonIgnore

Це дозволяє пропустити змінну серіалізатором json