Javaの@JsonSerializeアノテーションでカスタムシリアライザーを実装する方法

@JsonSerializeアノテーションは、フィールドやクラスをシリアライズする際にカスタムシリアライザーを宣言するために使用されます。カスタムシリアライザーを実装するには、Jacksonが提供するStdSerializerクラスを継承し、そのserialize()メソッドをオーバーライドします。

構文

@Target(value={ANNOTATION_TYPE,METHOD,FIELD,TYPE,PARAMETER})
@Retention(value=RUNTIME)
public @interface JsonSerialize

このアノテーションは、クラス・メソッド・フィールド・型・パラメーターに適用可能です。using要素にシリアライザークラスを指定することで、デフォルトの変換処理を任意のロジックに置き換えることができます。

実装手順

1. StdSerializerクラスを継承したカスタムシリアライザークラスを作成する
2. serialize()メソッドをオーバーライドし、JSONへの変換ロジックを記述する
3. 対象クラスに@JsonSerialize(using = CustomSerializer.class)を付与する

サンプルコード

以下のプログラムでは、Employeeクラスの言語情報（String配列）を、セミコロン区切りの単一文字列としてJSON出力するカスタムシリアライザーを実装しています。

import java.io.*;
import com.fasterxml.jackson.core.*;
import com.fasterxml.jackson.databind.*;
import com.fasterxml.jackson.databind.annotation.*;
import com.fasterxml.jackson.databind.ser.std.*;

public class JsonSerializeAnnotationTest {
   public static void main(String[] args) throws JsonProcessingException, IOException {
      Employee emp = new Employee(115, "Adithya", new String[] {"Java", "Python", "Scala"});
      ObjectMapper mapper = new ObjectMapper();
      String jsonString = mapper.writerWithDefaultPrettyPrinter().writeValueAsString(emp);
      System.out.println(jsonString);
   }
}

// カスタムシリアライザークラス
class CustomSerializer extends StdSerializer<Employee> {
   public CustomSerializer(Class<Employee> t) {
      super(t);
   }
   public CustomSerializer() {
      this(Employee.class);
   }
   @Override
   public void serialize(Employee emp, JsonGenerator jgen, SerializerProvider sp)
         throws IOException, JsonGenerationException {
      StringBuilder sb = new StringBuilder();
      jgen.writeStartObject();
      jgen.writeNumberField("id", emp.getId());
      jgen.writeStringField("name", emp.getName());
      for(String s : emp.getLanguages()) {
         sb.append(s).append(";");
      }
      jgen.writeStringField("languages", sb.toString());
      jgen.writeEndObject();
   }
}

// Employeeクラス
@JsonSerialize(using = CustomSerializer.class)
class Employee {
   private int id;
   private String name;
   private String[] languages;

   public Employee(int id, String name, String[] languages) {
      this.id = id;
      this.name = name;
      this.languages = languages;
   }

   public int getId() {
      return this.id;
   }

   public String getName() {
      return this.name;
   }

   public String[] getLanguages() {
      return this.languages;
   }

   @Override
   public String toString() {
      StringBuilder sb = new StringBuilder("ID: ").append(this.id)
            .append("\nName: ").append(this.name).append("\nLanguages:");
      for(String s : this.languages) {
         sb.append(" ").append(s);
      }
      return sb.toString();
   }
}

コードのポイント

• CustomSerializerクラス：serialize()メソッド内でJsonGeneratorを使用し、idとnameは通常どおり出力しつつ、languagesはStringBuilderで連結した1つの文字列として書き込んでいます。
• Employeeクラス：@JsonSerialize(using = CustomSerializer.class)を付与することで、ObjectMapperによるシリアライズ時に自動的にCustomSerializerが適用されます。

実行結果

{
  "id" : 115,
  "name" : "Adithya",
  "languages" : "Java;Python;Scala;"
}

このように、@JsonSerializeアノテーションを活用すれば、日付フォーマットの統一や機密情報のマスキングなど、プロジェクト固有の要件に合わせた柔軟なJSON変換が実現できます。