springMVC-REST风格

最新推荐文章于 2024-06-14 15:02:13 发布
最新推荐文章于 2024-06-14 15:02:13 发布
阅读量35 收藏
点赞数
分类专栏： spring 文章标签： java spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_64044840/article/details/133872531
版权

1、REST简介

  1. REST（Representational State Transfer）是一种基于HTTP协议的网络应用程序的架构风格，它强调客户端和服务器之间的交互操作，通过对资源的表现形式 进行操作来实现对资源的管理。REST 风格的 API 设计具有简单、灵活、可扩展等特点，因此在 Web 开发中得到了广泛应用。

1.1、表示一个网络资源的两种方式：

  1. 传统方式：
查询id为1的用户信息:
http://localhost/user/getById?id=1 

保存用户信息:
http://localhost/user/saveUser

相对于REST风格：传统方式一般是一个请求url对应一种操作，这样做不仅麻烦，也不安全，因为会程序的人读取了你的请求url地址，就可利用大概知道该url实现的是一个什么样的操作。

  1. REST风格描述形式：
查询id为1的用户信息:
http://localhost/user/1

查询id为1的用户信息:
http://localhost/user

相对于传统方式：请求地址变的简单了，并且光看请求URL并不是很能猜出来该URL的具体功能。

  1. REST风格的优缺点：

    • 1）优点：
      • 隐藏资源的访问行为，无法通过地址得知对资源是何种操作
      • 书写简化
    • 2）缺点：一个相同的url地址即可以是新增也可以是修改或者查询，因此会出现 难以区分该请求具体是什么操作 。

  2. 为了解决该缺点，按照REST风格访问资源时使用行为动作区分对资源进行了何种操作：

 1. 查询全部用户信息 GET（查询）：
http://localhost/users

 5. 查询指定用户信息 GET（查询）：
http://localhost/users/1 

 6. 添加用户信息 POST（新增/保存）
http://localhost/users 

 7. 修改用户信息 PUT（修改/更新）：
http://localhost/users 

 8.  删除用户信息 DELETE（删除）：
http://localhost/users/1
  1. 请求的方式比较多，但是比较常用的就4种，分别是：
    • GET：表示查询
    • POST：表示新增
    • PUT：表示修改
    • DELETE：表示删除

2、REST风格入门

如果不使用REST快速开发，RES风格和传统的springmvc设计的区别主要在表现层controller

2.1 传统方式下的controller

@Controller
public class UserController {

//新增
	@RequestMapping("/save")
	@ResponseBody
	public String save(@RequestBody User user) {
		System.out.println("user save..."+user);
		return "{'module':'user save'}";
	}
	
//删除
	@RequestMapping("/delete")
	@ResponseBody
	public String delete(Integer id) {
		System.out.println("user delete..." + id);
		return "{'module':'user delete'}";
	}

//修改
	@RequestMapping("/update")
	@ResponseBody
	public String update(@RequestBody User user) {
		System.out.println("user update..." + user);
		return "{'module':'user update'}";
	}

//查询（带参）
	@RequestMapping("/getById")
	@ResponseBody
	public String getById(Integer id) {
		System.out.println("user getById..." + id);
		return "{'module':'user getById'}";
	}
	
//查询
	@RequestMapping("/findAll")
	@ResponseBody
	public String getAll() {
		System.out.println("user getAll...");
		return "{'module':'user getAll'}";
	}
}
  1. 主要使用到的注解：
      1. @Controller：@Controller是Spring框架中的一个注解，用于标识一个类为控制器。控制器负责接收请求并将请求转发给相应的处理程序进行处理，然后将处理结果返回给客户端。使用@Controller注解的类通常会配合其他注解一起使用，如@RequestMapping、@ResponseBody等。（设置该类为spring管理的bean）
    • 2）@RequestMapping：设置当前控制器方法请求访问路径
    • 3）@ResponseBody：设置当前控制器返回值作为响应体,写在类上，该类的所有方法都有该注解功能。
名称@Controller
类型类注解
位置SpringMVC控制器类定义上方
作用设定SpringMVC的核心控制器bean（相当于@Component)
名称@RequestMapping
类型类注解或方法注解
位置SpringMVC控制器类或方法定义上方
作用设置当前控制器方法请求访问路径
相关属性value(默认)，请求访问路径
名称@ResponseBody
类型方法\类注解
位置SpringMVC控制器方法定义上方和控制类上
作用设置当前控制器返回值作为响应体,写在类上，该类的所有方法都有该注解功能
相关属性pattern：指定日期时间格式字符串

