SpringMVC：REST风格编程及案例

于 2024-12-04 22:12:28 发布
阅读量1.3k 收藏 16
点赞数 37
文章标签： mvc spring java maven servlet
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.youkuaiyun.com/qq_41187116/article/details/144248529
版权

REST（Representational State Transfer），表现形式状态转换,它是一种软件架构风格

REST的优点有:

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

REST风格请求的方式比较多，但是比较常用的就4种，分别是GET,POST,PUT,DELETE。按照不同的请求方式代表不同的操作类型。

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

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

下面以一个RESTful入门案例进行讲解：

1，环境准备

  • 创建一个Web的Maven项目

  • pom.xml添加Spring依赖

<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>
  • 创建对应的配置类
    ServletContainersInitConfig类：

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};
    }
}

SpringMvcConfig配置类：

@Configuration
@ComponentScan("com.itheima.controller")
//开启json数据类型自动转换
@EnableWebMvc
public class SpringMvcConfig {
}
  • 编写模型类User和Book
// User

public class User {
    private String name;
    private int age;

    @Override
    public String toString() {
        return "User{" +
                "name='" + name + '\'' +
                ", age=" + age +
                '}';
    }

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public int getAge() {
        return age;
    }

    public void setAge(int age) {
        this.age = age;
    }
}

//Book

public class Book {
    private String name;
    private double price;

    public String getName() {
        return name;
    }

    public void setName(String name) {
        this.name = name;
    }

    public double getPrice() {
        return price;
    }

    public void setPrice(double price) {
        this.price = price;
    }

    @Override
    public String toString() {
        return "Book{" +
                "书名='" + name + '\'' +
                ", 价格=" + price +
                '}';
    }
}
  • 编写UserController

@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风格中的删除操作
    //@PathVariable注解用于设置路径变量（路径参数），要求路径上设置对应的占位符，并且占位符名称与方法形参名称相同
    @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风格中的查询操作
    //@PathVariable注解用于设置路径变量（路径参数），要求路径上设置对应的占位符，并且占位符名称与方法形参名称相同
    @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'}";
    }

}
  • 编写BookController
//@Controller
//@ResponseBody配置在类上可以简化配置，表示设置当前每个方法的返回值都作为响应体
//@ResponseBody
@RestController     //使用@RestController注解替换@Controller与@ResponseBody注解，简化书写
@RequestMapping("/books")
public class BookController {

//    @RequestMapping( method = RequestMethod.POST)
    @PostMapping        //使用@PostMapping简化Post请求方法对应的映射配置
    public String save(@RequestBody Book book){
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }

//    @RequestMapping(value = "/{id}" ,method = RequestMethod.DELETE)
    @DeleteMapping("/{id}")     //使用@DeleteMapping简化DELETE请求方法对应的映射配置
    public String delete(@PathVariable Integer id){
        System.out.println("book delete..." + id);
        return "{'module':'book delete'}";
    }

//    @RequestMapping(method = RequestMethod.PUT)
    @PutMapping         //使用@PutMapping简化Put请求方法对应的映射配置
    public String update(@RequestBody Book book){
        System.out.println("book update..."+book);
        return "{'module':'book update'}";
    }

//    @RequestMapping(value = "/{id}" ,method = RequestMethod.GET)
    @GetMapping("/{id}")    //使用@GetMapping简化GET请求方法对应的映射配置
    public String getById(@PathVariable Integer id){
        System.out.println("book getById..."+id);
        return "{'module':'book getById'}";
    }

//    @RequestMapping(method = RequestMethod.GET)
    @GetMapping             //使用@GetMapping简化GET请求方法对应的映射配置
    public String getAll(){
        System.out.println("book getAll...");
        return "{'module':'book getAll'}";
    }
}
  • 最终创建好的项目结构如下:
    在这里插入图片描述

1，新增 POST

    //设置当前请求方法为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请求，则会报错

发送请求：
在这里插入图片描述
后台：
在这里插入图片描述

2，删除 DELETE

