SpringMVC（三）【REST 风格】

news2024/11/18 9:06:35

1、REST 风格

1.1、REST 简介

  • REST（Representational State Transfer），表现形式状态转换

        在开发中，它其实指的就是访问网络资源的格式

1.1.1、传统风格资源描述形式

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

1.1.2、REST 风格描述形式

在 REST 风格中，一般用 模块名 + s 的格式描述资源，表示这是一类资源，而不是单个资源。

4 个常用的 REST 风格请求行为：

  • http://localhost/users        查询所有用户信息        GET （查询）
  • http://localhost/users/1        查询指定用户信息        GET （查询）
  • http://localhost/users        添加用户信息        POST （新增）
  • http://localhost/users        修改用户信息        PUT （更新）
  • http://localhost/users/1        删除用户信息        DELETE （删除）

        REST 风格下，对于同一个路径，不同的请求代表对资源不同的操作。也就是说，我们只需要一个路径和一个请求方式就可以确定一个访问行为。

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

优点：

  1. 最大在优点就是隐藏资源的访问行为，无法通过地址得到对资源是如何操作的

注意：REST 风格只是一种风格，并不是一种规范，可以打破。也就是说我们想怎么写就怎么写，但是我们只是希望大家都遵守这种风格，方便开发。

1.2、RESTful 入门案例

        RESTful 就是指使用 REST 风格开发项目。

1.2.1、设定 http 请求动作

        REST 风格下，我们对资源的不同操作由路径和请求动作决定，这里的路径我们统一为 模块名 + s，所以我们需要把 Controller 类上面的 @RequsetMapping 中指定的该模块资源的统一前缀去掉。

        添加请求动作只需要先把原本 Controller 类的方法上 RequsetMapping 注解的参数改为 模块名 + s  ，然后通过 method 属性来给方法添加请求动作。

        查询都是 GET、新增是 POST 、修改是 PUT、删除是 DELETE。

    @RequestMapping(value = "/users",method = RequestMethod.POST)
    @ResponseBody
    public String save(@RequestBody User user){
        System.out.println("user save,  name = " + user.getName() + " , age = " + user.getAge());
        return "{'module':'user save'}";
    }

         这里的新增用户请求需要传递用户参数，这里我们通过 @RequestBody 注解来表示从请求体中获取参数，也就是通过 json 来传递。

1.2.2、设定请求路径参数

        也就是我们控制器类方法上面的注解 @RequsetMapping 中的 value 参数，这里需要根据需求决定需不需要带参数（比如删除 name 为 'zs' 的用户，那就需要指定 value="/users/name" 而不只是模块名+s）。

        此外，对于带有路径变量的请求参数需要给形参前面添加注解 @PathVariable ，表示从请求路径中解析出该变量当做形参的值。

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

 完整代码：

@Controller
public class UserController {

    @RequestMapping(value = "/users",method = RequestMethod.POST)
    @ResponseBody
    public String save(@RequestBody User user){
        System.out.println("user save,  name = " + user.getName() + " , age = " + user.getAge());
        return "{'module':'user save'}";
    }

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

    @RequestMapping(value = "/users",method = RequestMethod.PUT)
    @ResponseBody
    public String update(@RequestBody User user){
        System.out.println("user deleted ... user => " + user.toString());
        return "{'module': 'user update'}";
    }

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

    @RequestMapping(value = "/users",method = RequestMethod.GET)
    @ResponseBody
    public String getAll(){
        System.out.println("user get all ...");
        return "{'module': 'user get all'}";
    }
}

测试结果：

查询所有用户：

查询 id 为 1 的用户：

新增用户：

 

注意：新增用户时我们需要给控制器方法传递一个 User 类型创参数，因为需要使用 jackson 把我们的 json 转为 java 对象，这里要求该对象必须要有无参构造器，不然会报错！

删除用户：

修改用户：
 

1.2.3、请求参数总结

到现在我们共学习了三种请求参数的传递方法：

  1. @RequestBody
  2. @RequestParam（用的比较少）
  3. @PathVariable

1.3、RESTful 快速开发

        这一节我们来对上面的代码进行简化开发，比如所有的控制器方法的前缀都是 "/users" ，所有的控制器方法上面都有一个 @ResponseBody （因为我们不需要返回页面）。

1.3.1、统一路径前缀

        上一节使用 REST 风格后，我们发现所有的请求路径的前缀都是 "/users" + 路径变量，所以既然都有一个前缀 "/users" ，那么为什么不可以都踢出来呢：

@RequestMapping("/users")
public class UserController {
    // ...
}

        这样，对于那些在 REST 风格下路径本来就是 模块名+s（"/users"）的方法，直接就可以直接省去 @RequestMapping 中的 value 属性，对于请求路径包含路径变量的方法，可以省去前缀，就像这样：

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

