SpringBoot Jacksonでnull時にJSONオブジェクトから該当プロパティを除外する方法

2024/1/22 2024/1/22 書き溜め

SpringBootでJSON APIを作っているときや、特定のAPIに対してJSONをリクエストするときなどに、あるJSONオブジェクト内のプロパティがnullの場合はキーそのものを消してしまいたいことがあります。

今回は、その方法の書き溜め

先結論

@JsonInclude(JsonInclude.Include.NON_NULL) をつかう。

下記のように@JsonInclude(JsonInclude.Include.NON_NULL)を指定することで、該当フィールドがnullの場合は、JaksonでJSONに変換される際に除外されます。

import com.fasterxml.jackson.annotation.JsonInclude;

@Data
public class Hoge {
        @JsonProperty("my_key")
        @JsonInclude(JsonInclude.Include.NON_NULL)
        String myKey;
}

import com.fasterxml.jackson.annotation.JsonInclude;

@Data

public class Hoge {

@JsonProperty("my_key")

@JsonInclude(JsonInclude.Include.NON_NULL)

String myKey;

}

Ignore Null Fields with Jackson として、下記の記事でも解説されています。

じゃあねー。