iis服务器助手广告广告
返回顶部
首页 > 资讯 > 后端开发 > Python >SpringMVCREST风格深入详细讲解
  • 840
分享到

SpringMVCREST风格深入详细讲解

SpringMVCREST风格SpringMVCREST 2022-11-13 18:11:17 840人浏览 安东尼

Python 官方文档:入门教程 => 点击学习

摘要

目录REST简介RESTful入门案例REST快速开发案例-基于RESTful页面数据交互REST简介 REST介绍 REST(Representational State Tran

REST简介

REST介绍

  • REST(Representational State Transfer),表现形式状态转换

传统风格资源描述形式

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

REST风格描述形式

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

优点

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

RESTful介绍

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

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

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

注意事项

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

RESTful入门案例

快速入门

做法:在Controller中定义方法时设定"http请求动作(请求方式)"和"设定请求参数(路径变量)"

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

@PathVariable介绍

  • 名称:@PathVariable
  • 类型:形参注解
  • 位置:springMVC控制器方法形参定义前面
  • 作用:绑定路径参数与处理器方法形参间的关系,要求路径参数名与形参名一一对应

@RequestBody、@RequestParam、@PathVariable区别和应用

区别

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

应用

  • 后期开发中,发送请求参数超过1个时,以json格式为主,@RequestBody应用较广
  • 如果发送非json格式数据,选用@RequestParam接收请求参数
  • 采用RESTful进行开发,当参数数量较少时,例如1个,可以采用@PathVariable接收请求路径变量,通常用于传递id值

REST快速开发

代码中的问题

以上截图中的代码和之前写的UserController中的方法类似,其中图中两个方法都有三处是有问题的,可以进行优化。存在的问题如下:

  • 问题1:每个方法的@RequestMapping注解中都定义了访问路径/books,重复性太高。
  • 问题2:每个方法的@RequestMapping注解中都要使用method属性定义请求方式,重复性太高。
  • 问题3:每个方法响应json都需要加上@ResponseBody注解,重复性太高。

Rest快速开发

解决以上三个问题

解决问题1:在Controller类上使用@RequestMapping定义共同的访问路径。

@Controller
@RequestMapping("/books")
public class BookController {
    @RequestMapping(method = RequestMethod.POST)
    public String save(@RequestBody Book book){
        System.out.println("book save..." + book);
        return "{'module':'book save'}";
    }
    @RequestMapping(value = "/{id}" ,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(value = "/{id}" ,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 getAll'}";
    }
}

解决问题2:使用@GetMapping @PostMapping @PutMapping @DeleteMapping代替@RequestMapping(method=RequestMethod.XXX)

@Controller   
@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'}";
    }
}
  • 名称:@GetMapping @PostMapping @PutMapping @DeleteMapping
  • 类型:方法注解
  • 位置:基于springmvc的RESTful开发控制器方法定义上方
  • 作用:设置当前控制器方法请求访问路径与请求动作,每种对应一个请求动作,例如@GetMapping对应GET请求
  • 属性: value(默认):请求访问路径

解决问题3:在Controller类上使用@RestController注解,等同于@Controller与@ResponseBody两个注解组合功能

@RestController     //使用@RestController注解替换@Controller与@ResponseBody注解,简化书写
@RequestMapping("/books")
public class BookController {
    //方法省略了没写
}
  • 名称:@RestController
  • 类型:类注解
  • 位置:基于SpringMVC的RESTful开发控制器类定义上方
  • 作用:设置当前控制器类为RESTful风格,等同于@Controller与@ResponseBody两个注解组合功能

案例-基于RESTful页面数据交互

案例效果和环境准备

案例效果

环境准备

//POJO实体类
public class Book {
    private Integer id;
    private String type;
    private String name;
    private String description;
    //重写getter、setter、toString()方法...
}
//SpringMVC容器初始化类
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};
    }
}
//SpringMVC配置类
@Configuration
@ComponentScan({"com.moming.controller","com.moming.config"})
@EnableWEBMvc
public class SpringMvcConfig {
}

代码实现

制作SpringMVC控制器,并通过PostMan测试接口功能

