rest

REST【重点】

1 开发风格

是一种开发风格，遵从此风格开发软件，是restful的。

• 每个资源都有自己的标识

  http://localhost:8989/xxx/users

  http://localhost:8989/xxx/users/1

  http://localhost:8989/xxx/users/1/orders

• 每个请求都有明确的动词 ( GET, POST, PUT, DELETE )

  GET ：http://localhost:8989/xxx/users 查询所有用户

  POST：http://localhost:8989/xxx/users 增加一个用户

  PUT ：http://localhost:8989/xxx/users/1 修改用户1

  DELETE ：http://localhost:8989/xxx/users/1 删除用户1

  GET：http://localhost:8989/xxx/users/1/orders 查询用户1的订单

  POST：http://localhost:8989/xxx/users/1/orders 为用户1增加一个订单

2 优点

• 看Url就知道要什么
• 看http method就知道干什么
• 看http status code就知道结果如何

3 使用

3.1 定义Rest风格的 Controller

@RequestMapping(value="/users",method = RequestMethod.GET)

等价

@GetMapping("/users")

@Controller
public class RestController {
    @GetMapping("/users")
    @ResponseBody
    public List<User> queryAllUsers(){
        System.out.println("get");
        List<User> users = ....
        return users;
    }

    @PostMapping("/users")
    public String addUser(User user){
        System.out.println("Post user :"+user);
        return "index";
    }

    @GetMapping("/users/{id}")
    public String queryOneUser(@PathVariable Integer id){//@PathVariable 接收路径中的值
        System.out.println("Get user id:"+id);
        return "index";
    }

    @PutMapping("/users")
    public String updateUser(@RequestBody User user){
        System.out.println("Put user" user:"+user);
        return "index";
    }

    @DeleteMapping("/users/{id}")
    public String deleteOneUser(@PathVariable Integer id){//@PathVariable 接收路径中的值
        System.out.println("delete user id:"+id);
        return "index";
    }

    /**
     *
    @PostMapping("/users/{id}/orders")
    @ResponseBody
    public String addOrderForUser(@PathVariable Integer id,Order order){
        System.out.println("delete user id:"+id);
        return "index";
    }

    @GetMapping("/users/{id}/orders")
    @ResponseBody
    public String queryOrderForUser(@PathVariable Integer id,Order order){
    System.out.println("delete user id:"+id);
    return "index";
    }
    */
}

3.2 测试

//增加-表单
<form method="post" action="${pageContext.request.contextPath}/users">
	<input type="text" name="name"/>
    <input type="text" name="birth"/>
    ....
    <input type="submit" value="提交">
</form>

//更新-表单  (注意此时，会有问题，浏览器默认只支持get/post，其他method会被默认作为get)
<form method="put" action="${pageContext.request.contextPath}/users/${id}">
	<input type="text" name="name"/>
    <input type="text" name="birth"/>
    ....
    <input type="submit" value="提交">
</form>

3.3 解决

<!-- rest过滤器，不支持put、delete的浏览器默认会将他们转为get，所以通过如下过滤器来解决此问题
     可以定义一个method="post"的form，附加一个名为"_method"的请求参数(隐藏域)，即可模拟put，delete 请求方式 
-->
<filter>
    <filter-name>httpMethodFilter</filter-name>
    <filter-class>org.springframework.web.filter.HiddenHttpMethodFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>httpMethodFilter</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>
<!-- CharacterEncodingFilter 要配置在此过滤器之后 -->

<form method="post" action="${pageContext.request.contextPath}/users/${id}">
    <input type="hidden" name="_method" value="put"> <!-- 添加一个名为 “_method”的参数 -->
	<input type="text" name="name"/>
    <input type="text" name="birth"/>
    ....
    <input type="submit" value="提交">
</form>

3.4 JSP对请求方式的支持

应该先到一个get或post请求的c，这样可以避免jsp错误

JSP只支持了 head,get,post

put,delete,post 之后 均应该 重定向到 get上，再由get转发jsp

3.5 Ajax请求

@RequestMapping(value="/users",method = RequestMethod.PUT)
@ResponseBody
public MyRequestStatus updateUser(@RequestBody User user) {
    System.out.println("update One");
    MyRequestStatus status = new MyRequestStatus("update", "ok");
    return status;
}

@RequestMapping(value="/users/{id}",method = RequestMethod.DELETE)
@ResponseBody
public MyRequestStatus deleteOneUser(Integer id){
    System.out.println("delete One");
    MyRequestStatus status = new MyRequestStatus("delete", "ok");
    return status;
}

<script>
    function putUser(){
        var xhr = new XMLHttpRequest();
    	//定义 put，delete,get,post方式 即可，不用定义_method
        xhr.open("put","${pageContext.request.contextPath}/rest04/users");
    	// 设置请求头
        xhr.setRequestHeader("content-type","application/json")；
        // 设置请求参数
        xhr.send('{"nick":"zhj","username":"zzzz"}');
        xhr.onreadystatechange=function(){
            if(xhr.readyState==4 && xhr.status==200){
                var ret = xhr.responseText;
                // 解析json，并输出
                console.log(eval("("+ret+")"));
            }
        }
    }

	function delUser(){
        var xhr = new XMLHttpRequest();
        //定义 put，delete,get,post方式 即可，不用定义_method
        xhr.open("delete","${pageContext.request.contextPath}/rest04/users/1");
        xhr.send();
        xhr.onreadystatechange=function(){
            if(xhr.readyState==4 && xhr.status==200){
                var ret = xhr.responseText;
                console.log(eval("("+ret+")"));
            }
        }
    }
</script>