REST风格

最新推荐文章于 2022-03-08 15:19:36 发布

松鼠MaSaKi

最新推荐文章于 2022-03-08 15:19:36 发布

阅读量198

点赞数

分类专栏： Spring Ecosystem 文章标签： Rest风格

本文链接：https://blog.csdn.net/qq_45337431/article/details/102408394

版权

Spring Ecosystem 专栏收录该内容

34 篇文章 0 订阅

订阅专栏

1.REST

1.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增加一个订单

1.2 优点

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

1.3 使用

在这里插入图片描述

1.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";
    }
}

1.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>

1.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>

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

1.3.4 JSP对请求方式的支持

JSP只支持了 head,get,post

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

1.3.5 Ajax请求，不存在以上问题

@Controller
@RequestMapping("/user")
public class UserController {
    @Resource
    private UserService userService;

    @GetMapping("/userlist")
    @ResponseBody
    public List<User> querryAll() {
        List<User> users = userService.querryAll();
        System.out.println(users.size());
        for (User user : users) {
            System.out.println(user.toString());
        }
        return users;
    }

    @GetMapping("/userlist/{id}") //外部请求方式${pageContext.request.contextPath}/user/userlist/2
    @ResponseBody
    public User querryByid(@PathVariable Integer id) {
        User user = userService.querryById(id);
        System.out.println(user.toString());
        return user;
    }
}

   $(function () {
        $.ajax({
            url:"${pageContext.request.contextPath}/user/userlist/2",
            type:"get",
            dataType:"json",
            success:function (data) {
                $("#tds").append(
                    "<tr>" +
                    "<td>"+data.name+"</td>" +
                    "<td>"+data.birthday+"</td>" +
                    "<td>"+data.gender+"</td>" +
                    "<td>"+data.address+"</td>" +
                    "<td>"+data.money+"</td>" +
                    "</tr>"
                );
            }
        });
    });
<!--rest风格与表单、jsp不兼容，动词中的put和delete导致错误405-->

2.REST应用场景分析

2.1 最佳应用场景

Rest最佳实践，Json作为通信载体

2.2 Rest的三种经典应用场景

2.2.1 发送Post请求，中途转为Put Delete

浏览器本身只支持 get 和 post 请求，作为客户端，使用Rest时，如果需要发送 put 和 delete 请求，则：

就是前面【1.3.3 解决办法】

2.2.2 直接发送Put Delete请求

如果直接发送，则必须使用功能【ajax请求】，但是tomcat不处理put请求的请求体，其中参数不接收。

var xhr = new XMLHttpRequest(); 
xhr.open("put","${pageContext.request.contextPath}/rest04/users");//ajax发送正常的put请求
xhr.setRequestHeader("content-type","application/x-www-form-urlencoded");
xhr.send("id=1&name=zhj&gender=true&birth=2019-12-12");//携带参数

// 定义Handler，此时无法接收到请求参数！！！！！
@RequestMapping(value="/users",method = RequestMethod.PUT)
@ResponseBody
public MyRequestStatus updateUser(User user) {//此时无法接收到请求参数！！！！
    System.out.println("update One user2:"+user);
    MyRequestStatus status = new MyRequestStatus("update", "ok");
    return status;
}

解决方案：

<!-- 解决方案：
     如果Put请求中的 ”id=1&name=zhj&...“ 含有如此参数，则可以配置如下过滤器
     其作用：如果发现当前请求是Put请求，会将请求体中的请求参数获取出来，供后续使用。
     【与前面的表单解决方法的过滤器二选一】
-->
<filter>
    <filter-name>put</filter-name>
    <filter-class>org.springframework.web.filter.HttpPutFormContentFilter</filter-class>
</filter>
<filter-mapping>
    <filter-name>put</filter-name>
    <url-pattern>/*</url-pattern>
</filter-mapping>

2.2.3 直接发送Put请求,但携带Json格式数据参数，最理想的情景

var xhr = new XMLHttpRequest(); 
xhr.open("put","${pageContext.request.contextPath}/rest04/users");//ajax发送正常的put请求
xhr.setRequestHeader("content-type","application/json");
xhr.send('{"id":1,"name":"zhj","gender":true,"birth":"2019/12/12"}');//携带Json数据参数

public class User {
    private Integer id;
    private String name;
    private Boolean gender;
    @JsonFormat(pattern = "yyyy/MM/dd")
    private Date birth;
}

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

2.3 Rest的使用模版规范

@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";
    }
	
	//更新用户
    @PutMapping("/users")
    public String updateUser(@RequestBody User user){
        System.out.println("Put user" user:"+user);
        return "index";
    }
    
    // 查询id为x的用户
    @GetMapping("/users/{id}")
    public String queryOneUser(@PathVariable Integer id){//@PathVariable 接收路径中的值
        System.out.println("Get user id:"+id);
        return "index";
    }
    
    //删除用户
    @DeleteMapping("/users/{id}")
    public String deleteOneUser(@PathVariable Integer id){//@PathVariable 接收路径中的值
        System.out.println("delete user id:"+id);
        return "index";
    }

    // 查询分页用户
    @GetMapping("/users/{pageNum}/{pageSize}")
    @ResponseBody
    public List<User> queryAllUsers(@PathVariable Integer pageNum,@PathVariable Integer PageSize){
        System.out.println("get");
        List<User> users = ....
        return users;
    }
}

松鼠MaSaKi

关注

0
点赞
踩
2

收藏

觉得还不错? 一键收藏
0
评论
REST风格

1.REST1.1 开发风格是一种开发风格，遵从此风格开发软件，是restful的。每个资源都有自己的标识http://localhost:8989/xxx/usershttp://localhost:8989/xxx/users/1http://localhost:8989/xxx/users/1/orders每个请求都有明确的动词 ( GET, POST, PUT,...
复制链接

扫一扫

专栏目录