【springboot】@RequestBody和@ResponseBody以及@PathVariable的使用及区别

本文主要是介绍【springboot】@RequestBody和@ResponseBody以及@PathVariable的使用及区别,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

1、@RequestBody@ResponseBody

@RequestBody (通过@requestBody可以将请求体中的JSON字符串绑定到相应的bean上,当然,也可以将其分别绑定到对应的字符串上。实质上接受的是一个JSON的字符串)

   1) 该注解用于读取Request请求的body部分数据,使用系统默认配置的HttpMessageConverter进行解析,然后把相应的数据绑定到要返回的对象上;

   2) 再把HttpMessageConverter返回的对象数据绑定到 controller中方法的参数上。

使用时机:

A) GET、POST方式提时, 根据request header Content-Type的值来判断:

    application/x-www-form-urlencoded,可选(即非必须,因为这种情况的数据@RequestParam, @ModelAttribute也可以处理,当然@RequestBody也能处理);

    multipart/form-data, 不能处理(即使用@RequestBody不能处理这种格式的数据);

其他格式, 必须(其他格式包括application/json, application/xml等。这些格式的数据,必须使用@RequestBody来处理);

@ResponseBody

Controller层为控制视图层,当网页端一个请求发送到后台时,后台的控制视图层通过@RequestMapping映射相应的视图方法,如果在视图方法上用注解@ResponseBody标识后,方法执行完后返回的内容会返回到请求页面的body上,直接显示在网页上。示例如下

1、spring boot的启动类

@SpringBootApplication

public class App {

    public static void main(String[] args) {

        SpringApplication app = new SpringApplication(App.class);

        ConfigurableApplicationContext context = app.run(args);

    }

}

2、spring boot的控制视图层

@Controller

public class MyController {

    /*响应http://127.0.0.1:8080/hello请求*/

    @RequestMapping("/hello")

    @ResponseBody

    public String hello(){

        return "hello world";

    }

}

当启动启动类后,在浏览器中输入http://127.0.0.1:8080/hello时,控制视图层响应请求后,把“hello world”字符串返回到请求页面上。@ResponseBody注解的作用就是把控制视图方法返回的内容返回到请求页面上。

查看请求后页面的http://127.0.0.1:8080/hello源码

 

注意,请求前后的url不改变。通过请求后的页面可知,@ResponseBody注解把返回的字符串“hello world”放到了请求返回页面的<body></body> 标签中了。

 

2、@PathVariable注解的使用

XXXController包括了常用的Get、Post、Put、Delete请求,并使用注解的方式说明了请求路径

路径中的{id}元素是路径参数,可以通过@PathVariable注解获取,具体的参数获取与校验会在下一篇做介绍

 

总结

SpringBoot提供的获取参数注解包括:@PathVariable,@RequestParam,@RequestBody,三者的区别如下表:

 

1.Get请求的参数可以通过@PathVariable和@RequestParam获取

@GetMapping("/orders/{id}")

    public String getOrder(@PathVariable(value = "id")Integer id,                    

                                        @RequestParam(value = "name")String name,                          

                                        @RequestParam(value = "price",required = false,defaultValue = "0") Integer price)

 

2.Post使用@RequestBody注解将Json格式的参数自动绑定到Entity类

@PostMapping("/order/check")

public String checkOrder(@RequestBody Order order)

 

3.Post使用@RequestParam获取请求体中非Json格式的数据

@PostMapping("/order/checkmore")

public String checkMore(@RequestParam(value = "amount")Integer amount,

                                        @RequestParam(value = "discount")float discount)

 

4.Post请求也可以直接与对象类绑定,但需要参数名一致,不支持json格式,只支持form-data和x-www.form-urlencoded格式

@PostMapping("/order/add")

public String addOrder(Order order)

 

5.Put请求可以直接与对象类绑定,但需要参数名一致

 @PutMapping("/order/{id}/update")   

 public String updateOrder(@PathVariable(value = "id")Integer id,Order order)

 

注意点:

1.针对一些非必填的参数,可以使用required关键字来标识,同时必须设置默认值defaultValue,如getOrder方法中对price参数的获取:

(@RequestParam(value = "price",required = false,defaultValue = "0") Integer price)

 

2.参数可以直接与Entity类绑定,但不支持json格式,只支持form-data和x-www.form-urlencoded格式

@PostMapping("/order/add")

