【SpringMVC】REST(Representation State Transfer)ful开发

REST全称Representation State Transfer,表现形式状态转换

文章目录

  • 1. 为什么提出了REST?
  • 2. RESTful入门案例
    • 案例代码
    • 修改请求方式
      • 修改成RESTful风格,并以POST方式提交
    • RESTful格式下传参
    • RESTful入门案例总结
    • @RequestBody,@RequestParam,@PathVariable总结
  • 3. RESTful快速开发
    • 第一次修改
    • 第二次修改
    • 快速开发注解总结
  • 4. RESTful案例开发
    • 案例代码(一些config的设定和domain等)
    • 后台Controller的开发

1. 为什么提出了REST?

传统风格资源描述形式:

  • http://localhost/user/getById?id=1
  • http://localhost/user/saveUser

REST风格描述形式:

  • http://localhost/user/1
  • http://localhost/user

REST风格优点:

  • 隐藏资源的访问行为,无法通过地址得知对资源是何种操作(REST风格描述的第二项既可以描述一个saveUser操作,也可以描述一个updateUser操作)
  • 书写简化

按照REST风格访问资源时使用行为动作区分对资源进行了何种操作,根据REST风格对资源进行访问称为RESTful

地址作用行为动作
http://localhost/users查询全部用户信息GET (查询)
http://localhost/user/1查询指定用户信息GET (查询)
http://localhost/users添加用户信息POST (新增/保存)
http://localhost/users修改用户信息PUT (修改/更新)
http://localhost/users/1删除用户信息DELETE (删除)

注: 上述行为是约定方式,约定不是规范,可以打破,所以称REST风格,而不是REST规范
描述模块的名称通常使用复数,也就是加s的格式描述,表示此类资源,而非单个资源,例如:users、books、accounts

2. RESTful入门案例

案例代码

config/ServletContainerInitConfig.java

package com.demo.config;

import org.apache.ibatis.jdbc.Null;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.filter.CharacterEncodingFilter;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
import org.springframework.web.servlet.support.AbstractDispatcherServletInitializer;

import javax.servlet.Filter;

public class ServletContainerInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }

    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

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

config/SpringMvcConfig.java

package com.demo.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

@Configuration
@ComponentScan("com.demo.controller")
@EnableWebMvc
public class SpringMvcConfig {
}

controller/BookController.java

package com.demo.controller;

import com.demo.domain.Book;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@Controller
public class BookController {

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

    @RequestMapping(value = "/books", 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 update'}";
    }
}

controller/UserController.java

package com.demo.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
public class UserController {

    @RequestMapping("/save")
    @ResponseBody
    public String save(){
        System.out.println("User save...");
        return "{'module': 'springmvc'}";
    }

    @RequestMapping("/delete")
    @ResponseBody
    public String delete(Integer id){
        System.out.println("User delete..." + id);
        return "{'module': 'springmvc'}";
    }

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

domain/User.java

package com.demo.domain;

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

    Address address;

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

    public Address getAddress() {
        return address;
    }

    public void setAddress(Address address) {
        this.address = address;
    }

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

domain/Book.java

package com.demo.domain;

public class Book {
    String bookName;
    String issn;

    @Override
    public String toString() {
        return "Book{" +
                "bookName='" + bookName + '\'' +
                ", issn='" + issn + '\'' +
                '}';
    }

    public String getBookName() {
        return bookName;
    }

    public void setBookName(String bookName) {
        this.bookName = bookName;
    }

    public String getIssn() {
        return issn;
    }