//设置当前请求方法为DELETE，表示REST风格中的删除操作
    //@PathVariable注解用于设置路径变量（路径参数），要求路径上设置对应的占位符，并且占位符名称与方法形参名称相同
    @RequestMapping(value = "/users/{id}",method = RequestMethod.DELETE)
    @ResponseBody
    public String delete(@PathVariable Integer id){
        System.out.println("user delete..." + id);
        return "{'module':'user delete'}";
    }

  • 将请求路径更改为/users
    访问该方法使用 DELETE: http://localhost/users

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

  • 后端获取参数:
    修改@RequestMapping的value属性为/users/{id}，目的是和路径匹配
    在方法的形参前添加@PathVariable注解

发送请求：
在这里插入图片描述
后台：
在这里插入图片描述

  • 多个参数需要传递该
    前端发送请求的时候使用: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'}";
    }
}

3，修改 PUT

//设置当前请求方法为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

  • 访问并携带参数:
    在这里插入图片描述
    后台：
    在这里插入图片描述

4，根据ID查询 GET

 //设置当前请求方法为GET，表示REST风格中的查询操作
    //@PathVariable注解用于设置路径变量（路径参数），要求路径上设置对应的占位符，并且占位符名称与方法形参名称相同
    @RequestMapping(value = "/users/{id}" ,method = RequestMethod.GET)
    @ResponseBody
    public String getById(@PathVariable Integer id){
        System.out.println("user getById..."+id);
        return "{'module':'user getById'}";
    }
  • @PathVariable注解用于设置路径变量（路径参数），要求路径上设置对应的占位符，并且占位符名称与方法形参名称相同
  • 将请求路径更改为/users
    访问该方法使用 GET: http://localhost/users/666

发送请求：
在这里插入图片描述
后台：
在这里插入图片描述

5，查询所有 GET

    //设置当前请求方法为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

在这里插入图片描述
后台：
在这里插入图片描述

6，小结

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值

7，RESTful快速开发

上面的内容，有几个地方可以简化：

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

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

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

可以优化成：


//@Controller
//@ResponseBody配置在类上可以简化配置，表示设置当前每个方法的返回值都作为响应体
//@ResponseBody
@RestController     //使用@RestController注解替换@Controller与@ResponseBody注解，简化书写
@RequestMapping("/books")
public class BookController {

//    @RequestMapping( method = RequestMethod.POST)
    @PostMapping        //使用@PostMapping简化Post请求方法对应的映射配置
    public String save(@RequestBody Book book){
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }

//    @RequestMapping(value = "/{id}" ,method = RequestMethod.DELETE)
    @DeleteMapping("/{id}")     //使用@DeleteMapping简化DELETE请求方法对应的映射配置
    public String delete(@PathVariable Integer id){
        System.out.println("book delete..." + id);
        return "{'module':'book delete'}";
    }

//    @RequestMapping(method = RequestMethod.PUT)
    @PutMapping         //使用@PutMapping简化Put请求方法对应的映射配置
    public String update(@RequestBody Book book){
        System.out.println("book update..."+book);
        return "{'module':'book update'}";
    }

//    @RequestMapping(value = "/{id}" ,method = RequestMethod.GET)
    @GetMapping("/{id}")    //使用@GetMapping简化GET请求方法对应的映射配置
    public String getById(@PathVariable Integer id){
        System.out.println("book getById..."+id);
        return "{'module':'book getById'}";
    }

//    @RequestMapping(method = RequestMethod.GET)
    @GetMapping             //使用@GetMapping简化GET请求方法对应的映射配置
    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注解，简化书写

验证一个查询ID， GET，其他的不再演示：

