【Spring教程30】Spring框架实战：从零开始学习SpringMVC 之 Rest风格简介与RESTful入门案例

news2024/12/23 23:34:28

目录

  • 1 REST简介
  • 2 RESTful入门案例
    • 2.1 环境准备
    • 2.2 思路分析
    • 2.3 修改RESTful风格
  • 3 知识点总结

欢迎大家回到《Java教程之Spring30天快速入门》，本教程所有示例均基于Maven实现，如果您对Maven还很陌生，请移步本人的博文《如何在windows11下安装Maven并配置以及 IDEA配置Maven环境》，本文的上一篇为《SpringMVC 之 服务器响应》
在这里插入图片描述

1 REST简介

REST（Representational State Transfer），表现形式状态转换,它是一种软件架构风格当我们想表示一个网络资源的时候，可以使用两种方式:

  • 传统风格资源描述形式
    • http://localhost/user/getById?id=1 查询id为1的用户信息
    • http://localhost/user/saveUser 保存用户信息
  • REST风格描述形式
    • http://localhost/user/1
    • http://localhost/user

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

查看REST风格的描述，你会发现请求地址变的简单了，并且光看请求URL并不是很能猜出来该URL的具体功能

所以REST的优点有:

  • 隐藏资源的访问行为，无法通过地址得知对资源是何种操作
  • 书写简化

但是我们的问题也随之而来了，一个相同的url地址即可以是新增也可以是修改或者查询，那么到底我们该如何区分该请求到底是什么操作呢?

  • 按照REST风格访问资源时使用行为动作区分对资源进行了何种操作
    • http://localhost/users 查询全部用户信息 GET（查询）
    • http://localhost/users/1 查询指定用户信息 GET（查询）
    • http://localhost/users 添加用户信息 POST（新增/保存）
    • http://localhost/users 修改用户信息 PUT（修改/更新）
    • http://localhost/users/1 删除用户信息 DELETE（删除）

请求的方式比较多，但是比较常用的就4种，分别是GET , POST , PUT , DELETE。

按照不同的请求方式代表不同的操作类型。

  • 发送GET请求是用来做查询
  • 发送POST请求是用来做新增
  • 发送PUT请求是用来做修改
  • 发送DELETE请求是用来做删除

但是注意:

  • 上述行为是约定方式，约定不是规范，可以打破，所以称REST风格，而不是REST规范
    • REST提供了对应的架构方式，按照这种架构设计项目可以降低开发的复杂性，提高系统的可伸缩性
    • REST中规定GET/POST/PUT/DELETE针对的是查询/新增/修改/删除，但是我们如果非要用GET请求做删除，这点在程序上运行是可以实现的
    • 但是如果绝大多数人都遵循这种风格，你写的代码让别人读起来就有点莫名其妙了。描述模块的名称通常使用复数，也就是加s的格式描述，表示此类资源，而非单个资源，例如:users、books、accounts…

清楚了什么是REST风格后，我们后期会经常提到一个概念叫RESTful，那什么又是RESTful呢?

  • 根据REST风格对资源进行访问称为RESTful。

后期我们在进行开发的过程中，大多是都是遵从REST风格来访问我们的后台服务，所以可以说咱们以后都是基于RESTful来进行开发的。

2 RESTful入门案例

2.1 环境准备

  • 创建一个Web的Maven项目
  • pom.xml添加Spring依赖
