java - Jersey 解析 JSON/Jackson 子类型反序列化的规则

Question

我以这种方式接收 JSON:

@POST
@Path("log")
public Map<String, List<OperationResult>> log(Stats stats) {
  ..
}

JSON 示例:

{
  "eventType": 1
  "params": {
    "field1" : 10
  }
}

{
  "eventType": 2
  "params": {
    "field2" : "ten"
  }
}

我有一个类结构(它们是由jsonschema2pojo生成的，假设无所谓):

interface Params;
class Params1 implements Params{ public int field1; }
class Params2 implements Params{ public String field2; }

class Stats {
  public int eventType;
  public Params params;
}

我如何让 Jersey 解析 JSON，以便如果 eventType = 1 那么 stats.params 成为 Params1 的实例和 Params2 的实例？

Answer 1

今天早上我花了一些时间来解决这个问题。一个有趣的用例。我想出了如何做到这一点，但我不得不稍微改变你的 json。这不是绝对必要的，但是类型转换不是您问题的一部分，因此我们可以根据需要进行跟进:)

你的 json:

artur@pandaadb:~/tmp/test$ cat 1.json 
{
  "eventType": "1",
  "params": {
    "field1" : 10
  }
}
artur@pandaadb:~/tmp/test$ cat 2.json 
{
  "eventType": "2",
  "params": {
    "field2" : "10"
  }
}

我正在使用这 2 个文件来执行请求。请注意，我将 eventType t 更改为字符串而不是数字。我稍后会指出这一点。

你的模型对象:

public class Stats {

    @JsonProperty
    int eventType;


    public Params params;

    @JsonTypeInfo(use=JsonTypeInfo.Id.NAME, include=JsonTypeInfo.As.EXTERNAL_PROPERTY, property="eventType")
    @JsonSubTypes({ @Type(value = Param1.class, name = "1"), @Type(value = Param2.class, name = "2") })
    public void setParams(Params params) {
        this.params = params;
    }
}

我正在使用 JsonTypeInfo，这是它的作用:

JsonTypeInfo.Id.NAME 

逻辑类型名称，在您的情况下它是属性“eventType”

JsonTypeInfo.As.EXTERNAL_PROPERTY 

表示外部属性用于反序列化上下文。您只能在属性上使用它，不能作为 Params 本身的类注释。这就是为什么我注释 setter 方法而不是接口(interface)类。

property="eventType" 

简单地告诉 jackson 使用什么属性名

然后在 JsonSubTypes 中，我注释了可能的选项，在您的情况下为 2:

@Type(value = Param1.class, name = "1") 

这告诉 jackson 在 eventType 属性为“1”的情况下使用 Param1.class

相应地，PAram2.class 和属性值为“2”

注意 这就是我稍微更改 json 的原因。子类型注释不能将整数作为属性。现在您可以使用不同的选项，例如TypeConverters 在运行时将你的整数属性转换为字符串，这样你就可以保持你的 json 不变。我跳过了那一步，但快速谷歌会给你关于如何做到这一点的说明。

现在你的参数模型看起来像这样:

public interface Params {

    public static class Param1 implements Params {
        @JsonProperty
        int field1;
    }

    public static class Param2 implements Params {

        @JsonProperty
        String field2;
    }

}

我正在注释这些属性，以便 Jackson 知道反序列化这些属性。

注意 我遇到了一点问题，因为有两个属性在我懒惰疲倦的眼睛看来是一样的:

JsonTypeInfo.As.EXTERNAL_PROPERTY
JsonTypeInfo.As.EXISTING_PROPERTY

你不能使用 EXISTING :D 这实际上花了十分钟才弄明白。有趣的是，我有上面的两行，并一直在注释掉其中的一行，但不明白为什么其中一行抛出异常而另一行有效。

无论如何。

最后是测试:

artur@pandaadb:~/tmp/test$ curl -XPOST  "localhost:8085/api/v2/test" -d @1.json -H "Accept: application/json" -H "Content-Type: application/json"
io.gomedia.resource.Params$Param1
artur@pandaadb:~/tmp/test$ 
artur@pandaadb:~/tmp/test$ curl -XPOST  "localhost:8085/api/v2/test" -d @2.json -H "Accept: application/json" -H "Content-Type: application/json"
io.gomedia.resource.Params$Param2

请注意，资源正在打印实例化类的名称。如您所见，两个 json 都已反序列化为正确的实例类。

希望对您有所帮助:)

阿图尔

(有趣的事实 #2:在我的回答中，我也使用了 EXISTING 而不是 EXTERNAL，只是没有看到它。为了我的理智，我可能需要让 jackson 更改他们的名字)

编辑

我刚刚试过了，Jackson 很聪明，可以为你转换你的 json。因此，您可以保留 json 原样，只需将模型中的属性作为字符串(如所示)。一切正常。

不过，为了完整起见，如果您需要一个转换器(因为您可能需要将字符串模型转换回整数以进行序列化)，这将是一个整数到字符串的转换器:

public class EventTypeConverter implements Converter<Integer, String>{

    @Override
    public String convert(Integer value) {
        return String.valueOf(value);
    }

    @Override
    public JavaType getInputType(TypeFactory typeFactory) {
        return SimpleType.construct(Integer.class);
    }

    @Override
    public JavaType getOutputType(TypeFactory typeFactory) {
        return SimpleType.construct(String.class);
    }

}

您可以通过以下方式使用它:

@JsonProperty
@JsonDeserialize(converter=EventTypeConverter.class)
String eventType;