博客

Sprint Boot @JsonSubTypes使用方法详解

  • Post category:Java

@JsonSubTypes是Spring Boot框架中的一个注解，用于指定一个父类的子类，以便在序列化和反序列化时能够正确地识别子类类型。在实际开发中，我们可能需要将Java对象序列化为JSON字符串，或将JSON字符串反序列化为Java对象。使用@JsonTypes注解可以方便地指定父类的子类，以便在序列化和反序列化时能够正确地识别子类类型。

下面是@JsonSubTypes的使用方法的完整攻略：

1. 导入依赖

在使用@JsonSubTypes注解之前，我们需要先导入相关的依赖。在pom.xml文件中添加以下依赖：

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-web</artifactId>
</dependency>

2. 创建父类和子类

在使用@JsonSubTypes注解之前，我们需要先创建一个父类和子类。在子类中我们可以使用@JsonTypeName注解来指定子类的名称。例如：

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
@JsonSubTypes({
    @JsonSubTypes.Type(value = Circle.class, name = "circle"),
    @JsonSubTypes.Type(value = Rectangle.class, name = "rectangle")
})
public abstract class Shape {
    private String name;
    // 省略getter和setter方法
}

@JsonTypeName("circle")
public class Circle extends Shape {
    private Double radius;
    // 省略getter和setter方法
}

@JsonTypeName("rectangle")
public class Rectangle extends Shape {
    private Double width;
    private Double height;
    // 省略getter和setter方法
}

在上面的示例中，我们创建了一个Shape父类和两个子类Circle和Rectangle。在父类中，我们使用@JsonTypeInfo注解来指定子类的类型信息。@JsonTypeInfo注解的use属性用于指定类型的使用方式，include属性用于指定类型信息的包含方式，property属性用于指定类型信息的属性名。在子类中，我们使用@JsonTypeName注解来指定子类的名称。

3. 序列化和序列化

在实际开发中，我们可能需要将Java对象序列化为JSON字符串，或将JSON字符串反序列化为Java对象。在列化和反序列化过程中，使用@JsonSubTypes注解可以方便地指定父类的子类，以便在序列化和反序列化时能够正确地识别子类类型。例如：

Shape circle = new Circle();
circle.setName("circle");
((Circle) circle).setRadius(10.0);

Shape rectangle = new Rectangle();
rectangle.setName("rectangle");
((Rectangle) rectangle).setWidth(20.0);
((Rectangle) rectangle).setHeight(30.0);

List<Shape> shapes = new ArrayList<>();
shapes.add(circle);
shapes.add(rectangle);

ObjectMapper objectMapper = new ObjectMapper();
String json = objectMapper.writeValueAsString(shapes);

System.out.println(json); // [{"type":"circle","name":"circle","radius":10.0},{"type":"rectangle","name":"rectangle","width":20.0,"height":30.0}]

List<Shape> shapes = objectMapper.readValue(json, new TypeReference<List<Shape>>() {});

System.out.println(shapes.get(0) instanceof Circle); // true
System.out.println(shapes.get(1) instanceof Rectangle); // true

在上面的示例中，我们使用ObjectMapper将Java对象序列化为JSON字符串，或将JSON字符串反序列化为Java对象。在序列化和反序列化过程中，使用@JsonSubTypes注解可以方便地指定父类的子，以便在序列化和反序列化时能够正确地识别子类类型。

4. 示例1：指定子类名称

假设我们有一个图形实体类，包含name属性和两个子类Circle和Rectangle。我们需要将图形对象序列化为JSON字符串，并指定子类的名称。我们可以使用@JsonSubTypes注解来实现这一功能。例如：

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
@JsonSubTypes({
    @JsonSubTypes.Type(value = Circle.class, name = "circle"),
    @JsonSubTypes.Type(value = Rectangle.class, name = "rectangle")
})
public abstract class Shape {
    private String name;
    // 省略getter和setter方法
}

@JsonTypeName("circle")
public class Circle extends Shape {
    private Double radius;
    // 省略getter和setter方法
}

@JsonTypeName("rectangle")
public class Rectangle extends Shape {
    private Double width;
    private Double height;
    // 省略getter和setter方法
}

Shape circle = new Circle();
circle.setName("circle");
((Circle) circle).setRadius(10.0);

ObjectMapper objectMapper = new ObjectMapper();
String json = objectMapper.writeValueAsString(circle);

System.out.println(json); // {"type":"circle","name":"circle","radius":10.0}

在上面的示例中，我们使用@JsonSubTypes注解来指定子类的名称。在将图形对象序列化为JSON时，子类的名称被指定为type属性的值。

5. 示例2：反序列化时指定子类类型

假设有一个JSON字符串，包含type、name、radius和width属性。我们需要将JSON字符串反序列化为图形对象，并指定子类的类型。我们可以使用@JsonSubTypes`注解来实现这一功能。例如：

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.PROPERTY, property = "type")
@JsonSubTypes({
    @JsonSubTypes.Type(value = Circle.class, name = "circle"),
    @JsonSubTypes.Type(value = Rectangle.class, name = "rectangle")
})
public abstract class Shape {
    private String name;
    // 省略getter和setter方法
}

@JsonTypeName("circle")
public class Circle extends Shape {
    private Double radius;
    // 省略getter和setter方法
}

@JsonTypeName("rectangle")
public class Rectangle extends Shape {
    private Double width;
    private Double height;
    // 省略getter和setter方法
}

ObjectMapper objectMapper = new ObjectMapper();
String json = "{\"type\":\"circle\",\"name\":\"circle\",\"radius\":10.0}";

Shape shape = objectMapper.readValue(json, Shape.class);

System.out.println(shape instanceof Circle); // true

在上面的示例中，我们使用@JsonSubTypes注解来指定子类的类型。在将JSON字符串反序列化为图形对象时，子类的类型被指定为type属性的值。

6. 总结

@JsonSubTypes是Spring Boot框架中的一个注解，用于指定一个父类的子类，以便在序列化和反序列化时能够正确地识别子类类型。使用@JsonSubTypes注解可以方便地指定父类的子类，以便在序列化和反序列化时能够正确地识别子类类型。在实际开发中我们可以根据需要使用@JsonSubTypes注解来指定父类的子类。

Tags: ,