SpringMvc @JsonView 使用方式

Easter79
• 阅读 913

准确来说,@JsonView注解不是Spring的,它位于jackson-annotation包中; 作用:SpringMvc使用@ResponseBody将结果以json返回客户端,  有些实体类的某些字段可以不被包括在JSON中;

思考了这种情况可能适用的情形:有多方调用这个接口,需要针对不同业务场景返回不同形式的JSON,但是这种情况的话 只拷贝需要的属性 再返回也能达到目的,就当多学了一种注解、处理方式了;

一.作为 Jackson Api使用:

public class View {
    public static class UserPublic{}

    public static class UserPrivacy{}
}

public class User {
    @JsonView(View.UserPublic.class)
    public int id;

    @JsonView(View.UserPrivacy.class)
    public String name;
}

补充说明:每一个@JsonView标注在属性上,代表该属性在被序列化时候会被转化,视图名字为value指向的class;

public class User {
    @JsonView(View.UserPublic.class)
    int id;

    @JsonView(View.UserPrivacy.class)
    String name;

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

    public void setName(String name) {
        this.name = name;
    }
}

public static void main(String[] args) throws JsonProcessingException {
    User user = new User();
    user.setId(1);
    user.setName("lvbb");
    ObjectMapper mapper = new ObjectMapper();
    String res1 = mapper.writerWithView(View.UserPublic.class).writeValueAsString(user);
    System.out.println(res1);
    String res2 = mapper.writerWithView(View.UserPrivacy.class).writeValueAsString(user);
    System.out.println(res2);
}

输出结果:

SpringMvc @JsonView 使用方式

@JsonView注解没有@Repeatable注解标注,意味着一个属性只能标注一个@JsonView注解,  比如 View.UserPrivacy 这个Json View也需要有id字段,解决方案就是 让 UserPrivacy 继承 UserPublic视图

SpringMvc @JsonView 使用方式

同样的main方法查看输出: {"id":1,"name":"lvbb"} 

二. 结合Spring的使用方式. (注解@JsonView的 value只能为一个)

简单列举个例子如下: 在@ResponseBody标注下添加  @JsonView指定要展示的JSON View即可.

@RequestMapping("/demo2")
    @ResponseBody
    @JsonView(value = MyView.UserDetail.class)
    public User demo2(){
        User user = new User();
        user.setName("lvbinbin");
        user.setPassword("qwer0-5");
        return user;
    }

上面的代码使用效果和下面一段是一模一样的:

@RequestMapping(value = "/demo4")
    @ResponseBody
    public MappingJacksonValue demo4(){
        User user = new User();
        user.setName("lvbinbin");
        user.setPassword("qwer0-5");
        MappingJacksonValue mjv=new MappingJacksonValue(user);
        mjv.setSerializationView(MyView.UserDetail.class);
        return mjv;
    }

Json View  Api使用:

User user = new User();
        user.setId(1);
        user.setName("lvbb");
        ObjectMapper mapper = new ObjectMapper();
        MappingJacksonValue mappingJacksonValue = new MappingJacksonValue(user);
        mappingJacksonValue.setSerializationView(View.UserPrivacy.class); 
        ObjectWriter writer = mapper.writerWithView(mappingJacksonValue.getSerializationView());
        String res4= writer.writeValueAsString(mappingJacksonValue.getValue());
        System.out.println(res4);

当然MappingJacksonValue好像也是支持SpringMvc跨域JSONP调用的,具体不太了解以后补上.

同样类似的,接收JSON请求参数使用 @RequestBody同样可以和 @JsonView使用,这时候前台接收到参数就可以忽略指定的字段

@RequestMapping("/demo5")
    @ResponseBody
    public String demo5(@RequestBody @JsonView(MyView.UserSimple.class) User user){
        System.out.println(user);
        return "Hello World";
    }

Spring底层对MappingJacksonValue以及 @JsonView 流程记录:

MappingJackson的处理过程如下

org.springframework.http.converter.json.AbstractJackson2HttpMessageConverter#writeInternal 有这样一个代码片段:

@ResponseBody的返回值类型是MappingJacksonValue类型时,会做的多一步转换工作,取出mappingJackson的value值.

SpringMvc @JsonView 使用方式

org.springframework.web.servlet.mvc.method.annotation.AbstractMessageConverterMethodProcessor#writeWithMessageConverters

