Spring MVC 更灵活的控制 json 返回问题（自定义过滤字段）

r囧r小猫 2022-05-17 06:41 109阅读 0赞

这篇文章主要讲 Spring MVC 如何动态的去返回 Json 数据 在我们做 Web 接口开发的时候， 经常会遇到这种场景。

两个请求，返回同一个对象，但是需要的返回字段并不相同。如以下场景

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 </td> 
 <td> <code>/**</code> <code>* 返回所有名称以及Id</code> <code>*/</code> <code>@RequestMapping</code><code>(</code><code>"list"</code><code>)</code> <code>@ResponseBody</code> <code>public</code> <code>List&lt;Article&gt; findAllNameAndId() { </code> <code>&nbsp;</code><code>return</code> <code>articleService.findAll();</code> <code>}</code> &nbsp; <code>/**</code> <code>* 返回所有目录详情</code> <code>*/</code> <code>@RequestMapping</code><code>(</code><code>"list-detail"</code><code>)</code> <code>@ResponseBody</code> <code>public</code> <code>List&lt;Article&gt; findAllDetail() { </code> <code>&nbsp;</code><code>return</code> <code>articleService.findAll();</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

Spring MVC 默认使用转json框架是 jackson。 大家也知道， jackson 可以在实体类内加注解，来指定序列化规则，但是那样比较不灵活，不能实现我们目前想要达到的这种情况。

这篇文章主要讲的就是通过自定义注解，来更加灵活，细粒化控制 json 格式的转换。

最终我们需要实现如下的效果:

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 </td> 
 <td> <code>@RequestMapping</code><code>(value = </code><code>"{id}"</code><code>, method = RequestMethod.GET)</code> <code>// 返回时候不包含 filter 内的 createTime, updateTime 字段</code> <code>@JSON</code><code>(type = Article.</code><code>class</code><code>, filter=</code><code>"createTime,updateTime"</code><code>) </code> <code>public</code> <code>Article get(</code><code>@PathVariable</code> <code>String id) { </code> <code>&nbsp;&nbsp;</code><code>return</code> <code>articleService.get(id);</code> <code>}</code> <code>@RequestMapping</code><code>(value=</code><code>"list"</code><code>, method = RequestMethod.GET)</code> <code>// 返回时只包含 include 内的 id, name 字段 </code> <code>@JSON</code><code>(type = Article.</code><code>class</code> <code>, include=</code><code>"id,name"</code><code>)</code> <code>public</code> <code>List&lt;Article&gt; findAll() { </code> <code>&nbsp;&nbsp;</code><code>return</code> <code>articleService.findAll();</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**jackson 编程式过滤字段**

jackson 中， 我们可以在实体类上加上 @JsonFilter 注解，并且通过 ObjectMapper.setFilterProvider 来进行过滤规则的设置。 这里简单介绍一下 setFilterProvider 的使用

[?][Link 1]

输出结果

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>filterOut:{id: </code><code>""</code><code>, title: </code><code>""</code><code>}</code> <code>serializeAll:{content:</code><code>""</code><code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**封装json转换**

通过上面的代码，我们发现，可以使用 setFilterProvider 来灵活的处理需要过滤的字段。不过上面的方法还有一些缺陷就是，还是要在 原来的 model 上加注解，这里我们使用 ObjectMapper.addMixIn(Class<?> type, Class<?> mixinType) 方法，这个方法就是讲两个类的注解混合，让第一个参数的类能够拥有第二个参数类的注解。让需要过滤的 model 和 @JsonFilter 注解解除耦合

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 </td> 
 <td> <code>package</code> <code>diamond.cms.server.json;</code> &nbsp; <code>import</code> <code>com.fasterxml.jackson.annotation.JsonFilter;</code> <code>import</code> <code>com.fasterxml.jackson.core.JsonProcessingException;</code> <code>import</code> <code>com.fasterxml.jackson.databind.ObjectMapper;</code> <code>import</code> <code>com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter;</code> <code>import</code> <code>com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;</code> &nbsp; <code>/**</code> <code>&nbsp;</code><code>* depend on jackson</code> <code>&nbsp;</code><code>* @author Diamond</code> <code>&nbsp;</code><code>*/</code> <code>public</code> <code>class</code> <code>CustomerJsonSerializer { </code> &nbsp; <code>&nbsp;&nbsp;</code><code>static</code> <code>final</code> <code>String DYNC_INCLUDE = </code><code>"DYNC_INCLUDE"</code><code>;</code> <code>&nbsp;&nbsp;</code><code>static</code> <code>final</code> <code>String DYNC_FILTER = </code><code>"DYNC_FILTER"</code><code>;</code> <code>&nbsp;&nbsp;</code><code>ObjectMapper mapper = </code><code>new</code> <code>ObjectMapper();</code> &nbsp; <code>&nbsp;&nbsp;</code><code>@JsonFilter</code><code>(DYNC_FILTER)</code> <code>&nbsp;&nbsp;</code><code>interface</code> <code>DynamicFilter { </code> <code>&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;</code><code>@JsonFilter</code><code>(DYNC_INCLUDE)</code> <code>&nbsp;&nbsp;</code><code>interface</code> <code>DynamicInclude { </code> <code>&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;</code><code>/**</code> <code>&nbsp;&nbsp;&nbsp;</code><code>* @param clazz 需要设置规则的Class</code> <code>&nbsp;&nbsp;&nbsp;</code><code>* @param include 转换时包含哪些字段</code> <code>&nbsp;&nbsp;&nbsp;</code><code>* @param filter 转换时过滤哪些字段</code> <code>&nbsp;&nbsp;&nbsp;</code><code>*/</code> <code>&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>filter(Class&lt;?&gt; clazz, String include, String filter) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>(clazz == </code><code>null</code><code>) </code><code>return</code><code>;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>(include != </code><code>null</code> <code>&amp;&amp; include.length() &gt; </code><code>0</code><code>) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>mapper.setFilterProvider(</code><code>new</code> <code>SimpleFilterProvider().addFilter(DYNC_INCLUDE,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>SimpleBeanPropertyFilter.filterOutAllExcept(include.split(</code><code>","</code><code>))));</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>mapper.addMixIn(clazz, DynamicInclude.</code><code>class</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>} </code><code>else</code> <code>if</code> <code>(filter !=</code><code>null</code> <code>&amp;&amp; filter.length() &gt; </code><code>0</code><code>) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>mapper.setFilterProvider(</code><code>new</code> <code>SimpleFilterProvider().addFilter(DYNC_FILTER,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>SimpleBeanPropertyFilter.serializeAllExcept(filter.split(</code><code>","</code><code>))));</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>mapper.addMixIn(clazz, DynamicFilter.</code><code>class</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;</code><code>public</code> <code>String toJson(Object object) </code><code>throws</code> <code>JsonProcessingException { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>mapper.writeValueAsString(object);</code> <code>&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

我们之前的 Demo 可以变成:

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 </td> 
 <td> <code>// Demo</code> <code>class</code> <code>Demo { </code> <code>&nbsp;</code><code>public</code> <code>void</code> <code>main(String args[]) { </code> <code>&nbsp;&nbsp;</code><code>CustomerJsonSerializer cjs= </code><code>new</code> <code>CustomerJsonSerializer();</code> <code>&nbsp;&nbsp;</code><code>// 设置转换 Article 类时，只包含 id, name</code> <code>&nbsp;&nbsp;</code><code>cjs.filter(Article.</code><code>class</code><code>, </code><code>"id,name"</code><code>, </code><code>null</code><code>); </code> &nbsp; <code>&nbsp;&nbsp;</code><code>String include = cjs.toJson(</code><code>new</code> <code>Article()); </code> &nbsp; <code>&nbsp;&nbsp;</code><code>cjs = </code><code>new</code> <code>CustomerJsonSerializer();</code> <code>&nbsp;&nbsp;</code><code>// 设置转换 Article 类时，过滤掉 id, name</code> <code>&nbsp;&nbsp;</code><code>cjs.filter(Article.</code><code>class</code><code>, </code><code>null</code><code>, </code><code>"id,name"</code><code>); </code> &nbsp; <code>&nbsp;&nbsp;</code><code>String filter = cjs.toJson(</code><code>new</code> <code>Article());</code> &nbsp; <code>&nbsp;&nbsp;</code><code>System.out.println(</code><code>"include: "</code> <code>+ include);</code> <code>&nbsp;&nbsp;</code><code>System.out.println(</code><code>"filter: "</code> <code>+ filter);&nbsp; </code> <code>&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

输出结果

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 </td> 
 <td> <code>include: {id: </code><code>""</code><code>, title: </code><code>""</code><code>}</code> <code>filter: {content:</code><code>""</code><code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**自定义 @JSON 注解**

我们需要实现文章开头的那种效果。这里我自定义了一个注解，可以加在方法上，这个注解是用来携带参数给 CustomerJsonSerializer.filter 方法的，就是某个类的某些字段需要过滤或者包含。

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 </td> 
 <td> <code>package</code> <code>diamond.cms.server.json;</code> &nbsp; <code>import</code> <code>java.lang.annotation.ElementType;</code> <code>import</code> <code>java.lang.annotation.Retention;</code> <code>import</code> <code>java.lang.annotation.RetentionPolicy;</code> <code>import</code> <code>java.lang.annotation.Target;</code> &nbsp; <code>@Target</code><code>(ElementType.METHOD)</code> <code>@Retention</code><code>(RetentionPolicy.RUNTIME)</code> <code>public</code> <code>@interface</code> <code>JSON { </code> <code>&nbsp;&nbsp;</code><code>Class&lt;?&gt; type();</code> <code>&nbsp;&nbsp;</code><code>String include() </code><code>default</code> <code>""</code><code>;</code> <code>&nbsp;&nbsp;</code><code>String filter() </code><code>default</code> <code>""</code><code>;</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

**实现 Spring MVC 的 HandlerMethodReturnValueHandler**

HandlerMethodReturnValueHandler 接口 Spring MVC 用于处理请求返回值 。 看一下这个接口的定义和描述，接口有两个方法supportsReturnType 用来判断 处理类 是否支持当前请求， handleReturnValue 就是具体返回逻辑的实现。

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 </td> 
 <td> <code>// Spring MVC 源码</code> <code>package</code> <code>org.springframework.web.method.support;</code> &nbsp; <code>import</code> <code>org.springframework.core.MethodParameter;</code> <code>import</code> <code>org.springframework.web.context.request.NativeWebRequest;</code> &nbsp; <code>public</code> <code>interface</code> <code>HandlerMethodReturnValueHandler { </code> &nbsp; <code>&nbsp;&nbsp;</code><code>boolean</code> <code>supportsReturnType(MethodParameter returnType);</code> &nbsp; <code>&nbsp;&nbsp;</code><code>void</code> <code>handleReturnValue(Object returnValue, MethodParameter returnType,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>ModelAndViewContainer mavContainer, NativeWebRequest webRequest) </code><code>throws</code> <code>Exception;</code> &nbsp; <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

我们平时使用 @ResponseBody 就是交给 RequestResponseBodyMethodProcessor 这个类处理的

还有我们返回 ModelAndView 的时候， 是由 ModelAndViewMethodReturnValueHandler 类处理的

要实现文章开头的效果，我实现了一个 JsonReturnHandler类，当方法有 @JSON 注解的时候，使用该类来处理返回值。

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 </td> 
 <td> <code>package</code> <code>diamond.cms.server.json.spring;</code> &nbsp; <code>import</code> <code>java.lang.annotation.Annotation;</code> <code>import</code> <code>java.util.ArrayList;</code> <code>import</code> <code>java.util.Arrays;</code> <code>import</code> <code>java.util.List;</code> &nbsp; <code>import</code> <code>javax.servlet.http.HttpServletRequest;</code> <code>import</code> <code>javax.servlet.http.HttpServletResponse;</code> &nbsp; <code>import</code> <code>org.springframework.core.MethodParameter;</code> <code>import</code> <code>org.springframework.http.MediaType;</code> <code>import</code> <code>org.springframework.http.server.ServletServerHttpRequest;</code> <code>import</code> <code>org.springframework.http.server.ServletServerHttpResponse;</code> <code>import</code> <code>org.springframework.web.context.request.NativeWebRequest;</code> <code>import</code> <code>org.springframework.web.method.support.HandlerMethodReturnValueHandler;</code> <code>import</code> <code>org.springframework.web.method.support.ModelAndViewContainer;</code> <code>import</code> <code>org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;</code> <code>import</code> <code>org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;</code> &nbsp; <code>import</code> <code>diamond.cms.server.json.CustomerJsonSerializer;</code> <code>import</code> <code>diamond.cms.server.json.JSON;</code> &nbsp; <code>public</code> <code>class</code> <code>JsonReturnHandler </code><code>implements</code> <code>HandlerMethodReturnValueHandler{ </code> &nbsp; <code>&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;</code><code>public</code> <code>boolean</code> <code>supportsReturnType(MethodParameter returnType) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 如果有我们自定义的 JSON 注解 就用我们这个Handler 来处理</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>boolean</code> <code>hasJsonAnno= returnType.getMethodAnnotation(JSON.</code><code>class</code><code>) != </code><code>null</code><code>;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>return</code> <code>hasJsonAnno;</code> <code>&nbsp;&nbsp;</code><code>}</code> &nbsp; <code>&nbsp;&nbsp;</code><code>@Override</code> <code>&nbsp;&nbsp;</code><code>public</code> <code>void</code> <code>handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer,</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>NativeWebRequest webRequest) </code><code>throws</code> <code>Exception { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 设置这个就是最终的处理类了，处理完不再去找下一个类进行处理</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>mavContainer.setRequestHandled(</code><code>true</code><code>);</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>// 获得注解并执行filter方法 最后返回</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>HttpServletResponse response = webRequest.getNativeResponse(HttpServletResponse.</code><code>class</code><code>);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Annotation[] annos = returnType.getMethodAnnotations();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>CustomerJsonSerializer jsonSerializer = </code><code>new</code> <code>CustomerJsonSerializer();</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>Arrays.asList(annos).forEach(a -&gt; { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>if</code> <code>(a </code><code>instanceof</code> <code>JSON) { </code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>JSON json = (JSON) a;</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>jsonSerializer.filter(json.type(), json.include(), json.filter());</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;&nbsp;</code><code>}</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>});</code> &nbsp; <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>response.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>String json = jsonSerializer.toJson(returnValue);</code> <code>&nbsp;&nbsp;&nbsp;&nbsp;</code><code>response.getWriter().write(json);</code> <code>&nbsp;&nbsp;</code><code>}</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

通过这些，我们就可以最终实现以下效果。

[?][Link 1]

请求 /article/\{articleId\}

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 2 3 4 5 </td> 
 <td> <code>{ </code> <code>&nbsp;&nbsp;</code><code>id: </code><code>"xxxx"</code><code>,</code> <code>&nbsp;&nbsp;</code><code>title: </code><code>"xxxx"</code><code>,</code> <code>&nbsp;&nbsp;</code><code>content: </code><code>"xxxx"</code> <code>}</code> </td> 
 </tr> 
 </tbody> 
</table>

请求 article/list

[?][Link 1]

<table> 
 <tbody> 
 <tr> 
 <td> 1 </td> 
 <td> <code>[ {id: </code><code>"xx"</code><code>, title: </code><code>""</code><code>}, {id: </code><code>"xx"</code><code>, title: </code><code>""</code><code>}, {id: </code><code>"xx"</code><code>, title: </code><code>""</code><code>} ... ]</code> </td> 
 </tr> 
 </tbody> 
</table>

下载地址：[cms-admin-end\_jb51.rar][cms-admin-end_jb51.rar]

[Link 1]: https://www.jb51.net/article/105633.htm#
[cms-admin-end_jb51.rar]: http://xiazai.jb51.net/201702/yuanma/cms-admin-end_jb51.rar