Question

我正在为JSON API编写SDK，而且我遇到了一个看似奇怪的问题。 API在其POST数据验证中非常严格，并且在更新资源时不允许存在某些参数，例如id。出于这个原因，我添加了@Expose(serialize = false)我的资源类的ID字段。然而，似乎它仍然序列化该字段，导致请求被拒绝。资源类大致如下：

public class Organisation extends BaseObject
{
    public static final Gson PRETTY_PRINT_JSON = new GsonBuilder()
            .setPrettyPrinting()
            .create();

    @Expose(serialize = false)
    @SerializedName("_id")
    private String id;

    @SerializedName("email")
    private String email;

    @SerializedName("name")
    private String name;

    @SerializedName("parent_id")
    private String parentId;

    public String toJson()
    {
        return PRETTY_PRINT_JSON.toJson(this);
    }
}

我的单元测试通过API创建Organisation的实例，将新创建的实例作为类参数保存到测试类，并调用更新方法，通过更新新的方法来测试SDK的更新实现资源。这是它出错的地方。即使在新toJson()上调用Organisation方法将其序列化为JSON以获取更新请求，_id字段仍然存在，从而导致API拒绝更新。测试代码如下。注意代码中的注释。

@Test
public void testCreateUpdateAndDeleteOrganisation() throws RequestException
{
    Organisation organisation = new Organisation();
    organisation.setParentId(this.ORGANISATION_ID);
    organisation.setName("Java Test Organisation");

    Organisation newOrganisation = this.MySDK.organisation.create(organisation);
    this.testOrganisation(newOrganisation);
    this.newOrganisation = newOrganisation;

    this.testUpdateOrganisation();
}

public void testUpdateOrganisation() throws RequestException
{
    // I tried setting ID to null, but that doesn't work either
    // even though I've set Gson to not serialise null values
    this.newOrganisation.setId(null);
    this.newOrganisation.setName(this.newName);

    // For debugging
    System.out.println(this.newOrganisation.toJson());

    Organisation updatedOrganisation = this.MySDK.organisation.update(this.newOrganisation.getId(), this.newOrganisation);

    this.testOrganisation(updatedOrganisation);
    assertEquals(newOrganisation.getName(), this.newName);

    this.testDeleteOrganisation();
}

有人能发现我做错了什么吗？我有一种感觉，它与实例已经拥有/具有ID值的事实有关，但如果我明确告诉它不要将其序列化，这不应该是重要的吗？

提前感谢您的帮助。

编辑：在this.MySDK.organisation.update(this.newOrganisation.getId(), this.newOrganisation);，不编辑组织实例。给定的ID仅添加到SDK将POST到的URL（POST /organisation/{id}）

Answer 1

正如您在评论中提到的那样，@Expose应该是transient的最佳选择。重要的是要注意默认Gson实例不考虑@Expose注释！无论你设定什么选项，它都会忽略它。

如果要激活@Expose选项，则需要自定义Gson。根据您的上述代码，将其更改为：

public static final Gson PRETTY_PRINT_JSON = new GsonBuilder()
        .setPrettyPrinting()
        .excludeFieldsWithoutExposeAnnotation();
        .create();

您的@Expose(serialize = false)应该在序列化期间处于活动状态并被排除。

Answer 2

感谢@peitek指出@Expose被忽略，除非将.excludeFieldsWithoutExposeAnnotation()添加到GsonBuilder()。但是，我选择不使用此路由，因为它需要我将@Expose添加到我的模型类的每个参数，只是为了忽略序列化上的一个字段。相反，我编写了一个ExclusionStrategy来检查参数是否存在自定义SkipSerialisation注释。我按如下方式实现了这些：

策略的完整GsonBuilder：

public static final Gson PRETTY_PRINT_JSON = new GsonBuilder()
        .addSerializationExclusionStrategy(new ExclusionStrategy()
        {
            @Override
            public boolean shouldSkipField(FieldAttributes f)
            {
                return f.getAnnotation(SkipSerialisation.class) != null;
            }

            @Override
            public boolean shouldSkipClass(Class<?> clazz)
            {
                return false;
            }
        })
        .setPrettyPrinting()
        .create();

注释：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface SkipSerialisation
{
}

现在我可以做到

@SkipSerialisation
@SerializedName("_id")
private String id;

它有效！

Answer 3

我只想在此处添加一个内容，您可以按以下所需方式使用Expose：

builder.addSerializationExclusionStrategy(new ExclusionStrategy() {
        @Override
        public boolean shouldSkipField(FieldAttributes f) {
            Expose annotation = f.getAnnotation(Expose.class);
            if(annotation != null)
                return !annotation.serialize();
            else
                return false;
        }

        @Override
        public boolean shouldSkipClass(Class<?> clazz) {
            Expose annotation = clazz.getAnnotation(Expose.class);
            if(annotation != null)
                return !annotation.serialize();
            else
                return false;
        }
    });
    builder.addDeserializationExclusionStrategy(new ExclusionStrategy() {
        @Override
        public boolean shouldSkipField(FieldAttributes f) {
            Expose annotation = f.getAnnotation(Expose.class);
            if(annotation != null)
                return !annotation.deserialize();
            else
                return false;
        }

        @Override
        public boolean shouldSkipClass(Class<?> clazz) {
            Expose annotation = clazz.getAnnotation(Expose.class);
            if(annotation != null)
                return !annotation.deserialize();
            else
                return false;
        }
    });

Gson：参数get serialized，即使它有@Expose（serialize = false）

3 个答案: