@JsonSubTypes 与 Reflections 在 Jackson 中用于多态反序列化

使用 OpenRewrite 安全且自动地重构 Java 代码。

手动重构大型代码库既缓慢、有风险，又容易拖延。OpenRewrite 应运而生。这个用于大规模、自动化代码转换的开源框架可以帮助团队安全、一致地进行现代化改造。

每个月，OpenRewrite 的创建者和维护者 Moderne 都会举办现场、实践培训课程——一个面向初学者，一个面向经验丰富的用户。您将了解配方的运作方式、如何将其应用于项目，以及如何自信地进行代码现代化改造。

参加下一次课程，带来您的问题，并学习如何自动化通常会占用您 sprint 时间的工作。

回归测试是发布流程中的重要步骤，以确保新代码不会破坏现有功能。随着代码库的不断发展，我们希望频繁运行这些测试，以便尽早发现任何问题。

确保这些测试以自动化的方式频繁运行的最佳方法当然是将其包含在 CI/CD 管道中。 这样，每次向仓库提交代码时，回归测试将自动执行。

在本教程中，我们将学习如何使用 Selenium 创建回归测试，然后使用 GitHub Actions 将它们包含在我们的管道中，在 LambdaTest 云网格上运行

>> 如何使用 GitHub Actions 运行 Selenium 回归测试

1. 概述

多态反序列化是 Jackson 的一项特性，Jackson 是一个流行的 Java JSON 序列化和反序列化库。它允许我们将 JSON 反序列化为 Java 对象层次结构，即使在编译时不知道具体的类型。当您拥有父类和多个子类时，这种实用性在于，我们希望在反序列化过程中确定对象的实际类型，而不要丢失对象的多态性信息。

在本教程中，我们将探索如何通过两种方式实现这一点：使用类型处理注解来指示基类的子类型，或者使用基于 Reflections 的方法来扫描和注册所有子类型。

**2. 使用 @JsonTypeInfo 和 @JsonSubTypes 进行多态反序列化**

最直接的选择之一是 Jackson 多态类型处理注解。

让我们看一个实现示例，我们将使用 @JsonTypeInfo 和 @JsonSubTypes 来指示 Vehicle 实体的子类型，并根据现有属性对其进行反序列化

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "type", visible = true)
@JsonSubTypes({
    @JsonSubTypes.Type(value = Vehicle.ElectricVehicle.class, name = "ELECTRIC_VEHICLE"),
    @JsonSubTypes.Type(value = Vehicle.FuelVehicle.class, name = "FUEL_VEHICLE")
})
public class Vehicle {

    public String type;

    // standard setters and getters

    public static class ElectricVehicle extends Vehicle {

        String autonomy;
        String chargingTime;

        // standard setters and getters
    }

    public static class FuelVehicle extends Vehicle {

        String fuelType;
        String transmissionType;

        // standard setters and getters
    }
}

现在，让我们看看如何将 JSON 输入反序列化为 Vehicle 子类型

@Test
public void whenDeserializingPolymorphic_thenCorrect() throws JsonProcessingException {
    String json = "{\"type\":\"ELECTRIC_VEHICLE\",\"autonomy\":\"500\",\"chargingTime\":\"200\"}";

    Vehicle vehicle = new ObjectMapper().readerFor(Vehicle.class).readValue(json);

    assertEquals(Vehicle.ElectricVehicle.class, vehicle.getClass());
}

**3. 使用 @JsonTypeInfo 和 Reflections 进行多态反序列化，用于注册子类型**

接下来，让我们探索如何通过创建自定义注解并使用 Reflections Library 来扫描和注册所有现有子类型，从而使用不同的方法。

3.1. 反射介绍

反射是一项强大的特性，它允许 Java 程序在运行时检查或操作其结构和行为。这很有用，因为我们可以创建一个自定义注解来指示每个子类型的类型名称，并使用 Reflections 来识别和注册它们。

我们的关于 Reflections Library 的指南更详细地描述了它及其用例。

3.2. Maven 依赖

首先，要使用 Reflections，我们需要添加 reflections 依赖

<dependency>
    <groupId>org.reflections</groupId>
    <artifactId>reflections</artifactId>
    <version>0.10.2</version>
</dependency>

我们可以在 Maven Central Repository 上找到它的最新版本。

3.3. 创建自定义注解以指示子类型的类型名称

Java 注解是一种元数据形式，它提供有关类、方法、字段和其他程序元素在编译时或运行时附加信息。它们不会直接影响代码逻辑，而是为编译器或运行时环境提供指令或详细信息。

有关自定义注解的更多信息，请参阅我们的文章关于在 Java 中创建自定义注解。

为了指示每个 Vehicle 子类型的类型名称，我们将创建以下注解，具有运行时可见性并适用于类型（类）

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.TYPE)
public @interface VehicleSubType {
    String value();
}

现在，让我们看看我们应该如何更新现有代码，以指定每个定义的子类型

@JsonTypeInfo(use = JsonTypeInfo.Id.NAME, include = JsonTypeInfo.As.EXISTING_PROPERTY, property = "type", visible = true)
public class Vehicle {

    public String type;

    // standard setters and getters

    @VehicleSubType("ELECTRIC_VEHICLE")
    public static class ElectricVehicle extends Vehicle {

        String autonomy;
        String chargingTime;

        // standard setters and getters
    }

    @VehicleSubType("FUEL_VEHICLE")
    public static class FuelVehicle extends Vehicle {

        String fuelType;
        String transmissionType;

        // standard setters and getters
    }
}

请注意，**我们仍然需要在父类上使用 @JsonTypeInfo 注解** 来指定用于存储类型信息的属性。

3.4. 使用反射注册子类型

最后，我们需要自定义 Jackson ObjectMapper 来注册带有注解的类作为子类型。

我们将首先识别所有带有我们自定义注解 @VehicleSubType 的类。之后，对于找到的每个类，我们可以提取注解的值并使用关联的类型名称注册子类型

private ObjectMapper getCustomObjectMapper() {

    ObjectMapper objectMapper = new ObjectMapper();

    Reflections reflections = new Reflections("com.baeldung.jackson.polymorphicdeserialization.reflection");
    Set<Class<?>> subtypes = reflections.getTypesAnnotatedWith(VehicleSubType.class);

    for (Class<?> subType : subtypes) {
        VehicleSubType annotation = subType.getAnnotation(VehicleSubType.class);
        if (annotation != null) {
            String typeName = annotation.value();
            objectMapper.registerSubtypes(new NamedType(subType, typeName));
        }
    }

    return objectMapper;
}

现在，让我们使用与之前相同的输入来测试我们的代码

@Test
public void whenDeserializingPolymorphic_thenCorrect() throws JsonProcessingException {
    String json = "{\"type\":\"ELECTRIC_VEHICLE\",\"autonomy\":\"500\",\"chargingTime\":\"200\"}";
    ObjectMapper objectMapper = getCustomObjectMapper();

    Vehicle vehicle = objectMapper.readValue(json, Vehicle.class);

    assertEquals(Vehicle.ElectricVehicle.class, vehicle.getClass());
}