【SpringBoot】| 接口架构风格—RESTful

我爱普洱茶  金牌会员 | 2025-2-18 19:29:24 | 显示全部楼层 | 阅读模式
打印 上一主题 下一主题
楼主

主题 854|帖子 854|积分 2562

目录 
一：接口架构风格—RESTful
1. 认识RESTful
2. RESTful 的注解

一：接口架构风格—RESTful

1. 认识RESTful

（1）接口
   ①接口： API（Application Programming Interface，应用步伐接口）是一些预先界说的接口（如函数、HTTP接口），或指软件体系差别组成部分衔接的约定。 用来提供应用步伐与开辟职员基于某软件或硬件得以访问的一组例程，而又无需访问源码，或理解内部工作机制的细节。
  ②接口（API）：可以指访问servlet， controller的url， 调用其他步伐的函数。
  （2）架构风格
   指API的组织方式（长什么样子），就是一个传统的风格：http://localhost:9002/mytrans/addStudent?name=lisi&age=26
  在地址上提供了 访问的资源名称addStudent, 在其后利用了get方式传递参数。
  （3）REST架构风格
   REST : 是一种接口的架构风格和设计的理念，不是尺度。（英文： Representational State Transfer , 中文： 表现层状态转移)
  ①表现层状态转移:
  表现层：就是视图层， 显示资源的， 例如：jsp等显示操纵资源的结果。
  状态： 表现资源的变化。
  转移： 资源可以变化的；资源能创建（new状态）、资源创建后可以查询资源（能看到资源的内容）、资源内容可以被修改（修改后资源 和之前的不一样）。
  ②REST中的要素：用REST表现资源和对资源的操纵
  资源利用URL表现，通过名词表现资源：
   在url中，利用名词表现资源， 以及访问资源的信息，在url中，利用“ / " 分隔对资源的信息，例如： http://localhost:8080/myboot/student/1001
  查询资源： 通过url找到资源。
  创建资源： 添加资源。
  更新资源：更新资源 ，编辑。
  删除资源： 去除。
  利用http中的动作（请求方式）， 表现对资源的操纵（CURD）： 
GET: 查询资源 ---> sql select
   处理单个资源： 用他的单数方式
  http://localhost:8080/myboot/student/1001
  http://localhost:8080/myboot/student/1002
  处理多个资源：利用复数形式
  http://localhost:8080/myboot/students/1001/1002
  POST: 创建资源 ---> sql insert
   http://localhost:8080/myboot/student
  在post请求中传递数据
  1. <form action="http://localhost:8080/myboot/student" method="post">
  2.         姓名：<input type="text" name="name" />
  3.     年龄：<input type="text" name="age" />
  4. </form>
复制代码
PUT：更新资源 ---> sql update
   欣赏器不能直接支持put，所以先成post；然后利用一个隐蔽域，把post请求酿成真实的put
  1. <form action="http://localhost:8080/myboot/student/1" method="post">
  2.         姓名：<input type="text" name="name" />
  3.     年龄：<input type="text" name="age" />
  4.     <input type="hidden" name="_method" value="PUT" />
  5. </form>
复制代码
DELETE: 删除资源 ---> sql delete
  1. <a href="http://localhost:8080/myboot/student/1">删除1的数据</a>
复制代码
总结：利用url表现资源 ，利用http动作操纵资源！
（4）分页
   如果必要分页、排序等参数，依然是通过?的形式放在url的后面， 例如：
  http://localhost:8080/myboot/students?page=1&pageSize=20
  （5）优点
   ①轻量：直接基于 http，不再必要任何别的诸如消息协议。
  ②面向资源：一览无余，具有自解释性。
  ③数据描述简朴：一样平常以 xml，json做数据交换。
  ④无状态：在调用一个接口（访问、操纵资源）的时间，可以不用考虑上下文，不用考虑当前状态， 极大的低落了复杂度。
  ⑤简朴、低耦合
  
2. RESTful 的注解

   ①@PathVariable，用来获取url中的数据；该注解是实现RESTFul最主要的一个注解！
  ②@GetMapping，接收get方式的请求；等同于@RequestMapping( method=RequestMethod.GET)。
  ③@PostMapping，接收和处理Post方式的请求；等同于@RequestMapping( method=RequestMethod.POST) 。
  ④@PutMapping，接收put方式的请求；等同于 @RequestMapping( method=RequestMethod.PUT)。
  ⑤@DeleteMapping，接收delete方式的请求；等同于 @RequestMapping( method=RequestMethod.DELETE)。
  ⑥@RestController复合注解， 是@Controller 和@ResponseBody组合；在类的上面利用@RestController ， 表现当前类者的全部方法都加入了 @ResponseBody。
  案例：@PathVariable注解和@GetMapping注解的联合利用（查询资源）
   ①在类上利用@RestController复合注解，作用时把当前类交给Spring容器管理，而且在该类下面的每个方法都默认加上@ResponseBody。
  ②利用GetMapping注解发送get请求，我们知道Restful风格的请求路径中是没有变量的，所以要先利用{变量名}界说路径变量，在利用路径变量@PathVariable注解引用路径变量；例如：queryStudent(@PathVariable(value = "stuId") Integer stuId)，表现把路径变量传过来的值赋给stuId变量。
  1. package com.zl.controller;
  3. import org.springframework.web.bind.annotation.GetMapping;
  4. import org.springframework.web.bind.annotation.PathVariable;
  5. import org.springframework.web.bind.annotation.RestController;
  7. @RestController
  8. public class MyRestController {
  10.     @GetMapping("/student/{stuId}")
  11.     public String queryStudent(@PathVariable(value = "stuId") Integer stuId){
  12.         return "Studnet的id是："+stuId;
  14.     }
  15. }
