RESTful 风格详解

2023-11-05

一. 什么是Restful风格

1.1 概念

RESTFUL是一种网络应用程序的设计风格和开发方式，基于HTTP，可以使用 XML 格式定义或 JSON 格式定义。最常用的数据格式是JSON。由于JSON能直接被JavaScript读取，所以，使用JSON格式的REST风格的API具有简单、易读、易用的特点。

1.是一种风格，不是协议规定，这种风格更简介美观
2.基于HTTP，可以使用 XML 格式定义或 JSON 格式定义，前后端分离时代都用json传递数据了

1.2 REST 是面向资源的

每个资源都有一个唯一的资源定位符（URI）。每个URI代表一种资源（resource），所以URI中不能有动词，只能有名词，而且所用的名词往往与数据库的表名对应。

1.面向资源去获取json数据，那怎么面向资源？
2.通过url地址去获得资源，怎么通过url地址去获得资源
3.在url地址后面加参数，注意的是：在url后加的只能是名词，即是写死的值，（类似于session传参的一种，往url地址后写入值，但是两者大有不同，以下区分）
4.url后加入的名词往往与数据库的表名对应，
5.大多数时候，我们对数据库进行操作拿到的值都是很多个，都会选择通过list集合把这很多个值装起来），所以URI中的名词也应该使用复数

1.3请求方式

常用	-
请求方式	含义
get	查询
post	增改
delete	删除

不常用	-
请求方式	含义
put	在服务器更新资源（更新完整资源）
update	在服务器更新资源， PATCH更新个别属性

1.4 传统模式URl 和Restful风格对比

1.4.1查询

查询	传统	REST	REST 后台接收
查询所有	http://localhost:8080/employee/	http://localhost:8080/employees	@RequestMapping(value = “/employees”, method = RequestMethod.GET)
查询单个	http://localhost:8080/employee/list?id=1	http://localhost:8080/employees/1	@RequestMapping(value = “/employees/{id}”, method = RequestMethod.GET) @ResponseBody public Employee queryById(@PathVariable Long id) {}

1.4.2添加

添加	传统	REST	REST 后台接收
添加	http://localhost:8080/employee/add	http://localhost:8080/employees	@RequestMapping(value = “/employees”, method = RequestMethod.POST) public Employee add(@ModelAttribute(“emp”) Employee employee) {}

1.4.3 修改

修改	传统	REST	REST 后台接收
添加	http://localhost:8080/employee/update	http://localhost:8080/employees	@RequestMapping(value = “/employees”, method = RequestMethod.PUT) public Employee update(@ModelAttribute(“emp”) Employee employee) {}

1.4.4 删除

删除	传统	REST	REST 后台接收
删除	http://localhost:8080/employee/delete	http://localhost:8080/employees	@RequestMapping(value = “/employees/{id}”, method = RequestMethod.DELETE) @ResponseBody public JsonResult delete(@PathVariable Long id) {}

以上来自Yan Yang 大佬的详解，本段拷自这篇文章

注意：

1.当需要返回的参数非单个的时候，不要使用参数路径方式
2.当参数名敏感的时候，建议使用参数路径的方式，可以隐藏参数名

二. Restful风格的规范

所遵循的原则：来自百度百科
1、每一个URI代表1种资源；
2、客户端使用GET、POST、PUT、DELETE4个表示操作方式的动词对服务端资源进行操作：GET用来获取资源，POST用来新建资源（也可以用于更新资源），PUT用来更新资源，DELETE用来删除资源；
3、通过操作资源的表现形式来操作资源；
4、资源的表现形式是XML或者HTML；
5、客户端与服务端之间的交互在请求之间是无状态的，从客户端到服务端的每个请求都必须包含理解请求所必需的信息。 [1]

三.Restful 风格相关的注解

注解	作用
@RestController	由 @Controller + @ResponseBody组成（返回 JSON 数据格式）
@PathVariable	URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到控制器处理方法的形参中
@RequestMapping	注解用于请求地址的解析，是最常用的一种注解
@GetMapping	查询请求
@PostMapping	添加请求
@DeleteMapping	删除请求
@RequestParam	将请求参数绑定到你控制器的方法参数上（是springmvc中接收普通参数的注解）

3.1 @RequestParam 使用注意

语法

