如何让Resteasy根据JSON的type属性值自动创建对应Java类实例

这个需求本质是JSON多态反序列化，Resteasy默认使用Jackson处理JSON的序列化/反序列化，你只需要配合Jackson的多态类型注解就能实现，不需要修改Resteasy核心逻辑，步骤如下： #

1. 定义公共父类 #

给Clipart和Image类创建一个公共抽象父类，在父类上添加Jackson多态配置注解，指定用type字段作为实例类型的判别依据：

import com.fasterxml.jackson.annotation.JsonSubTypes;
import com.fasterxml.jackson.annotation.JsonTypeInfo;

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
@JsonSubTypes({
    // JSON中type值为clipart时，自动实例化Clipart类
    @JsonSubTypes.Type(value = Clipart.class, name = "clipart"),
    // JSON中type值为image时，自动实例化Image类
    @JsonSubTypes.Type(value = Image.class, name = "image")
})
public abstract class Media {
    // 可抽取两个子类的公共属性，比如id、资源地址、名称等
    private String id;
    private String url;
    // 省略getter、setter方法
}

2. 定义业务子类 #

分别定义Clipart和Image类，继承上面的公共父类Media：

// 剪贴画子类
public class Clipart extends Media {
    // Clipart类特有属性，比如是否为矢量格式
    private Boolean isVector;
    // 省略getter、setter方法
}

// 图片子类
public class Image extends Media {
    // Image类特有属性，比如分辨率
    private Integer width;
    private Integer height;
    // 省略getter、setter方法
}

3. 编写Resteasy接口 #

直接在接口中使用父类Media作为请求参数类型即可，Jackson会自动根据type字段值生成对应子类的实例：

import javax.ws.rs.POST;
import javax.ws.rs.Path;
import javax.ws.rs.Consumes;
import javax.ws.rs.core.MediaType;
import javax.ws.rs.core.Response;

@Path("/media")
public class MediaApi {
    @POST
    @Consumes(MediaType.APPLICATION_JSON)
    public Response handleMediaUpload(Media media) {
        // 这里拿到的media已经是Clipart或Image的实例，直接判断类型处理即可
        if (media instanceof Clipart) {
            Clipart clipart = (Clipart) media;
            // 剪贴画专属业务逻辑
        } else if (media instanceof Image) {
            Image image = (Image) media;
            // 图片专属业务逻辑
        }
        return Response.ok().build();
    }
}

4. 确认依赖配置 #

确保你的项目中已经引入了Resteasy的Jackson集成依赖，Maven项目依赖示例如下：

<dependency>
    <groupId>org.jboss.resteasy</groupId>
    <artifactId>resteasy-jackson2-provider</artifactId>
    <version>和你项目Resteasy版本匹配的版本号</version>
</dependency>

没有特殊自定义配置的情况下，Resteasy会自动注册这个Jackson Provider，上面的多态反序列化规则会直接生效。 #

效果验证 #

你可以通过两个不同的请求测试效果：

1. 发送type为clipart的JSON请求，接口会拿到Clipart实例，特有属性isVector会被自动赋值：

{
  "type": "clipart",
  "id": "c001",
  "url": "https://xxx/clipart.svg",
  "isVector": true
}

2. 发送type为image的JSON请求，接口会拿到Image实例，特有属性width、height会被自动赋值：

{
  "type": "image",
  "id": "i001",
  "url": "https://xxx/photo.jpg",
  "width": 1920,
  "height": 1080
}

内容的提问来源于stack exchange，提问作者BuZZ-dEE