1.3.2、@RestController

        从上一节我们的代码中可以发现，控制器类的方法都带有一个 @ResponseBody ，这是因为因为我们不需要返回页面。所以这里我们可以直接简化把它提到控制器类上面：

@Controller
@ResponseBody
@RequestMapping("/users")
public class UserController {
    // ...
}

        但是 SpringMVC 还是觉得不够简化，它又提供了一个注解 @RestController ，它就相当于同时包含了 @ResponseBody 和 @Controller 两个注解，毕竟控制器类上面肯定是由 @Controller 注解的。所以以后我们直接这么写就行了：

@RestController
@RequestMapping("/users")
public class UserController {
    // ...
}

1.3.2、标准请求动作注解

        经过上一步的简化，我们的 UserController 现在变成了这样：

@RestController
@RequestMapping("/users")
public class UserController {

    @RequestMapping(method = RequestMethod.POST)
    public String save(@RequestBody User user){
        System.out.println("user save,  name = " + user.getName() + " , age = " + user.getAge());
        return "{'module':'user save'}";
    }

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

    @RequestMapping(method = RequestMethod.PUT)
    public String update(@RequestBody User user){
        System.out.println("user deleted ... user => " + user.toString());
        return "{'module': 'user update'}";
    }

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

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

        现在看起来还是很冗余，我们可以对这些方法的请求行为进行进一步简化，现在这么长的参数太扎眼了，现在我们的代码就变成了这样（把 value =  "/{param}" 和  method = RequestMethpd.X 合并到一个注解中）：

@RestController
@RequestMapping("/users")
public class UserController {

    @PostMapping
    public String save(@RequestBody User user){
        System.out.println("user save,  name = " + user.getName() + " , age = " + user.getAge());
        return "{'module':'user save'}";
    }

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

    @PutMapping
    public String update(@RequestBody User user){
        System.out.println("user deleted ... user => " + user.toString());
        return "{'module': 'user update'}";
    }

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

    @GetMapping
    public String getAll(){
        System.out.println("user get all ...");
        return "{'module': 'user get all'}";
    }
}

显然一下子变得清新脱俗！舒服多了。

1.4、基于 RESTful 页面数据交互

  实体类：

package com.lyh.domain;

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

    public Book(){}

    public Book(Integer id, String type, String name, String description) {
        this.id = id;
        this.type = type;
        this.name = name;
        this.description = 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;
    }
}

SpringMVC 配置类：

@Configuration
@ComponentScan("com.lyh.controller") // 扫描
@EnableWebMvc // 开启 json 转对象的功能等各种格式转换
public class SpringMvcConfig {

}

Sevlet 容器配置类：

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

BookController 控制器类：

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


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

    @GetMapping
    public List<Book> getAll(){
        List<Book> list = new ArrayList<Book>();
        list.add(new Book(1,"编程","《图解Spark》","大数据技术"));
        list.add(new Book(2,"小说","《黄金时代》","王小波著作"));
        return list;
    }
}

测试：

        导入静态资源后访问 localhost:85/pages/boos.html 发现报错找不到映射：No Mapping for GET /pages/books.html 这是因为我们现在的请求都被 SpringMVC 拦截走了，其实这些静态资源应该是由 Tomcat 处理的。

1.4.1、放行非 SpringMVC 请求

        上面的问题是对于静态资源的访问，本该是由 Tomcat 处理，但是前面我们在 Servlet 配置类中设置了所有请求都由 SpringMVC 来响应。所以，现在我们需要通过添加一个配置类来实现放行静态资源：

@Configuration
public class SpringMvcSupport extends WebMvcConfigurationSupport {

    @Override
    protected void addResourceHandlers(ResourceHandlerRegistry registry) {
        // 当访问 /pages/下的资源时,走 /pages 目录下的内容
        registry.addResourceHandler("/pages/**").addResourceLocations("/pages/");
        registry.addResourceHandler("/js/**").addResourceLocations("/js/");
        registry.addResourceHandler("/css/**").addResourceLocations("/css/");
        registry.addResourceHandler("/plugins/**").addResourceLocations("/plugins/");
        }
}

        然后，我们需要让 SpringMVC 去加载这个新的配置类：

这样就可以访问到了：

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

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

相关文章

吴恩达机器学习笔记 三十五 异常检测与监督学习

吴恩达机器学习笔记 三十五 异常检测与监督学习

什么时候选择异常检测&#xff1f; 正样本 ( y 1 ) 的数量非常少 负样本 ( y 0 ) 的数量非常多 有很多不同的异常&#xff0c;现有的算法不能从正样本中得知什么是异常&#xff0c;或未来可能出现完全没见过的异常情况。 例如金融欺诈&#xff0c;隔几个月或几年就有新的…
阅读更多...
智慧公厕是如何诞生的？