<?xml version="1.0" encoding="UTF-8"?>
<project xmlns="http://maven.apache.org/POM/4.0.0"
xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0
http://maven.apache.org/xsd/maven-4.0.0.xsd">
	<modelVersion>4.0.0</modelVersion>
	<groupId>com.itheima</groupId>
	<artifactId>springmvc_06_rest</artifactId>
	<version>1.0-SNAPSHOT</version>
	<packaging>war</packaging>
	<dependencies>
		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>javax.servlet-api</artifactId>
			<version>3.1.0</version>
			<scope>provided</scope>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-webmvc</artifactId>
			<version>5.2.10.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>com.fasterxml.jackson.core</groupId>
			<artifactId>jackson-databind</artifactId>
			<version>2.9.0</version>
		</dependency>
	</dependencies>

	<build>
		<plugins>
			<plugin>
				<groupId>org.apache.tomcat.maven</groupId>
				<artifactId>tomcat7-maven-plugin</artifactId>
				<version>2.1</version>
				<configuration>
					<port>80</port>
					<path>/</path>
				</configuration>
			</plugin>
		</plugins>
	</build>
</project>
  • 创建对应的配置类
public class ServletContainersInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
	protected Class<?>[] getRootConfigClasses() {
		return new Class[0];
	}
	
	protected Class<?>[] getServletConfigClasses() {
		return new Class[]{SpringMvcConfig.class};
	}
	
	protected String[] getServletMappings() {
		return new String[]{"/"};
	}

	//乱码处理
	 @Override
	protected Filter[] getServletFilters() {
		CharacterEncodingFilter filter = new CharacterEncodingFilter();
		filter.setEncoding("UTF-8");
		return new Filter[]{filter};
	}
}

@Configuration
@ComponentScan("com.itheima.controller")
//开启json数据类型自动转换
@EnableWebMvc
public class SpringMvcConfig {
}
  • 编写模型类User和Book
public class User {
	private String name;
	private int age;
	//getter...setter...toString省略
}

public class Book {
	private String name;
	private double price;
	//getter...setter...toString省略
}
  • 编写UserController和BookController
@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'}";
	}
}


@Controller
public class BookController {

	@RequestMapping(value = "/books",method = RequestMethod.POST)
	@ResponseBody
	public String save(@RequestBody Book book){
		System.out.println("book save..." + book);
		return "{'module':'book save'}";
	}

	@RequestMapping(value = "/books/{id}",method = RequestMethod.DELETE)
	@ResponseBody
	public String delete(@PathVariable Integer id){
		System.out.println("book delete..." + id);
		return "{'module':'book delete'}";
	}

	@RequestMapping(value = "/books",method = RequestMethod.PUT)
	@ResponseBody
	public String update(@RequestBody Book book){
		System.out.println("book update..." + book);
		return "{'module':'book update'}";
	}

	@RequestMapping(value = "/books/{id}",method = RequestMethod.GET)
	@ResponseBody
	public String getById(@PathVariable Integer id){
		System.out.println("book getById..." + id);
		return "{'module':'book getById'}";
	}
	@RequestMapping(value = "/books",method = RequestMethod.GET)
	@ResponseBody
	public String getAll(){
		System.out.println("book getAll...");
		return "{'module':'book getAll'}";
	}
}

最终创建好的项目结构如下:
在这里插入图片描述

2.2 思路分析

需求:将之前的增删改查替换成RESTful的开发方式。
1.之前不同的请求有不同的路径,现在要将其修改为统一的请求路径
修改前: 新增: /save ,修改: /update,删除 /delete…
修改后: 增删改查: /users
2.根据GET查询、POST新增、PUT修改、DELETE删除对方法的请求方式进行限定
3.发送请求的过程中如何设置请求参数?

2.3 修改RESTful风格

新增

@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'}";
	}
}
  • 将请求路径更改为/users
    • 访问该方法使用 POST: http://localhost/users
  • 使用method属性限定该方法的访问方式为POST
    • 如果发送的不是POST请求，比如发送GET请求，则会报错
      在这里插入图片描述
      删除
@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'}";
	}
}
  • 将请求路径更改为/users
    • 访问该方法使用 DELETE: http://localhost/users

访问成功，但是删除方法没有携带所要删除数据的id,所以针对RESTful的开发，如何携带数据参数?

传递路径参数

前端发送请求的时候使用: 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)如果方法形参的名称和路径{}中的值不一致，该怎么办?
在这里插入图片描述
(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'}";
	}
}

