Spring Boot过滤返回的数据

考虑这样的场景：对于同一个Model类，在不同的api中需要返回不同的字段。该如何优雅的实现呢？

解决方案

采用JsonView，根据定义自动实现字段的过滤。

具体方法

1. 创建一个view类，声明一个summary接口，summary接口继承summary用来演示扩展

   public class View {
       public interface Summary {}
       public interface Summary2 extends Summary{}
   }

2. 在model上使用注解，定义view中需要呈现的列

   public class Article {
       @JsonView(View.Summary.class)
       private String id;
       @JsonView(View.Summary2.class)
       private String title;
       private String content;
       // 省略getter setter
   }

3. 通常在RESTful API工程中，实体类不是直接返回给调用者，而是做了一层封装，我们同样需要在封装类上加上注解

   public class Result {
       @JsonView(View.Summary.class)
       private int status;
       @JsonView(View.Summary.class)
       private String message;
       @JsonView(View.Summary.class)
       private Object data;
   	//省略getter setter
   }

4. 在RestController中的API方法上添加注解，说明返回的JsonView

   @JsonView(View.Summary.class)
   @RequestMapping(path="/test",method = RequestMethod.POST)
   public Result test(){
       Article article = new Article();
       article.setId("123");
       article.setTitle("test");
       article.setContent("hahahatest");
       return ResultGenerator.genSuccessResult(article);
   }

5. 如果我们注解使用View.Summary.class ，那么return的内容为

   {"status":200,"message":"SUCCESS","data":{"id":"123"}}

   如果我们注解使用View.Summary2.class，那么return的内容为

   {"status":200,"message":"SUCCESS","data":{"id":"123","title":"test"}}

END