Spring MVC 更靈活的控制 json 返回問題（自定義過濾字段）

發布時間：2020-08-26 03:01:04 來源：腳本之家閱讀：421 作者：DiamondFsd 欄目：編程語言

這篇文章主要講 Spring MVC 如何動態的去返回 Json 數據在我們做 Web 接口開發的時候，經常會遇到這種場景。

兩個請求，返回同一個對象，但是需要的返回字段并不相同。如以下場景

/**
* 返回所有名稱以及Id
*/
@RequestMapping("list")
@ResponseBody
public List<Article> findAllNameAndId() {
 return articleService.findAll();
}

/**
* 返回所有目錄詳情
*/
@RequestMapping("list-detail")
@ResponseBody
public List<Article> findAllDetail() {
 return articleService.findAll();
}

Spring MVC 默認使用轉json框架是 jackson。大家也知道， jackson 可以在實體類內加注解，來指定序列化規則，但是那樣比較不靈活，不能實現我們目前想要達到的這種情況。

這篇文章主要講的就是通過自定義注解，來更加靈活，細粒化控制 json 格式的轉換。

最終我們需要實現如下的效果:

@RequestMapping(value = "{id}", method = RequestMethod.GET)
// 返回時候不包含 filter 內的 createTime, updateTime 字段
@JSON(type = Article.class, filter="createTime,updateTime") 
public Article get(@PathVariable String id) {
  return articleService.get(id);
}
@RequestMapping(value="list", method = RequestMethod.GET)
// 返回時只包含 include 內的 id, name 字段 
@JSON(type = Article.class , include="id,name")
public List<Article> findAll() {
  return articleService.findAll();
}

jackson 編程式過濾字段

jackson 中，我們可以在實體類上加上 @JsonFilter 注解，并且通過 ObjectMapper.setFilterProvider 來進行過濾規則的設置。這里簡單介紹一下 setFilterProvider 的使用

@JsonFilter("ID-TITLE")
class Article {
 private String id;
 private String title;
 private String content;
 // ... getter/setter
}

// Demo
class Demo {
 public void main(String args[]) {
  ObjectMapper mapper = new ObjectMapper();
  // SimpleBeanPropertyFilter.filterOutAllExcept("id,title")
  // 過濾除了 id,title 以外的所有字段，也就是序列化的時候，只包含 id 和 title
  mapper.setFilterProvider(new SimpleFilterProvider().addFilter("ID-TITLE",
          SimpleBeanPropertyFilter.filterOutAllExcept("id,title"))); 

  String filterOut = mapper.writeValueAsString(new Article());

  mapper = new ObjectMapper();
  // SimpleBeanPropertyFilter.serializeAllExcept("id,title")
  // 序列化所有字段，但是排除 id 和 title，也就是除了 id 和 title之外，其他字段都包含進 json
  mapper.setFilterProvider(new SimpleFilterProvider().addFilter("ID-TITLE",
      SimpleBeanPropertyFilter.serializeAllExcept(filter.split("id,title"))));

  String serializeAll = mapper.writeValueAsString(new Article());

  System.out.println("filterOut:" + filterOut);
  System.out.println("serializeAll :" + serializeAll);  
 }
}

輸出結果

filterOut:{id: "", title: ""}
serializeAll:{content:""}

封裝json轉換

通過上面的代碼，我們發現，可以使用 setFilterProvider 來靈活的處理需要過濾的字段。不過上面的方法還有一些缺陷就是，還是要在原來的 model 上加注解，這里我們使用 ObjectMapper.addMixIn(Class<?> type, Class<?> mixinType) 方法，這個方法就是講兩個類的注解混合，讓第一個參數的類能夠擁有第二個參數類的注解。讓需要過濾的 model 和 @JsonFilter 注解解除耦合

package diamond.cms.server.json;

