RESTful

什么是API

API（Application Programming Interface，应用程序接口）是一些预先定义的函数，或指软件系统不同组成部分衔接的约定。 [1] 目的是提供应用程序与开发人员基于某软件或硬件得以访问一组例程的能力，而又无需访问原码，或理解内部工作机制的细节。

研发人员A开发了软件A，研发人员B正在研发软件B。

有一天，研发人员B想要调用软件A的部分功能来用，但是他又不想从头看一遍软件A的源码和功能实现过程，怎么办呢？

研发人员A想了一个好主意：我把软件A里你需要的功能打包好；你把这个包放在软件B里，就能直接用我的方法了！

其中，API就是研发人员A说的那个方法。

Web 发展阶段

Web 开发技术的发展可以粗略划分成以下几个阶段

静态内容阶段：在这个最初的阶段，使用 Web 的主要是一些研究机构。Web 由大量的静态 HTML 文档组成。
CGI 程序阶段：在这个阶段，Web 服务器增加了一些编程 API。通过这些 API 编写的应用程序，可以向客户端提供一些动态变化的内容。。
脚本语言阶段：在这个阶段，服务器端出现了 ASP、PHP、JSP、ColdFusion 等支持 session 的脚本语言技术，浏览器端出现了 Java Applet、JavaScript 等技术。使用这些技术，可以提供更加丰富的动态内容。
瘦客户端应用阶段：在这个阶段，在服务器端出现了独立于 Web 服务器的应用服务器。同时出现了 Web MVC 开发模式，各种 Web MVC 开发框架逐渐流行，并且占据了统治地位。基于这些框架开发的 Web 应用，通常都是瘦客户端应用，因为它们是在服务器端生成全部的动态内容。
RIA 应用阶段：在这个阶段，出现了多种 RIA（Rich Internet Application）技术，大幅改善了 Web 应用的用户体验。应用最为广泛的 RIA 技术是 DHTML+Ajax。Ajax 技术支持在不刷新页面的情况下动态更新页面中的局部内容。同时诞生了大量的 Web 前端 DHTML 开发库，例如 Prototype、Dojo、ExtJS、jQuery/jQuery UI 等等。
移动 Web 应用阶段：在这个阶段，出现了大量面向移动设备的 Web 应用开发技术。除了 Android、iOS、Windows Phone 等操作系统平台原生的开发技术之外，基于 HTML5 的开发技术也变得非常流行。

传统VS前后端分离

传统的开发模式

前端写好静态的html页面交给后端开发，后端把html改成模板，然后使用模板引擎去套模板，比如jsp，freemarker等
后端人员在开发过程中如果发现页面有问题，要返回给前端修改，前端再交给后端，直至功能实现。

问题：前后端严重耦合
1.前端需要改bug调试时，需要在当前电脑安装一整套后端的开发工具，启动后端程序。
2.还要求后端人员会html，js等前端语言。
3.前端页面也会嵌入很多后端的代码
4.一旦后端换了一套语言，前端也需要重新开发
5.沟通成本，调试成本，前后端开发进度相互影响，从而大大降低开发效率

前后端分离

前后端分离并不只是开发模式，也是web应用的一种架构模式。
在开发阶段，前后端人员约定好数据交互接口，即可并行开发与测试。

前端开发完成可以独自进行mock测试，后端也可以使用postman等接口测试工具进行测试。
最后可进行功能联调测试。

优点：
1.前后端责任清晰，后端专注于数据上，前端专注于视觉上。
2.无需等待对方的开发工作结束，提高开发效率。
3.可应对复杂多变的前端需求。
4.增强代码可维护性

RESTful接口设计

存在原因

web2.0阶段的出现，客户端将不仅限于PC浏览器，可能是移动APP，也可能是小程序，这就要求服务端能提供一套统一的API接口，不同类型的客户端基于相同的协议/规则就能来调用该API接口并获取预期的数据。

此时核心：如何设计一套科学的API接口？

不同开发者对API接口的设计习惯不同 , 比如可能会出现这种情况

新增员工:
http://localhost/employee/save
http://localhost/employee/add
http://localhost/employee/new
http://localhost/employee/xinzeng
http://localhost/employee/append
http://localhost/employee?cmd=add

而且发送的请求方式以及响应结果也比较可能随意