语法：@RequestParam(value=”参数名”,required=”true/false”,defaultValue=””)
 
value：参数名
 
required：是否包含该参数，默认为true，表示该请求路径中必须包含该参数，如果不包含就报错。
 
defaultValue：默认参数值，如果设置了该值，required=true将失效，自动为false,如果没有传该参数，就使用默认值

@RequestParam 的正确使用–绑定对象

这里写的是一个增加的接口，需要注意的是，我们这@RequestParam 这个注解最好是用来绑定对象到我们的控制器的方法参数上。且只能绑定一个参数，所以当我们用此注解来传递json数据的时候，最好把所有的数据封装到一个包装类中。

1.绑定一个参数
2.只能用来传递对象
3.不能传一个对象一个参数值，一个绑定一个不绑定


    @PostMapping("/insert")
    public ResponseCode addEmployeeec(@PathVariable Employeeec employeeec){
        int counts = employeeecService.addEmployeeec(employeeec);
        if (counts == 1) {
            return ResponseCode.ok("插入成功");
        }else  if (counts == -1){
            return  ResponseCode.error("用户存在，插入失败");
        }
        return ResponseCode.error("用户插入失败");
    }

在这里插入图片描述
500错误

1.服务器的错误
2.一般来说代码写错了
3.或者像这种请求方式有问题的

换成

	    @PostMapping("/insert")
    public ResponseCode addEmployeeec(@RequestBody Employeeec employeeec){
        int counts = employeeecService.addEmployeeec(employeeec);
        if (counts == 1) {
            return ResponseCode.ok("插入成功");
        }else  if (counts == -1){
            return  ResponseCode.error("用户存在，插入失败");
        }
        return ResponseCode.error("用户插入失败");
    }

在这里插入图片描述
说明当传递的json为一个对象的时候，我们要用@RequestParam

@RequestParam 的错误使用1：绑定一个参数

//测试用
 @DeleteMapping("/delete/{id}")
    public ResponseCode deleteEmployeeec(@RequestBody Integer id){
        int count = employeeecService.deleteEmployeeec(id);
        if (count ==1 ){
            return  ResponseCode.ok("删除成功");
        }else  if (count ==-1) {
            return  ResponseCode.error("用户不存在，删除失败");
        }
        return ResponseCode.error("用户删除失败");
    }

在这里插入图片描述
400错误 Http错误

1.400错误的要求
2. 由于语法格式错误，服务器无法理解该请求
3.无效的URL
4.浏览器发送了此服务器无法理解的请求

但是换成

@DeleteMapping("/delete/{id}")
    public ResponseCode deleteEmployeeec(@PathVariable Integer id){
        int count = employeeecService.deleteEmployeeec(id);
        if (count ==1 ){
            return  ResponseCode.ok("删除成功");
        }else  if (count ==-1) {
            return  ResponseCode.error("用户不存在，删除失败");
        }
        return ResponseCode.error("用户删除失败");
    }

在这里插入图片描述
400错误 Http错误

1.400错误的要求
2. 由于语法格式错误，服务器无法理解该请求
3.无效的URL
4.浏览器发送了此服务器无法理解的请求

@RequestParam 的错误使用2：绑定两个参数

这里是一个分页查询，我们用它绑定两个参数试一试

    @GetMapping("/{page}/{size}")
    public List<Employeeec> getAllEmployeeec(@RequestBody Integer page ,@RequestBody Integer size){
        return  employeeecService.getAllEmployeec(page,size);
    }

在这里插入图片描述
400错误 Http错误

1.400错误的要求
2. 由于语法格式错误，服务器无法理解该请求
3.无效的URL
4.浏览器发送了此服务器无法理解的请求

  @GetMapping("/{page}/{size}")
    public List<Employeeec> getAllEmployeeec(@PathVariable Integer page ,@PathVariable Integer size){
        return  employeeecService.getAllEmployeec(page,size);
    }

在这里插入图片描述

@RequsetParam 的错误使用3：绑定一个对象，一个参数，这种情况兄弟们用包装类装起来哇，看着就就觉得有问题。。

3.2@PathVariable使用规范–一定是绑定参数而非对象

本文内容由网友自发贡献，版权归原作者所有，本站不承担相应法律责任。如您发现有涉嫌抄袭侵权的内容，请联系:hwhale#tublm.com(使用前将#替换为@)