import com.fasterxml.jackson.annotation.JsonFilter;
import com.fasterxml.jackson.core.JsonProcessingException;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.fasterxml.jackson.databind.ser.impl.SimpleBeanPropertyFilter;
import com.fasterxml.jackson.databind.ser.impl.SimpleFilterProvider;

/**
 * depend on jackson
 * @author Diamond
 */
public class CustomerJsonSerializer {

  static final String DYNC_INCLUDE = "DYNC_INCLUDE";
  static final String DYNC_FILTER = "DYNC_FILTER";
  ObjectMapper mapper = new ObjectMapper();

  @JsonFilter(DYNC_FILTER)
  interface DynamicFilter {
  }

  @JsonFilter(DYNC_INCLUDE)
  interface DynamicInclude {
  }

  /**
   * @param clazz 需要設置規則的Class
   * @param include 轉換時包含哪些字段
   * @param filter 轉換時過濾哪些字段
   */
  public void filter(Class<?> clazz, String include, String filter) {
    if (clazz == null) return;
    if (include != null && include.length() > 0) {
      mapper.setFilterProvider(new SimpleFilterProvider().addFilter(DYNC_INCLUDE,
          SimpleBeanPropertyFilter.filterOutAllExcept(include.split(","))));
      mapper.addMixIn(clazz, DynamicInclude.class);
    } else if (filter !=null && filter.length() > 0) {
      mapper.setFilterProvider(new SimpleFilterProvider().addFilter(DYNC_FILTER,
          SimpleBeanPropertyFilter.serializeAllExcept(filter.split(","))));
      mapper.addMixIn(clazz, DynamicFilter.class);
    }
  }

  public String toJson(Object object) throws JsonProcessingException {
    return mapper.writeValueAsString(object);
  }
}

我們之前的 Demo 可以變成:

// Demo
class Demo {
 public void main(String args[]) {
  CustomerJsonSerializer cjs= new CustomerJsonSerializer();
  // 設置轉換 Article 類時，只包含 id, name
  cjs.filter(Article.class, "id,name", null); 

  String include = cjs.toJson(new Article()); 

  cjs = new CustomerJsonSerializer();
  // 設置轉換 Article 類時，過濾掉 id, name
  cjs.filter(Article.class, null, "id,name"); 

  String filter = cjs.toJson(new Article());

  System.out.println("include: " + include);
  System.out.println("filter: " + filter);  
 }
}

輸出結果

include: {id: "", title: ""}
filter: {content:""}

自定義 @JSON 注解

我們需要實現文章開頭的那種效果。這里我自定義了一個注解，可以加在方法上，這個注解是用來攜帶參數給 CustomerJsonSerializer.filter 方法的，就是某個類的某些字段需要過濾或者包含。

package diamond.cms.server.json;

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

@Target(ElementType.METHOD)
@Retention(RetentionPolicy.RUNTIME)
public @interface JSON {
  Class<?> type();
  String include() default "";
  String filter() default "";
}

實現 Spring MVC 的 HandlerMethodReturnValueHandler

HandlerMethodReturnValueHandler 接口 Spring MVC 用于處理請求返回值。看一下這個接口的定義和描述，接口有兩個方法supportsReturnType 用來判斷處理類是否支持當前請求， handleReturnValue 就是具體返回邏輯的實現。

 // Spring MVC 源碼
package org.springframework.web.method.support;

import org.springframework.core.MethodParameter;
import org.springframework.web.context.request.NativeWebRequest;

public interface HandlerMethodReturnValueHandler {

  boolean supportsReturnType(MethodParameter returnType);

  void handleReturnValue(Object returnValue, MethodParameter returnType,
      ModelAndViewContainer mavContainer, NativeWebRequest webRequest) throws Exception;

}

我們平時使用 @ResponseBody 就是交給 RequestResponseBodyMethodProcessor 這個類處理的

還有我們返回 ModelAndView 的時候，是由 ModelAndViewMethodReturnValueHandler 類處理的