答案：具有RESTful 风格的API接口

RESTful风格

REST是一种设计API接口规则(风格)，因其具有简单、易读、易用的特点，在web项目中非常受欢迎。在设计接口时，如果满足rest约束条件和原则的应用程序或设计就称其为RESTful 应用。

约束规则

回一下，传统的web接口(请求映射方法)设计需要考虑几个要点。

以员工列表为例子。

@Controller
public class EmployeeController {
    @RequestMapping("/employee/list")
    public String list(Model model){
        model.addAttribute("list", employeeService.list())
        return "employee/list";
    }
}

传统接口设计

设计传统web接口时考虑：

1>请求路径

一般采用见名知意的方式，比如：/employee/list

2>请求方式

不在意，@RequestMapping注解可以接受任意请求方式，包括:GET POST

3>请求参数

没有固定，根据接口的功能而定，可以说是由需求决定

4>请求响应

没有固定，由需求决定，可以是Json格式也可以页面模板。

RESTful接口设计

以员工列表为例子。

@Controller
public class EmployeeController {
    @RequestMapping(value = "/employees", method = RequestMethod.GET)
	@ResponseBody
    public List<Employee> list(){
        return employeeService.list();
    }
}

1>请求路径

不再是见名知意的方式，而是由操作的资源决定，一般采用资源名称复数形式。

比如接口操作对象(资源)是员工，路径可设计为： /employees

问题来了，何为资源？

一切皆为资源

RESTful眼中，互联网上，一切皆为资源，并且，每个资源都有一个唯一的资源定位符（URI）。

一张图片是一个资源：https://c-ssl.duitang.com/uploads/item/201810/17/20181017111458_dqioq.jpg

一张网页是一个资源：https://www.baidu.com/

一个请求路径是一个资源：http://localhost:8080/employee?id=1

回归到代码，url http://localhost:8080/employee?id=1 表示查询数据库中id=1的员工信息，这个员工信息就是restful中描述的资源，一般资源都不会只有一个，就像员工不仅仅只有id=1的数据，大多都是以复数，所以RESTful 约定：针对接口要操作资源统一使用复数。

@RequestMapping("/employees")
public class EmployeeController{

}

看看下面例子：

http://www.langfeiyes.cn/depts 部门资源

https://api.example.com/v1/zoos：动物园资源
 https://api.example.com/v1/animals：动物资源
 https://api.example.com/v1/employees：饲养员资源

看别人写的restful风格接口
http://docs.jiguang.cn/jmessage/server/rest_api_im/

最后大白话总结：RESTful接口设计-路径一般就是操作实体对象复数

2>请求方式

传统接口设计方式，使用见名知意设计路径，可以从路径上看出接口对资源操作，而RESTful风格接口使用资源复数作为路径，就无法从路径上看出接口对资源操作，那该怎么办？

RESTful风格在HTTP请求方法上做文章，约定：

GET（SELECT）：从服务器取出资源（一项或多项）。
POST（CREATE）：在服务器新建一个资源。
PUT（UPDATE）：在服务器更新资源（客户端提供改变后的完整资源）。PUT更新整个对象
PATCH（UPDATE）：在服务器更新资源（客户端提供改变的属性【补丁】）。 PATCH更新个别属性
DELETE（DELETE）：从服务器删除资源。

//了解

HEAD：获得一个资源的元数据，比如一个资源的hash值或者最后修改日期；
OPTIONS：获得客户端针对一个资源能够实施的操作；(获取该资源的api(能够对资源做什么操作的描述))

传统的路径见名知意 = RESTful 路径 + 请求方式

示例

传统方式：

http://www.langfeiyes.cn/employee/list

http://www.langfeiyes.cn/employee/get?id=1

http://www.langfeiyes.cn/employee/save?name=xx

http://www.langfeiyes.cn/employee/update?id=1&name=xx

http://www.langfeiyes.cn/employee/delete?id=1

RESTful方式：

http://www.langfeiyes.cn/employees
新增：POST
更新：PUT
删除：DELETE
查询：GET

GET /zoos：列出所有动物园
POST /zoos：新建一个动物园
GET /zoos/{id}：获取某个指定动物园的信息
PUT /zoos/{id}：更新某个指定动物园的信息（提供该动物园的全部信息）
PATCH /zoos/{id}：更新某个指定动物园的信息（提供该动物园的部分信息）
DELETE /zoos/{id}：删除某个动物园
GET /zoos/{id}/animals：列出某个指定动物园的所有动物

