Android - GSon + RetroFit 中的继承和抽象类

Posted 2023-03-22

【中文标题】Android - GSon + RetroFit 中的继承和抽象类

【英文标题】：Android - Inheritance and abstract classes in GSon + RetroFit

【发布时间】：2015-09-27 19:36:32

【问题描述】：

我有以下类层次结构

public abstract class SyncModel 
    @Expose
    @SerializedName("id")
    private Long globalId;

    @Expose
    protected DateTime lastModified;
    
    /* Constructor, methods... */


public class Event extends SyncModel 
    @Expose
    private String title;
    
    /* Other fields, constructor, methods... */

我需要向后端发送一个 Event 实例。

案例1.@Body

当我在请求正文中发布 Event 实例时，它被很好地序列化了。

RetroFit Java 接口：

public interface EventAPI 
    @POST("/event/create")
    void sendEvent(@Body Event event, Callback<Long> cbEventId);

RetroFit 日志：

D 改造 ---> HTTP POST http://hostname:8080/event/create D 改造Content-Type：application/json；字符集=UTF-8 D 改造内容长度：297 D 改造

"title":"Test Event 01",...,"id":null,"lastModified":"2015-07-09T14:17:08.860+03:00"

D 改造 ---> END HTTP（297 字节正文）

案例2。@Field

但是当我在请求参数中发布 Event 实例时，只有抽象类被序列化。

RetroFit Java 接口：

@FormUrlEncoded
@POST("/event/create")
void sendEvent(@Field("event") Event event, Callback<Long> cbEventId);

RetroFit 日志：

D 改造 ---> HTTP POST http://hostname:8080/event/create D Retrofit Content-Type：application/x-www-form-urlencoded；字符集=UTF-8 D 改造内容长度：101 D 改造

event=SyncModel%28globalId%3Dnull%2C+lastModified%3D2015-07-09T13%3A36%3A33.510%2B03%3A00%29

D 改造 ---> END HTTP（101 字节正文）

注意区别。

问题

为什么？ 如何在请求参数中将序列化的 Event 实例发送到后端？ 我是否需要为抽象类编写自定义 JSON 序列化程序？ （例如：Polymorphism with JSON） 还是它是 RetroFit 特有的功能（忽略子类）？

我还注意到，在第二种情况下，globalId 字段序列化名称是 globalId，但它应该是 id！这让我觉得 RetroFit 对 @Field 使用不同的 GsonConverter 而不是 @Body 参数...

---

配置

Gradle 依赖项

compile 'com.squareup.retrofit:retrofit:1.9.+'
compile 'com.squareup.okhttp:okhttp:2.3.+'
compile 'net.danlew:android.joda:2.8.+'
compile ('com.fatboyindustrial.gson-jodatime-serialisers:gson-jodatime-serialisers:1.1.0')   // GSON + Joda DateTime
    exclude group: 'joda-time', module: 'joda-time'

REST 客户端

public final class RESTClient 

    // Not a real server URL
    public static final String SERVER_URL = "http://hostname:8080";

    // one-time initialization
    private static GsonBuilder builder = new GsonBuilder()
            .serializeNulls()
            .excludeFieldsWithoutExposeAnnotation()
            .setDateFormat("yyyy'-'MM'-'dd'T'HH':'mm':'ss'.'SSS'Z'");
    // Joda DateTime type support
    private static Gson gson = Converters.registerDateTime(builder).create();

    private static RestAdapter restAdapter = new RestAdapter.Builder()
            .setLogLevel(RestAdapter.LogLevel.FULL)     // for development
            .setEndpoint(SERVER_URL)
            .setConverter(new GsonConverter(gson))    // custom converter
            .build();

    private static final EventAPI eventService = restAdapter.create(EventAPI.class);
    /* + Getter for eventService */

    static 
        // forget them
        restAdapter = null;
        gson = null;
        builder = null;
    

打电话

RESTClient.getEventService().sendEvent(event, new Callback<Long>() /* ... */);

【参考方案1】：

看看@Field's documentation。它说：

使用String#valueOf(Object) 将值转换为字符串，然后形成 URL 编码。

String#valueOf(Object) 在内部调用Object#toString()。我想你的SyncModel 有一个toString() 方法，而Event 没有。当 Retrofit 调用 String.valueOf(event) 时，会调用 SyncModel#toString() 而不是 Event#toString()。这就是您在 Retrofit 日志中看不到 title 的原因。

在转换@Field 参数时，Gson 根本不起任何作用。不过也可以——你可以让你的 toString() 方法看起来像这样：

@Override
public String toString() 
    return GsonProvider.getInstance().toJson(this);

把它放在你的抽象 SyncModel 类中，它也应该适用于 Event。

【讨论】：

补充一点，这很有意义，因为您可能不会将复杂对象作为查询参数发送，而是将它们作为请求正文的一部分发送。

不错的猜测！我会检查并尽快接受答案。