RESTful风格-走进RESTful
RESTful
什么是API
API (应用程序编程接口) 两种用法
- 类似jar的使用:A软件将功能打包成组件(功能块:比如java中的jar),让B软件导入直接使用
- http请求方式:A项目(系统)提供一个映射方法路径,B项目(系统)发起http请求得到对应功能 (应用请求方式)
应用接口:很多情况下,需要把系统的部分功能(组件)作为服务暴露给外部的其他应用使用,所以就需要把系统中的服务作为API接口暴露出去,一般分为公共接口和私用接口(公司内部)
了解Web技术的发展阶段
- 静态内容阶段:Web 由大量的静态 HTML 文档组成
- CGI 程序阶段：Web 服务器增加了一些编程 API，可以提供一些动态的内容
- 脚本语言阶段:服务器端出现了 ASP、PHP、JSP、ColdFusion 等支持 session 的脚本语言技术,浏览器端出现了 Java Applet、JavaScript 等技术
- 瘦客户端应用阶段:服务器端出现了独立于 Web 服务器的应用服务器。同时出现了 Web MVC 开发模式
- RIA 应用阶段:出现了多种 RIA（Rich Internet Application）技术,应用最为广泛的 RIA 技术是 DHTML+Ajax
- 移动 Web 应用阶段:出现了大量面向移动设备的 Web 应用开发技术 Android、iOS 、H5等
前后端分离模式
前后端分离,字面意思就是 前端+后端分离,传统的开发模式前后端耦合过高,不利于维护,一旦前后端任意一方换,不利于开发.
优点:
前后端责任分离,后端负责数据,前端负责页面
提高工作效率,无需等待对方开发工作结束
增强代码的可维护性
应对复杂的前端需求
RESTful风格
是一种规范,规范后端编写的逻辑. REST是一种设计API的模式(风格),常用JSON数据格式(能被JS直接读取) , REST只是一种设计风格 , 而不是标准
restful规范与传统规范的区别
- 传统的请求映射方法(接口)设计考虑要点:
- 请求路径 : /employee/list
- 请求方法:GET/POST
- 请求参数: employee对象
- 请求响应值: JsonResult对象
- RESTful风格接口约束的要点:
- 请求路径: 要求是操作资源(实体对象:domain)名称复数 /employees
- 请求方式: 使用请求方式替换资源CRUD操作 :POST–新增 ,GET–查询 ,DELETE–删除 ,PUT–更新
- 请求参数:跟之前一样,需求决定
- 请求响应值:跟之前一样,需求决定,但是建议返回值都是json格式
RESTful设计
- 网络上的所有事物都被抽象为资源
restful认为,每个资源都有自己唯一的资源定位符(URI),每个URI都代表了一种资源,以一张图片为例:图片有自己的路径,所以图片也是一种资源. 所以URI中不用动词,只用名词.一般数据库的表都是记录同种的集合,所以为名词为复数 这就是为什么请求路径中的操作资源要加 s ,可以不遵循这个规范(看自己喜欢或者公司规范)
- 资源状态转换
当我们访问一个网站,必然代表客户端和服务端间的互动,这种互动,会涉及资源间的状态变化,HTTP协议，是一个无状态协议,所以资源的状态保存在服务器中,如果需要改变状态,需要使用http方法去让服务器资源发生改变.简单的说就是,对应请求发生改变
新增 :从无到有
更新:从某个状态变成另一个状态
删除 :从有到无
- 使用统一接口
REST要求，必须通过统一的接口来对资源执行各种操作
- GET: 查询全部list http://localhost:8080/employees
- GET :查询单个 http://localhost:8080/employees/1 (1是id参数值,同时也是请求路径的一部分)
- POST: http://localhost:8080/employees?新增的员工信息
- PUT: http://localhost:8080/employees?id=1 更新 id为1的员工信息
- DELETE: http://localhost:8080/employees?id=1 更新 id为2的员工信息
- HEAD：获得一个资源的元数据，比如一个资源的hash值或者最后修改日期
- OPTIONS：获得客户端针对一个资源能够实施的操作,获取该资源的api
员工列表查询与员工单个查询,使用相同映射路径" /employees 和相同请求方法:RequestMethod.GET,
导致请求路径(路径+请求方法)一样,报错restful提供解决方案:使用参数路径方法参数路径:将参数作为请求路径的一部分 /employee/{id} 还要加上注解@PathVariable,将id拿到浏览器/postman发起请求时使用:http://localhost:8080/employee/1 其中1是id参数值,同时也是请求路径的一部分另外,请求映射方法必须使用@PathVariable 进行参数读取注意: 如果路径参数标记与请求参数名不一致时 ,怎么办?可以使用@PathVariable("eid") value属性指定
例子:
@Controller
public class EmployeeController {@RequestMapping(value = "employees",method = RequestMethod.GET)@ResponseBodypublic List<Employee> list(){List<Employee> employees = Arrays.asList(new Employee(1L, "小罗", 22), new Employee(2L, "小轩", 18));return employees;}@RequestMapping(value = "employees/{id}",method = RequestMethod.GET)@ResponseBodypublic Employee get(@PathVariable Long id){List<Employee> employees = Arrays.asList(new Employee(1L, "xxx", 22), new Employee(2L, "qqq", 22));return employees.get((int) (id-1));}@RequestMapping(value = "employees",method = RequestMethod.POST)@ResponseBodypublic Employee save(Employee employee){employee.setId(1L);return employee ;}@RequestMapping(value = "employees",method = RequestMethod.DELETE)@ResponseBodypublic JsonResult delete(Long id){return new JsonResult(true,"删除成功");}@RequestMapping(value = "employees",method = RequestMethod.PUT)@ResponseBodypublic JsonResult update(Long id){return new JsonResult(true,"更新成功");}
}
参数路径方法与传统方式对比
参数路径方式:优点:可以隐藏参数,避免暴露参数,相对安全缺点:如果参数较多,url过长 不建议使用 参数较少选用参数路径方法
同一资源具有多种表现形式
HTTP请求的头信息中用Accept和Content-Type字段表现形式
Accept与Content-Type的区别
- Accept属于请求头， Content-Type属于实体头。
- Accept代表发送端（客户端）希望接受的数据类型。Content-Type代表发送端（客户端|服务器）发送的实体数据的数据类型。
Accept：application/json :代表客户端希望接受得数据类型是json类型,后台返回json数据
Content-Type：application/json:代表发送端发送数据格式是json,后台要以这种格式类接收前端的数据
使用Ajax发送请求
删除,更新操作$.ajax({url: 路径 ,type: 类型 ,data: 参数{id:111},success:(回调函数)function(data){}})
<script>$(function () {//查全部$("#btn1").click(function () {$.get("/employees" ,function (data) {console.log(data);})});//查单个$("#btn2").click(function () {$.get("/employees/1" ,function (data) {console.log(data);})});//新增$("#btn4").click(function () {$.post("/employees" ,{name:"xiao",age:18},function (data) {console.log(data);})});//删除$("#btn3").click(function () {$.ajax({url:"/employees",type: "DELETE",data:{id:1},success:function (data) {console.log(data);}})});//更新$("#btn5").click(function () {$.ajax({url:"/employees",type: "PUT",data:{id:1},success:function (data) {console.log(data);}})})})</script>
springMVC默认不支持put请求,需要额外处理put或patch请求方式的过滤器,Springboot支持
<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>
相关注解
@GetMapper、@PostMapping、@DeleteMapping、@PutMapping
等价于 method =RequestMethod.GET|POST|DELETE|PUT
@RestController
等价于 @Controller +@ResponseBody
@PathVariable
通过 @PathVariable 可以将 URL 中占位符参数绑定到控制器处理方法参数中
URL 中的 {xxx} 占位符可以通过@PathVariable(“xxx“) 绑定到操作方法的参数中。
@RequestMapping标签属性
1.params :要求请求中必须携带指定名称的参数 params="name" :必须携带name参数params="name=xuan" :必须携带name参数,并且name=xuan 2. headers :请求头，限定要处理请求的请求头信息，只有匹配才会被方法处理3.consume :等价于Content-Type
4.value/path：映射路径
5.method：限定请求的方式
优化RESTful规范的 例子代码
@RestController
@RequestMapping("employees")
public class EmployeeController {@GetMappingpublic List<Employee> list(){List<Employee> employees = Arrays.asList(new Employee(1L, "小罗", 22), new Employee(2L, "小轩", 18));return employees;}@GetMapping(value = "/{id}")public Employee get(@PathVariable Long id){List<Employee> employees = Arrays.asList(new Employee(1L, "xxx", 22), new Employee(2L, "qqq", 22));return employees.get((int) (id-1));}@PostMappingpublic Employee save(Employee employee){employee.setId(1L);return employee ;}@DeleteMappingpublic JsonResult delete(Long id){return new JsonResult(true,"删除成功");}@PutMappingpublic JsonResult update(Long id){return new JsonResult(true,"更新成功");}
}
API接口测试工具
Postman, Insomnia
RESTful开发框架
常见的有 SpringMVC , jersey , play
RESTful风格-走进RESTful相关推荐
- Restful风格和restful服务是什么？
参考文章https://blog.csdn.net/Sai_BAN/article/details/116380778?spm=1001.2014.3001.5501
- SpringMVC基础学习之Restful风格的简单使用
前言: 小伙伴们,大家好,我是狂奔の蜗牛rz,当然你们可以叫我蜗牛君,我是一个学习Java半年多时间的小菜鸟,同时还有一个伟大的梦想,那就是有朝一日,成为一个优秀的Java架构师. 这个SpringM ...
- SpringBoot开发Restful风格的接口实现CRUD功能
一.前言 我们都知道SpringBoot的出现使得在开发web项目的时候变得更加方便.快捷.之前写过一篇文章是如何快速搭建一个springboot项目:SpringBoot入门:使用IDEA和Ecli ...
- SpringMVC3----@Controller注解、RestFul风格的讲解和应用、SpringMVC的接受请求参数、网页跳转方式和数据回显、乱码问题
目录 7 Controller类的写法 7.1 继承Controller接口 7.2 一个简单通过@Controller注解实现的程序. 7.3 @RequestMapping 8 RestFul风格 ...
- 传统请求风格 VS RestFul 风格
RestFul 风格 概念 Restful就是一个资源定位及资源操作的风格.不是标准也不是协议,只是一种风格.基于这个风格设计的软件可以更简洁,更有层次,更易于实现缓存等机制. 功能 资源:互联网所有 ...
- RESTful风格及其SpringMVC实现
目录 1.RESTful概念 2.RESTful功能 3.对比:传统方式操作资源 4.SpringMVC实现传统方式操作资源 5.使用RestFul操作资源 6.SpringMVC实现RESTful操 ...
- springboot 集成jpa_基于Spring Boot+JPA Restful 风格的数据
第一章 Restful简介 Restful是一种软件架构风格,设计风格而不是标准,只是提供了一组设计原则和约束条件.它主要用于客户端和服 务器交互类的软件.基于这个风格设计的软件可以更简洁,更有层次, ...
- java restful接口开发实例_Spring Boot 中 10 行代码构建 RESTful 风格应用！
点击上方"Java后端技术",选择"置顶或者星标" 你关注的就是我关心的! 作者:江南一点雨 微信公众号:牧码小子(ID:a_javaboy) 推荐阅读:10个 ...
- 分享一个基于 Shiro 的权限管理系统，亮点是支持 restful 风格 URL.
Shiro-Action 本项目使用 Spring Boot 搭建, 用于加深对 Spring Boot 与 Shiro 的学习, 项目特色是支持 restful 风格权限控制, 支持对同一 URL, ...
最新文章
- java数据包解析_请教http请求数据包如何解析 重组
- 【翻译】ASP.NET 4中的可扩展输出缓存
- JAVA回形数的实现
- python调用usb摄像头黑屏_ORB-SLAM2编译安装和USB摄像头例程运行
- ESP32 TIMER
- 菜鸟心态综合症4：缺乏自信，总对自己说No
- 代码整洁之道-第5章-格式-读书笔记
- 关于有时在安卓布局文件中EditText出现文字显示不出来或者光标不显示的问题的解决方案...
- 马踏棋盘（骑士周游问题）
- 用计算机刻盘,用电脑可以刻录光盘吗?
- 生成1000个不同的随机数
- A. Vasya the Hipster
- chrome更新后，再次使用selenium打开chrome却发现闪退了？全网最详细教程，肯定能帮到你！
- 2017中国开发者调查报告-云栖社区
- OC - @preperty的一些修饰词
- 混合模式程序集是针对“v1.1.4322”版的运行时生成的,在没有配置其他信息的情况下,无法在 4.0 运行时中加载该程序集。
- python 命令行解析模块_Python命令行解析模块详解
- bzoj 1022: [SHOI2008]小约翰的游戏John（anti-nim）
- H5 Vue 视频 video 支持预览图 poster
- 如何查询大量DHL国际快递物流轨迹、签收情况