Rest风格

最新推荐文章于 2024-04-02 19:07:20 发布
最新推荐文章于 2024-04-02 19:07:20 发布
阅读量1.2k 收藏 2
点赞数 3
分类专栏： Spring 文章标签： spring
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/weixin_46370595/article/details/130168173
版权

一、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

REST的优点有:

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

按照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风格后，我们后期会经常提到一个概念叫RESTful，那什么又是RESTful呢?

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

二、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.liming</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风格

新增

@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'}";
    }
}

删除

@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){

}

知识点1：@PathVariable
名称@PathVariable
类型形参注解
位置SpringMVC控制器方法形参定义前面
作用绑定路径参数与处理器方法形参间的关系，要求路径参数名与形参名一一对应

关于接收参数，我们学过三个注解@RequestBody、@RequestParam、@PathVariable,这三个注解之间的区别和应用分别是什么?

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

三、RESTful快速开发

做完了RESTful的开发，你会发现好麻烦，麻烦在哪?

在这里插入图片描述

问题1：每个方法的@RequestMapping注解中都定义了访问路径/books，重复性太高。

问题2：每个方法的@RequestMapping注解中都要使用method属性定义请求方式，重复性太高。

问题3：每个方法响应json都需要加上@ResponseBody注解，重复性太高。

对于上面所提的这三个问题，具体该如何解决?

@RestController //@Controller + ReponseBody
@RequestMapping("/books")
public class BookController {
    
	//@RequestMapping(method = RequestMethod.POST)
    @PostMapping
    public String save(@RequestBody Book book){
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }

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

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

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

    //@RequestMapping(method = RequestMethod.GET)
    @GetMapping
    public String getAll(){
        System.out.println("book getAll...");
        return "{'module':'book getAll'}";
    }
    
}

对于刚才的问题，我们都有对应的解决方案：

问题1：每个方法的@RequestMapping注解中都定义了访问路径/books，重复性太高。

将@RequestMapping提到类上面，用来定义所有方法共同的访问路径。

问题2：每个方法的@RequestMapping注解中都要使用method属性定义请求方式，重复性太高。

使用@GetMapping  @PostMapping  @PutMapping  @DeleteMapping代替

问题3：每个方法响应json都需要加上@ResponseBody注解，重复性太高。

1.将ResponseBody提到类上面，让所有的方法都有@ResponseBody的功能
2.使用@RestController注解替换@Controller与@ResponseBody注解，简化书写
知识点1：@RestController
名称@RestController
类型类注解
位置基于SpringMVC的RESTful开发控制器类定义上方
作用设置当前控制器类为RESTful风格，
等同于@Controller与@ResponseBody两个注解组合功能
知识点2：@GetMapping @PostMapping @PutMapping @DeleteMapping
名称@GetMapping @PostMapping @PutMapping @DeleteMapping
类型方法注解
位置基于SpringMVC的RESTful开发控制器方法定义上方
作用设置当前控制器方法请求访问路径与请求动作，每种对应一个请求动作，
例如@GetMapping对应GET请求
相关属性value（默认）：请求访问路径
小钟不想敲代码
关注
  • 3
    点赞
  • 踩
  • 2
    收藏
    觉得还不错? 一键收藏
  • 打赏
    打赏
  • 0
    评论
