Jackson@JsonValue注释选择性地覆盖或禁用

Question

我有一个具有以下属性的枚举：

private Integer id;
private String name;
private String description;

此枚举有一个带有Jackson的@JsonValue注释的函数:

@JsonValue
public String toValue() {
    return Stream.of(values())
            .filter(eventType -> eventType == this)
            .findAny()
            .map(EventType::toString)
            .orElseThrow(() -> new IllegalArgumentException("Unable to convert EventType to value:" + this));
}

这将根据需要执行，将枚举值序列化为toString返回的值，这是枚举的名称。

我希望能够禁用@JsonValue注释，并且仅使用附加到此类的 Jackson 的默认 JSON 序列化行为：在某些情况下，必须获取表示整个枚举的对象而不仅仅是名称，@JsonFormat（shape = JsonFormat.Shape.OBJECT）。

Jackson似乎没有内置这种能力（要么是这样，要么是我对它的理解不够好）。我不能创建一个扩展这个类的包装类，因为Java不允许枚举这样做。

有什么建议吗？

Answer 1

我想不出一个现成的解决方案，但我能想到的最接近的选项是为这个特定的枚举类型使用自定义序列化程序。

添加自定义序列化程序很容易，只需要扩展< code>JsonSerializer类并实现< code>serialize方法，然后在需要的地方使用类型的< code>@JsonSerialize批注中的类(不需要< code>@JsonValue)。枚举对象将被传递到< code>serialize方法中，在那里您可以选择写入< code>toString或< code>toValue。

下面提供了示例代码以及输出。

import com.fasterxml.jackson.core.JsonGenerator;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.JsonSerializer;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.SerializerProvider;
import com.fasterxml.jackson.databind.annotation.JsonSerialize;
import lombok.AllArgsConstructor;
import lombok.Data;

import java.io.IOException;
import java.util.stream.Stream;

public class SOQuestion {

    static ThreadLocal<Boolean> USE_TO_STRING = ThreadLocal.withInitial(() -> false);

    @JsonSerialize(using = MySerializer.class)
    enum EventType{
        ONE(1, "One", "Just One"), TWO(2, "Two", "Just Two");

        private Integer id;
        private String name;
        private String description;

        EventType(Integer id, String name, String description) {
            this.id = id;
            this.name = name;
            this.description = description;
        }

        public String toValue() {
            return Stream.of(values())
                    .filter(eventType -> eventType == this)
                    .findAny()
                    .map(EventType::toString)
                    .map(s -> "toValue="+s)
                    .orElseThrow(() -> new IllegalArgumentException("Unable to convert EventType to value:" + this));
        }
    }

    @Data
    @AllArgsConstructor
    static class Dummy{
        int someNum;
        EventType eventType;
    }

    public static void main(String[] args) throws JsonProcessingException {
        ObjectMapper objectMapper = new ObjectMapper();
        Dummy dummy = new Dummy(100, EventType.ONE);
        System.out.println("**** DEFAULT *****");
        System.out.println(objectMapper.writeValueAsString(dummy));
        System.out.println("**** toString *****");
        USE_TO_STRING.set(true);
        System.out.println(objectMapper.writeValueAsString(dummy));
    }

    private static class MySerializer extends JsonSerializer<EventType> {
        @Override
        public void serialize(EventType value, JsonGenerator gen, SerializerProvider serializers) throws IOException, JsonProcessingException {
            if(USE_TO_STRING.get()){
                gen.writeString(value.toString());
            }else{
                gen.writeString(value.toValue());
            }
        }
    }
}

输出：

**** DEFAULT *****
{"someNum":100,"eventType":"toValue=ONE"}
**** toString *****
{"someNum":100,"eventType":"ONE"}

为使用lombok而道歉，它使事情变得简单。如果你不熟悉，是时候拿起它了。

Answer 2

这可以通过使用Mixin来实现。

保持枚举类不变，创建一个 mixin 类：

// MyEnumMixin.java

import com.fasterxml.jackson.annotation.JsonValue;

public abstract class MyEnumMixin {

    @JsonValue(false)
    public abstract String toValue();
}

然后在创建映射器时添加混音

// MyService.java

...
    ObjectMapper mapper = new ObjectMapper();
    mapper.addMixIn(MyEnum.class, MyEnumMixin.class);
    return mapper.writeValueAsString(pojoWithEnum);
...

感谢https://stackoverflow.com/users/6911095/ldz帮助我解决了类似的问题，并能够在这里添加答案。https://stackoverflow.com/a/59459177/7589862