    public void setIssn(String issn) {
        this.issn = issn;
    }
}

修改请求方式

测试一下UserController中的三个方法:
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

修改成RESTful风格,并以POST方式提交

将两个方法上的@RequestMapping注解,均新增一个method属性,并修改value属性,如下:

@RequestMapping(value = "/users", method = RequestMethod.POST)
@RequestMapping(value = "/users", method = RequestMethod.DELETE)
@RequestMapping(value = "/users", method = RequestMethod.PUT)

再运行,发现可以运行(注意,Postman中请求的模式要记得修改):
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述

RESTful格式下传参

我们的delete方法中是有参数的,那在RESTful风格下,我们的路径是localhost/delete/1,那这个1怎么传到方法中的id里呢?
应该在路径后面接上{variable name}来表示我们想要传递的参数,这里variable name填写的应该是方法中的参数名;并在方法的参数前面使用@PathVariable注解声明该变量来自路径。例如:

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

但对于像Update方法中这种传User这种POJO数据(注意 Integer不算POJO数据)的,则不需要做改动
修改后请求delete方法如下
在这里插入图片描述
请求update方法仍然是将JSON数据转换为POJO,
在这里插入图片描述

RESTful入门案例总结

想要使用RESTful风格,步骤如下:

  1. 设定http请求动作(动词),如Request.POST, Request.PUT, Request.GET, Request.Delete等
  2. 设定请求参数(路径变量),在请求路径中使用{variable name}添加请求参数,方法中的参数前使用@PathVariable进行注解

@RequestBody,@RequestParam,@PathVariable总结

区别:

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

应用:

  • 后期开发中,发送请求参数超过1个时,以JSON格式为主,@RequestBody应用较广
  • 发送非JSON格式数据,选用@RequestParam接收请求参数
  • 采用RESTful开发,当参数量较少时,例如1个,可以采用@PathVariable接收请求路径变量,通常用于传递id值。当然也可以通过@PathVariable注解接收多个请求路径变量,但多个变量主要还是用JSON

3. RESTful快速开发

入门案例中存在一个问题,如下(下边以BookController为例讲解),红框中内容重复,应该简化掉:
在这里插入图片描述

第一次修改

针对于这个问题,我们首先可以将@RequestMapping作为类注解写在类上,@ResponseBody也可以作为类注解写在类上。但有一个更简便的办法:@RestController注解包含了@Controller@ResponseBody,最终修改如下:

package com.demo.controller;

import com.demo.domain.Book;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@RequestMapping("books")
@RestController
public class BookController {

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

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

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

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

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

第二次修改

修改完以后,代码里又存在大量的@RequestMapping(method=...),也挺冗余的,可以做如下修改:
@RequestMapping(method = RequestMethod.xxx)替换成@xxxMapping
如果在@RequestMapping中还有表示参数的value,就在@xxxMapping后加上(参数路径),比如@xxxMapping("/{id}")
所有代码再次修改如下:

package com.demo.controller;

import com.demo.domain.Book;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.*;

@RequestMapping("books")
@RestController
public class BookController {

    @PostMapping
    public String save(@RequestBody Book book){
        System.out.println("book save ...");
        return "{'module': 'book save'}";
    }

    @DeleteMapping("/{id}")
    public String delete(@PathVariable Integer id){
        System.out.println("book delete ..." + id);
        return "{'module': 'book delete'}";
    }

    @PutMapping
    public String update(@RequestBody Book book){
        System.out.println("book update ..." + book);
        return "{'module': 'book update'}";
    }

    @GetMapping("/{id}")
    public String getById(@PathVariable Integer id){
        System.out.println("book getById ..." + id);
        return "{'module': 'book getById'}";
    }

    @GetMapping
    public String getAll(){
        System.out.println("book getAll ...");
        return "{'module': 'book update'}";
    }
}

逐项进行测试:
在这里插入图片描述

在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
在这里插入图片描述
控制台输出:
在这里插入图片描述

快速开发注解总结