要實現文章開頭的效果，我實現了一個 JsonReturnHandler類，當方法有 @JSON 注解的時候，使用該類來處理返回值。

package diamond.cms.server.json.spring;

import java.lang.annotation.Annotation;
import java.util.ArrayList;
import java.util.Arrays;
import java.util.List;

import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;

import org.springframework.core.MethodParameter;
import org.springframework.http.MediaType;
import org.springframework.http.server.ServletServerHttpRequest;
import org.springframework.http.server.ServletServerHttpResponse;
import org.springframework.web.context.request.NativeWebRequest;
import org.springframework.web.method.support.HandlerMethodReturnValueHandler;
import org.springframework.web.method.support.ModelAndViewContainer;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;
import org.springframework.web.servlet.mvc.method.annotation.ResponseBodyAdvice;

import diamond.cms.server.json.CustomerJsonSerializer;
import diamond.cms.server.json.JSON;

public class JsonReturnHandler implements HandlerMethodReturnValueHandler{

  @Override
  public boolean supportsReturnType(MethodParameter returnType) { 
    // 如果有我們自定義的 JSON 注解 就用我們這個Handler 來處理
    boolean hasJsonAnno= returnType.getMethodAnnotation(JSON.class) != null;
    return hasJsonAnno;
  }

  @Override
  public void handleReturnValue(Object returnValue, MethodParameter returnType, ModelAndViewContainer mavContainer,
      NativeWebRequest webRequest) throws Exception {
    // 設置這個就是最終的處理類了，處理完不再去找下一個類進行處理
    mavContainer.setRequestHandled(true);

    // 獲得注解并執行filter方法 最后返回
    HttpServletResponse response = webRequest.getNativeResponse(HttpServletResponse.class);
    Annotation[] annos = returnType.getMethodAnnotations();
    CustomerJsonSerializer jsonSerializer = new CustomerJsonSerializer();
    Arrays.asList(annos).forEach(a -> {
      if (a instanceof JSON) {
        JSON json = (JSON) a;
        jsonSerializer.filter(json.type(), json.include(), json.filter());
      }
    });

    response.setContentType(MediaType.APPLICATION_JSON_UTF8_VALUE);
    String json = jsonSerializer.toJson(returnValue);
    response.getWriter().write(json);
  }
}

通過這些，我們就可以最終實現以下效果。

class Article {
 private String id;
 private String title;
 private String content;
 private Long createTime;
 // ... getter/setter
}

@Controller
@RequestMapping("article")
class ArticleController {
 @RequestMapping(value = "{id}", method = RequestMethod.GET)
 @JSON(type = Article.class, filter="createTime") 
 public Article get(@PathVariable String id) {
   return articleService.get(id);
 }

 @RequestMapping(value="list", method = RequestMethod.GET)
 @JSON(type = Article.class , include="id,title")
 public List<Article> findAll() {
   return articleService.findAll();
 }
}

請求 /article/{articleId}

{
  id: "xxxx",
  title: "xxxx",
  content: "xxxx"
}

請求 article/list

[ {id: "xx", title: ""}, {id: "xx", title: ""}, {id: "xx", title: ""} ... ]

下載地址：cms-admin-end_jb51.rar

以上就是本文的全部內容，希望對大家的學習有所幫助，也希望大家多多支持億速云。

向AI問一下細節

91超碰碰碰碰久久久久久综合_超碰av人澡人澡人澡人澡人掠_国产黄大片在线观看画质优化_txt小说免费全本

Spring MVC 更靈活的控制 json 返回問題（自定義過濾字段）

猜你喜歡

91超碰碰碰碰久久久久久综合_超碰av人澡人澡人澡人澡人掠_国产黄大片在线观看画质优化_txt小说免费全本

Spring MVC 更靈活的控制 json 返回問題（自定義過濾字段）

猜你喜歡

最新資訊

相關推薦

相關標簽