ジャクソン：フィールドのシリアル化を防ぐ方法

私はパスワードフィールドを持つエンティティクラスを持っています：

class User {
    private String password;

    //setter, getter..
}

シリアル化中にこのフィールドをスキップしたい。しかし、それでもデシリアライズできるはずです。これは、クライアントが新しいパスワードを送信できるようにするために必要ですが、現在のパスワードを読み取ることはできません。

ジャクソンでこれをどのように達成しますか？

としてマークでき@JsonIgnoreます。

1.9では、@JsonIgnoreゲッター@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
    }
}

以降ではジャクソン2.6、プロパティが読み取りまたは書き込み専用としてマークすることができます。両方のアクセサーの注釈をハッキングするよりも簡単で、すべての情報を1か所に保持します。

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

の他に@JsonIgnore、他にもいくつかの可能性があります。

• JSONビューを使用してフィールドを条件付きでフィルターで除外します（デフォルトでは、非直列化には使用されません。2.0では使用可能になりますが、直列化、非直列化で別のビューを使用できます）
• @JsonIgnoreProperties クラスで役立つかもしれません

transient私のためのソリューションです。ありがとう！これはJavaのネイティブであり、フレームワーク固有の別のアノテーションを追加する必要がありません。

パスワードにパブリックゲッターメソッドが必要な理由を尋ねる必要があります。Hibernate、またはその他の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シリアライザーによって変数をスキップできます