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

@JsonDeserializeアノテーションは、JSONをJavaオブジェクトへデシリアライズする際に、カスタムデシリアライザーを指定するために使用されます。Jacksonライブラリが提供するこのアノテーションを活用することで、標準的なマッピングルールでは対応しきれない複雑なJSON構造や、独自の変換ロジックが必要なケースにも柔軟に対応できます。

カスタムデシリアライザーを実装するには、対象の型（ここではEmployee）をジェネリック型として指定したStdDeserializerクラスを継承し、そのdeserialize()メソッドをオーバーライドします。

構文

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

このアノテーションは、クラス・フィールド・メソッド・パラメーターなど、さまざまな要素に付与できることが@Targetの定義からもわかります。

実装例

以下のプログラムでは、@JsonDeserializeアノテーションを使用してカスタムデシリアライザーを実装しています。

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

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

// カスタムデシリアライザークラス
class CustomDeserializer extends StdDeserializer<Employee> {
   public CustomDeserializer(Class<Employee> t) {
      super(t);
   }
   public CustomDeserializer() {
      this(Employee.class);
   }
   @Override
   public Employee deserialize(JsonParser jp, DeserializationContext dc) throws IOException, JsonProcessingException {
      int id = 0;
      String name = null;
      JsonToken currentToken = null;
      while((currentToken = jp.nextValue()) != null) {
         switch(currentToken) {
            case VALUE_NUMBER_INT:
               if(jp.getCurrentName().equals("id")) {
                  id = jp.getIntValue();
               }
               break;
            case VALUE_STRING:
               switch(jp.getCurrentName()) {
                  case "name":
                     name = jp.getText();
                     break;
                  default:
                     break;
               }
               break;
            default:
               break;
         }
      }
      return new Employee(id, name);
   }
}

// Employeeクラス
@JsonDeserialize(using=CustomDeserializer.class)
class Employee {
   private int id;
   private String name;
   public Employee(int id, String name) {
      this.id = id;
      this.name = name;
   }
   public int getId() {
      return id;
   }
   public String getName() {
      return name;
   }
   @Override
   public String toString() {
      StringBuilder sb = new StringBuilder("ID: ").append(this.id).append("\nName: ").append(this.name);
      return sb.toString();
   }
}

コードのポイント

• CustomDeserializerクラスは、StdDeserializer<Employee>を継承し、deserialize()メソッド内でJSONトークンを1つずつ読み込みながらオブジェクトを組み立てます。
• JsonParserのnextValue()メソッドでトークンを順次取得し、トークンの種類（VALUE_NUMBER_INT、VALUE_STRINGなど）に応じて処理を分岐させています。
• Employeeクラスに@JsonDeserialize(using=CustomDeserializer.class)を付与することで、このクラスへのデシリアライズ時に自動的にCustomDeserializerが使用されます。
• なお、比較的新しいバージョンのJacksonでは、getCurrentName()やgetIntValue()は非推奨となっており、それぞれcurrentName()やgetValueAsInt()などの代替メソッドの使用が推奨されています。

出力結果

ID: 115
Name: Adithya

このように、@JsonDeserializeアノテーションとStdDeserializerクラスを組み合わせることで、JSONの解析プロセスを完全に制御したカスタムデシリアライズ処理を簡単に導入できます。