  • 控制器
//    @RequestMapping(value = "/{id}" ,method = RequestMethod.GET)
    @GetMapping("/{id}")    //使用@GetMapping简化GET请求方法对应的映射配置
    public String getById(@PathVariable Integer id){
        System.out.println("book getById..."+id);
        return "{'module':'book getById'}";
    }
  • 发送请求
    在这里插入图片描述
    后台：
    在这里插入图片描述
    说明验证没问题！
    其他的几类不再一一演示！
知识点1：@RestController
名称@RestController
类型类注解
位置基于SpringMVC的RESTful开发控制器类定义上方
作用设置当前控制器类为RESTful风格，
等同于@Controller与@ResponseBody两个注解组合功能
知识点2：@GetMapping @PostMapping @PutMapping @DeleteMapping
名称@GetMapping @PostMapping @PutMapping @DeleteMapping
类型方法注解
位置基于SpringMVC的RESTful开发控制器方法定义上方
作用设置当前控制器方法请求访问路径与请求动作，每种对应一个请求动作，
例如@GetMapping对应GET请求
相关属性value（默认）：请求访问路径

[声明]：内容主要来源黑马程序员网上资源学习，仅供学习参考!

fa_lsyk
关注
PostMan使用案例（1）
Learning
07-23 7122
postman客户端下载地址：https://www.getpostman.com/apps 1.接口请求的使用 第一步：将接口放URL中，选取请求方式， 第二步：填入请求头信息，参数，如果是post请求，则将参数内容放在body中。 当请求参数值从环境变量中取时，用{{}}括起来，PS：当有环境变量时，记得在右上角选择你定义的那个环境变量，不然会读取环境变量失...
postman的经典操作实例
dgx1963的博客
03-15 1031
今天我们就来说说postman这个工具的使用，具体介绍几种经典的接口测试用例。 首先打开postman这个工具，点击新增页面。 1.首先测试一个get请求的接口，其实get请求直接在浏览器就可以测试，这里呢，我们通过这个工具看看如何实现。 2.接口url地址： http://api.nnzhp.cn/api/user/login 请求post 里面包含两个参数：...
PostMan案例
littletomorrow的博客
01-12 315
REST（Representational State Transfer），表现形式状态转换传统风格资源描述形式id=1REST风格描述形式优点：隐藏资源的访问行为，无法通过地址得知对资源是何种操作书写简化按照REST风格访问资源时使用行为动作区分对资源进行了何种操作http://localhost/books 「GET」查询全部书目信息 （查询）http://localhost/books/1 「GET」查询指定书目信息（查询）
Postman基本操作实例
石头缝里的小松鼠（AlySam）
03-04 1175
1、API请求与响应 1、请求构建器 （1）、Method 使用下拉菜单，不同的请求方法的可编辑区域不同。 （2）、URL 自动拆分键值对。 （3）、Headers （4）、Body form-data：Web表单用来传输数据的默认编码； x-www-form-urlencoded：只输入键值对； raw：请求体可以发送任何格式的文本数据； binary：请求体允许用户发送不能输入的内容，如图像、音频、视频等文件及文本文件。 （5）、Cookies：单击“Send”按钮下方的“Cookies
接口测试工具-----Postman使用入门实战案例
测试领域专家，多领域测试技术、管理、工具都略懂，略懂一二
08-18 2630
这里我们会针对接口测试，重点是将Postman基本应用，其他接口基本知识，可以看看视频： https://edu.51cto.com/center/course/lesson/index?id=261168 Postman：这个是谷歌的，应用嵌套在谷歌浏览器里面，它是浏览器的一个组件，一个插件。 接口测试首先要开发提供相关的接口文档，不然我们无法进行测试，要记住。 安装方式自己百度（谷...
Java开发学习----SpringMVC之Rest风格解析及快速开发
lt_xiaodou的博客
08-29 703
REST（Representational State Transfer），表现形式状态转换,它是一种软件架构风格当我们想表示一个网络资源的时候，可以使用两种方式:传统风格资源描述形式id=1查询id为1的用户信息保存用户信息REST风格描述形式传统方式一般是一个请求url对应一种操作，这样做不仅麻烦，也不安全，因为会程序的人读取了你的请求url地址，就大概知道该url实现的是一个什么样的操作。查看REST风格的描述，你会发现请求地址变的简单了，并且光看请求URL并不是很能猜出来该URL的具体功能。...
SSM框架整合实践：Spring+SpringMVC+Mybatis案例解析
SpringMVC支持REST风格的接口设计，并能与Spring框架无缝集成。 **Mybatis框架**： Mybatis是支持定制化SQL、存储过程以及高级映射的持久层框架。Mybatis避免了几乎所有的JDBC代码和手动设置参数以及获取结果集。...
Java Web开发新贵：Spring+SpringMVC+Hibernate框架案例分析
SpringMVC支持RESTful Web服务的构建，允许开发者创建符合REST架构风格的资源服务。 #### 异常处理和数据验证 SpringMVC提供了一套灵活的异常处理机制和数据验证框架，可以轻松地对客户端请求进行校验和异常的抛出...
SpringMVC教程：掌握核心架构与设计模式
3. **强大灵活的路由和控制器**：提供了强大的映射机制，可以处理各种类型的请求，并且支持REST风格的URL映射。 4. **支持多种视图技术**：支持JSP、FreeMarker、Thymeleaf等多种视图解析技术。 5. **数据验证和格式...
SpringMVC3.1与Mybatis3.1实战案例解析
对于SpringMVC和Mybatis，需要添加核心依赖及驱动依赖等。接下来，配置web.xml文件，设置DispatcherServlet。然后，在Spring的配置文件中配置视图解析器、静态资源处理、注解驱动等。对于Mybatis，需要配置...
Postman模拟请求
06-09
研发者可以用这个工具模拟GET、POST请求，支持添加header。
postMan例子
shiyuezhong的专栏
09-25 273
var siteId="swyapp"; var param="{\"goodsId\":\"1\",\"buyCnt\":\"1\",\"scene\":\"0\",\"account\":\"127.0.0.1\",\"clientIp\":\"127.0.0.1\"}"; //var tt=new Date().getTime(); var moment = requ...
Postman 测试案例（GET、POST）
python之程的博客
07-04 3025
Postman 测试案例（GET、POST）HTTP的测试工具，使用比较方便，网站编程必不可少，而且有免费版本，可取官网上下载。对于32位机，下载Postman-win32-6.1.4-Setup.exe。下面给出两个例子，一个是GET方法，一个是POST方法。被测试程序是一个使用Flask的程序，也一并给出代码，使得可以全面体会。Flask是一个基于python的网站的框架，可使用标准的pip ...
Postman断言示例
bange2277的博客
03-21 262
我们来看一些Postman测试的例子。其中大多数都是Postman内部的片段。您可以根据需要为请求提供尽可能多的测试。 设置环境变量 pm.environment.set("variable_key","variable_value"); 将嵌套对象设置为环境变量 vararray =[1,2,3,4]; pm.environment.se...
Postman接口测试-入门级使用案例与介绍
qq_39123467的博客
04-13 877
Postman-入门级使用案例与介绍
Postman工具的实战与应用（十一）
jennifer880204的博客
08-10 4680
Postman为本地应用程序，要安装postman的方式有二种，第一种方式是以chrome浏览器插件的方式安装，需要到chrome官方应用商店才可以安装，在chrome://extensions中 可查看已安装的插件。另外一种方式是直接到：https://www.getpostman.com下载，对应的平台分别为windows,mac,以及linux，可依据自己的平台来进行选择的安装。安装很
postman接口测试教程与实例分享
最新发布
A18285759691的博客
11-28 831
在gold_add 接口中，{{username}} 由于在环境变量"user_pwd" 中已经设置，可以直接输入变量名, {{sign}} 动态取得login接口中 Response 的 "sign" 值，{{sign}}已在上面login 请求的"Tests" 中定义。格式，在key 里输入"file"，在右边的下拉里选取类型为"File"，点击"Choose Files" 就可以上传本地文件了。输入需要的key 以及value， 点击"Send"， 即可在"Response" 中查看返回的结果。
postman+jmeter接口实例 ,你要的这里都有
HB8888888的博客
02-25 1506
接口基础 一、为什么要单独测试接口？ 1. 程序是分开开发的，前端还没有开发，后端已经开发完了，可以提前进入测试 2. 接口直接返回的数据------越底层发现bug，修复成本是越低的 3. 接口测试能模拟功能测试不能测到的异常情况，例如修改订单金额 二、get请求和post请求 两者的区别： get请求向服务端获取数据的 ，post请求向服务端发送数据 get传参写在url或cookie中 ，post将数据放在body中 get请求没有请求体，只有请求头，post有请求头和请求体 get.
postman使用实例演示、例子
weixin_30606669的博客
01-16 2016
先举例已经对接的前端后端代码，在说明postman中该如何写。 一、前端后端已经对接的案例： 　　 注意点：1. 由图中标注一看出此次post请求是以form表单形式提交的（content-type:application/x-www-form-urlencoded;）。 　　　　　　2. 标注二，detailId这个参数是String 格式；在前端使用 JSON.stringify 将...
评论
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

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

抵扣说明：

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

余额充值