Spring MVC开发restful API之用户查询请求

一，什么是restful风格？

首先，我们来看几组例子。

传统的url:
查询 /user/query?name=tom GET
详情 /user/query?id=1 GET
创建 /user/create?name=tom POST
修改 /user/update?id=1&name=jerry POST
删除 /user/delete?id=1 GET

restful风格的url：
查询 /user?name=tom GET
详情 /user/1 GET
创建 /user POST
修改 /user/1 PUT
删除 /user/1 DELETE

经过上面的几组对比，我们可以得出结论：

1. 传统的URL是通过链接表示行为，而restful风格是用URL描述资源
2. 使用HTTP方法描述行为，使用HTTP状态码表示不同的结果。在传统的请求方式上，我们一般会采用POST和GET方法来发送请求，而在restful风格中它使用GET表示查询请求，POST表示增加的请求，PUT表示修改的请求，DELETE表示删除的请求。在传统的请求中，无论你请求的成功与否，它都会给你返回一大串的json格式的数据来描述请求的结果，但是在restful风格中，它对不同的结果都有不同的状态码来描述不同的结果。
3. 使用json格式的数据来交互。在传统的URL中，我们常常会将有些信息通过链接的形式发送给服务器，但是在restful风格中这些传递给服务器或者传给前台的数据都会使用json格式的数据来传递。
4. 最后一点，要强调的是，restful是中风格，并不是强制要求的规范。

二，使用Sring MVC的restful风格开发用户请求的案例

接下来，让我们用实例来体验一下restful风格。
首先，我们创建maven项目。
在src/main/java包下创建一个包，然后在这个包下床架一个controller类

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.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.RestController;

import cn.shinelon.vo.User;
import cn.shinelon.vo.UserQueryCondition;

/**
 * @author Shinelon
 *
 */

@RestController
public class UserController {

    @RequestMapping(value="/user",method=RequestMethod.GET)
    //required表示是否是必须要填的，false表示不需要，然后defaultValue表示默认值
//  public List query(@RequestParam(required=false,defaultValue="jerrty") String username){
    //当前台需要传来多个值的时候，可以把参数封装到一个对象中

    //pageable表示分页的信息，同样的，如果前台没有传来数据，也可以给分页信息来设置默认值
    public List query(UserQueryCondition condition,@PageableDefault(size=15,page=3,sort="username，asc") Pageable pageable){

        System.out.println(pageable.getPageSize());
        System.out.println(pageable.getPageNumber());
        System.out.println(pageable.getSort());
    //使用反射来输出查询的参数
    System.out.println(ReflectionToStringBuilder.toString(condition,ToStringStyle.MULTI_LINE_STYLE));

        List list=new ArrayList();
        list.add(new User());
        list.add(new User());
        list.add(new User());
        return list;
    }
}

先介绍一下上面的代码的含义，我们使用@RestController注解来声明这个类是使用了restful风格的controller控制层，@RequestMapping这个注解相信大家都不陌生吧，它的第一个属性表示你的请求路径，第二个是你的请求的方法，如果在一个方法前面加入这个注解，我们就可以通过这个注解上表示的URL来请求到这个方法的操作以及返回结果。

    //required表示是否是必须要填的，false表示不需要，然后defaultValue表示默认值
//  public List<User> query(@RequestParam(required=false,defaultValue="jerrty") String username){

在这段代码中，我们可以使用@RequestParam注解来显示的指明传递的参数，required表示是否是必须要填的，false表示不需要，然后defaultValue表示默认值，表示如果前台没有传递这个参数，就使用这个默认值。当然，如果你前台传递的参数和你的方法参数一样的话就不用指明这个注释了，它会自动的给这个方法传递参数，这也体现了spring的强大之处。

