004 使用SpringMVC开发restful API二--编写用户详情

一：编写用户详情服务

1.任务

　　@PathVariable隐射url片段到java方法的参数

　　在url声明中使用正则表达式

　　@JsonView控制json输出内容

二：@PathVariable

1.@PathVariable小测试

　　测试类

@Test
    public void whenGetInfoSuccess() throws Exception {
        //发送请求
        mockMvc.perform(MockMvcRequestBuilders.get("/user/1")
                .contentType(MediaType.APPLICATION_JSON_UTF8))
            .andExpect(MockMvcResultMatchers.status().isOk())
            .andExpect(MockMvcResultMatchers.jsonPath("$.username").value("tom"));
    }

　　控制类

@RequestMapping(value="/user/{id}",method=RequestMethod.GET)
    public User getInfo(@PathVariable(value="idid") String idid){
        System.out.println("id="+idid);
        User user=new User();
        user.setUsername("tom");
        return user;
    }

2.效果

　　

三：url声明中的正则表达式

1.测试

　　测试类

/**
     * 测试url声明的正则表达式
     * @throws Exception
     */
    @Test
    public void whenGetInfoFail() throws Exception {
        //发送请求
        mockMvc.perform(MockMvcRequestBuilders.get("/user/aa")
                .contentType(MediaType.APPLICATION_JSON_UTF8))
            .andExpect(MockMvcResultMatchers.status().is4xxClientError());
    }

　　控制类

　　　　只许传递的id为数字。

@RequestMapping(value="/user/{id:\d+}",method=RequestMethod.GET)
    public User getInfo(@PathVariable(value="idid") String idid){
        System.out.println("id="+idid);
        User user=new User();
        user.setUsername("tom");
        return user;
    }

四：@JsonView

1.说明

　　以过滤序列化对象的字段属性，可以使你有选择的序列化对象

2.使用步骤

　　使用接口来声明多个视图

　　在值对象的get方法上指定视图

　　在controller方法上指定视图

3.按照步骤实现一个场景

　　

4.程序

　　完成前两步

package com.cao.dto;

import com.fasterxml.jackson.annotation.JsonView;

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;
    }
    
}

　　完成第三步

package com.cao.web.controller;

import static org.mockito.Matchers.contains;

import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang.builder.ReflectionToStringBuilder;
import org.apache.commons.lang.builder.ToStringStyle;
import org.springframework.data.domain.Pageable;
import org.springframework.data.web.PageableDefault;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.cao.dto.User;
import com.cao.dto.UserQueryCondition;
import com.fasterxml.jackson.annotation.JsonView;

//此controller可以提供restful服务
@RestController
public class UserController {
    @RequestMapping(value="/user",method=RequestMethod.GET)
    @JsonView(User.UserSimpleView.class)
    public List<User> query(UserQueryCondition condition,@PageableDefault(size=13) 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<User> userList=new ArrayList<>();
        userList.add(new User());
        userList.add(new User());
        userList.add(new User());
        return userList;
    }
    
    @RequestMapping(value="/user/{id:\d+}",method=RequestMethod.GET)
    @JsonView(User.UserDetailView.class)
    public User getInfo(@PathVariable(value="id") String idid){
        System.out.println("id="+idid);
        User user=new User();
        user.setUsername("tom");
        return user;
    }

}

　　测试类一：

/*
     * 测试几个常见的声明
     */
    @Test
    public void whenQuerySuccess() throws Exception {
        //发送请求
        String result=mockMvc.perform(MockMvcRequestBuilders.get("/user")
                .param("username", "Job")
                .param("age", "18")
                .param("xxx", "XXX")
                //分页,查第三页，每页15条，按照age降序
//                    .param("page", "3")
//                    .param("size", "15")
//                    .param("sort", "age,desc")
                //
                .contentType(MediaType.APPLICATION_JSON_UTF8))
            .andExpect(MockMvcResultMatchers.status().isOk())
            .andExpect(MockMvcResultMatchers.jsonPath("$.length()").value(3))
            .andReturn().getResponse().getContentAsString();
        System.out.println("result="+result);
    }

　　效果

　　

　　测试类二

/**
     * 测试pathVariable
     * @throws Exception
     */
    @Test
    public void whenGetInfoSuccess() 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="+result);
    }

　　效果

　　

五：重构代码

1.重构服务

　　@RequestMapping("/user")

　　@GetMapping

package com.cao.web.controller;

import static org.mockito.Matchers.contains;

import java.util.ArrayList;
import java.util.List;

import org.apache.commons.lang.builder.ReflectionToStringBuilder;
import org.apache.commons.lang.builder.ToStringStyle;
import org.springframework.data.domain.Pageable;
import org.springframework.data.web.PageableDefault;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import com.cao.dto.User;
import com.cao.dto.UserQueryCondition;
import com.fasterxml.jackson.annotation.JsonView;

//此controller可以提供restful服务
@RestController
@RequestMapping("/user")
public class UserController {
//    @RequestMapping(value="/user",method=RequestMethod.GET)
    @JsonView(User.UserSimpleView.class)
    @GetMapping
    public List<User> query(UserQueryCondition condition,@PageableDefault(size=13) 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<User> userList=new ArrayList<>();
        userList.add(new User());
        userList.add(new User());
        userList.add(new User());
        return userList;
    }
    
//    @RequestMapping(value="/user/{id:\d+}",method=RequestMethod.GET)
    @JsonView(User.UserDetailView.class)
    @GetMapping(value="/{id:\d+}")
    public User getInfo(@PathVariable(value="id") String idid){
        System.out.println("id="+idid);
        User user=new User();
        user.setUsername("tom");
        return user;
    }

}

2.重新跑测试类

　　这里主要是验证重构代码后的正确性。