Jackson: làm thế nào để ngăn chặn tuần tự hóa trường

Tôi có một lớp thực thể với trường mật khẩu:

class User {
    private String password;

    //setter, getter..
}

Tôi muốn lĩnh vực này được bỏ qua trong quá trình tuần tự hóa. Nhưng nó vẫn có thể DEserialize. Điều này là cần thiết, để khách hàng có thể gửi cho tôi một mật khẩu mới, nhưng không thể đọc được mật khẩu hiện tại.

Làm thế nào để tôi thực hiện điều này với Jackson?

Bạn có thể đánh dấu nó là @JsonIgnore.

Với 1.9, bạn có thể thêm @JsonIgnorecho getter, @JsonPropertycho setter, để làm cho nó được giải tuần tự hóa nhưng không tuần tự hóa.

Minh họa những gì StaxMan đã nêu, điều này hiệu quả với tôi

private String password;

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

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

Cách dễ dàng là chú thích getters và setters của bạn.

Dưới đây là ví dụ ban đầu được sửa đổi để loại trừ mật khẩu văn bản đơn giản, nhưng sau đó chú thích một phương thức mới chỉ trả về trường mật khẩu dưới dạng văn bản được mã hóa.

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

Bắt đầu với Jackson 2.6 , một tài sản có thể được đánh dấu là chỉ đọc hoặc viết. Nó đơn giản hơn việc hack các chú thích trên cả hai bộ truy cập và giữ tất cả thông tin ở một nơi:

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

Ngoài ra @JsonIgnore, có một vài khả năng khác:

• Sử dụng Chế độ xem JSON để lọc ra các trường một cách có điều kiện (theo mặc định, không được sử dụng để giải tuần tự hóa, trong 2.0 sẽ có sẵn nhưng bạn có thể sử dụng chế độ xem khác nhau về tuần tự hóa, giải tuần tự hóa)
• @JsonIgnoreProperties trên lớp có thể hữu ích

transientlà giải pháp cho tôi. cảm ơn! nó có nguồn gốc từ Java và tránh cho bạn thêm một chú thích cụ thể theo khung khác.

Bạn nên hỏi tại sao bạn muốn một phương thức getter công khai cho mật khẩu. Hibernate, hoặc bất kỳ khung ORM nào khác, sẽ thực hiện với phương thức getter riêng. Để kiểm tra xem mật khẩu có đúng không, bạn có thể sử dụng

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

Jackson có một lớp có tên SimpleBeanPropertyFilter giúp lọc các trường trong quá trình tuần tự hóa và giải tuần tự hóa; không phải trên toàn cầu Tôi nghĩ đó là những gì bạn muốn.

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

    //setter, getter..
}

Sau đó, trong mã của bạn:

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

Điều này sẽ ngăn passwordtrường để được nối tiếp. Ngoài ra, bạn sẽ có thể khử lưu lượng passwordcác trường như nó là. Chỉ cần đảm bảo không có bộ lọc nào được áp dụng trên đối tượng ObjectMapper.

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

đặt biến là

@JsonIgnore

Điều này cho phép biến bị bỏ qua bởi json serializer