//当前台需要传来多个值的时候，可以把参数封装到一个对象中

    //pageable表示分页的信息，同样的，如果前台没有传来数据，也可以给分页信息来设置默认值
    public List query(UserQueryCondition condition,@PageableDefault(size=15,page=3,sort="username，asc") Pageable pageable){

在看上面这段代码，如果前台传递来几个参数，那很好办，我们只要给这个方法多几个形参就可以，但是如果前台传递来大量的信息，我们还会创建那么多的参数吗？那样恐怕会使你的代码特别难看吧。这时，我们可以将多个参数封装到一个对象中，而在这个方法中传递这个对象的一个引用，如上面的代码我们将查询的请求全部封装到了一个UserQueryCondition 的类中。这样就化简了代码，也让更加有了层次性。
我们在src/main/java路径下创建一个VO层，然后创建UserQueryCondition 类如下：

public class UserQueryCondition {
    public String username;
    public String sex;
    public int age;
    public String address;
    //省略set，get方法
}

在VO层，另一个Javabean是USER类，代码如下：

public class User {
    public String username;
    public String password;
    //省略set,get方法
}

我们接着上面的讲解，Pageable这个类可以传递分页的信息，比如每页的信息数量，页数等等信息，@PageableDefault(size=15,page=3,sort=”username，asc”) 这个参数表示分页信息的默认值，如果我们不传递分页的信息，那么它将默认每页的大小size为15，页数page为第三页，分类的方式是使用username，采用asc升序的方式排列。

解释完上面的代码我们就可以开始测试，相信大家都知道，后台开发就头疼的就是测试，你每次测试都要启动服务器，这样很浪费时间，不过在这里我们可以采用spring提供的测试的平台，我们就可以不用每次去启动服务器了，哈哈哈，体会到了spring的强大之处了吧。话不多说，先看代码。

import static org.springframework.test.web.servlet.request.MockMvcRequestBuilders.get;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.jsonPath;
import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.status;

import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.http.MediaType;
import org.springframework.test.context.junit4.SpringRunner;
import org.springframework.test.web.servlet.MockMvc;
import org.springframework.test.web.servlet.request.MockMvcRequestBuilders;
import org.springframework.test.web.servlet.result.MockMvcResultMatchers;
import org.springframework.test.web.servlet.setup.MockMvcBuilders;
import org.springframework.web.context.WebApplicationContext;
/**
 * @author Shinelon
 *
 */
@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 {
//      mockMvc.perform(MockMvcRequestBuilders.get("/user")
//      .contentType(MediaType.APPLICATION_JSON_UTF8))
//      .andExpect(MockMvcResultMatchers.status().isOk())
//      .andExpect(MockMvcResultMatchers.jsonPath("$.length()").value(3));

        //在STS里的偏好设置中设置了这几个类，所以可以自动引入其静态方法
        mockMvc.perform(get("/user")
//              .param("username", "shinelon")
                .param("username", "shinelon")
                .param("sex", "male")
                .param("age", "18")
                .param("address", "北京市")
                .param("size", "15")    //分页的信息
                .param("page", "3")
                .param("sort", "age,desc")      //按照年龄升序排列
                .contentType(MediaType.APPLICATION_JSON_UTF8))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.length()").value(3));
    }
}

在这里，我们使用springboot，@SpringBootTest注解声明下面这个类为springboot的测试类，我们可以去src/test/java这个路径下去创建这个类，@Before这个注解是前置声明，表示每次测试之前都会先执行这段代码，在这里，我们创建了mockMvc这个来，这是spring提供的一种测试类，读者可以去查查其API，这里不做详细介绍了。

//      mockMvc.perform(MockMvcRequestBuilders.get("/user")
//      .contentType(MediaType.APPLICATION_JSON_UTF8))
//      .andExpect(MockMvcResultMatchers.status().isOk())
//      .andExpect(MockMvcResultMatchers.jsonPath("$.length()").value(3));

这里，介绍一下这段注释掉的代码，和下面的那段代码作用相同，不过下面的代码更加简洁，我们可以在eclipse中的偏好设置favorite中设置MockMvcRequestBuilders，MockMvcResultMatchers这两个类型的设置，这样就可以化简代码，eclipse将会自动加入其静态方法，这里读者可能看不出来是什么意思，自己试一下就会感受到了，不会的可以留言哈。

mockMvc.perform(get("/user")
//              .param("username", "shinelon")
                .param("username", "shinelon")
                .param("sex", "male")
                .param("age", "18")
                .param("address", "北京市")
                .param("size", "15")    //分页的信息
                .param("page", "3")
                .param("sort", "age,desc")      //按照年龄升序排列
                .contentType(MediaType.APPLICATION_JSON_UTF8))
                .andExpect(status().isOk())
                .andExpect(jsonPath("$.length()").value(3));

最后，上面的代码时我们测试的参数，比如username,age,还有分页的信息等等，这类似与我们前台URL或者表单中提交到后台的参数。这里还有一点要介绍的是.andExpect(jsonPath(“$.length()”).value(3))，这段代码表示前台期望返回的是一个json格式的数据其长度为3，这种写法读者可以去github上搜索jsonPath这个关键字，上面有官方的详细介绍文档。

最后我们启动程序，看控制台输出的结果，下面是控制台打印的主要信息。怎么样，是不是感受到了restful的风格，自己动手试试会更加深有体会。

15
3
age: DESC
cn.shinelon.vo.UserQueryCondition@ee96866[
  username=shinelon
  sex=male
  age=18
  address=北京市
]