龙岗商城网站建设最好,什么查看WordPress的用户名及密码,自适应自助建站网站,重庆妇科医院排名前十第四章 SpringMVC
四、RESTFUL 风格设计和实战
1. RESTFul 风格概述
1.1 RESTFul 风格简介 RESTful#xff08;Representational State Transfer#xff09;是一种软件架构风格#xff0c;用于设计网络应用程序和服务之间的通信。它是一种基于标准 HTTP 方法的简单和轻量…第四章 SpringMVC
四、RESTFUL 风格设计和实战
1. RESTFul 风格概述
1.1 RESTFul 风格简介 RESTfulRepresentational State Transfer是一种软件架构风格用于设计网络应用程序和服务之间的通信。它是一种基于标准 HTTP 方法的简单和轻量级的通信协议广泛应用于现代的 Web 服务开发。通过遵循 RESTful 架构的设计原则可以构建出易于理解、可扩展、松耦合和可重用的 Web 服务。RESTful API 的特点是简单、清晰并且易于使用和理解它们使用标准的 HTTP 方法和状态码进行通信不需要额外的协议和中间件。总而言之RESTful 是一种基于 HTTP 和标准化的设计原则的软件架构风格用于设计和实现可靠、可扩展和易于集成的 Web 服务和应用程序 学习 RESTful 设计原则可以帮助我们更好去设计 HTTP 协议的 API 接口
1.2 RESTFul 风格特点
每一个 URI 代表 1 种资源URI 是名词客户端使用 GET、POST、PUT、DELETE 4 个表示操作方式的动词对服务端资源进行操作GET 用来获取资源POST 用来新建资源也可以用于更新资源PUT 用来更新资源DELETE 用来删除资源资源的表现形式是 XML 或者JSON客户端与服务端之间的交互在请求之间是无状态的从客户端到服务端的每个请求都必须包含理解请求所必需的信息。
1.3 RESTFul 风格设计规范
1.3.1 HTTP 协议请求方式要求
REST 风格主张在项目设计、开发过程中具体的操作符合HTTP 协议定义的请求方式的语义。
操作请求方式查询操作GET保存操作POST删除操作DELETE更新操作PUT
1.3.2 URL 路径风格要求
REST 风格下每个资源都应该有一个唯一的标识符例如一个 URI统一资源标识符或者一个 URL统一资源定位符。资源的标识符应该能明确地说明该资源的信息同时也应该是可被理解和解释的使用 URL请求方式确定具体的动作他也是一种标准的 HTTP 协议请求
操作传统风格REST 风格保存/CRUD/saveEmpURL 地址/CRUD/emp请求方式POST删除/CRUD/removeEmp?empId2URL 地址/CRUD/emp/2请求方式DELETE更新/CRUD/updateEmpURL 地址/CRUD/emp请求方式PUT查询/CRUD/editEmp?empId2URL 地址/CRUD/emp/2请求方式GET
总结 根据接口的具体动作选择具体的 HTTP 协议请求方式路径设计从原来携带动标识改成名词对应资源的唯一标识即可
1.4 RESTFul 风格好处
1.4.1 含蓄安全
使用问号键值对的方式给服务器传递数据太明显容易被人利用来对系统进行破坏。使用 REST 风格携带数据不再需要明显的暴露数据的名称。
1.4.2 风格统一
URL 地址整体格式统一从前到后始终都使用斜杠划分各个单词用简单一致的格式表达语义。
1.4.3 无状态
在调用一个接口访问、操作资源的时候可以不用考虑上下文不用考虑当前状态极大的降低了系统设计的复杂度。
1.4.4 严谨规范
严格按照 HTTP1.1 协议中定义的请求方式本身的语义进行操作。
1.4.5 简洁优雅
过去做增删改查操作需要设计 4 个不同的 URL现在一个就够了。
操作传统风格REST 风格保存/CRUD/saveEmpURL 地址/CRUD/emp 请求方式POST删除/CRUD/removeEmp?empId2URL 地址/CRUD/emp/2 请求方式DELETE更新/CRUD/updateEmpURL 地址/CRUD/emp 请求方式PUT查询/CRUD/editEmp?empId2URL 地址/CRUD/emp/2 请求方式GET
1.4.6 丰富的语义 通过 URL 地址就可以知道资源之间的关系。它能够把一句话中的很多单词用斜杠连起来反过来说就是可以在 URL 地址中用一句话来充分表达语义。 http://localhost:8080/shop http://localhost:8080/shop/product http://localhost:8080/shop/product/cellPhone http://localhost:8080/shop/product/cellPhone/iPhone
2. RESTFul 风格实战
2.1 需求分析
数据结构 User {id 唯一标识,name 用户名age 用户年龄}功能分析 用户数据分页展示功能条件page 页数 默认 1size 每页数量 默认 10保存用户功能根据用户 id 查询用户详情功能根据用户 id 更新用户数据功能根据用户 id 删除用户数据功能多条件模糊查询用户功能条件keyword 模糊关键字page 页数 默认 1size 每页数量 默认 10
2.2 RESTFul 风格接口设计
2.2.1 接口设计
功能接口和请求方式请求参数返回值分页查询GET /userpage1size10{ 响应数据 }用户添加POST /user{ user 数据 }{响应数据}用户详情GET /user/1路径参数{响应数据}用户更新PUT /user{ user 更新数据}{响应数据}用户删除DELETE /user/1路径参数{响应数据}条件模糊GET /user/searchpage1size10keywork关键字{响应数据}
2.2.2 问题讨论 为什么查询用户详情就使用路径传递参数多条件模糊查询就使用请求参数传递 误区restful 风格下不是所有请求参数都是路径传递可以使用其他方式传递 在 RESTful API 的设计中路径和请求参数和请求体都是用来向服务器传递信息的方式。 对于查询用户详情使用路径传递参数是因为这是一个单一资源的查询即查询一条用户记录。使用路径参数可以明确指定所请求的资源便于服务器定位并返回对应的资源也符合 RESTful 风格的要求。而对于多条件模糊查询使用请求参数传递参数是因为这是一个资源集合的查询即查询多条用户记录。使用请求参数可以通过组合不同参数来限制查询结果路径参数的组合和排列可能会很多不如使用请求参数更加灵活和简洁。 此外还有一些通用的原则可以遵循 路径参数应该用于指定资源的唯一标识或者 ID而请求参数应该用于指定查询条件或者操作参数。请求参数应该限制在 10 个以内过多的请求参数可能导致接口难以维护和使用。对于敏感信息最好使用 POST 和请求体来传递参数。
2.3 后台接口实现
2.3.1 准备用户实体类
package com.alex.pojo;/*** projectName: com.alex.pojo* 用户实体类*/
public class User {private Integer id;private String name;private Integer age;public Integer getId() {return id;}public void setId(Integer id) {this.id id;}public String getName() {return name;}public void setName(String name) {this.name name;}public Integer getAge() {return age;}public void setAge(Integer age) {this.age age;}Overridepublic String toString() {return User{ id id , name name \ , age age };}
}2.3.2 准备用户 Controller
/*** projectName: com.alex.controller** description: 用户模块的控制器*/
RequestMapping(user)
RestController
public class UserController {/*** 模拟分页查询业务接口*/GetMappingpublic Object queryPage(RequestParam(name page,required false,defaultValue 1)int page,RequestParam(name size,required false,defaultValue 10)int size){System.out.println(page page , size size);System.out.println(分页查询业务!);return {status:ok};}/*** 模拟用户保存业务接口*/PostMappingpublic Object saveUser(RequestBody User user){System.out.println(user user);System.out.println(用户保存业务!);return {status:ok};}/*** 模拟用户详情业务接口*/PostMapping(/{id})public Object detailUser(PathVariable Integer id){System.out.println(id id);System.out.println(用户详情业务!);return {status:ok};}/*** 模拟用户更新业务接口*/PutMappingpublic Object updateUser(RequestBody User user){System.out.println(user user);System.out.println(用户更新业务!);return {status:ok};}/*** 模拟条件分页查询业务接口*/GetMapping(search)public Object queryPage(RequestParam(name page,required false,defaultValue 1)int page,RequestParam(name size,required false,defaultValue 10)int size,RequestParam(name keyword,required false)String keyword){System.out.println(page page , size size , keyword keyword);System.out.println(条件分页查询业务!);return {status:ok};}
}