专栏目录
REST风格详细介绍
Huang405267467的博客
04-13 1万+
REST风格 restful风格详细描述 springboot中建议使用此风格编写。
REST风格
qi341500的博客
12-19 626
一、REST风格 1、设定http请求动作 2、设定请求参数（路径变量）
大牛带你深入讲解REST风格的架构：什么是REST？及REST设计原则
最新发布
2401_83384536的博客
04-02 799
随着互联网应用、Cloud Native、云计算的兴起，越来越多的应用采用了以HTTP为主的网络通信特别是RESTful（REST风格）的Web服务。RESTful Web服务所提供的API也成为REST API，这类API具有平台无关性、语言无关性等特点，在Cloud Native、微服务等架构中作为主要的通信协议。那么到底什么样的HTTP算是REST？一说到REST，大家都耳熟能详，很多人的第一反应就是认为这是前端请求后台的一种通信方式。
什么是REST风格? 什么是RESTFUL?（一篇全读懂）
热门推荐
SeniorShen的博客
12-23 2万+
一、什么是REST ？（一种软件架构风格） 缩写：REST （不是"rest"这个单词） 外文名：Representational State Transfer，简称REST。 中文名：表现层状态转移。 提出时间：2020年。 属性：一种软件架构风格。（以Web为平台的。web服务的架构风格，前后端接口时候用到。） REST之所以晦涩难懂，是因为前面主语（Resource ）被去掉了。 全称是： Resource Representational State Transfer。 通俗来讲就是：资源在网络
JavaEE(SSM框架，黑马程序员) P51~P79
Scxioi0的博客
03-09 1289
一、SpringMVC的数据响应 (1) 页面跳转 1、直接返回字符串 2、通过ModelAndVIew对象返回 ①、形式一 ②、形式二 ③、形式三 ④、形式四 (2) 回写数据 1、直接返回字符串 ①、形式一 ②、形式二 ③、使用JSON的转换工具将对象转换成JSON格式字符串在返回 导入坐标 2、返回JSON对象类型 ①、形式一 ②、返回集合类型 ③、上面配置比较麻烦的话，可以加载驱动使用更方便，代码如下： 3.1、注释 3.2、加载mvc注解驱动 3.3、运
rest风格+jdbctemplate的CRUD操作.rar
05-31
使用SpringMVC+jdbctemplate实现REST风格的CRUD功能 完成功能：能够对用户进行CRUD操作，界面粗糙，只做演示 运行环境：eclipse2019.03+JDK8+Tomcat9.0.41+MySQL5.5 运用到的技术：spring+springMVC+jdbctemplate+...
SpringMVC的REST风格的四种请求方式总结
08-29
SpringMVC的REST风格的四种请求方式总结 SpringMVC的REST风格的四种请求方式总结是指在SpringMVC框架中使用REST风格的四种基本操作：GET、POST、PUT、DELETE。这些操作方式都是通过HTTP协议实现的，每种操作方式都...
rest风格webservice
07-07
在初学者编写REST风格的Web服务时，通常会用到一些开发工具和技术，如Java的Spring Boot框架，它提供了方便的REST API支持；或者Node.js的Express框架，它们简化了REST服务的开发过程。开发者需要理解HTTP协议，掌握...
cxf开发rest风格接口jar
11-02
【标题】"CXF开发REST风格接口所需的最小JAR包" 在Java开发中，Apache CXF是一个广泛使用的开源服务框架，它支持Web服务（SOAP）和RESTful接口的创建。REST（Representational State Transfer）风格的接口已经成为...
REST风格的XCAP协议
03-01
XCAP（eXtensible CAPacity，可扩展的能力协议）是REST风格的一个应用，主要用于管理网络设备或服务器上的用户数据，特别是与IMS（IP Multimedia Subsystem，IP多媒体子系统）相关的用户配置和服务。 **REST风格的...
浅谈REST架构风格
菜鸟小码的博客
03-28 569
现如今微服务如日中天，那么大家有没有想过各个微服务之间是怎么调用数据亦或是怎么交互的呢？当然方式有很多，但今天所说的REST风格被业界推荐为微服务之间交互的首选方式（小编还是非常喜欢这种方式的）。废话不多讲，下面就说说REST风格到底是个神马东东。 REST简介 REST（Representational State Transfer）又被唤作表现层状态转换。它涉及到三个重要名词： 资源 所...
REST是一种设计风格而不是一个标准
潘小安。
07-19 210
转载自：维基百科（http://zh.wikipedia.org/wiki/REST）。 表象化状态转变（英文：Representational State Transfer，简称REST）是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格。 目前在三种主流的Web服务实现方案中，因为REST模式的Web服务与复杂的SOAP和XML-RPC对比来讲明显的更加简...
Restful风格的编程
weixin_51423778的博客
11-08 1万+
Restful风格编程体系架构
什么是 rest 参数？
weixin_47450807的博客
03-10 5708
一、什么是rest参数(…rest) ES6中引入rest参数(形式为'...变量名')，用于获取函数的多余参数。rest参数之后不能再有其他参数(即只 能是最后一个参数)。 二、函数的rest参数 1、rest参数是真正意义上的数组，可以使用数组的任何方法 ES5 function fn() { console.log(arguments) //[Arguments] { '0': 1, '1': 2, '2': 3, '3': 4 } } fn(1,2,3,4) ES6 function f
REST风格介绍、restful使用案例
m0_45877477的博客
06-18 771
操作 访问方式 访问路径 增 POST http://localhost:8080/users 删 DELETE http://localhost:8080/users/1 改 PUT http://localhost:8080/users 查一 GET http://localhost:8080/users/1 查所有 GET http://localhost:8080/users
REST风格（RESTful）的风趣理解
大鱼的博客
11-01 5527
背景：   小A准备给他外地的女朋友寄一封爱情的信件，于是去学校的商店买了一个信封，外加一些非常漂亮的信纸 回到宿舍，他诗兴大发，洋洋洒洒一封几千字的情书就写好了，该填信封了，这时，他对信封有点不满意 为什么这样说呢？他发现他买的信封竟然需要自己DIY，需要自己写填自己想填的内容，可能这类信封的设计初衷，是为了显示寄信人的创意，可是这很操蛋不是吗，这样的信封邮局会收吗？ 于是他找到了卖信封...
REST 编程风格是什么
wzbwzh的专栏
06-21 8195
首先，REST规范：强调HTTP应当以资源为中心，并且规范了资源URI的风格；规范了HTTP请求动作（PUT，POST等）的使用，具有对应的语义；遵循REST规范的Web应用将会获得下面好处：URL具有很强可读性的，具有自描述性；资源描述与视图的松耦合；可提供OpenAPI，便于第三方系统集成，提高互操作性；如果提供无状态的服务接口，可提高应用的水平扩展性；下面再详细说明一下REST。了解事物，分...
mybatisplus代码生成rest风格
09-06
根据引用和引用的内容，生成的模板代码符合常规前后端开发模式，但是生成的controller的注解是@Controller，并不是Rest风格的。因此，如果你希望生成的代码符合Rest风格，你需要自己修改生成的controller代码。你可以将注解@Controller替换为@RestController，这样就符合了Rest风格的要求。 这样修改后，生成的代码就能够满足Rest风格的需求了。<span class="em">1</span><span class="em">2</span><span class="em">3</span> #### 引用[.reference_title] - *1* [Mybatis-Plus代码生成器详解及完整代码实现](https://blog.csdn.net/weixin_45906061/article/details/128236674)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] - *2* *3* [springboot整合mybatis-plus rest风格后台开发 步骤和注意事项](https://blog.csdn.net/LeiV587/article/details/125941929)[target="_blank" data-report-click={"spm":"1018.2226.3001.9630","extra":{"utm_source":"vip_chatgpt_common_search_pc_result","utm_medium":"distribute.pc_search_result.none-task-cask-2~all~insert_cask~default-1-null.142^v93^chatsearchT3_1"}}] [.reference_item style="max-width: 50%"] [ .reference_list ]

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

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

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

小钟不想敲代码

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

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

余额充值