Jackson: bagaimana mencegah serialisasi lapangan

Saya memiliki kelas entitas dengan bidang kata sandi:

class User {
    private String password;

    //setter, getter..
}

Saya ingin bidang ini dilewati selama serialisasi. Tapi itu harus tetap bisa melakukan DEserialize. Ini diperlukan, agar klien dapat mengirim saya kata sandi baru, tetapi tidak dapat membaca yang sekarang.

Bagaimana saya melakukannya dengan Jackson?

Anda dapat menandainya sebagai @JsonIgnore.

Dengan 1.9, Anda dapat menambahkan @JsonIgnoreuntuk getter, @JsonPropertyuntuk setter, untuk membuatnya deserialize tetapi tidak serial.

Menggambarkan apa yang telah dikatakan StaxMan, ini bekerja untuk saya

private String password;

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

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

Cara mudah adalah dengan membuat anotasi getter dan setter Anda.

Berikut ini adalah contoh asli yang dimodifikasi untuk mengecualikan kata sandi teks biasa, tetapi kemudian menjelaskan metode baru yang hanya mengembalikan bidang kata sandi sebagai teks terenkripsi.

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

Dimulai dengan Jackson 2.6 , properti dapat ditandai sebagai hanya baca atau tulis. Ini lebih sederhana daripada meretas anotasi pada kedua pengakses dan menyimpan semua informasi di satu tempat:

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

Selain itu @JsonIgnore, ada beberapa kemungkinan lain:

• Gunakan Tampilan JSON untuk memfilter bidang secara kondisional (secara default, tidak digunakan untuk deserialisasi; pada 2.0 akan tersedia tetapi Anda dapat menggunakan tampilan berbeda pada serialisasi, deserialisasi)
• @JsonIgnoreProperties di kelas mungkin berguna

transientadalah solusi untuk saya. Terima kasih! itu asli ke Java dan menghindari Anda untuk menambahkan anotasi khusus kerangka lain.

Orang harus bertanya mengapa Anda menginginkan metode getter publik untuk kata sandi. Hibernate, atau kerangka kerja ORM lainnya, akan dilakukan dengan metode pengambil pribadi. Untuk memeriksa apakah kata sandi itu benar, Anda dapat menggunakan

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

Jackson memiliki kelas bernama SimpleBeanPropertyFilter yang membantu memfilter bidang selama serialisasi dan deserialisasi; tidak secara global. Saya pikir itu yang Anda inginkan.

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

    //setter, getter..
}

Kemudian dalam kode Anda:

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

Ini akan mencegah passwordbidang untuk mendapatkan serial. Anda juga akan dapat deserialize passwordbidang seperti itu. Pastikan tidak ada filter yang diterapkan pada objek ObjectMapper.

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

atur variabel sebagai

@JsonIgnore

Ini memungkinkan variabel untuk dilewati oleh json serializer