修改

@Controller
public class UserController {
	//设置当前请求方法为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'}";
	}
}
  • 将请求路径更改为/users
    • 访问该方法使用 PUT: http://localhost/users
  • 访问并携带参数:
    在这里插入图片描述
    根据ID查询
@Controller
public class UserController {
	//设置当前请求方法为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'}";
	}
}

将请求路径更改为/users

  • 访问该方法使用 GET: http://localhost/users/666

查询所有

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

将请求路径更改为/users

  • 访问该方法使用 GET: http://localhost/users

小结
RESTful入门案例，我们需要学习的内容如下:
(1)设定Http请求动作(动词)
@RequestMapping(value=“”,method = RequestMethod.POST|GET|PUT|DELETE)
(2)设定请求参数(路径变量)
@RequestMapping(value=“/users/{id}”,method = RequestMethod.DELETE)
@ReponseBody
public String delete(@PathVariable Integer id){
}

3 知识点总结

知识点1：@PathVariable
在这里插入图片描述
关于接收参数，我们学过三个注解@RequestBody、@RequestParam、@PathVariable ,这三个注解之间的区别和应用分别是什么?

  • 区别
    • @RequestParam用于接收url地址传参或表单传参
    • @RequestBody用于接收json数据
    • @PathVariable用于接收路径参数，使用{参数名称}描述路径参数
  • 应用
    • 后期开发中，发送请求参数超过1个时，以json格式为主，@RequestBody应用较广
    • 如果发送非json格式数据，选用@RequestParam接收请求参数
    • 采用RESTful进行开发，当参数数量较少时，例如1个，可以采用@PathVariable接收请求路径变量，通常用于传递id值

本文来自互联网用户投稿，该文观点仅代表作者本人，不代表本站立场。本站仅提供信息存储空间服务，不拥有所有权，不承担相关法律责任。如若转载，请注明出处：http://www.coloradmin.cn/o/1315716.html

如若内容造成侵权/违法违规/事实不符，请联系多彩编程网进行投诉反馈，一经查实，立即删除！

相关文章

我的世界合成表大全(最新完整版)

我的世界合成表大全(最新完整版)

我的世界合成表配方是什么? 我的世界是一款非常有趣的高自由度的沙盒游戏&#xff0c;游戏中玩家可以根据合成配方制作各种各样的物品。今天小编就为大家带来我的世界合成表大全(最新完整版)&#xff0c;希望可以帮到大家。 我的世界合成表大全(最新完整版) 基础物品合成表&a…
阅读更多...
知识付费小程序开发：构建个性化学习平台的技术实践

知识付费小程序开发：构建个性化学习平台的技术实践

随着在线学习和知识付费的兴起&#xff0c;开发一款知识付费小程序成为了创新的热点之一。本文将通过使用Node.js、Express和MongoDB为例&#xff0c;演示如何构建一个基础的知识付费小程序后端&#xff0c;并实现用户认证和知识内容管理。 1. 初始化项目 首先&#xff0c;确…
阅读更多...
eNSP小实验（ACL和NAT）

eNSP小实验（ACL和NAT）

一.ACL 实验目的&#xff1a;过滤流量&#xff0c;然后匹配规划后&#xff0c;判断该流量通过或拒绝 1.拓扑图 2.配置 基本ACL 其它同理配置 R1 [Huawei]sys R1 [R1]int g0/0/0 [R1-GigabitEthernet0/0/0]dis th [V200R003C00] # interface GigabitEthernet0/0/0 # return…
阅读更多...
基础IO --- 下

基础IO --- 下

目录 1. 理解文件系统中inode的概念 1.1. 了解磁盘 1.1.1. 认识磁盘 1.1.2. 磁盘的物理结构 1.1.3. 简单了解磁盘如何读写数据的 1.1.4. 磁头和盘面没有物理上的接触 1.1.5. 扇区的了解 1.1.6. 如何在物理上找到一个具体的扇区 1.2. 站在OS的角度看待磁盘 1.2.1. …
阅读更多...
走进暄桐教室 一起观看暄桐同学作品及感受

