แจ็กสัน: วิธีการป้องกันการทำให้เป็นอันดับสนาม

ฉันมีคลาสเอนทิตีที่มีฟิลด์รหัสผ่าน:

class User {
    private String password;

    //setter, getter..
}

ฉันต้องการให้ฟิลด์นี้ข้ามระหว่างการทำให้เป็นอนุกรม แต่ควรจะสามารถยกเลิกการตั้งค่า นี่เป็นสิ่งจำเป็นเพื่อให้ลูกค้าสามารถส่งรหัสผ่านใหม่ให้ฉันได้ แต่ไม่สามารถอ่านรหัสปัจจุบันได้

ฉันจะทำสิ่งนี้ให้สำเร็จด้วยแจ็คสันได้อย่างไร

@JsonIgnoreคุณสามารถทำเครื่องหมายว่า

ด้วย 1.9 คุณสามารถเพิ่ม@JsonIgnoregetter @JsonPropertyสำหรับ setter เพื่อทำให้ deserialize แต่ไม่ทำให้เป็นอนุกรม

แสดงให้เห็นถึงสิ่งที่ StaxMan ระบุไว้สิ่งนี้ใช้ได้กับฉัน

private String password;

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

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

วิธีง่าย ๆ คือการใส่คำอธิบายประกอบใน getters และ setters ของคุณ

นี่คือตัวอย่างดั้งเดิมที่ได้รับการแก้ไขเพื่อแยกรหัสผ่านข้อความล้วน แต่จากนั้นใส่คำอธิบายวิธีการใหม่ที่เพิ่งส่งคืนฟิลด์รหัสผ่านเป็นข้อความที่เข้ารหัส

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 Viewsเพื่อกรองฟิลด์ตามเงื่อนไข (โดยค่าเริ่มต้นไม่ได้ใช้สำหรับการดีซีเรียลไลซ์เซชั่นใน 2.0 จะพร้อมใช้งาน แต่คุณสามารถใช้มุมมองที่แตกต่างกันในการทำให้เป็นอนุกรมการดีซีเรียลไลเซชัน)
• @JsonIgnoreProperties ในชั้นเรียนอาจมีประโยชน์

transientเป็นทางออกสำหรับฉัน ขอบคุณ! เป็นภาษาของ Java และหลีกเลี่ยงการเพิ่มหมายเหตุประกอบเฉพาะของกรอบงานอื่น

หนึ่งควรถามว่าทำไมคุณต้องการวิธี getter สาธารณะสำหรับรหัสผ่าน ไฮเบอร์เนตหรือกรอบ ORM อื่น ๆ จะทำอย่างไรกับวิธีทะเยอทะยานส่วนตัว สำหรับการตรวจสอบว่ารหัสผ่านถูกต้องคุณสามารถใช้

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

Jackson มีคลาสชื่อว่า 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 serializer