2.2 REST风格下的controller

@Controller
public class UserController {
	//设置当前请求方法为POST，表示REST风格中的添加操作
	@RequestMapping(value = "/users",method = RequestMethod.POST)
	@ResponseBody
	public String save() {
		System.out.println("user save...");
		return "{'module':'user save'}";
	}

	//设置当前请求方法为DELETE，表示REST风格中的删除操作
	@RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
	@ResponseBody
	public String delete(@PathVariable Integer id) {
		System.out.println("user delete..." + id);
		return "{'module':'user delete'}";
	}
	
	//设置当前请求方法为PUT，表示REST风格中的修改操作
	@RequestMapping(value = "/users",method = RequestMethod.PUT)
	@ResponseBody
	public String update(@RequestBody User user) {
		System.out.println("user update..." + user);
		return "{'module':'user update'}";
	}

	//设置当前请求方法为GET，表示REST风格中的查询操作
	@RequestMapping(value = "/users/{id}" ,method = RequestMethod.GET)
	@ResponseBody
	public String getById(@PathVariable Integer id){
		System.out.println("user getById..."+id);
		return "{'module':'user getById'}";
	}

	//设置当前请求方法为GET，表示REST风格中的查询操作
	@RequestMapping(value = "/users" ,method = RequestMethod.GET)
	@ResponseBody
	public String getAll() {
		System.out.println("user getAll...");
		return "{'module':'user getAll'}";
	}
}
  1. 使用到的注解： @PathVariable：绑定路径参数与处理器方法形参间的关系，要求路径参数名与形参名一一对应
名称@PathVariable
类型形参注解
位置SpringMVC控制器方法形参定义前面
作用绑定路径参数与处理器方法形参间的关系，要求路径参数名与形参名一一对应
  1. 关于接收参数，我们学过三个注解@RequestBody、@RequestParam、@PathVariable ,这三个注解之间的区别和应用分别是什么?

区别：

  • @RequestParam用于接收url地址传参或表单传参
  • @RequestBody用于接收json数据
  • @PathVariable用于接收路径参数，使用{参数名称}描述路径参数

应用：

  • 后期开发中，发送请求参数超过1个时，以json格式为主，@RequestBody应用较广
  • 如果发送非json格式数据，选用@RequestParam接收请求参数
  • 采用RESTful进行开发，当参数数量较少时，例如1个，可以采用@PathVariable接收请求路径变量，通常用于传递id值

2.2.1 REST风格下的controller–传递路径参数

@Controller
public class UserController {
	//设置当前请求方法为DELETE，表示REST风格中的删除操作
	@RequestMapping(value = "/users",method = RequestMethod.DELETE)
	@ResponseBody
	public String delete(Integer id) {
		System.out.println("user delete..." + id);
		return "{'module':'user delete'}";
	}
}

前端发送请求的时候使用: 
http://localhost/users/1 
路径中的1就是我们想要传递的参数。

后端获取参数，需要做如下修改:
修改@RequestMapping的value属性，将其中修改为/users/{id}，目的是和路径匹配
在方法的形参前添加@PathVariable注解.

@Controller
public class UserController {
	//设置当前请求方法为DELETE，表示REST风格中的删除操作
	@RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
	@ResponseBody
	public String delete(@PathVariable Integer id) {
		System.out.println("user delete..." + id);
		return "{'module':'user delete'}";
	}
}
  1. 问题：

    • 1）如果方法形参的名称和路径{}中的值不一致，该怎么办?
      在这里插入图片描述

    • 2）如果有多个参数需要传递该如何编写?

前端发送请求的时候使用:
http://localhost/users/1/tom ,
路径中的1和tom就是我们想要传递的两个参数。

后端获取参数，需要做如下修改:

@Controller
public class UserController {
	//设置当前请求方法为DELETE，表示REST风格中的删除操作
	@RequestMapping(value = "/users/{id}/{name}",method =
	RequestMethod.DELETE)
	@ResponseBody
	public String delete(@PathVariable Integer id,@PathVariable String name)
	{
		System.out.println("user delete..." + id+","+name);
		return "{'module':'user delete'}";
	}
}

2.2.2 REST风格下的controller–总结

  1. (1)设定Http请求动作(动词)
    @RequestMapping(value=“设置访问路径（一般为实体类名（如users …）”,method = RequestMethod.POST|GET|PUT|DELETE)
  2. (2)设定请求参数(路径变量)：路径变量应该和参数变量相同，如果不同需要使用@PathVariable(“参数名（要和路径参数一样）”)
    @RequestMapping(value=“/users/{id}”,method = RequestMethod.DELETE)
    @ReponseBody
    public String delete(@PathVariable Integer id){
    }

