@JsonView使用

Posted 2023-02-05 马伟奇

在实际生产项目中，在某一些请求返回的JSON中，我们并不希望返回某些字段。而在另一些请求中需要返回某些字段。直白点，根据不同的需求返回不同的json数据

例如：

• 在查询列表请求中，不返回password字段
• 在获取用户详情中，返回password字段

用户类

public class User 


    //  @JsonView的使用步骤
   //  1.使用接口来声明多个视图
  //   2.在值对象的get方法或属性上指定视图
  //   3.在Controller的方法上指定视图
    public interface UserSimpleView  

    public interface UserDetailView extends UserSimpleView  

    private String username;
    private String password;

    public User(String username, String password) 
        this.username = username;
        this.password = password;
    

    public User() 
    

    @JsonView(UserSimpleView.class)
    public String getUsername() 
        return username;
    

    public void setUsername(String username) 
        this.username = username;
    
    @JsonView(UserDetailView.class)
    public String getPassword() 
        return password;
    

    public void setPassword(String password) 
        this.password = password;
    


    @Override
    public String toString() 
        return "User" +
                ", username='" + username + '\\'' +
                ", password='" + password + '\\'' +
                '';
    

上面定义了两个视图接口 UserSimpleView 和 UserDetailView, 其中UserDetailView继承UserSimpleView，UserDetailView拥有视图UserSimpleView的属性；在相应的get方法或属性上声明JsonView；

（2）Controller的定义 – UserController

@RestController
public class UserController 

    @GetMapping(value = "/id")
    @JsonView(User.UserDetailView.class)
    public User getInfo(@PathVariable String id) 

        User user = new User();
        user.setUsername("tom");
        user.setPassword("123");
        return user;
    

    @GetMapping("/user")
    @JsonView(User.UserSimpleView.class)
    public List<User> query() 
        List<User> userList = new ArrayList<>();
        userList.add(new User("张三","111"));
        userList.add(new User("李四","222"));
        userList.add(new User("王五","333"));
        return userList;
    

测试结果
（1）返回结果所有字段都有；
发送请求： localhost:8082/1
返回数据：

  "username": "tom",
  "password": "123"

（2）返回结果只有username字段；
发送请求：localhost:8082/user
返回数据：

[
  
    "username": "张三"
  ,
  
    "username": "李四"
  ,
  
    "username": "王五"
  
]