获取某个部门的所有员工

GET /employee/getByDeptId 以前的 ,比较随意

GET /departments/{id}/employees restful风格

3>请求参数

没有固定，根据接口的功能而定，可以说是由需求决定

4>请求响应

RESTful对响应值，还是做了细致的约定的：

GET /collection：返回资源对象的列表（数组）
GET /collection/resource：返回单个资源对象
POST /collection：返回新生成的资源对象
PUT /collection/resource：返回完整的资源对象
PATCH /collection/resource：返回完整的资源对象
DELETE /collection/resource：返回一个空文档

以上数据返回都使用Json格式。

真实开发，具体响应什么数据，以公司规定/操作需求需要为主。

使用注意

REST只是一种设计风格 , 而不是标准 , 只是提供了一组设计原则和约束条件，具体操作结合公司要求/项目要求。

RESTful框架

常见的有 SpringMVC , jersey , play

API测试工具

Postman, Insomnia

RESTful接口练习

项目准备

1>构建一个标准的Springboot项目，使用web环境

依赖

 <!-- SpringBoot的依赖配置-->
<parent>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-parent</artifactId>
    <version>2.4.3</version>
    <relativePath/>
</parent>

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <version>1.18.20</version>
        <scope>provided</scope>
    </dependency>


</dependencies>

2>配置application.properties

server.port=80

3>编辑实体类，启动类，controller类

@Getter
@Setter
@AllArgsConstructor
@NoArgsConstructor
public class Employee {
    private Long id;
    private String name;
    private int age;
}

@SpringBootApplication
public class App {
    public static void main(String[] args) {
        SpringApplication.run(App.class, args);
    }
}

@Controller
public class EmployeeController {
}

接口设计

1.获取所有的员工

/**
 * 需求： 查询所有员工数据
 * 1>请求路径:  确定资源： /employees
 * 2>请求方式： GET
 * 3>请求参数： 无
 * 4>请求响应：  List<Employee> Json格式
*/
@RequestMapping(value = "/employees", method = RequestMethod.GET)
@ResponseBody
public List<Employee> list(){
    return Arrays.asList(new Employee(1L, "dafei", 18),
                         new Employee(2L, "xiaofei", 17) );
}

测试

URL：http://localhost:80/employees

请求方式：GET

2.添加一个员工

/**
 * 需求： 添加一个员工信息
 * 1>请求路径:  确定资源： /employees
 * 2>请求方式： POST
 * 3>请求参数： 员工相关信息（属性）
 * 4>请求响应：  Employee  Json格式
*/
@RequestMapping(value = "/employees", method = RequestMethod.POST)
@ResponseBody
public Employee add(Employee employee){
    employee.setId(1L);  //假装添加到数据，新增id为1L
    return employee;
}

测试

URL：http://localhost:80/employees

请求方式：POST

参数：name， age

3.更新员工数据

/**
 * 需求： 更新一个员工信息
 * 1>请求路径:  确定资源： /employees
 * 2>请求方式： PUT
 * 3>请求参数： 员工相关信息（属性）
 * 4>请求响应：  Employee  Json格式
*/
@RequestMapping(value = "/employees", method = RequestMethod.PUT)
@ResponseBody
public Employee update(Employee employee){
    employee.setName(employee.getName() + "_update");
    return employee;
}

测试

URL：http://localhost:80/employees

请求方式：PUT

参数：id, name， age

4.删除一个员工

要求，操作成功后返回操作状态提示，需要额外定制状态封装对象(统一返回值)

@Setter
@Getter
public class JsonResult{

    private int code;  //状态码
    private String msg;//提示信息
    private Object data;//结果数据
    public JsonResult(int code, String msg, Object data){
        this.code = code;
        this.msg = msg;
        this.data = data;
    }
    public static JsonResult success(){
        return new JsonResult(200, "操作成功", null);
    }
    public static JsonResult error(String msg){
        return new JsonResult(500, msg, null);
    }
}