2、RESTful快速开发

在这里插入图片描述

  1. 观察上面的入门案例，会发现三个比较明显的问题：
    • 1）每个方法的@RequestMapping注解中都定义了访问路径/books，重复性太高。
      解决1：
将@RequestMapping提到类上面，用来定义所有方法共同的访问路径。
  • 2）每个方法的@RequestMapping注解中都要使用method属性定义请求方式，重复性太高。
    解决2：
使用@GetMapping @PostMapping @PutMapping @DeleteMapping代替
  • 3）每个方法响应json都需要加上@ResponseBody注解，重复性太高。
    解决3：
1.将ResponseBody提到类上面，让所有的方法都有@ResponseBody的功能
2.使用@RestController注解替换@Controller与@ResponseBody注解，简化书写

2.1、RESTful快速开发–controller

@RestController //@Controller + ReponseBody
@RequestMapping("/books")
public class UserController {
	//设置当前请求方法为POST，表示REST风格中的添加操作
	
	//@RequestMapping(value = "/users",method = RequestMethod.POST)
	//@ResponseBody
	@PostMapping
	public String save() {
		System.out.println("user save...");
		return "{'module':'user save'}";
	}

	//设置当前请求方法为DELETE，表示REST风格中的删除操作
	//@RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
	//@ResponseBody
	@DeleteMapping("/{id}")
	public String delete(@PathVariable Integer id) {
		System.out.println("user delete..." + id);
		return "{'module':'user delete'}";
	}
	
	//设置当前请求方法为PUT，表示REST风格中的修改操作
	//@RequestMapping(value = "/users",method = RequestMethod.PUT)
	//@ResponseBody
	@PutMapping
	public String update(@RequestBody User user) {
		System.out.println("user update..." + user);
		return "{'module':'user update'}";
	}

	//设置当前请求方法为GET，表示REST风格中的查询操作
	//@RequestMapping(value = "/users/{id}" ,method = RequestMethod.GET)
	//@ResponseBody
	@GetMapping("/{id}")
	public String getById(@PathVariable Integer id){
		System.out.println("user getById..."+id);
		return "{'module':'user getById'}";
	}

	//设置当前请求方法为GET，表示REST风格中的查询操作
	//@RequestMapping(value = "/users" ,method = RequestMethod.GET)
	//@ResponseBody
	@GetMapping
	public String getAll() {
		System.out.println("user getAll...");
		return "{'module':'user getAll'}";
	}
}
名称@RestController
类型类注解
位置基于SpringMVC的RESTful开发控制器类定义上方
作用设置当前控制器类为RESTful风格，等同于@Controller与@ResponseBody两个注解组合功能
  1. 请求：
    • get：查询
    • put：修改
    • post：新增
    • delete：删除
名称@GetMapping @PostMapping @PutMapping @DeleteMapping
类型方法注解
位置基于SpringMVC的RESTful开发控制器方法定义上方
作用设置当前控制器方法请求访问路径与请求动作，每种对应一个请求动作，例如@GetMapping对应GET请求
相关属性value（默认）：请求访问路径
大刀爱敲代码
关注
  • 0
    点赞
  • 踩
  • 0
    收藏
    觉得还不错? 一键收藏
  • 0
    评论