  1. @RestController:类注解,在控制器类上方进行定义,设置当前控制器为RESTful风格,等同于@Controller@ResponseBody两个注解组合功能
  2. @GetMapping,@PostMapping,@PutMapping,@DeleteMapping:方法注解,注解在SpringMVC的RESTful开发控制器方法上方,其作用是设置当前控制器方法访问路径与请求动作,每种对应一个请求动作

4. RESTful案例开发

我们在这个案例下的目标是通过RESTful实现案例交互:发送RESTful请求,获取数据后在页面中展示结果

案例代码(一些config的设定和domain等)

config/SevletContainerInitConfig.java

package com.demo.config;

import org.apache.ibatis.jdbc.Null;
import org.springframework.web.context.WebApplicationContext;
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
import org.springframework.web.filter.CharacterEncodingFilter;
import org.springframework.web.servlet.support.AbstractAnnotationConfigDispatcherServletInitializer;
import org.springframework.web.servlet.support.AbstractDispatcherServletInitializer;

import javax.servlet.Filter;

public class ServletContainerInitConfig extends AbstractAnnotationConfigDispatcherServletInitializer {
    @Override
    protected Class<?>[] getRootConfigClasses() {
        return new Class[0];
    }

    @Override
    protected Class<?>[] getServletConfigClasses() {
        return new Class[]{SpringMvcConfig.class};
    }

    @Override
    protected String[] getServletMappings() {
        return new String[]{"/"};
    }

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

config/SpringMvcConfig.java

package com.demo.config;

import org.springframework.context.annotation.ComponentScan;
import org.springframework.context.annotation.Configuration;
import org.springframework.web.servlet.config.annotation.EnableWebMvc;

@Configuration
@ComponentScan("com.demo.controller")
@EnableWebMvc
public class SpringMvcConfig {
}

domain/Book.java

package com.demo.domain;

public class Book {
    private Integer id;
    private String type;
    private String name;
    private String description;

    @Override
    public String toString() {
        return "Book{" +
                "id=" + id +
                ", type='" + type + '\'' +
                ", name='" + name + '\'' +
                ", description='" + description + '\'' +
                '}';
    }

    public Integer getId() {
        return id;
    }

    public void setId(Integer id) {
        this.id = id;
    }

    public String getType() {
        return type;
    }

    public void setType(String type) {
        this.type = type;
    }

    public String getName() {
        return name;
    }

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

    public String getDescription() {
        return description;
    }

    public void setDescription(String description) {
        this.description = description;
    }
}

后台Controller的开发

写一个save方法和一个getAll方法

package com.demo.controller;

import com.demo.domain.Book;
import org.springframework.web.bind.annotation.*;

import java.util.ArrayList;
import java.util.List;

@RestController
@RequestMapping("/books")
public class BookController {

    @PostMapping
    public String save(@RequestBody Book book){
        System.out.println("book save ==> " + book);
        return "{'module':'book save success'}";
    }