复制代码
实行结果：
   根据url传过来的值，赋值给路径变量，路径变量在通过@PathVariable注解让我们拿到数据，进行展示。
  


案例：@PathVariable注解和@PostMapping注解的联合利用（创建资源）
addStudent.html表单页面（属于静态资源放到static目录下），在post请求中传递数据
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>Title</title>
  6. </head>
  7. <body>
  8.     <h3>添加学生</h3>
  9.     <form action="student/zhangsan/18" method="post">
  10.         <input type="submit" value="注册学生">
  11.     </form>
  12. </body>
  13. </html>
复制代码
接收数据
  1.     // 创建资源
  2.     @PostMapping("/student/{name}/{age}")
  3.     public String createStudent(@PathVariable("name") String name,
  4.                                 @PathVariable("age") Integer age){
  5.         return "创建资源Student"+name+"="+age;
  6.     }
复制代码
实行结果：


案例：对于Post、Put、Delete都必要编写一个表单页面，比力麻烦，而且对于put和delete请求欣赏器是不支持的；可以借助一个Postman工具
   注：当路径变量名和形参名保持一致，@PathVariable中的value可以省略。
  Postman测试工具：可以测试 get ，post ， put ，delete 等请求
  1.     // 更新资源
  2.     @PutMapping("/student/{id}/{age}")
  3.     public String modifyStudent(@PathVariable Integer id,
  4.                                 @PathVariable Integer age){
  5.         return "更新资源Student："+id+"="+age;
  6.     }
  9.     // 删除资源
  10.     @DeleteMapping("/student/{id}")
  11.     public String removeStudentById(@PathVariable Integer id){
  12.         return "删除资源Student："+id;
  13.     }
复制代码
实行结果：省去写表单页面了


案例：利用HiddenHttpMethodFilter过滤器，将post请求转为put ，delete
   在SpringMVC中 有一个过滤器org.springframework.web.filter.HiddenHttpMethodFilter。
  作用： 把请求中的post请求转为 put ， delete。
  第一步：在application.properties(yml) : 开启利用HiddenHttpMethodFilter过滤器
   源码分析发现在SpringBoot中默认是把这个组件已经配置好的，但是默认是关闭的，要想见效必须手动设置见效。
  1. package org.springframework.boot.autoconfigure.web.servlet;
  3. public class WebMvcAutoConfiguration {
  4.         @Bean
  5.         @ConditionalOnMissingBean(HiddenHttpMethodFilter.class)
  6.         @ConditionalOnProperty(prefix = "spring.mvc.hiddenmethod.filter", name = "enabled")
  7.         public OrderedHiddenHttpMethodFilter hiddenHttpMethodFilter() {
  8.                 return new OrderedHiddenHttpMethodFilter();
  9.         }
  10. }
复制代码
设置为true
  1. #启用过滤器
  2. spring.mvc.hiddenmethod.filter.enabled=true
复制代码
第二步：在请求页面中，发出post请求；type范例利用隐蔽域hidden，name参数是 _method， value对应着我们真正的请求方式put、delete
form表单页面，实际上真正发出的是put请求！
  1. <!DOCTYPE html>
  2. <html lang="en">
  3. <head>
  4.     <meta charset="UTF-8">
  5.     <title>Title</title>
  6. </head>
  7. <body>
  8.     <form action="student/test" method="post" >
  9.         <!--指定真正的请求方式-->
  10.         <input type="hidden" name="_method" value="put">
  11.         <input type="submit" value="测试" />
  12.     </form>
  13. </body>
  14. </html>
复制代码
扩展：当前也可以把_method参数设置为自界说参数
   通过前面的源码分析，如果没有自界说HiddenHttpMethodFilter，容器会帮我们自界说一个纳入容器管理，此时利用的默认参数就是_method！
  

所以就可以本身创建一个HiddenHttpMethodFilter，调用setMethodParam方法本身界说
  1. package com.zl.config;
  3. import org.springframework.context.annotation.Bean;
  4. import org.springframework.context.annotation.Configuration;
  5. import org.springframework.web.filter.HiddenHttpMethodFilter;
  7. @Configuration(proxyBeanMethods = false)
  8. public class MyConfig {
  9.     // 自定义Filter，纳入容器管理
  10.     @Bean
  11.     public HiddenHttpMethodFilter hiddenHttpMethodFilter(){
  12.         HiddenHttpMethodFilter methodFilter = new HiddenHttpMethodFilter();
  13.         // 设置method参数为_m
  14.         methodFilter.setMethodParam("_m");
  15.         return methodFilter;
  16.     }
  18. }
复制代码


问题：请求路径辩论
例如：以下两个请求，利用get请求，资源名也雷同，携带的数据范例也雷同；我们直接进行访问：http://localhost:8081/student/1；此时就会有路径辩论，导致访问失败！
解决：设计路径，必须唯一， 路径uri和请求方式必须唯一！
  1. @GetMapping("/student/{id}")
  2. @GetMapping("/student/{age}")
复制代码


免责声明：如果侵犯了您的权益，请联系站长，我们会及时删除侵权内容，谢谢合作！更多信息从访问主页：qidao123.com:ToB企服之家，中国第一个企服评测及商务社交产业平台。
回复

使用道具 举报

0 个回复

倒序浏览
返回列表

快速回复

高级模式
B Color Image Link Quote Code Smilies
您需要登录后才可以回帖 登录 or 立即注册

本版积分规则

我爱普洱茶

金牌会员
这个人很懒什么都没写!

楼主热帖

标签云

挺好的 服务器
微信订阅号
微信服务号
微信客服
小程序
H5
关于我们 商务合作 网站地图
©Copyright 2022-2024 杭州祥升科技有限公司 版权所有 浙ICP备20004199号
快速回复 返回顶部 返回列表