专栏目录
SpringMVC之Rest风格
qq_61313896的博客
02-03 496
SpringMVC之Rest风格
SpringMvc---RESTFul风格
wowo
11-21 393
SpringMvc---RESTFul REST：Representational State Transfer，表现层资源状态转移。 RESTFul是一种风格，通过请求方式界定对服务器资源的操作，不使用问号键值对的方式携带参数，而是在URL地址上通过路径的方式告诉服务器要请求的资源和其他参数【前面在学习Request Mapping时学习过，RequestMapping注解支持请求路径中有占位符，比如这样（ @Request（ /请求路径/{占位符}/{占位符} ） ）】 ，通过请求方式确定要对资源
SpringMVC-Rest风格
qq_53098203的博客
03-17 431
SpringMVC-Rest风格
SpringMvc-REST风格
Hey_Join的博客
07-10 65
SpringMvc-Rest风格
SpringMVC-REST风格
qq_26843637的博客
07-12 102
在SpringMVC中使用Rest风格时候进行删除和修改的时候会跳转到成功执行后的页面会出现以下错误 解决办法如下：
SpringMVC-REST风格简介及RESTful入门案例
m0_61961937的博客
06-28 1806
REST风格简介及RESTful入门案例、@RequestBody、@RequestParam、@PathVariable的区别与应用
SpringMVC-Rest url 请求风格
爱笑的boy的博客
06-04 517
SpringMVC-Rest-优雅的 url 请求风格
SpringMVC学习 --REST风格
dongyunyanjiusuo的博客
10-13 240
SpringMVC学习 --REST风格
Java：SpringMvc--REST风格
islunatic的博客
03-19 190
RequestParam用于接收url地址传参或表单传参；@RequestBody用于接收json数据；@PathVariable用于接收路径参数，使用{参数名称}描述路径参数。当有形参的时候，需要添加@PathVariable来接收路径参数。
【知识整理】SpringMVC-REST风格CRUD
qq_19891827的博客
04-24 355
一.POST、PUT、DELETE，他们分别对应四种基本操作，GET用来获取资源，POST用来新建资源，PUT用来更新资源，DELETE用来删除资源。 1.HiddenHttpMethodFiter:浏览器表单只支持GET与POST请求，而DELETE\PUT等method不支持，Spring3.0添加一个过滤器，可以将这些请求转为标准的http方法，使得支持GET\POST\PUT\DELET
SpringMVC-REST风格和SSM整合（注解版）彩色PPT版本.pptx
06-01
REST风格简介 2、RESTful入门案例 入门案例 请求方法设定 请求路径参数 3、REST快速开发 RESTful快速开发（标准开发） @RestController 标准请求动作映射（4种） 4、案例：基于RESTful页面数据交互 5、SSM整合 ...
SpringMVC的REST风格的四种请求方式总结
08-29
SpringMVC的REST风格的四种请求方式总结 SpringMVC的REST风格的四种请求方式总结是指在SpringMVC框架中使用REST风格的四种基本操作：GET、POST、PUT、DELETE。这些操作方式都是通过HTTP协议实现的，每种操作方式都...
springmvc之rest风格的crud
09-16
springmvc中rest风格的增删改查，适合初学者参考
springMVC rest风格视图解析
05-03
springMVC spring mybatis rest风格架构 根据请求的后缀名 解析成json 或者 xml格式的数据
firstssm：我的第一个Spring-SpringMVC-Mybatis应用程序
02-01
Rest风格的URI，即使用HTTP协议请求方式的动词，来表示对资源的操作 技术点： 基础框架-ssm（SpringMVC + Spring + MyBatis） 数据库-MySQL 前端框架-bootstrap 项目依赖管理-Maven 分页-pagehelper 逆向工程-...
【仿真建模-anylogic】FlowchartPort原理解析
zhaoyaxuan001的博客
06-14 384
FlowchartPort是流图组件端口的基类，一般不会直接使用；如果需要自行封装组件库时会用到；FlowchartPort继承Port类，并定义了一系列抽象函数；用于输入端口判定此刻是否不能接收Agent。用于输出端口判定是否有Agent准备离开。判定端口是否发生错误。
（Javascript）AI数字人mp4转canvas播放并去除背景绿幕
lx_nhs的博客
06-12 555
去除前：去除后： 3、可能会出现的报错 （1）视频路径跨域问题：解决：vue开启代理
盲盒App开发时有哪些技术框架可以借鉴
最新发布
bytekj的博客
06-14 652
在开发盲盒App时，可以根据项目需求和团队技术栈选择合适的技术框架。前端可以选择微信小程序框架、React Native或Vue.js等；后端可以选择Node.js或Spring Boot等；数据库可以选择MySQL或MongoDB等。同时，还需要考虑缓存、消息队列、支付和物流接口等其他技术来完善应用的功能和性能。
SpringBoot之请求映射原理
好记性不如烂笔头
06-12 1271
我们发出的请求，SpringMVC是如何精准定位到那个Controller以及具体方法？其实这都是 HandlerMapping 发挥的作用，这篇博文我们以 RequestMappingHandlerMapping 为例并结合源码一步步进行分析。默认 HandlerMapping 主要定义在和其祖父类中获取所有类型是 Object 的 beans，并且 beanName 不以开头根据 beanName 获取 beanType如果 beanType 上存在注解则进行处理。
springMVC的REST风格
04-19
回答：Spring MVC的REST风格是一种基于HTTP协议的API设计风格，通过映射URL和HTTP方法到Controller中的相应处理方法，实现资源的增删改查等操作。这种风格可以提高API的可读性和可维护性，也更符合实际开发的需求。

“相关推荐”对你有帮助么？

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值