Spring和Jackson Json，用视图序列化不同的字段

Question

在previous similar question 中，我询问了如何使用 JacksonJson 和 Spring 序列化两组不同的字段。

我的用例是带有 @ResponseBody 注释的典型 Controller 映射，直接返回特定对象或对象集合，然后每当客户端在 Accept 标头中添加 application/json 时使用 JacksonJson 呈现这些对象。

我有两个答案，第一个建议使用不同的 getter 列表返回不同的接口，第二个建议使用 Json Views。

我理解第一种方式没有问题，但是第二种方式，在阅读了JacksonJsonViews上的文档后，我不知道如何用Spring实现它。

为了继续举例，我将在 Views 类中声明三个存根类：

// View definitions:
public class Views {
    public static class Public { }
    public static class ExtendedPublic extends PublicView { }
    public static class Internal extends ExtendedPublicView { }
}

然后我要声明提到的类：

public class PublicView { }   
public class ExtendedPublicView { }

他们到底为什么要声明空静态类和外部空类，我不知道。我知道他们需要一个“标签”，但是 Views 的静态成员就足够了。并不是ExtendedPublic 扩展Public，因为这是合乎逻辑的，但它们实际上完全不相关。

最后，bean 将通过注解指定视图或视图列表：

//changed other classes to String for simplicity and fixed typo 
//in classname, the values are hardcoded, just for testing
public class Bean {
    // Name is public
    @JsonView(Views.Public.class)
    String name = "just testing";

    // Address semi-public
    @JsonView(Views.ExtendedPublic.class)
    String address = "address";

    // SSN only for internal usage
    @JsonView(Views.Internal.class)
    String ssn = "32342342";
}

最后在 Spring Controller 中，我要考虑如何更改我的测试 bean 的原始映射：

@RequestMapping(value = "/bean") 
@ResponseBody
public final Bean getBean() {
    return new Bean();
}

它说调用：

//or, starting with 1.5, more convenient (ObjectWriter is reusable too)
objectMapper.viewWriter(ViewsPublic.class).writeValue(out, beanInstance);

所以我有一个不知从何而来的ObjectMapper 实例和一个out，它不是典型的servlet PrintWriter out = response.getWriter();，而是JsonGenerator 的一个实例，并且无法通过new 运算符获得。所以不知道怎么修改方法，这里是一个不完整的尝试：

@RequestMapping(value = "/bean")
@ResponseBody
public final Bean getBean() throws JsonGenerationException, JsonMappingException, IOException {
    ObjectMapper objectMapper = new ObjectMapper();
    JsonGenerator out; //how to create?
    objectMapper.viewWriter(Views.Public.class).writeValue(out, new Bean());
    return ??; //what should I return?
}

所以我想知道是否有人成功使用 JsonView 和 Spring 以及他/她是如何做到的。整个概念看起来很有趣，但文档似乎缺乏，示例代码也不见了。

如果不可能，我将只使用相互扩展的接口。抱歉问了这么长的问题。

Answer 1

根据@igbopie 和@chrislovecnm 的回答，我整理了一个注释驱动的解决方案：

@Controller
public class BookService
{
    @RequestMapping("/books")
    @ResponseView(SummaryView.class)
    public @ResponseBody List<Book> getBookSummaries() {}

    @RequestMapping("/books/{bookId}")
    public @ResponseBody Book getBook(@PathVariable("bookId") Long BookId) {}
}

SummaryView 在 Book 模型上的注释如下：

@Data
class Book extends BaseEntity
{
    @JsonView(SummaryView.class)
    private String title;
    @JsonView(SummaryView.class)
    private String author;
    private String review;

    public static interface SummaryView extends BaseView {}
}

@Data
public class BaseEntity
{
    @JsonView(BaseView.class)
    private Long id;    
}

public interface BaseView {}

然后将自定义 HandlerMethodReturnValueHandler 连接到 Spring MVC 的上下文中以检测 @ResponseView 注释，并相应地应用 Jackson 视图。

我提供了完整的代码over on my blog。

Answer 2

您需要手动连接 MappingJacksonHttpMessageConverter。在 spring 3.1 中，您可以使用 mvc xml 标签，如下所示：

<mvc:annotation-driven >
    <mvc:message-converter>
        <bean class="org.springframework.http.converter.json.MappingJacksonHttpMessageConverter" />
    </mvc:message-converters>