public String addOrder(Order order){

 

4.增删改查请求参数规范@PostMapping;@GetMapping;@PutMapping;@DeleteMapping

 

  * 通过RestController注解告知SpringBoot这是一个控制器类

  * 通过RequestMapping注解说明统一处理以user开头的URL请求

  */

 @RestController

 @RequestMapping("/user")

 public class UserController {

 

     /**

      * 获取特定用户

      * @param id

      * @return

      */

     @GetMapping("/users/{id}")

     public User getUser(@PathVariable(value="id") Integer id){

        return null;

     }

 

     /**

      * 添加用户

      * @param user

      * @return

      */

     @PostMapping("/add")

     public String addUser(@RequestBody User user){

         return "添加成功";

     }

 

     /**

      * 修改用户

      * @param id

      * @param user

     * @return

     */

@PutMapping("/users/{id}/update")

 

     public String updateUser(@PathVariable(value="id") Integer id,@RequestBody User user){

         return "修改成功";

     }

 

     /**

      * 删除用户

      * @param id

      * @return

      */

     @DeleteMapping("/users/{id}/delete")

     public String deleteUser(@PathVariable(value="id") Integer id){

 

         return "删除成功";

     }

 }

这篇关于【springboot】@RequestBody和@ResponseBody以及@PathVariable的使用及区别的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/1105354

相关文章

什么是 Java 的 CyclicBarrier(代码示例)

《什么是Java的CyclicBarrier(代码示例)》CyclicBarrier是多线程协同的利器,适合需要多次同步的场景,本文通过代码示例讲解什么是Java的CyclicBarrier,感... 你的回答(口语化,面试场景)面试官:什么是 Java 的 CyclicBarrier?你:好的,我来举个例

Java使用Mail构建邮件功能的完整指南

《Java使用Mail构建邮件功能的完整指南》JavaMailAPI是一个功能强大的工具,它可以帮助开发者轻松实现邮件的发送与接收功能,本文将介绍如何使用JavaMail发送和接收邮件,希望对大家有所... 目录1、简述2、主要特点3、发送样例3.1 发送纯文本邮件3.2 发送 html 邮件3.3 发送带

Java实现数据库图片上传功能详解

《Java实现数据库图片上传功能详解》这篇文章主要为大家详细介绍了如何使用Java实现数据库图片上传功能,包含从数据库拿图片传递前端渲染,感兴趣的小伙伴可以跟随小编一起学习一下... 目录1、前言2、数据库搭建&nbsChina编程p; 3、后端实现将图片存储进数据库4、后端实现从数据库取出图片给前端5、前端拿到

Java实现将byte[]转换为File对象

《Java实现将byte[]转换为File对象》这篇文章将通过一个简单的例子为大家演示Java如何实现byte[]转换为File对象,并将其上传到外部服务器,感兴趣的小伙伴可以跟随小编一起学习一下... 目录前言1. 问题背景2. 环境准备3. 实现步骤3.1 从 URL 获取图片字节数据3.2 将字节数组

使用DeepSeek搭建个人知识库(在笔记本电脑上)

《使用DeepSeek搭建个人知识库(在笔记本电脑上)》本文介绍了如何在笔记本电脑上使用DeepSeek和开源工具搭建个人知识库,通过安装DeepSeek和RAGFlow,并使用CherryStudi... 目录部署环境软件清单安装DeepSeek安装Cherry Studio安装RAGFlow设置知识库总

Java捕获ThreadPoolExecutor内部线程异常的四种方法

《Java捕获ThreadPoolExecutor内部线程异常的四种方法》这篇文章主要为大家详细介绍了Java捕获ThreadPoolExecutor内部线程异常的四种方法,文中的示例代码讲解详细,感... 目录方案 1方案 2方案 3方案 4结论方案 1使用 execute + try-catch 记录

SpringBoot接收JSON类型的参数方式

《SpringBoot接收JSON类型的参数方式》:本文主要介绍SpringBoot接收JSON类型的参数方式,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、jsON二、代码准备三、Apifox操作总结一、JSON在学习前端技术时,我们有讲到过JSON,而在

Python FastAPI入门安装使用

《PythonFastAPI入门安装使用》FastAPI是一个现代、快速的PythonWeb框架,用于构建API,它基于Python3.6+的类型提示特性,使得代码更加简洁且易于绶护,这篇文章主要介... 目录第一节:FastAPI入门一、FastAPI框架介绍什么是ASGI服务(WSGI)二、FastAP

Spring-AOP-ProceedingJoinPoint的使用详解

《Spring-AOP-ProceedingJoinPoint的使用详解》:本文主要介绍Spring-AOP-ProceedingJoinPoint的使用方式,具有很好的参考价值,希望对大家有所帮... 目录ProceedingJoinPoijsnt简介获取环绕通知方法的相关信息1.proceed()2.g

Spring Security注解方式权限控制过程

《SpringSecurity注解方式权限控制过程》:本文主要介绍SpringSecurity注解方式权限控制过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、摘要二、实现步骤2.1 在配置类中添加权限注解的支持2.2 创建Controller类2.3 Us