智慧公厕是如何诞生的？

在城市化进程中&#xff0c;公共卫生设施的建设一直是重要议题之一。而随着科技的不断发展&#xff0c;智慧公厕作为一种创新的解决方案&#xff0c;逐渐成为了现代城市管理的亮点。那么&#xff0c;智慧公厕是如何产生的呢&#xff1f; 一、城市化进程的推动 城市人口的增加和…
阅读更多...
vue elmentui 可编辑table 实现

vue elmentui 可编辑table 实现

废话不多说上图&#xff1a; 1.可编辑input 2.可编辑下来框 3.点击chechbox 4.可编辑radio 其实后面两种可以直接显示值 需要修改直接改就行 保持风格统一所以就做了点击之后出现修改功能 上代码&#xff0c;不要哔哔 哈哈 粗暴 真得是曲不离口 拳不离手&#xff0c; 几天…
阅读更多...
java学习笔记5

java学习笔记5

9. 类和对象 9.1 类 9.1.1 类的定义 ​ 类是具有相同属性和方法的具体实例的集合，类是对象的抽象，对象是类的具体实例 9.1.2 类语法 public class 类名{// 1. 属性public 变量的类型 变量名称1;public 变量的类型 变量名称2;...// 2. 方法public void 方法1(){}public v…
阅读更多...
pandas/python 一个实战小案例

pandas/python 一个实战小案例

上次写坦克游戏的时候&#xff0c;接触了一点pandas&#xff0c;当时只是简单了解了一下如何遍历行和列并获取值来替换图片&#xff0c;想更多了解pandas。正好有一些数据需要筛选&#xff0c;试试能不能用通过代码实现。虽然总的来说不复杂&#xff0c;但由于原始数据在命名、…
阅读更多...
【重要】Perplexity订阅问题看这一篇就够了！Perplexity免费版和订阅版区别？免费使用G|P|T-4！

【重要】Perplexity订阅问题看这一篇就够了！Perplexity免费版和订阅版区别？免费使用G|P|T-4！

常见问题 Q&#xff1a;Perplexity是什么&#xff1f;Perplexity有什么用&#xff1f; A&#xff1a;Perplexity是一个AI搜索引擎&#xff0c;可以理解为可以检索网络结果的G|P|T&#xff0c;尤其是选中“Academic”后支持特定学术论文的检索。并且文献是真是可查到的而不是G|P…
阅读更多...
启明智显应用分享|基于ESP32-S3方案的SC01PLUS彩屏与chatgpt融合应用DEMO

启明智显应用分享|基于ESP32-S3方案的SC01PLUS彩屏与chatgpt融合应用DEMO

今天将带大家真实体验科技与智慧的完美融合——SC01PLUS与ChatGPT的深度融合DEMO效果呈现。 彩屏的清晰显示与ChatGPT的精准回答&#xff0c;将为我们带来前所未有的便捷与高效。 SC01PLUS是启明智显基于ESP32-S3打造的一款3.5寸480*320分辨率的彩屏产品&#xff0c;您可以看…
阅读更多...
【算法刷题 | 回溯思想 06】4.17（子集、子集||）

【算法刷题 | 回溯思想 06】4.17（子集、子集||）

文章目录 9.子集9.1题目9.2解法&#xff1a;回溯9.2.1回溯思路&#xff08;1&#xff09;函数返回值以及参数&#xff08;2&#xff09;终止条件&#xff08;3&#xff09;遍历过程 9.2.2代码实现 10.子集 ||10.1题目10.2解法&#xff1a;回溯10.2.1回溯思路10.2.2代码实现 9.子…
阅读更多...
SpringBoot集成EasyExcel 3.x：高效实现Excel数据的优雅导入与导出

SpringBoot集成EasyExcel 3.x：高效实现Excel数据的优雅导入与导出

目录 介绍 快速开始 引入依赖 简单导出 定义实体类 自定义转换器 定义接口 测试接口 复杂导出 自定义注解 定义实体类 数据映射与平铺 自定义单元格合并策略 定义接口 测试接口 一对多导出 自定义单元格合并策略 测试数据 简单导入 定义接口 测试接口 参…
阅读更多...
畅游网络：构建C++网络爬虫的指南

畅游网络：构建C++网络爬虫的指南

概述 随着信息时代的来临&#xff0c;网络爬虫技术成为数据采集和网络分析的重要工具。本文旨在探讨如何运用C语言及其强大的cpprestsdk库构建一个高效的网络爬虫&#xff0c;以便捕捉知乎等热点信息。为了应对IP限制的挑战&#xff0c;我们将引入亿牛云爬虫代理服务&#xff…
阅读更多...
【网络设备巡检命令】--思科、华为、H3C、锐捷

【网络设备巡检命令】--思科、华为、H3C、锐捷

【网络设备巡检命令】--思科、华为、H3C、锐捷 一、思科二、华为三、H3C四、锐捷 &#x1f496;The Begin&#x1f496;点点关注&#xff0c;收藏不迷路&#x1f496; 一、思科 1、查看系统信息&#xff1a; show version2、查看时间&#xff1a; show clock3、查看序列号&a…
阅读更多...
友思特应用 | 红外视角的延伸：短波红外相机的机器视觉应用

友思特应用 | 红外视角的延伸：短波红外相机的机器视觉应用

导读 短波红外SWIR在不同波段针对不同材料的独特成像特征为各领域检测应用的拓宽提供了基础。本文将展现短波红外成像技术在水分检测、塑料检测、太阳能电池板检查和矿场开采等领域的丰富应用案例&#xff0c;讨论短波红外相机在未来的发展方向。 SWIR 背景简介 短波红外 &am…
阅读更多...
【vue】el-tree的新增/编辑/删除节点

【vue】el-tree的新增/编辑/删除节点

1、概述 关于树形结构的新增同级节点&#xff0c;新增子级节点&#xff0c;修改节点名称&#xff0c;删除节点等四种操作&#xff0c;各种参数配置完全继承el-tree&#xff0c;本篇使用vue2 element-ui 2、效果图展示 3、调用方式 <template><Tree:data"tree…
阅读更多...
前后端跨域请求代码实战（vue3.4+springboot2.7.18）

前后端跨域请求代码实战（vue3.4+springboot2.7.18）

前端代码 v3.4.21&#xff08;前端不是主业&#xff0c;所以就贴一贴代码&#xff0c;有疑问评论区见&#xff09;后端代码&#xff0c;springboot 2.7.18&#xff08;后端&#xff09; 文章内容&#xff1a; 一&#xff0c;后端代码 二&#xff0c;前端代码 三&#xff0c;后…
阅读更多...
美创科技19周年数据安全案例展

美创科技19周年数据安全案例展

2005-2024 践行“让数据更安全&#xff0c;更有价值”的使命 美创19年砌垒&#xff0c;与不同行业用户 一同筑牢数字之基 美创19周年案例展 走进这段时间长廊 探索美创与各行业伙伴的数据安全实践 #1 数据安全体系化建设 浙江省&#xff0c;数字化改革先行地。以数字化…
阅读更多...
进程间通信（1）管道

进程间通信（1）管道

我最近开了几个专栏&#xff0c;诚信互三&#xff01; > |||《算法专栏》&#xff1a;&#xff1a;刷题教程来自网站《代码随想录》。||| > |||《C专栏》&#xff1a;&#xff1a;记录我学习C的经历&#xff0c;看完你一定会有收获。||| > |||《Linux专栏》&#xff1…
阅读更多...
抖音小店怎么做？新手起店只需三步，看这一篇就够了

抖音小店怎么做？新手起店只需三步，看这一篇就够了

大家好&#xff0c;我是电商笨笨熊 抖音小店现如今已经人尽皆知&#xff0c;只因为让不少的普通玩家有了做电商的机会。 但是对于新手小白来说&#xff0c;做抖店一定不要盲目&#xff0c;此项目固然能让众多人从个人走到团队化&#xff0c;但也要掌握方法。 所以今天我们就…
阅读更多...
半导体存储电路知识点总结

半导体存储电路知识点总结

目录 一、SR锁存器 1.SR锁存器的概念 2.作用 二、电平触发器&#xff08;Flip-Flop&#xff09; 1.时钟信号 2.电平触发的触发器电路结构 3.带异步置位复位的电平触发器 三、边沿触发器 1.特点 2.两个D触发器组成的边沿触发D触发器 3.CMOS边沿触发D触发器的典型电路 …
阅读更多...
通过PyCharm平台开发Django应用程序

通过PyCharm平台开发Django应用程序

学会使用命令行工具开发Django应用程序是基础&#xff0c;不过更多的时候还是要借助平台开发工具。目前&#xff0c;最好的Django应用程序开发工具就是jetBrains公司推出的PyCharm平台了。 借助PyCharm开发平台&#xff0c;可以极大提高开发Django应用程序的效率&#xff0c;同…
阅读更多...
R语言中的execl数据转plink

R语言中的execl数据转plink

文章目录 带出外部连接的方式添加列的方式从列表中选出对应的数据信息查看变量信息没有成功 带出外部连接的方式 点击这个黄色的按钮就可以弹出外部链接的方式 添加列的方式 创建一个数据框的方式 我们创建一个三行三列的数据方式 df <- data.frame(name c("Alice&…
阅读更多...
推荐文章
最新文章

Copyright @ 2022~2023