/**
 * 需求： 删除一个员工信息
 * 1>请求路径:  确定资源： /employees
 * 2>请求方式： DELETE
 * 3>请求参数： id
 * 4>请求响应： 状态提示(成功/失败)
*/
@RequestMapping(value = "/employees", method = RequestMethod.DELETE)
@ResponseBody
public JsonResult delete(Long id){
    return JsonResult.success();
}

测试

URL：http://localhost:80/employees

请求方式：DELETE

参数：id

5.获取某个员工的信息

/**
 * 需求： 查询指定id的员工数据
 * 1>请求路径:  确定资源： /employees
 * 2>请求方式： GET
 * 3>请求参数： id
 * 4>请求响应：  Employee Json格式
 */
@RequestMapping(value = "/employees", method = RequestMethod.GET)
@ResponseBody
public Employee detail(Long id){
    return new Employee(id, "dafei", 18);
}

项目启动时，直接报错，说mapping映射重复

分析原因

    /**
     *
     * 查询所有员工与查询某个员工， 使用路径： /employees   使用方法： GET  都相同
     * 此时在springmvc语法中，2个请求是不允许共存的。此时怎么办？
     *
     * 方案1：使用多级路径方式区分， 比如： /employees/detail
     * 方案2：参数路径的方式
     * 参数路径：请求映射接口中，将请求参数作为路径的一部分 
     *    比如：/employees/{id}      {id}  路径参数的占位符
     *    注意：客户发起请求时：
               url路径写法： http://localhost:8080/employees/1      其中 1 是路径参数
     *
     * 接口想要获取路径中参数，需要使用：@PathVariable 注解
     *   @PathVariable 作用：将url路径上参数解析并赋值到请求映射方法的形式参数
     *   注意： 如果路径参数的占位符跟请求映射方法的形式参数名不一致，需要使用注解属性明确指定
     *   "/employees/{eid}"    --->   @PathVariable("eid")
     *
     */

方案1：

@RequestMapping(value = "/employees/detail", method = RequestMethod.GET)
@ResponseBody
public Employee detail(Long id){
    return new Employee(id, "dafei", 18);
}

测试

URL：http://localhost:80/employees/detail

请求方式：GET

参数：id

方案2：

@RequestMapping(value = "/employees/{id}", method = RequestMethod.GET)
@ResponseBody
public Employee detail(@PathVariable Long id){
    return new Employee(id, "dafei", 18);
}

测试

URL：http://localhost:80/employees/1

请求方式：DELETE

参数路径拓展

页面请求接口

需求：页面有5个按钮，点击发起异步请求，访问对应restful接口

1>导入jquery.js

2>编写info.html页面

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
    <script src="js/jquery/jquery.min.js"></script>

    <script>
        $(function () {
            $("#btn1").click(function () {
                $.get("/employees/1",function (data) {
                    console.log(data);
                })

            })

            $("#btn2").click(function () {
                $.get("/employees",function (data) {
                    console.log(data);
                })
            })

            $("#btn3").click(function () {

                $.post("/employees", {name:"dafei", age:18}, function (data) {
                    console.log(data);
                })


            })
            $("#btn4").click(function () {

                $.ajax({
                    url:"/employees",
                    type:"PUT",
                    data:{id:1, name:"dafei", age:18},
                    success:function (data) {
                        console.log(data);
                    }
                })

            })
            $("#btn5").click(function () {
                $.ajax({
                    url:"/employees",
                    type:"DELETE",
                    data:{id:1},
                    success:function (data) {
                        console.log(data);
                    }
                })
            })
        })
    </script>
</head>
<body>
<button id="btn1">查单个</button><br>
<button id="btn2">查所有</button><br>
<button id="btn3">添加</button><br>
<button id="btn4">更新</button><br>
<button id="btn5">删除</button><br>
</body>
</html>

3>访问，依次点击按钮

注意

springMVC默认不支持处理put请求，需要配置处理put或patch请求方式的过滤器

<filter>
	<filter-name>httpPutFormContentFilter</filter-name>
	<filter-class>org.springframework.web.filter.HttpPutFormContentFilter</filter-class>
</filter>

<filter-mapping>
	<filter-name>httpPutFormContentFilter</filter-name>
	<servlet-name>springMVC</servlet-name>
</filter-mapping>

RESTful接口简化

@RestController

由 @Controller + @ResponseBody组成，贴在controller类上面

@PathVariable

通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法的入参中

URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的入参中。

贴在请求映射方法参数上

**@GetMapping **
贴在请求映射方法上，等价于：@RequestMapping(method = RequestMethod.GET)

**@PostMapping **

贴在请求映射方法上，等价于：@RequestMapping(method = RequestMethod.POST)

**@PutMapping **

贴在请求映射方法上，等价于：@RequestMapping(method = RequestMethod.PUT)

**@DeleteMapping **

贴在请求映射方法上，等价于：@RequestMapping(method = RequestMethod.DELETE)

@RestController  //等价于：@ResponseBody + @Controller
@RequestMapping("employees")
public class EmployeeController {
    @GetMapping
    public List<Employee> list(){
        return Arrays.asList(new Employee(1L, "dafei", 18),
                new Employee(2L, "xiaofei", 17) );
    }
    @GetMapping("/{id}")
    public Employee detail(@PathVariable Long id){
        return new Employee(id, "dafei", 18);
    }
    @PostMapping
    public Employee add(Employee employee){
        employee.setId(1L);
        return employee;
    }
    @PutMapping
    public Employee update(Employee employee){
        employee.setName(employee.getName() + "_update");
        return employee;
    }
    @DeleteMapping
    public JsonResult delete(Long id){
        return JsonResult.success();
    }
}

RequestMapping注解属性

value/path：映射路径；
method：限定请求的方式，枚举：

public enum RequestMethod {
    GET, HEAD, POST, PUT, PATCH, DELETE, OPTIONS, TRACE
}

params：限定要处理请求的参数，只有匹配该参数的请求，才会被该方法处理；

/**
 * @RequestMapping(value = "/test", params = {"name"})  要求请求必须带上name参数
 * @RequestMapping(value = "/test", params = {"name=dafei"})  要求请求必须带上name参数，并且值为dafei
 */
@RequestMapping(value = "/test", params = {"name=dafei"})
@ResponseBody
public String test(){
}

headers：限定要处理请求的请求头信息，只有匹配该请求头内容的请求，才会被该方法处理；

@RequestMapping(value = "/test2", headers = {"accept=application/json"})
@ResponseBody
public String test2(){
    return "ok--json";
}

@RequestMapping(value = "/test2", headers = {"content-type=application/xml"})
@ResponseBody
public String test3(){
    return "ok--xml";
}

consumes：限定要处理请求的请求头信息，明确指定客户端携带参数类型

//等价于：@RequestMapping(value = "/test2", headers = {"content-type=application/json"})
@RequestMapping(value = "/test2", consumes = {"application/json"})
@ResponseBody
public String test4(){
    return "ok--json";
}

produces：限定要处理请求的请求头信息，明确指定客户端希望服务端响应会指定参数类型

//等价于：@RequestMapping(value = "/test2", headers = {"accept=application/json"})
@RequestMapping(value = "/test2", produces = {"application/json"})
@ResponseBody
public String test5(){
    return "ok--json";
}

总结

RESTful接口设计也就这么点事

1>请求路径

确定具体操作资源，结合需求，可以适当加路径前后缀，或者使用参数路径方式

2>请求方法

根据接口实际功能，针对资源的CRUD找合适方法

资源从无到有：POST

资源从有到无：DELETE

资源从A状态到B状态：PUT

资源状态不改变：GET

3>请求参数

根据接口实现功能按需传入参数

4>请求响应

根据接口实现，客户端调用要求，决定具体返回值，建议使用JSON格式。

总结一句话：RESTful是一种接口设计风格，建议你遵守，开发中在遵守大前提下，结合实际灵活处理。

posted @ 2022-12-29 20:59 0x7F 阅读(77) 评论(0) 编辑收藏举报

刷新页面返回顶部

ghy

RESTful

什么是API

Web 发展阶段

传统VS前后端分离

RESTful接口设计

存在原因

RESTful风格

约束规则

传统接口设计

1>请求路径

2>请求方式

3>请求参数

4>请求响应

RESTful接口设计

1>请求路径

2>请求方式

3>请求参数

4>请求响应

相关拓展

HTTP响应状态码

资源表现形式

使用注意

RESTful框架

API测试工具

RESTful接口练习

项目准备

接口设计

参数路径拓展

页面请求接口

RESTful接口简化

RequestMapping注解属性

总结

公告