Java Spring自定义枚举以json序列化的字符串转换

Question

我正在尝试将枚举值转换为自定义字符串，作为JSON响应的一部分，在Java Spring应用程序中。我试图覆盖枚举的tostring方法并创建一个弹簧转换器，但两种尝试似乎都无法使用。

示例控制器

@RequestMapping(value = "/test/endpoint", produces = APPLICATION_JSON_VALUE)
@RestController
public class RecommenderController {
    ...
    @GetMapping("test")
    public List<MyEnum> test() {
        return new ArrayList<>() {{
            this.add(MyEnum.SAMPLE);
        }};
    }
}

枚举

public enum MyEnum {
    SAMPLE("sample"), OTHER_SAMPLE("other sample");
    private final String name;
    public MyEnum(String name) {
        this.name = name;
    }
    public String toString() {
        return this.name;
    }
}

此代码返回响应 [“ sample”] ，尽管我希望它返回 [“ sampe”] 。有没有办法在春季实施？

Answer 1

假设您正在使用默认 mappingJackson2HttpMessageConverter ，则在场景的后面使用Jackson的 Objectmapper 来执行所有JSON序列化和否定化。因此，这是为您的协议对象配置杰克逊的问题。

在这种情况下，可能是最直接的告诉杰克逊，它可以使用 myenum 的实例 @jsonvalue 注释。

public enum MyEnum {
    SAMPLE("sample"), OTHER_SAMPLE("other sample");
    private final String name;

    public MyEnum(String name) {
        this.name = name;
    }

    @JsonValue
    public String getValue() {
        return this.name;
    }
}

@jsonvalue 有一个奖励，如其Javadoc中所述：

注意：当使用Java枚举时，另一项功能是，通过注释方法返回的值也被认为是从json字符串到序列化的值。这是可能的，因为一组枚举值是恒定的，并且可以定义映射，但对于POJO类型来说通常不能进行。因此，这不用于pojo。

因此，如果您的应用程序中具有相同的枚举定义，则可以将人类可读的值重新归因于您的枚举。

Answer 2

这可以通过在枚举定义中使用 @jsonvalue 注释来完成：

public enum MyEnum {
    ...
    @JsonValue
    public String getName() {
        return this.name;
    }
}