@formurlencoded@field枚举未使用自定义Moshi适配器

Question

我在我的应用程序中使用了reverfit(V2.9.0)和Moshi(V1.11.0)。我尝试这样调用endpoint：

@FormUrlEncoded
@PATCH("anime/{anime_id}/my_list_status")
fun updateListStatus(
    @Path("anime_id") animeId: Long,
    @Field("num_watched_episodes") nbWatchedEpisodes: Int,
    @Field("score") score: Double,
    @Field("status") watchStatus: WatchStatus,
): Single<MyListStatus>

但是WatchStatus->JSON转换没有像预期的那样工作。WatchStatus是一个简单的枚举类：

enum class WatchStatus {
    COMPLETED,
    DROPPED,
    ON_HOLD,
    PLAN_TO_WATCH,
    WATCHING,
}

我创建了一个自定义适配器，因为我的应用程序使用大写枚举名称，而后端使用小写名称：

class AnimeMoshiAdapters {

    /* Others adapters */

    @ToJson
    fun watchStatusToJson(watchStatus: WatchStatus): String = 
watchStatus.toString().toLowerCase(Locale.getDefault())

    @FromJson
    fun watchStatusFromJson(watchStatus: String): WatchStatus =
        WatchStatus.valueOf(watchStatus.toUpperCase(Locale.getDefault()))
}

我以以下方式创建Moshi实例：

Moshi.Builder()
        .addLast(KotlinJsonAdapterFactory())
        .add(AnimeMoshiAdapters())
        .build()

并且我的改型实例使用它（带有Koin注入）：

Retrofit.Builder()
        .baseUrl(get<String>(named("baseUrl")))
        .client(get(named("default")))
        .addConverterFactory(MoshiConverterFactory.create(get()))
        .addCallAdapterFactory(RxJava2CallAdapterFactory.create())
        .build()

解析Json以创建WatchStatus枚举时，将使用适配器。这是很明显的，因为如果我移除自定义适配器，调用失败并出现错误“com.squareup.moshi.jsonDataException：Expected one of[COMPLETED,drop,ON_HOLD,PLAN_TO_WATCH,wating]”。当我试图调用上面指定的endpoint时，Json中WatchStatus的转换是错误的，枚举名保持大写，这意味着没有使用我的自定义适配器。如果我检查修改日志，我可以看到它发送“num_watched_episodes=12&score=6.0&status=on_hold”，所以状态不是用小写转换的。

如果我尝试使用相同的Moshi实例手动转换Json中的WatchStatus，它会按照预期工作，因此我相信我的自定义适配器实现是正确的。

我如何在这个调用中使用我的自定义Moshi适配器？

Answer 1

Moshi适配器的tojson应用于改装请求的主体(==带有@body注释的params)，而不是查询参数(==带有@field注释的params)。这是正确的和预期的行为，因为按照标准，查询参数不期望是JSON格式的字符串（即使在您的例子中，它只是一个字符串）。如果您的服务器希望status字段作为查询参数，那么除了自己提供小写字段之外，没有其他方法：

@FormUrlEncoded
@PATCH("anime/{anime_id}/my_list_status")
fun updateListStatus(
    ...
    @Field("status") watchStatus: String
): Single<MyListStatus>

并向updateListStatus提供已经小写的值：

updateListStatus(..., COMPLETED.name.toLowerCase())

如果您对服务器的实现没有影响，那么就跳过这篇文章的其余部分。

如果希望利用自定义适配器的toJSON函数，服务器需要更改请求以接受JSON正文而不是查询参数，如下所示：

PUT: anime/{anime_id}/my_list_status
BODY:
{
  "anime_id" : Long,
  "num_watched_episodes" : Int,
  "score" : Double,
  "status" : WatchStatus
}

然后您将为主体创建一个数据类，例如命名为requestbody，然后您可以将请求更改为：

@PUT("anime/{anime_id}/my_list_status")
fun updateListStatus(
    ...
    @BODY body: RequestBody
): Single<MyListStatus>

在这种情况下，您的自定义适配器将生效并通过其定义的ToJSON逻辑转换RequestBody内部的WatchStatus。