Spring MVC @JsonView使用詳解

Spring 提供了對Jackson 很是好的支持，能夠查看此spring-jackson-demo代碼來掌握。這裏着重說一下@JsonView的用法

JSON Views 基本用法

@JsonView能夠過濾序列化對象的字段屬性，能夠使你有選擇的序列化對象。下面看一個例子: 首先咱們定義一個View類，裏面包含咱們對「要序列化的字段」的定義，咱們暫時歸爲Summary（摘要）。屬於Summary的字段都是咱們要序列化的字段。

這裏也能夠將View類理解爲一組「標識」，而Summary就是其中的一個「標識」。

public class View {
   interface Summary {}
}

View類的定義很簡單。

而後咱們定義咱們的Bean類：User

public class User { 
  @JsonView(View.Summary.class) 
  private Long id; 
  @JsonView(View.Summary.class) 
  private String firstname; 
  @JsonView(View.Summary.class) 
  private String lastname; 
  private String email; 
  private String address; 
  private String postalCode; 
  private String city; 
  private String country;
}

能夠看到，@JsonView使用很簡單，加在屬性上，指定一個「標識」就行了。上面例子咱們將Summary指定給了id、firstname、lastname三個屬性，這樣，當咱們使用@JsonView序列化User對象的時候，就只會序列化這三個屬性，能夠隱藏一些不想序列化的字段屬性。 SpringMVC根據@JsonView序列化的方法以下：

@RestController
public class UserRestController{
  @Autowired 
  private UserService userService;

  @RequestMapping("/user")
  @JsonView(View.Summary.class) 
  public List<User> getUsers(){
    return userService.listUsers();
  }
}

在Controller中指定JsonVIew便可。 當咱們訪問/user時，會獲得以下結果：

[
  { "id" : 1, "firstname" : "Brian", "lastname" : "Clozel" },
  { "id" : 2, "firstname" : "Stéphane", "lastname" : "Nicoll" },
  { "id" : 3, "firstname" : "Rossen", "lastname" : "Stoyanchev" }
]

用法是否是很簡單？

JSON Views 繼承用法

JsonView 同時還支持繼承 好比咱們須要將User分兩個規則進行序列化，一個是「基本資料」，即上面那三個屬性的規則；另外一個是「詳細資料」，除了包含「基本資料」中的三個屬性外，另外還要包含幾個詳細資料email、address。

咱們在View中再加一個「標識」SummaryWithDetail，定義以下：

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

這裏使用了繼承，SummaryWithDetail繼承了Summary，也就是說，當咱們以SummaryWithDetail的方式進行對象序列化時，出來的屬性同時也包含Summary指定的屬性。咱們在User中指定SummaryWithDetail:

public class User { 
  @JsonView(View.Summary.class) 
  private Long id; 
  @JsonView(View.Summary.class) 
  private String firstname; 
  @JsonView(View.Summary.class) 
  private String lastname; 

  @JsonView(View.SummaryWithDetail .class) 
  private String email; 
  @JsonView(View.SummaryWithDetail .class) 
  private String address; 

  private String postalCode; 
  private String city; 
  private String country;
}

能夠看到，咱們對email和address指定了SummaryWithDetail標識。

增長Controller方法，測試：

@RestController
public class UserRestController{
  @Autowired 
  private UserService userService;

  @RequestMapping("/user")
  @JsonView(View.Summary.class) 
  public List<User> getUsers(){
    return userService.listUsers();
  }

  @RequestMapping("/user-with-detail")
  @JsonView(View.SummaryWithDetail.class) 
  public List<User> getUsersWithDetail(){
    return userService.listUsers();
  }
}

這樣，當咱們訪問/user-with-detail時，會獲得以下結果：

[
  { 
    "id" : 1, 
    "firstname" : "Brian", 
    "lastname" : "Clozel", 
    "email": "brian@163.com", 
    "address": "beijing China" 
  },
  { 
    "id" : 2, 
    "firstname" : "Stéphane", 
    "lastname" : "Nicoll", 
    "email": "nicoll@163.com", 
    "address": "beijing China" 
   },
  { 
    "id" : 3, 
    "firstname" : "Rossen", 
    "lastname" : "Stoyanchev" , 
    "email": "stoyanchev@163.com", 
    "address": "beijing China" 
  }
]

其實要想實現對屬性的排除過濾，Jackson還有一種更簡單的方法：@JsonFilter。 官方文檔地址：http://wiki.fasterxml.com/JacksonFeatureJsonFilter Java及開源