    @GetMapping
    public List<Book> getAll(){
        Book book1 = new Book();
        book1.setType("计算机");
        book1.setName("SpringMVC1111");
        book1.setDescription("小试牛刀");

        Book book2 = new Book();
        book2.setType("计算机");
        book2.setName("SpringMvc2222");
        book2.setDescription("一代宗师");

        List<Book> bookList = new ArrayList<>();
        bookList.add(book1);
        bookList.add(book2);
        return bookList;
    }

}

启动Tomcat容器进行测试
在这里插入图片描述
在这里插入图片描述
前端使用了ElementUI+Vue,但是我目前不太记得这个东西了(等我弄清楚了再来这里补充),可以先转去视频,里边有很详细的介绍完整的案例开发:Bilibili-基于RESTful的页面数据交互

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

如若内容造成侵权/违法违规/事实不符,请联系我们进行投诉反馈qq邮箱809451989@qq.com,一经查实,立即删除!

相关文章

2023 Intellij IDEA的热部署配置

第一步&#xff1a;导入依赖 <!--热部署--><dependency><groupId>org.springframework.boot</groupId><artifactId>spring-boot-devtools</artifactId></dependency>第二步&#xff1a;配置idea

【Git 小妙招】学习多人协作场景(万字图文讲解+实战练习)

文章目录 前言1. 多人协作(场景一)2. 多人协作(场景二)3. 解决一个问题总结 前言 还记得我们学习 Git 是为了什么吗? 当然是实现多人协作了. 在学习了解博主前面关于 Git 的文章后, 我们就可以模拟来进行一些超超超简单的多人协作场景了. 本文就简单举两个多人协作的例子. 关…

C++ 强制类型转换static_cast<typeName>

C允许通过强制类型转换机制显式地进行类型转换。强制类型转换的格式有两种。 如&#xff1a; 为将存储在变量nData中的int值转换为long类型&#xff0c;可以使用下面的表达式中的一种&#xff1a; (long)nData …

Unity 问题 之 ScrollView ,LayoutGroup,ContentSizeFitter 一起使用时,动态变化时无法及时刷新更新适配界面的问题

Unity 问题 之 ScrollView ,LayoutGroup,ContentSizeFitter 一起使用时&#xff0c;动态变化时无法及时刷新更新适配界面的问题 目录 Unity 问题 之 ScrollView ,LayoutGroup,ContentSizeFitter 一起使用时&#xff0c;动态变化时无法及时刷新更新适配界面的问题 一、简单介绍…

js中将数字转成中文

文章目录 一、实现二、最后 一、实现 如果要将数字10、100和1000转换成中文的"十"、“一百"和"一千”&#xff0c;可以使用以下 JavaScript 代码实现&#xff1a; function numberToChinese(num) {const chineseNums [零, 一, 二, 三, 四, 五, 六, 七, …

最新版 JESD79-5B,2022年,JEDEC 内存SDRAM规范

本标准定义了DDR5 SDRAM规范&#xff0c;包括特性、功能、交流和直流特性、封装以及球/信号分配。本标准旨在为x4、x8和x16 DDR5 SDRAM设备定义符合JEDEC标准的8 Gb至32 Gb的最低要求。该标准是基于DDR4标准&#xff08;JESD79-4&#xff09;和DDR、DDR2、DDR3和LPDDR4标准的一…

IP应用场景的规划

IP地址作为互联网通信的基石&#xff0c;在现代社会中扮演着至关重要的角色。本文将深入探讨IP地址在不同应用场景中的规划与拓展&#xff0c;探讨其在网络通信、安全、商业、医疗和智能城市等领域的关键作用与未来发展趋势。 IP地址的基本原理 IP地址是分配给网络上设备的数…

NC65 查询单据所处的流程状态以及流程平台客户端工具类

1、查询单据所处的流程状态 nc.bs.wfengine.engine.EngineService的queryFlowStatus()方法 /*** 查询单据所处的流程状态* * param billId* param billType* param result* return* throws DbException*/public int queryFlowStatus(String billId, String billType, int flo…

每日一练2023.12.23——考试座位号【PTA】

题目链接&#xff1a;L1-005 考试座位号 题目要求&#xff1a; 每个 PAT 考生在参加考试时都会被分配两个座位号&#xff0c;一个是试机座位&#xff0c;一个是考试座位。正常情况下&#xff0c;考生在入场时先得到试机座位号码&#xff0c;入座进入试机状态后&#xff0c;系…

手机无人直播:解放直播的新方式

现如今&#xff0c;随着科技的迅猛发展&#xff0c;手机已经成为我们生活中不可或缺的一部分。除了通讯、娱乐等功能外&#xff0c;手机还能够通过直播功能将我们的生活实时分享给他人。而针对传统的直播方式&#xff0c;使用手机进行无人直播成为了一种全新的选择。 手机无人…

聊聊软件行业那些事

博主介绍&#xff1a;✌全网粉丝5W&#xff0c;全栈开发工程师&#xff0c;从事多年软件开发&#xff0c;在大厂呆过。持有软件中级、六级等证书。可提供微服务项目搭建与毕业项目实战&#xff0c;博主也曾写过优秀论文&#xff0c;查重率极低&#xff0c;在这方面有丰富的经验…

2023-12-22 linux C语言pthread_kill函数,pthread_kill(tid, 0)可以用来判断线程是否存在

一、该函数其实不是kill线程&#xff0c;而是向线程发送一个signal&#xff0c;pthread_kill()函数的作用是向某个线程传递一个信号&#xff0c;创建的线程中signal(SIGKILL,sig_handler)函数去处理对应的信号&#xff0c;如果你给一个线程发送了SIGQUIT、SIGKILL&#xff0c;但…

【vue】开发常见问题及解决方案

有一些问题不限于 Vue&#xff0c;还适应于其他类型的 SPA 项目。 1. 页面权限控制和登陆验证页面权限控制 页面权限控制是什么意思呢&#xff1f; 就是一个网站有不同的角色&#xff0c;比如管理员和普通用户&#xff0c;要求不同的角色能访问的页面是不一样的。如果一个页…

华为鸿蒙(HarmonyOS):连接一切,智慧无限

华为鸿蒙是一款全场景、分布式操作系统&#xff0c;旨在构建一个真正统一的硬件生态系统。该操作系统于2019年8月首次发布&#xff0c;并被设计为可以应用于各种设备&#xff0c;包括智能手机、智能手表、智能电视、车载系统等多种智能设备。 推荐一套最新版的鸿蒙4.0开发教程 …

深度剖析:Golang中结构体方法的高级应用

深度剖析&#xff1a;Golang中结构体方法的高级应用 引言结构体方法的基础回顾结构体的定义和用法方法的定义和绑定基本语法和用法 高级特性与应用封装、继承和多态方法集与接口的关系结构体方法的匿名字段和嵌入结构体 性能优化与最佳实践接收器类型的选择&#xff1a;指针还是…

【QT八股文】系列之篇章1 | QT的基础知识及事件/机制

【QT八股文】系列之篇章1 | QT的基础知识及事件/机制 前言0. 基础Qt/PyQt5介绍/关联Qt的优缺点&#xff08;为什么要用qt来做界面&#xff09;Qt 的核心机制请简要介绍一下Qt中的主窗口&#xff08;MainWindow&#xff09;类&#xff0c;它有哪些重要的函数和成员变量&#xff…

【K8s】1# 使用kuboard-spray安装K8s集群

文章目录 搭建k8s集群1.推荐配置1.1.服务器配置1.2.软件版本 2.使用Kuboard-Spray安装k8s集群2.1.配置要求2.2.操作系统兼容性2.3.安装 Kuboard-Spray2.4.加载离线资源包2.5.规划并安装集群2.6.安装成功2.7.访问集群 3.涉及的命令3.1.linux 4.问题汇总Q1&#xff1a;启动离线集…

MES系统怎么实现车间管理中的生产计划和排产计划

MES中的生产计划和排产计划都是制造企业中非常重要的概念&#xff0c;它们的目的是为了确保企业能够按时交付高质量的产品&#xff0c;同时还要保持生产效率和成本效益。 一、生产计划 生产计划是指制造企业为了满足客户需求而制定的计划&#xff0c;它包括了制造的数量、时间…

C++类与对象(中)第一篇

目录 前言&#xff1a; 类的六个默认成员函数 构造函数 析构函数 拷贝构造函数 拷贝场景一&#xff1a;函数参数类型为类类型对象 拷贝场景二&#xff1a;利用已存在的对象创建新对象 拷贝场景三&#xff1a;函数返回值类型为类类型对象 前言&#xff1a; 编译器编译类…

JavaScript原型,原型链 ? 有什么特点?

一、原型 JavaScript 常被描述为一种基于原型的语言——每个对象拥有一个原型对象 当试图访问一个对象的属性时&#xff0c;它不仅仅在该对象上搜寻&#xff0c;还会搜寻该对象的原型&#xff0c;以及该对象的原型的原型&#xff0c;依次层层向上搜索&#xff0c;直到找到一个…