我要评论
目录
前言
该知识点主要来源于springmvc：springmvc从入门到精通（全）
慢慢作为一名全栈，偶尔看项目使用@requestparam或者@requestbody，对此需要做一个深度的总结，防止混淆
1. 基本知识
@requestparam注解用于从http请求中提取查询参数或表单参数。
其中一些常用的属性参数包括name、defaultvalue和required。
下面是对这三个属性参数的详细解释：
name属性：用于指定要提取的查询参数或表单参数的名称defaultvalue属性：用于设置参数的默认值。（请求中没有提供相应的参数，将使用默认值）required属性：用于指定参数是否是必需的
设置为 true，则请求中必须包含相应的参数
设置为 false，则参数是可选的
@getmapping("/example")
public string examplemethod(@requestparam(name = "param", defaultvalue = "default", required = true) string param) {
// method implementation
}
@requestbody注解用于从请求体中获取数据。
主要用于处理http请求的请求体，通常用于接收json或xml格式的数据。
接收json数据： 通常用于接收通过post请求发送的json数据
@postmapping("/example")
public string examplemethod(@requestbody exampledto exampledto) {
// method implementation
}
其中自定义的对象如下：（ 通常与自定义的java对象结合使用，spring将尝试将请求体映射到该对象。）
public class exampledto {
private string field1;
private int field2;
// getters and setters
}
其他数据格式： 除了json，@requestbody也可以处理其他格式的数据，例如xml
@postmapping("/example")
public string examplemethod(@requestbody string xmldata) {
// method implementation
}
使用@requestparam注解时更加灵活地处理查询参数或表单参数。
可以根据具体的需求，指定参数名、设置默认值以及确定参数是否是必需的
2. 使用场景
主要分析以下两种注解的常用形式，以及接口测试中是如何测试的
2.1 @requestparam注解
处理查询参数：（处理http get请求中的查询参数）
当客户端通过url传递参数时，可以使用@requestparam将这些参数映射到方法的参数中。
@getmapping("/search")
public responseentity<string> search(@requestparam(name = "query") string query) {
// method implementation
}
处理表单参数：（通常用于处理http post请求中的表单数据）
当客户端通过表单提交数据时，可以使用@requestparam将表单参数映射到方法的参数中。
@postmapping("/submitform")
public responseentity<string> submitform(@requestparam(name = "username") string username,
@requestparam(name = "password") string password) {
// method implementation
}
设置默认值：
使用@requestparam可以为参数设置默认值，当请求中没有提供相应的参数时，将使用默认值。
@getmapping("/example")
public responseentity<string> example(@requestparam(name = "param", defaultvalue = "default") string param) {
// method implementation
}
接收多个参数
@requestparam允许接收多个参数，并将它们映射到方法的多个参数中。可以通过多次使用该注解来处理多个参数。
@getmapping("/multipleparams")
public responseentity<string> multipleparams(@requestparam(name = "param1") string param1,
@requestparam(name = "param2") int param2) {
// method implementation
}
2.2 @requestbody注解
处理非表单数据：
@requestbody适用于处理非表单格式的数据，例如json、xml等。当请求的数据不是通过表单提交，而是通过请求体中的结构化数据传递时，可以使用该注解。
// createobject方法接收的是一个自定义对象 myobject，该对象的数据可以通过请求体中的json数据进行填充
@postmapping("/create")
public responseentity<string> createobject(@requestbody myobject myobject) {
// method implementation
}
接收复杂对象：（自动将请求体中的数据映射为方法参数所需的对象，无需手动解析）
当需要接收复杂的java对象或自定义的数据结构时，使用@requestbody更为方便
//updateobject方法接收的是一个包含更新数据的自定义请求对象 updateobjectrequest
@postmapping("/update")
public responseentity<string> updateobject(@requestbody updateobjectrequest request) {
// method implementation
}
处理restful api请求：（@requestbody使得处理这种情况变得更加简便）
需要从请求体中获取数据进行资源的创建、更新或其他操作
//updateresource方法接收的是路径中的资源标识符以及请求体中的数据
@putmapping("/update/{id}")
public responseentity<string> updateresource(@pathvariable long id, @requestbody resourcedata data) {
// method implementation
}
支持多种数据格式：（后端服务可以根据实际需求选择最适合的数据格式）
@requestbody不限于特定的数据格式，因此可以支持多种数据格式的传递，包括json、xml等
//processdata方法可以接收不同格式的数据对象，根据实际请求体中的数据格式进行处理
@postmapping("/process")
public responseentity<string> processdata(@requestbody dataobject data) {
// method implementation
}
3. 接口测试
3.1 @requestbody注解
- post获取的接口都是带有参数的，此处的参数为string
测试代码如下：
对应的接口测试可以选择 params 或者 body 中的 x-www-form-urlencoded
或者如下图：
（由于删除功能此处做了逻辑删除，博主在后台改了属性又恢复回来了！）
对应的逻辑删除可看这篇文章：详细讲解mybatisplus实现逻辑删除
3.2 @requestbody注解
代码示例如下：
对于apipost的测试软件，大致如下界面：
对于postman的测试接口界面如下，截图如下，对应需要选择raw中的json格式，才可测试成功：（由于是下载excel，对应会有乱码， 但是返回值为200）
4. 总结
-
@requestparam适用于处理http请求中的查询参数和表单参数，以及在需要设置默认值、接收多个参数的情况下使用。这使得在spring mvc应用中，处理简单的参数传递变得更加方便。 -
@requestbody注解适用于接收请求体中的结构化数据，特别是在处理非表单数据、接收复杂对象、处理restful api请求以及支持多种数据格式的情况下。
（一般用于处理非content-type: application/x-www-form-urlencoded编码格式的数据，比如：application/json、application/xml等类型的数据）
注意：前端使用$.ajax的话，一定要指定 contenttype: "application/json;charset=utf-8;"，默认为 application/x-www-form-urlencoded
发表评论