如何通过 Retrofit 在 @Query 中传递自定义枚举？

Question

我有一个简单的枚举：

public enum Season {
    @SerializedName("0")
    AUTUMN,
    @SerializedName("1")
    SPRING;
}

从某个版本开始，GSON 能够解析此类枚举。为了确保，我这样做了：

final String s = gson.toJson(Season.AUTUMN);

如我所料。输出为 "0"。所以，我尝试在我的 Retrofit 服务中使用它：

@GET("index.php?page[api]=test")
Observable<List<Month>> getMonths(@Query("season_lookup") Season season);
/*...some files later...*/
service.getMonths(Season.AUTUMN);

并且还添加了日志记录以真正确定其结果：

HttpLoggingInterceptor httpLoggingInterceptor = new HttpLoggingInterceptor();
httpLoggingInterceptor.setLevel(HttpLoggingInterceptor.Level.BODY);

OkHttpClient httpClient = new OkHttpClient.Builder()
        .addInterceptor(httpLoggingInterceptor)
        .build();

但是失败了。 @Query 完全忽略 @SerializedName 并使用 .toString() 代替，所以日志显示 .../index.php?page[api]=test&season_lookup=AUTUMN.

我追踪 Retrofit 来源并找到文件 RequestFactoryParser 行：

Converter<?, String> converter = 
    retrofit.stringConverter(parameterType, parameterAnnotations);
action = new RequestAction.Query<>(name, converter, encoded);

它似乎根本不关心枚举。在这些行之前，它测试 rawParameterType.isArray() 是一个数组或 Iterable.class.isAssignableFrom() 仅此而已。

改造实例创建为：

retrofit = new Retrofit.Builder()
                .baseUrl(ApiConstants.API_ENDPOINT)
                .client(httpClient)
                .addConverterFactory(GsonConverterFactory.create(gson))
                .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
                .build();

gson 是 GsonBuilder().create()。我查看了源代码，里面有预定义的 ENUM_TypeAdapters.ENUM_FACTORY 用于枚举，所以我保持原样。

问题是我能做什么，以防止在我的枚举上使用 toString() 并使用 @SerializedName?我用 toString() 作其他用途

Answer 1

正如@DawidSzydło 提到的，我误解了 Gson Retrofit 中的用法。它仅用于 response/request decoding/encoding，而不用于 @Query/@Url/@Path e.t.c。对于它们，Retrofit 使用 Converter.Factory 将任何类型转换为 String。这是在将 @SerializedName 传递给 Retrofit 服务时自动使用 @SerializedName 作为任何 Enum 的值的代码。

转换器：

public class EnumRetrofitConverterFactory extends Converter.Factory {
    @Override
    public Converter<?, String> stringConverter(Type type, Annotation[] annotations, Retrofit retrofit) {
        Converter<?, String> converter = null;
        if (type instanceof Class && ((Class<?>)type).isEnum()) {
            converter = value -> EnumUtils.GetSerializedNameValue((Enum) value);
        }
        return converter;
    }
}

枚举工具：

public class EnumUtils {
    @Nullable
    static public <E extends Enum<E>> String GetSerializedNameValue(E e) {
        String value = null;
        try {
            value = e.getClass().getField(e.name()).getAnnotation(SerializedName.class).value();
        } catch (NoSuchFieldException exception) {
            exception.printStackTrace();
        }
        return value;
    }
}

改造创建：

retrofit = new Retrofit.Builder()
        .baseUrl(ApiConstants.API_ENDPOINT)
        .client(httpClient)
        .addConverterFactory(GsonConverterFactory.create(gson))
        .addConverterFactory(new EnumRetrofitConverterFactory())
        .addCallAdapterFactory(RxJavaCallAdapterFactory.create())
        .build();

08.18 更新 添加了 kotlin 模拟：

class MainActivity : AppCompatActivity() {

    override fun onCreate(savedInstanceState: Bundle?) {
        super.onCreate(savedInstanceState)
        setContentView(R.layout.activity_main)

        val httpLoggingInterceptor = HttpLoggingInterceptor()
        httpLoggingInterceptor.level = HttpLoggingInterceptor.Level.BODY

        val httpClient = OkHttpClient.Builder()
                .addInterceptor(httpLoggingInterceptor)
                .build()

        val gson = GsonBuilder().create()

        val retrofit = Retrofit.Builder()
                .baseUrl(Api.ENDPOINT)
                .client(httpClient)
                .addConverterFactory(GsonConverterFactory.create(gson))
                .addConverterFactory(EnumConverterFactory())
                .build()

        val service = retrofit.create(Api::class.java)
        service.getMonths(Season.AUTUMN).enqueue(object : Callback<List<String>> {
            override fun onFailure(call: Call<List<String>>?, t: Throwable?) {
                /* ignore */
            }

            override fun onResponse(call: Call<List<String>>?, response: Response<List<String>>?) {
                /* ignore */
            }
        })
    }
}

class EnumConverterFactory : Converter.Factory() {
    override fun stringConverter(type: Type?, annotations: Array<out Annotation>?,
                                 retrofit: Retrofit?): Converter<*, String>? {
        if (type is Class<*> && type.isEnum) {
            return Converter<Any?, String> { value -> getSerializedNameValue(value as Enum<*>) }
        }
        return null
    }
}

fun <E : Enum<*>> getSerializedNameValue(e: E): String {
    try {
        return e.javaClass.getField(e.name).getAnnotation(SerializedName::class.java).value
    } catch (exception: NoSuchFieldException) {
        exception.printStackTrace()
    }

    return ""
}

enum class Season {
    @SerializedName("0")
    AUTUMN,
    @SerializedName("1")
    SPRING
}

interface Api {
    @GET("index.php?page[api]=test")
    fun getMonths(@Query("season_lookup") season: Season): Call<List<String>>

    companion object {
        const val ENDPOINT = "http://127.0.0.1"
    }
}

在日志中您会看到：

D/OkHttp: --> GET http://127.0.0.1/index.php?page[api]=test&season_lookup=0 
D/OkHttp: --> END GET 
D/OkHttp: <-- HTTP FAILED: java.net.ConnectException: Failed to connect to /127.0.0.1:80

使用的依赖项是：

implementation 'com.squareup.retrofit2:retrofit:2.4.0'
implementation 'com.google.code.gson:gson:2.8.5'
implementation 'com.squareup.okhttp3:logging-interceptor:3.11.0'
implementation 'com.squareup.retrofit2:converter-gson:2.4.0'

如何通过 Retrofit 在 @Query 中传递自定义枚举？

How to pass custom enum in @Query via Retrofit?

rest

android

gson

retrofit

retrofit2