JavaのGsonでカスタムFieldNamingStrategyを実装する方法をわかりやすく解説

FieldNamingStrategyは、Gsonライブラリにおいてカスタムのフィールド命名を実現するための仕組みです。このインターフェースを利用すると、クライアントコード側でフィールド名を任意の命名規則へ変換できます。これは、通常のJavaフィールド宣言のルールでは表現できない形式（例：特定のプレフィックスやスネークケースへの変換など）を扱いたい場合に特に有効です。

本記事では、translateName()メソッドをオーバーライドし、すべてのフィールド名に文字列「pre_」というプレフィックスを付与するカスタムFieldNamingStrategyの実装例を紹介します。

カスタムFieldNamingStrategyの実装例

以下のコードでは、CustomFieldNamingStrategyクラスがFieldNamingStrategyインターフェースを実装しています。GsonBuilderのsetFieldNamingStrategy()メソッドにこのインスタンスを渡すことで、シリアライズ時にすべてのフィールド名へプレフィックスが適用されます。

import java.lang.reflect.Field;
import com.google.gson.*;

public class GsonFieldNamingStrategyTest {
    public static void main(String[] args) {
        Employee emp = new Employee();
        emp.setEmpId(115);
        emp.setFirstName("Adithya");
        emp.setLastName("Jai");

        CustomFieldNamingStrategy customFieldNamingStrategy = new CustomFieldNamingStrategy();
        GsonBuilder gsonBuilder = new GsonBuilder();
        Gson gson = gsonBuilder.setFieldNamingStrategy(customFieldNamingStrategy).create();

        String result = gson.toJson(emp);
        System.out.println(result);
    }

    // カスタムFieldNamingStrategy
    private static class CustomFieldNamingStrategy implements FieldNamingStrategy {
        @Override
        public String translateName(Field field) {
            return "pre_" + field.getName();
        }
    }
}

// Employeeクラス
class Employee {
    private int empId;
    private String firstName;
    private String lastName;

    public int getEmpId() {
        return empId;
    }

    public void setEmpId(int empId) {
        this.empId = empId;
    }

    public String getFirstName() {
        return firstName;
    }

    public void setFirstName(String firstName) {
        this.firstName = firstName;
    }

    public String getLastName() {
        return lastName;
    }

    public void setLastName(String lastName) {
        this.lastName = lastName;
    }
}

実行結果

{"pre_empId":115,"pre_firstName":"Adithya","pre_lastName":"Jai"}

ポイントのまとめ

• FieldNamingStrategyインターフェースを実装したクラスを作成し、translateName()メソッドで命名変換ロジックを定義します。
• GsonBuilder#setFieldNamingStrategy()を使ってGsonインスタンスに戦略を登録することで、JSON出力時のすべてのフィールド名に変換が適用されます。
• 上記の例では、各フィールド名の先頭に「pre_」が付加され、出力結果にもそのまま反映されていることが確認できます。