JsonView注解控制结果显示内容

小鱼儿 2021-06-11 15:14 330阅读 0赞

## 代码结构 ##

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTUxNTMxMjgzMg_size_16_color_FFFFFF_t_70][]

## User类 ##

public class User { 
    
        public interface UserSimpleView { };
    
        public interface UserDetailView extends UserSimpleView { };
    
        private String username;
    
        private String password;
    
        @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;
        }
    }

## UserQueryCondition类 ##

public class UserQueryCondition { 
    
        private String username;
    
        private int age;
    
        private int ageTo;
    
        private String xxx;
    
        public String getUsername() { 
            return username;
        }
    
        public void setUsername(String username) { 
            this.username = username;
        }
    
        public int getAge() { 
            return age;
        }
    
        public void setAge(int age) { 
            this.age = age;
        }
    
        public int getAgeTo() { 
            return ageTo;
        }
    
        public void setAgeTo(int ageTo) { 
            this.ageTo = ageTo;
        }
    
        public String getXxx() { 
            return xxx;
        }
    
        public void setXxx(String xxx) { 
            this.xxx = xxx;
        }
    }

UserController类

@RestController
    public class UserController { 
    
        @RequestMapping(value = "/user", method = RequestMethod.GET)
        @JsonView(User.UserSimpleView.class)
        public List<User> query(UserQueryCondition condition, @PageableDefault(page = 2, size = 17, sort = "username,asc") Pageable pageable) { 
            System.out.println(ReflectionToStringBuilder.toString(condition, ToStringStyle.MULTI_LINE_STYLE));
            System.out.println(pageable.getPageSize());
            System.out.println(pageable.getPageNumber());
            System.out.println(pageable.getSort());
            List list = new ArrayList();
            list.add(new User());
            list.add(new User());
            list.add(new User());
            return list;
        }
    
        @RequestMapping(value = "/user/{id:\\d+}",method = RequestMethod.GET)
        @JsonView(User.UserDetailView.class)
        public User getInfo(@PathVariable String id){  // 指定了name可以和里面不一样，没有指定一定要一样
            User user = new User();
            user.setUsername("tom");
            return user;
        }
        
    }

## UserControllerTest ##

@RunWith(SpringRunner.class)
    @SpringBootTest
    public class UserControllerTest { 
    
        @Autowired
        private WebApplicationContext wac;
    
        private MockMvc mockMvc;
    
        @Before
        public void setup() { 
            mockMvc = MockMvcBuilders.webAppContextSetup(wac).build();
        }
    
        @Test
        public void whenQuerySuccess() throws Exception { 
            String result = mockMvc.perform(MockMvcRequestBuilders.get("/user") // 发送一个模拟的get请求
                    .param("username", "pojo") // 设置参数
                    .param("age", "18")
                    .param("ageTo", "60")
                    .param("xxx", "yyy")
    // .param("size", "15")
    // .param("page", "3")
    // .param("sort", "age,desc")
                    .contentType(MediaType.APPLICATION_JSON_UTF8)) // 设置编码格式
                    .andExpect(MockMvcResultMatchers.status().isOk()) // 确定请求是成功的
                    .andExpect(MockMvcResultMatchers.jsonPath("$.length()").value(3))// 设置返回的是集合，长度为3
                    .andReturn().getResponse().getContentAsString();
            System.out.println(result);
        }
    
    
        @Test
        public void whenGenInfoSuccess() throws Exception { 
            String result = mockMvc.perform(MockMvcRequestBuilders.get("/user/1")
                    .contentType(MediaType.APPLICATION_JSON_UTF8))
                    .andExpect(MockMvcResultMatchers.status().isOk())
                    .andExpect(MockMvcResultMatchers.jsonPath("$.username").value("tom")).andReturn().getResponse().getContentAsString();
            System.out.println(result);
    
        }
    
    }

## 测试类运行结果 ##

whenQuerySuccess()的运行结果：\[\{“username”:null\},\{“username”:null\},\{“username”:null\}\]  
whenGenInfoSuccess()的运行结果：\{“username”:“tom”,“password”:null\}

JsonView注解的作用就是根据不同的需求，控制显示不同的结果。

[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3FxMTUxNTMxMjgzMg_size_16_color_FFFFFF_t_70]: /images/20210529/795c5d5de4ee43d2a8cba06326c0da65.png