Spring Boot MVC / Rest控制器和枚举反序列化转换器

时间:2017-01-08 23:37:56

标签: java spring spring-mvc spring-boot spring-restcontroller

在我的Spring Boot应用程序中,我有以下@RestController方法:

@RequestMapping(value = "/{decisionId}/decisions", method = RequestMethod.POST)
    public List<DecisionResponse> getChildDecisions(@PathVariable Long decisionId, @Valid @RequestBody Direction direction) {
    }

我使用枚举org.springframework.data.domain.Sort.Direction作为请求正文。

现在Spring内部逻辑无法在客户端请求后反序列化此Direction枚举。

您能否展示如何编写自定义枚举转换器(或类似的东西)并使用Spring Boot进行配置,以便能够从客户端请求中反序列化Direction枚举?此外,还应允许null值。

1 个答案:

答案 0 :(得分:2)

首先,您应该创建自定义转换器类,它实现HttpMessageConverter<T>接口:

package com.somepackage;

public class DirectionConverter implements HttpMessageConverter<Sort.Direction> {

    public boolean canRead(Class<?> aClass, MediaType mediaType) {
        return aClass== Sort.Direction.class;
    }

    public boolean canWrite(Class<?> aClass, MediaType mediaType) {
        return false;
    }

    public List<MediaType> getSupportedMediaTypes() {
        return new LinkedList<MediaType>();
    }

    public Sort.Direction read(Class<? extends Sort.Direction> aClass,
                                 HttpInputMessage httpInputMessage) 
                                 throws IOException, HttpMessageNotReadableException {   

        String string = IOUtils.toString(httpInputMessage.getBody(), "UTF-8");
        //here do any convertions and return result 
    }

    public void write(Sort.Direction value, MediaType mediaType, 
                      HttpOutputMessage httpOutputMessage) 
                      throws IOException, HttpMessageNotWritableException {

    }

}

我使用Apache Commons IO中的IOUtilsInputStream转换为String。但你可以采用任何一种优先的方式。

现在您已在Spring转换器列表中注册了创建的转换器。接下来加入<mvc:annotation-driven>标记:

 <mvc:annotation-driven>
     <mvc:message-converters>
         <bean class="com.somepackage.DirectionConverter"/>
     </mvc:message-converters>
 </mvc:annotation-driven>

或者如果你正在使用java配置:

@EnableWebMvc
@Configuration
public class WebConfig extends WebMvcConfigurerAdapter {

    @Override
    public void configureMessageConverters(
      List<HttpMessageConverter<?>> converters) {    
        messageConverters.add(new DirectionConverter()); 
        super.configureMessageConverters(converters);
    }
}