在往响应对象Response写回结果之前, 会调用ResponseBodyAdvice接口的beforeBodyWrite方法进行切面处理,当前对象为 RequestResponseBodyAdviceChain,其持有JsonViewResponseBodyAdvice 以及JsonViewRequestBodyAdvice, 前者就是处理@ResponseBody的;

SpringMvc @JsonView 使用方式

JsonViewResponseBodyAdvice 直接获取了 方法上的JsonView注解,然后调用Jackson View Api进行设置;也就是说上面提及到的两种方式是一模一样的.

SpringMvc @JsonView 使用方式

参考文档:

一个关于jackson使用很全面的外文网站https://www.baeldung.com/jackson

点赞
收藏
评论区
推荐文章
blmius blmius
3年前
MySQL:[Err] 1292 - Incorrect datetime value: ‘0000-00-00 00:00:00‘ for column ‘CREATE_TIME‘ at row 1
文章目录问题用navicat导入数据时,报错:原因这是因为当前的MySQL不支持datetime为0的情况。解决修改sql\mode:sql\mode:SQLMode定义了MySQL应支持的SQL语法、数据校验等,这样可以更容易地在不同的环境中使用MySQL。全局s
Wesley13 Wesley13
3年前
java将前端的json数组字符串转换为列表
记录下在前端通过ajax提交了一个json数组的字符串,在后端如何转换为列表。前端数据转化与请求varcontracts{id:'1',name:'yanggb合同1'},{id:'2',name:'yanggb合同2'},{id:'3',name:'yang
皕杰报表之UUID
​在我们用皕杰报表工具设计填报报表时,如何在新增行里自动增加id呢?能新增整数排序id吗?目前可以在新增行里自动增加id,但只能用uuid函数增加UUID编码,不能新增整数排序id。uuid函数说明:获取一个UUID,可以在填报表中用来创建数据ID语法:uuid()或uuid(sep)参数说明:sep布尔值,生成的uuid中是否包含分隔符'',缺省为
待兔 待兔
4个月前
手写Java HashMap源码
HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程HashMap的使用教程22
Jacquelyn38 Jacquelyn38
3年前
2020年前端实用代码段,为你的工作保驾护航
有空的时候,自己总结了几个代码段,在开发中也经常使用,谢谢。1、使用解构获取json数据let jsonData  id: 1,status: "OK",data: 'a', 'b';let  id, status, data: number   jsonData;console.log(id, status, number )
Easter79 Easter79
3年前
Twitter的分布式自增ID算法snowflake (Java版)
概述分布式系统中,有一些需要使用全局唯一ID的场景,这种时候为了防止ID冲突可以使用36位的UUID,但是UUID有一些缺点,首先他相对比较长,另外UUID一般是无序的。有些时候我们希望能使用一种简单一些的ID,并且希望ID能够按照时间有序生成。而twitter的snowflake解决了这种需求,最初Twitter把存储系统从MySQL迁移
Stella981 Stella981
3年前
Django中Admin中的一些参数配置
设置在列表中显示的字段,id为django模型默认的主键list_display('id','name','sex','profession','email','qq','phone','status','create_time')设置在列表可编辑字段list_editable
Wesley13 Wesley13
3年前
unity将 -u4E00 这种 编码 转汉字 方法
 unity中直接使用 JsonMapper.ToJson(对象),取到的字符串,里面汉字可能是\\u4E00类似这种其实也不用转,服务器会通过类似fastjson发序列化的方式,将json转对象,获取对象的值就是中文但是有时服务器要求将传参中字符串中类似\\u4E00这种转汉字,就需要下面 publ
Wesley13 Wesley13
3年前
MySQL部分从库上面因为大量的临时表tmp_table造成慢查询
背景描述Time:20190124T00:08:14.70572408:00User@Host:@Id:Schema:sentrymetaLast_errno:0Killed:0Query_time:0.315758Lock_
Python进阶者 Python进阶者
10个月前
Excel中这日期老是出来00:00:00,怎么用Pandas把这个去除
大家好,我是皮皮。一、前言前几天在Python白银交流群【上海新年人】问了一个Pandas数据筛选的问题。问题如下:这日期老是出来00:00:00,怎么把这个去除。二、实现过程后来【论草莓如何成为冻干莓】给了一个思路和代码如下:pd.toexcel之前把这
Easter79
Easter79
Lv1
今生可爱与温柔,每一样都不能少。
文章
2.8k
粉丝
5
获赞
1.2k