</mvc:annotation-driven>

不使用 spring 3.1 是相当难看的，它会为你节省大约 20 行 xml。 mvc:annotation 标签做的很多。

您需要使用正确的视图编写器连接对象映射器。我最近注意到使用@Configuration 类可以使这样的复杂接线变得容易得多。使用 @Configuration 类并使用您的 MappingJacksonHttpMessageConverter 创建一个 @Bean，并将引用连接到该 bean 而不是上面的 MappingJacksonHttpMessageConverter。

Answer 3

我已经设法通过这种方式解决了这个问题：

• 创建自定义抽象类以包含 json 响应对象：

public abstract AbstractJson<E>{
    @JsonView(Views.Public.class)
    private E responseObject;

    public E getResponseObject() {
        return responseObject;
    }
    public void setResponseObject(E responseObject) {
        this.responseObject = responseObject;
    }
}

• 为每个可见性创建一个类（只是为了标记响应）：

public class PublicJson<E> extends AbstractJson<E> {}
public class ExtendedPublicJson<E> extends AbstractJson<E> {}
public class InternalJson<E> extends AbstractJson<E> {}

• 更改您的方法声明：

    @RequestMapping(value = "/bean")
    @ResponseBody
    public final PublicJson<Bean> getBean() throws JsonGenerationException, JsonMappingException, IOException {
         return new PublicJson(new Bean());
    }

• 创建自定义MessageConverter：

public class PublicJsonMessageConverter extends MappingJacksonHttpMessageConverter{

    public PublicApiResponseMessageConverter(){
        super();
        org.codehaus.jackson.map.ObjectMapper objMapper=new org.codehaus.jackson.map.ObjectMapper();
        objMapper.configure(SerializationConfig.Feature.DEFAULT_VIEW_INCLUSION, false);
        objMapper.setSerializationConfig(objMapper.getSerializationConfig().withView(Views.Public.class));
        this.setObjectMapper(objMapper);
    }

     public boolean canWrite(Class<?> clazz, MediaType mediaType) {
         if(clazz.equals(PublicJson.class)){
             return true;
         }
         return false;
     }

}

public class ExtendedPublicJsonMessageConverter extends MappingJacksonHttpMessageConverter{

    public ExtendedPublicJsonMessageConverter(){
        super();
        org.codehaus.jackson.map.ObjectMapper objMapper=new org.codehaus.jackson.map.ObjectMapper();
        objMapper.configure(SerializationConfig.Feature.DEFAULT_VIEW_INCLUSION, false);
        objMapper.setSerializationConfig(objMapper.getSerializationConfig().withView(Views.ExtendedPublic.class));
        this.setObjectMapper(objMapper);
    }

     public boolean canWrite(Class<?> clazz, MediaType mediaType) {
         if(clazz.equals(ExtendedPublicJson.class)){
             return true;
         }
         return false;
     }

}

public class InternalJsonMessageConverter extends MappingJacksonHttpMessageConverter{

    public InternalJsonMessageConverter(){
        super();
        org.codehaus.jackson.map.ObjectMapper objMapper=new org.codehaus.jackson.map.ObjectMapper();
        objMapper.configure(SerializationConfig.Feature.DEFAULT_VIEW_INCLUSION, false);
        objMapper.setSerializationConfig(objMapper.getSerializationConfig().withView(Views.Internal.class));
        this.setObjectMapper(objMapper);
    }

     public boolean canWrite(Class<?> clazz, MediaType mediaType) {
         if(clazz.equals(Internal.class)){
             return true;
         }
         return false;
     }

}

• 将以下内容添加到您的 xml：

<mvc:annotation-driven>
    <mvc:message-converters>
        <bean class="PublicJsonMessageConverter"></bean>
        <bean class="ExtendedPublicJsonMessageConverter"></bean>
        <bean class="InternalJsonMessageConverter"></bean>
    </mvc:message-converters>
</mvc:annotation-driven>

就是这样！我不得不更新到 spring 3.1 但仅此而已。我使用 responseObject 发送有关 json 调用的更多信息，但您可以覆盖 MessageConverter 的更多方法以使其完全透明。我希望有一天春天会为此添加一个注释。

希望这会有所帮助！