@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(){
        System.out.println("book getAll is running ...");
        List<Book> bookList = new ArrayList<Book>();
        Book book1 = new Book();
        book1.setType("计算机");
        book1.setName("SpringMVC入门教程");
        book1.setDescription("小试牛刀");
        bookList.add(book1);
        Book book2 = new Book();
        book2.setType("计算机");
        book2.setName("SpringMVC实战教程");
        book2.setDescription("一代宗师");
        bookList.add(book2);
        Book book3 = new Book();
        book3.setType("计算机丛书");
        book3.setName("SpringMVC实战教程进阶");
        book3.setDescription("一代宗师呕心创作");
        bookList.add(book3);
        return bookList;
    }
}

静态页面资源(REST功能页面)

链接:链接: https://pan.baidu.com/s/1u9GSGrDejwDDbFAe_inEGQ?pwd=aaey

设置对静态资源的访问放行

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

books.html前端页面通过异步提交访问后台控制器

//添加
saveBook () {
    axiOS.post("/books",this.fORMData).then((res)=>{
    });
},
//主页列表查询
getAll() {
    axios.get("/books").then((res)=>{
        this.dataList = res.data;
    });
},

到此这篇关于SpringMVC REST深入详细讲解的文章就介绍到这了,更多相关SpringMVC REST内容请搜索编程网以前的文章或继续浏览下面的相关文章希望大家以后多多支持编程网!

--结束END--

本文标题: SpringMVCREST风格深入详细讲解

本文链接: https://www.lsjlt.com/news/170238.html(转载时请注明来源链接)

有问题或投稿请发送至: 邮箱/279061341@qq.com    QQ/279061341

本篇文章演示代码以及资料文档资料下载

下载Word文档到电脑,方便收藏和打印~

