Retrofit のカスタム Gson コンバーターを使用したネストされた JSON の抽出

多くの API は、ルート オブジェクトがネストされたオブジェクトを含む共通の JSON 構造で応答を提供します。必要なデータを含む「content」フィールド。ただし、ほとんどの POJO は「コンテンツ」フィールド内のデータのみをモデル化しているため、レトロフィット タイプのアダプターは適切なオブジェクトを抽出して返すことができません。

これに対処するために、カスタム Gson デシリアライザーを開発して、" content" フィールドを検索し、埋め込みオブジェクトを返します。方法は次のとおりです:

カスタム デシリアライザー:

目的の POJO タイプの JsonDeserializer インターフェイスを実装するクラスを作成します。たとえば、「コンテンツ」の場合、POJO:

class ContentDeserializer implements JsonDeserializer {
    @Override
    public Content deserialize(JsonElement je, Type type, JsonDeserializationContext jdc)
        throws JsonParseException {
        // Extract the "content" element
        JsonElement content = je.getAsJsonObject().get("content");

        // Deserialize the content using a new Gson instance
        return new Gson().fromJson(content, Content.class);
    }
}

Gson 構成:

カスタム デシリアライザーを GsonBuilder インスタンスに登録します:

Gson gson = new GsonBuilder()
    .registerTypeAdapter(Content.class, new ContentDeserializer())
    .create();

この Gson インスタンスを使用して、JSON 応答を埋め込み「コンテンツ」オブジェクトに直接逆シリアル化できるようになりました。

レトロフィット統合:

最後に、Retrofit インスタンスを作成するときにカスタム Gson コンバータを使用します:

Retrofit retrofit = new Retrofit.Builder()
    .baseUrl(url)
    .addConverterFactory(GsonConverterFactory.create(gson))
    .build();

今後、Retrofit は API 応答を逆シリアル化するときに、カスタム コンバーターを使用して「コンテンツ」フィールドのみを抽出し、適切な POJO タイプを返します。