将 @JsonView 与 Spring MVC 一起使用

Question

我正在使用以下 bean 定义来使我的 spring 应用程序以 JSON 进行通信，

<bean id="jacksonMessageConverter" class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter" />

此消息转换器 bean 是否可以使用 @JsonView 注释？

Answer 1

@JsonView 在 v1 版本的 Jackson JSON 处理器中已受支持 .4 起。

更新 Jackson 1.9.12

新编辑：根据 v1.8.4 文档 我正在使用的函数 writeValueUsingView 现已弃用 使用 ObjectMapper.viewWriter(java.lang.Class) 代替...但是这也已弃用 >从1.9开始，改用writerWithView(Class)！ （参见 v1.9.9 文档）

所以这里是一个更新的示例，使用 Spring 3.2.0 和 Jackson 1.9.12 进行测试，它仅返回 {id: 1} 而不是扩展的 {name: "name"} 因为它使用的是 .writerWithView(Views.Public.class)。切换到 Views.ExtendPublic.class 将导致 {"id":1,"name":"name"}

package com.demo.app;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

import org.codehaus.jackson.map.annotate.JsonView;
import org.codehaus.jackson.map.ObjectMapper;
import org.codehaus.jackson.map.ObjectWriter;

import javax.servlet.http.HttpServletResponse;

import java.io.IOException;

@Controller
public class DemoController {
    private final ObjectMapper objectMapper = new ObjectMapper();

    @RequestMapping(value="/jsonOutput")
    @ResponseBody
    public String myObject(HttpServletResponse response) throws IOException {
        ObjectWriter objectWriter = objectMapper.writerWithView(Views.Public.class);
        return objectWriter.writeValueAsString(new MyObject());
    }

    public static class Views {
        static class Public {}
        static class ExtendPublic extends Public {}
    }

    public class MyObject {
        @JsonView(Views.Public.class) Integer id = 1;
        @JsonView(Views.ExtendPublic.class) String name = "name";
    }
}

上一次编辑： 您需要实例化ObjectMapper并使用自定义视图写出对象，如此处，或者在此示例中：

定义视图：

class Views {
    static class Public {}
    static class ExtendedPublic extends PublicView {}
    ...
}

public class Thing {
    @JsonView(Views.Public.class) Integer id;
    @JsonView(Views.ExtendPublic.class) String name;
}

使用视图：

private final ObjectMapper objectMapper = new ObjectMapper();

@RequestMapping(value = "/thing/{id}")
public void getThing(@PathVariable final String id, HttpServletResponse response) {
    Thing thing = new Thing();
    objectMapper.writeValueUsingView(response.getWriter(), thing, Views.ExtendPublic.class);
}

如果您使用 Jackson >= 1.7，您可能会发现 @JSONFilter 更适合您的需求。

Answer 2

Spring 不支持 @JsonView 注解，但这个问题已解决！
遵循此

添加对 Jackson 序列化视图的支持

Spring MVC 现在支持 Jackon 的序列化视图进行渲染
来自不同控制器的同一 POJO 的不同子集
方法（例如详细页面与摘要视图）。
问题：SPR-7156

这是 SPR-7156。

状态：已解决

描述

Jackson 的 JSONView 注释允许开发人员控制方法的哪些方面被序列化。在当前的实现中，必须使用 Jackson 视图编写器，但内容类型不可用。如果可以在 RequestBody 注释中指定 JSONView，那就更好了。

可在Spring 版本 >= 4.1

谢谢 Spring！