Spring @RequestBody 和枚举值

Question

我有这个枚举

public enum Reos {

    VALUE1("A"),VALUE2("B"); 

    private String text;

    Reos(String text){this.text = text;}

    public String getText(){return this.text;}

    public static Reos fromText(String text){
        for(Reos r : Reos.values()){
            if(r.getText().equals(text)){
                return r;
            }
        }
        throw new IllegalArgumentException();
    }
}

还有一个名为 Review 的类，该类包含 enum Reos 类型的属性。

public class Review implements Serializable{

    private Integer id;
    private Reos reos;

    public Integer getId() {return id;}

    public void setId(Integer id) {this.id = id;}

    public Reos getReos() {return reos;}

    public void setReos(Reos reos) {
        this.reos = reos;
    }
}

最后我有一个控制器，它通过 @RequestBody 接收对象审查。

@RestController
public class ReviewController {

    @RequestMapping(method = RequestMethod.POST, value = "/reviews")
    @ResponseStatus(HttpStatus.CREATED)
    public void saveReview(@RequestBody Review review) {
        reviewRepository.save(review);
    }
}

如果我用

调用控制器

{"reos":"VALUE1"}

没有问题，但是当我用

调用时

{"reos":"A"}

我收到此错误

Could not read document: Can not construct instance of com.microservices.Reos from String value 'A': value not one of declared Enum instance names: [VALUE1, VALUE2] at [Source: java.io.PushbackInputStream@23ce847a; line: 1, column: 40] (through reference chain: com.microservices.Review["reos"]); nested exception is com.fasterxml.jackson.databind.exc.InvalidFormatException: Can not construct instance of com.microservices.Reos from String value 'A': value not one of declared Enum instance names: [VALUE1, VALUE2] at [Source: java.io.PushbackInputStream@23ce847a; line: 1, column: 40] (through reference chain: com.microservices.Review["reos"])"

我理解了这个问题，但我想知道一种方法来告诉 Spring 对于每个带有 Reos 枚举的对象都使用 Reos.fromText() 而不是 Reos.valueof()。

这可能吗？

Answer 1

我找到了我需要的东西。 http://chrisjordan.ca/post/50865405944/custom-json-serialization-for-enums-using-jackson.

这是两步。

1. 重写 Reos 枚举的 toString 方法

@Override
public String toString() {
    return text;
}

1. 使用 @JsonCreator 注释 Reos 枚举的 fromText 方法。

@JsonCreator
public static Reos fromText(String text)

仅此而已。

我希望这可以帮助其他面临同样问题的人。

Answer 2

我个人更喜欢使用jackson 提供的JsonDeserializer 编写我自己的反序列化器类。您只需要为您的枚举编写一个反序列化器类。在这个例子中：

class ReosDeserializer extends JsonDeserializer<Reos> {

    @Override
    public Reos deserialize(JsonParser jsonParser, DeserializationContext deserializationContext) throws IOException, JsonProcessingException {

        ObjectCodec oc = jsonParser.getCodec();
        JsonNode node = oc.readTree(jsonParser);

        if (node == null) {
            return null;
        }

        String text = node.textValue(); // gives "A" from the request

        if (text == null) {
            return null;
        }

        return Reos.fromText(text);
    }
}

那么，我们应该将上面的类标记为Reos的反序列化类，如下：

@JsonDeserialize(using = ReosDeserializer.class)
public enum Reos {

   // your enum codes here
}

就是这样。我们都准备好了。

如果您需要enum 的序列化程序。您可以通过创建一个扩展 JsonSerializer 的序列化程序类并使用注释 @JsonSerialize 以类似的方式做到这一点。

我希望这会有所帮助。

Answer 3

您需要使用自定义 MessageConverter 来调用您的自定义 fromText() 方法。有一篇文章 here 概述了如何做到这一点。

你扩展AbstractHttpMessageConverter<Reos>并实现所需的方法，然后你注册它。