走进暄桐教室 一起观看暄桐同学作品及感受

暄桐是一间传统美学教育教室&#xff0c;创办于2011年&#xff0c;林曦是创办人和授课老师&#xff0c;教授以书法为主的传统文化和技艺&#xff0c;旨在以书法为起点&#xff0c;亲近中国传统之美&#xff0c;以实践和所得&#xff0c;滋养当下生活。其实&#xff0c;暄桐教室…
阅读更多...
Linux 系统 yum 安装 jdk1.8

Linux 系统 yum 安装 jdk1.8

1、首先检查是否存在jdk java -version上图这样就是系统没有找到已经安装的jdk 2.查看jdk版本列表 yum -y list java*执行此命令会显示所有版本 jdk 安装包 3、下载安装jdk 这里安装的是jdk1.8 yum install java-1.8.0-openjdk-devel.x86_64这里输入回车y继续安装 4、再次检…
阅读更多...
低代码开发入局，同飞股份应用云表自主开发MES管理系统

低代码开发入局，同飞股份应用云表自主开发MES管理系统

近日&#xff0c;为了贯彻落实《“十四五”智能制造发展规划》&#xff0c;推动中国从制造大国向制造强国转变&#xff0c;工业和信息化部发布了2023年度“智能制造优秀场景”名单。经过省级有关部门和中央企业的推荐、专家评审、网上公示等程序&#xff0c;同飞股份凭借其“先…
阅读更多...
LeetCode-反转链表问题

LeetCode-反转链表问题

1.反转链表 题目描述&#xff1a; 给你单链表的头节点 head &#xff0c;请你反转链表&#xff0c;并返回反转后的链表。 思路&#xff1a; 反转链表也就是链表倒置&#xff0c;我一直以来的办法就是先建立一个头节点&#xff0c;之后再遍历链表来进行头插。 代码&#xff1…
阅读更多...
自动驾驶技术：驶向未来的智能之路

自动驾驶技术：驶向未来的智能之路

导言 自动驾驶技术正引领着汽车产业向着更安全、高效、智能的未来演进。本文将深入研究自动驾驶技术的核心原理、关键技术、应用场景以及对交通、社会的深远影响。 1. 简介 自动驾驶技术是基于先进传感器、计算机视觉、机器学习等技术的创新&#xff0c;旨在实现汽车在不需要人…
阅读更多...
强化学习--免模型预测与控制

强化学习--免模型预测与控制

免模型预测与控制 强化学习 免模型预测与控制免模型预测蒙特卡洛估计时序差分估计时序产分与蒙特卡洛的比较免模型控制Q-learning 免模型预测 蒙特卡洛估计 蒙特卡洛估计方法在强化学习中是免模型预测价值函数的方式之一&#xff0c;本质是一种统计模拟方法&#xff0c;它的发…
阅读更多...
Mac brew install youtube-dl 【 youtube 下载工具：youtube-dl 安装】

Mac brew install youtube-dl 【 youtube 下载工具：youtube-dl 安装】

文章目录 1. 简介2. 预备3. 安装4. 命令5. 测试 1. 简介 youtube-dl - 从youtube.com或其他视频平台下载视频 https://github.com/ytdl-org/youtube-dl 2. 预备 安装并配置 git安装 brew 3. 安装 MacBook-Pro ~ % brew install youtube-dl Warning: youtube-dl has been …
阅读更多...
mysql 索引场景 大于＞为什么失效

mysql 索引场景 大于＞为什么失效

可以先看这个&#xff1a;Mysql查询条件为大于时&#xff0c;不走索引失效场景-CSDN博客 改为> &#xff0c;可双看到key_len减少了&#xff0c;从90变到了86&#xff0c;也就是说联合索引(a b c) &#xff0c;只有(a b) 起了效果,c 没有。 可以不查c看看结果&#xff0c;还…
阅读更多...
Leetcode—459.重复的子字符串【简单】