下载Word文档
猜你喜欢
  • SpringMVCREST风格深入详细讲解
    目录REST简介RESTful入门案例REST快速开发案例-基于RESTful页面数据交互REST简介 REST介绍 REST(Representational State Tran...
    99+
    2022-11-13
    SpringMVC REST风格 SpringMVC REST
  • SpringBootRESTful风格入门讲解
    目录1、Restful简介2、查询用户以及用户详情2.1常用注解2.2查询用户详情3、处理创建请求3.1@RequestBody注解3.1.1用途3.1.2语法规范3.2日期类型的处...
    99+
    2022-11-13
    SpringBoot RESTful SpringBoot RESTful接口
  • SpringBoot超详细深入讲解底层原理
    目录手写springbootSpringboot项目自动配置小结手写springboot 在日常开发中只需要引入下面的依赖就可以开发Servlet进行访问了。 <depende...
    99+
    2024-04-02
  • SpringBoot中controller深层详细讲解
    在基于spring框架的项目开发中,必然会遇到controller层,它可以很方便的对外提供数据接口服务,也是非常关键的出口,所以非常有必要进行规范统一,使其既简洁又优雅。 cont...
    99+
    2023-02-02
    SpringBoot controller SpringBoot controller层
  • axios引入的详细讲解
    安装axios:npm install axios,等待安装完毕即可 引用axios:在需要使用的页面中引用  import axios from 'axios'  即可 axios请求的时候有两种方式:一种是get请求,另一种是post请...
    99+
    2023-10-25
    javascript 开发语言 ecmascript
  • PHP之深入学习Yii2缓存Cache组件详细讲解
    什么是缓存组件Cache 缓存是提升 Web 应用性能简便有效的方式。 通过将相对静态的数据存储到缓存并在收到请求时取回缓存, 应用程序便节省了每次重新生成这些数据所需的时间。 定...
    99+
    2024-04-02
  • PHP 接入shopify SDK 详细讲解
    前言: 有关 shopify 的实操例子太少了 为了给后面的人行以方便,也为了我下次不那么麻烦。我打算记录一下我的代码以及操作流程 首先既然是有关shopify的操作,你必须有一个shopify账号.(创建流程就不在这里进行描述) ...
    99+
    2023-09-04
    php 经验分享 其他
  • 超详细的JVM 深入解析
    工作之余,想总结一下JVM相关知识。Java运行时数据区:Java虚拟机在执行Java程序的过程中会将其管理的内存划分为若干个不同的数据区域,这些区域有各自的用途、创建和销毁的时间,有些区域随虚拟机进程的启动而存在,有些区域则是依赖用户线程...
    99+
    2023-06-02
  • python 深入了解GIL锁详细
    目录1、什么是GIL锁2、CPython对线程安全的内存管理机制3、GIL锁的产生4、GIL锁的底层原理5、Python GIL不能绝对保证线程安全6、总结前言: python的使用...
    99+
    2024-04-02
  • Vue对象的深层劫持详细讲解
    目录一,前言二,对象属性的深层观测问题1,抛出问题2,测试问题3,查看结果三,对象属性深层观测的实现1,实现思路2,代码逻辑四,data 相关优化五,结尾一,前言 上篇,主要介绍了在...
    99+
    2023-01-06
    Vue对象深层劫持 Vue深层劫持 Vue对象劫持
  • C++ Cartographer的入口nodemain详细讲解
    目录Run函数读取配置参数构建地图构建器Node类的初始化开始轨迹与结束轨迹啃一下谷歌优秀的激光SLAM开源框架-Cartographer. 这个框架算法简单,但是程序部分太多需要学...
    99+
    2023-03-19
    C++ node main C++ Cartographer
  • Java 泛型超详细入门讲解
    目录1、什么是泛型2、泛型是怎么编译的泛型的编译机制:擦除机制1、什么是泛型 泛型其实就是将类型作为参数传递,泛型允许程序员在编写代码时使用一些以后才指定的类型 ,在实例化该类时将想...
    99+
    2024-04-02
  • springmvc详细讲解
    一、SpringMVC 1.1 引言 java开源框架,Spring Framework的一个独立模块。 MVC框架,在项目中开辟MVC层次架构 对控制器中的功能 包装 简化 扩展践行工厂...
    99+
    2023-10-21
    servlet java spring mvc
  • 【OAuth2】详细讲解
    文章目录                         一、Oauth2是什么?                         二、Oauth2的四种角色?                         三、Oauth2的...
    99+
    2023-09-20
    大数据 java spring boot web app
  • 深入讲解Socket原理
    目录关于TCP/IP、UDP、Socket什么是TCP/IP、UDP?Socket在哪里呢?Socket是什么呢?你会使用它们吗?1、网络中进程之间如何通信?2、什么是Socket?...
    99+
    2024-04-02
  • AndroidLayerDrawable超详细讲解
    目录1. 前言2. 实例1. 前言 Android LayerDrawble 包含一个Drawable数组,系统将会按照这些Drawable对象的数组顺序来绘制他们,索引最大的 Dr...
    99+
    2022-11-13
    Android LayerDrawable Android LayerDrawable原理
  • Redisson可重入锁解锁逻辑详细讲解
    目录主动释放自动释放本篇文章基于redisson-3.17.6版本源码进行分析 相比较Redisson可重入锁的加锁逻辑,释放锁的逻辑就相对简单一些。释放锁分为主动释放和自动释放两种...
    99+
    2023-02-11
    Redisson可重入锁 Redisson可重入锁解锁
  • GoLangunsafe包详细讲解
    目录1.前言2.指针类型转换3.指针运算4.获取大小和偏移5.关于string1.前言 开发中,[]byte类型和string类型需要互相转换的场景并不少见,直接的想法是像下面这样进...
    99+
    2024-04-02
  • AndroidSwipeRefreshLayout超详细讲解
    目录1. 控件说明2. API介绍3. 使用方法3.1 布局文件3.2 界面代码4. 注意事项1. 控件说明 SwipeRefreshLayout是google官方推荐使用的下拉刷新...
    99+
    2022-11-13
    Android SwipeRefreshLayout Android SwipeRefreshLayout控件
  • C++BoostAtomic详细讲解
    目录一、说明二、示例和代码一、说明 Boost.Atomic 提供类 boost::atomic,可用于创建原子变量。它们被称为原子变量,因为所有访问都是原子的。 Boost.Ato...
    99+
    2022-11-21
    C++ Boost Atomic C++ Atomic
软考高级职称资格查询
编程网,编程工程师的家园,是目前国内优秀的开源技术社区之一,形成了由开源软件库、代码分享、资讯、协作翻译、讨论区和博客等几大频道内容,为IT开发者提供了一个发现、使用、并交流开源技术的平台。
  • 官方手机版

  • 微信公众号

  • 商务合作