使用Jackson Mixins与MappingJacksonHttpMessageConverter和Spring MVC

Question

我将马上讨论我真正的问题/问题，是否有任何方法访问HttpMessageConverter内部控制器处理程序方法上的注释？我很确定答案是否定的（在浏览了Spring的源代码之后）。

在使用MappingJacksonHttpMessageConverter时，是否有其他方法使用Jackson Mixins配对？我已经基于MappingJacksonHttpMessageConverter实现了自己的HttpMessageConverter，以“升级”它来使用Jackson2.0。

Controller.class

@Controller
public class Controller {

    @JsonFilter({ @JsonMixin(target=MyTargetObject.class, mixin=MyTargetMixin.class) })
    @RequestMapping(value="/my-rest/{id}/my-obj", method=RequestMethod.GET, produces="application/json")
    public @ResponseBody List<MyTargetObject> getListOfFoo(@PathVariable("id") Integer id) {
        return MyServiceImpl.getInstance().getBarObj(id).getFoos();
    }
}

@jsonfilter是一个我希望传递给映射器的自定义注释，然后可以直接自动地将其提供给ObjectMapper。

MappingJacksonHttpMessageConverter.class

public class MappingJacksonHttpMessageConverter extends AbstractHttpMessageConverter<Object> {

    ...

    @Override
    protected void writeInternal(Object object, HttpOutputMessage outputMessage) {

            //Obviously, no access to the HandlerMethod here.

    }

    ...
}

我到处寻找这个答案。到目前为止，我只看到人们在控制器的处理方法中将他们的对象序列化为JSON（在每个方法中重复违反DRY原则）。或者直接注释它们的数据对象（没有关于如何公开对象的解耦或多重配置）。

可能是在HttpMessageConverter中无法完成。还有其他选择吗？拦截器提供对HandlerMethod的访问，但不提供对处理程序方法的返回对象的访问。

Answer 1

这不是理想的解决方案。看我的第二个答案。

我使用ModelandViewResolver解决了这个问题。您可以直接在AnnotationMethodHandlerAdapter中注册这些代码，因为您知道它们总是会在默认处理发生之前首先启动。因此，Spring的文档-

/**
 * Set a custom ModelAndViewResolvers to use for special method return types.
 * <p>Such a custom ModelAndViewResolver will kick in first, having a chance to resolve
 * a return value before the standard ModelAndView handling kicks in.
 */
public void setCustomModelAndViewResolver(ModelAndViewResolver customModelAndViewResolver) {
    this.customModelAndViewResolvers = new ModelAndViewResolver[] {customModelAndViewResolver};
}

查看ModelandViewResolver接口，我知道它包含了将某些功能扩展到处理程序方法工作方式所需的所有参数。

public interface ModelAndViewResolver {

    ModelAndView UNRESOLVED = new ModelAndView();

    ModelAndView resolveModelAndView(Method handlerMethod,
            Class handlerType,
            Object returnValue,
            ExtendedModelMap implicitModel,
            NativeWebRequest webRequest);
}

看看ResolveModelandView中所有这些美味的参数！我几乎可以访问Spring所知道的关于该请求的所有信息。以下是我如何实现该接口，使其行为与映射JacksonHttpMessageConverter非常相似，除了单向方式（向外）：

public class JsonModelAndViewResolver implements ModelAndViewResolver {

    public static final Charset DEFAULT_CHARSET = Charset.forName("UTF-8");

    public static final MediaType DEFAULT_MEDIA_TYPE = new MediaType("application", "json", DEFAULT_CHARSET);

    private boolean prefixJson = false;

    public void setPrefixJson(boolean prefixJson) {
        this.prefixJson = prefixJson;
    }

    /**
     * Converts Json.mixins() to a Map<Class, Class>
     *
     * @param jsonFilter Json annotation
     * @return Map of Target -> Mixin classes
     */
    protected Map<Class<?>, Class<?>> getMixins(Json jsonFilter) {

        Map<Class<?>, Class<?>> mixins = new HashMap<Class<?>, Class<?>>();

        if(jsonFilter != null) {
            for(JsonMixin jsonMixin : jsonFilter.mixins()) {
                mixins.put(jsonMixin.target(), jsonMixin.mixin());
            }
        }

        return mixins;
    }

    @Override
    public ModelAndView resolveModelAndView(Method handlerMethod, Class handlerType, Object returnValue, ExtendedModelMap implicitModel, NativeWebRequest webRequest) {

        if(handlerMethod.getAnnotation(Json.class) != null) {

            try {

                HttpServletResponse httpResponse = webRequest.getNativeResponse(HttpServletResponse.class);

                httpResponse.setContentType(DEFAULT_MEDIA_TYPE.toString());

                OutputStream out = httpResponse.getOutputStream();

                ObjectMapper objectMapper = new ObjectMapper();

                objectMapper.setMixInAnnotations(getMixins(handlerMethod.getAnnotation(Json.class)));

                JsonGenerator jsonGenerator =
                        objectMapper.getJsonFactory().createJsonGenerator(out, JsonEncoding.UTF8);

                if (this.prefixJson) {
                    jsonGenerator.writeRaw("{} && ");
                }

                objectMapper.writeValue(jsonGenerator, returnValue);

                out.flush();
                out.close();

                return null;

            } catch (JsonProcessingException e) {
                e.printStackTrace();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }

        return UNRESOLVED;
    }

}

上面使用的唯一自定义类是我的注释类@json，它包括一个名为mixins的参数。下面是我如何在控制器端实现这一点。

@Controller
public class Controller {

    @Json({ @JsonMixin(target=MyTargetObject.class, mixin=MyTargetMixin.class) })
    @RequestMapping(value="/my-rest/{id}/my-obj", method=RequestMethod.GET)
    public @ResponseBody List<MyTargetObject> getListOfFoo(@PathVariable("id") Integer id) {
        return MyServiceImpl.getInstance().getBarObj(id).getFoos();
    }
}

这是相当棒的简单。ModelAndViewResolver将自动将返回对象转换为JSON，并应用带注释的混合格式。

一个“缺点”（如果你这么说的话）是必须回到Spring2.5的配置方式，因为新的3.0标记不允许直接配置ModelAndViewResolver。也许他们只是忽略了这一点？

我的旧配置（使用Spring3.1样式）

<mvc:annotation-driven />

我的新配置（使用Spring2.5样式）

<bean class="org.springframework.web.servlet.mvc.annotation.AnnotationMethodHandlerAdapter"> 
    <property name="customModelAndViewResolvers">
        <list>
            <bean class="my.package.mvc.JsonModelAndViewResolver" />
        </list>
    </property>
</bean>

^^3.0+无法连接自定义ModelandViewResolver。因此，切换回旧的样式。

以下是自定义注释：

@Target({ElementType.METHOD})
@Retention(RetentionPolicy.RUNTIME)
public @interface Json {

    /**
     * A list of Jackson Mixins.
     * <p>
     * {@link http://wiki.fasterxml.com/JacksonMixInAnnotations}
     */
    JsonMixin[] mixins() default {};

}

public @interface JsonMixin {
    public Class<? extends Serializable> target();
    public Class<?> mixin();
}