Leetcode—459.重复的子字符串【简单】

2023每日刷题&#xff08;五十九&#xff09; Leetcode—459.重复的子字符串 算法思想 巧解的算法思想 实现代码 从第一个位置开始到s.size()之前&#xff0c;看s字符串是否是ss的子串 class Solution { public:bool repeatedSubstringPattern(string s) {return (s s).fin…
阅读更多...
常见内存泄漏场景与解决方案

常见内存泄漏场景与解决方案

服务器开发文章目录 文章目录 服务器开发文章目录前言一、内存泄漏是什么&#xff1f;二、常见内存泄漏场景三、内存泄漏规避与定位总结 前言 作为C/C程序员&#xff0c;谁还不写Bug&#xff0c;Bug中最常见要数内存泄漏、内存崩溃、死锁等问题&#xff0c;本文主要讲解内存泄…
阅读更多...
【Python表白系列】满屏飘字表白代码等你来取！（完整代码）

【Python表白系列】满屏飘字表白代码等你来取！（完整代码）

文章目录 环境需求完整代码详细分析系列文章环境需求 python3.12.0PyCharm Community Edition 2023.2.5pyinstaller6.2.0（可选，这个库用于打包，使程序没有python环境也可以运行，如果想发给好朋友的话需要这个库哦~）【注】 python环境搭建请见：https://want595.blog.csdn.…
阅读更多...
汽车租赁小程序源码租车小程序

汽车租赁小程序源码租车小程序

汽车租赁小程序&#xff0c;多门店租车小程序&#xff0c;本套系统分为用户端&#xff0c;门店管理端&#xff0c;总管理后台三部分。门店可以加盟入驻平台。可以源码&#xff0c;也可以二次开发&#xff0c;也可以定制开发。php开发语言&#xff0c;前端是uniapp。用户端是小程…
阅读更多...
微软Microsoft二面面试题分享通过总结（不是标准答案分享

微软Microsoft二面面试题分享通过总结（不是标准答案分享

误打误撞 我写的shitty代码 当年面试算法开发岗竟然通过了 Background 先说下背景&#xff0c;软件工程本科毕业之后&#xff0c;当年8月到北欧读两年制硕士。面试发生在当年的11月&#xff0c;微软哥本哈根&#xff0c;location在丹麦的哥本哈根lingby&#xff08;是不是这么…
阅读更多...
点赋网络：15秒快速新科技，重新定义新智能

点赋网络：15秒快速新科技，重新定义新智能

随着科技的不断进步&#xff0c;自助设备在我们的生活中变得越来越常见。其中&#xff0c;智能饮品机作为一种方便快捷的购物方式&#xff0c;受到了广大消费者的喜爱。然而&#xff0c;以前的智能饮品机往往存在购物流程繁琐、速度缓慢等问题。现在&#xff0c;一种全新的智能…
阅读更多...
Linux面试题精选：提升你的面试准备

Linux面试题精选：提升你的面试准备

大家有关于JavaScript知识点不知道可以去 &#x1f389;博客主页&#xff1a;阿猫的故乡 &#x1f389;系列专栏&#xff1a;JavaScript专题栏 &#x1f389;ajax专栏&#xff1a;ajax知识点 &#x1f389;欢迎关注&#xff1a;&#x1f44d;点赞&#x1f64c;收藏✍️留言 学习…
阅读更多...
canal环境部署

canal环境部署

docker 部署canal同步数据 1 环境: 2 Mysql 配置 查看 binlog 是否启用 SHOW VARIABLES LIKE ‘%log_bin%’; 开启 binlog, 修改 my.cnf docker cp mysql:/etc/my.cnf /data/mysql/conf 拷贝文件到临时目录修改后再拷贝回去 # For advice on how to change settings please …
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023