前言
最近在与前端联调时候,出现前端传输参数无法解析的问题,最后发现问题出在
Content-type
上。作为一个1年多经验的开发人员,实在不应该。所有写这篇文章,对涉及前后端参数传递的内容做一个梳理。
一、GET/POST/DELETE/PUT
1、语义上的区别
- Get:获取数据,幂等的。
- Post:发送数据,会创建新的内容(数据库Insert)
- Put:发送数据,修改数据内容(数据库的Update)
- DELETE:删除数据
2、细节上的区别
W3SCHOOL上的Get与Post的区别:
操作 | GET | POST |
---|---|---|
后退按钮/刷新 | 无害 | 数据会被重新提交(浏览器应该告知用户数据会被重新提交)。 |
书签 | 可收藏为书签 | 不可收藏为书签 |
缓存 | 能被缓存 | 不能缓存 |
编码类型 | application/x-www-form-urlencoded | application/x-www-form-urlencoded 或 multipart/form-data。为二进制数据使用多重编码。 |
历史 | 参数保留在浏览器历史中。 | 参数不会保存在浏览器历史中。 |
对数据长度的限制 | 是的。当发送数据时,GET 方法向 URL 添加数据;URL 的长度是受限制的(URL 的最大长度是 2048 个字符)。 | 无限制。 |
对数据类型的限制 | 只允许 ASCII 字符。 | 没有限制。也允许二进制数据。 |
安全性 | 与 POST 相比,GET 的安全性较差,因为所发送的数据是 URL 的一部分。在发送密码或其他敏感信息时绝不要使用 GET ! | POST 比 GET 更安全,因为参数不会被保存在浏览器历史或 web 服务器日志中。 |
可见性 | 数据在 URL 中对所有人都是可见的。 | 数据不会显示在 URL 中。 |
3、content-type
🙋****
http协议采用请求/响应模型,HTTP消息由一个起始行,一个或者多个头域,一个只是头域结束的空行和可选的消息体组成。
HTTP的头域包括通用头,请求头,响应头和实体头四个部分。content-type属于实体头部分。
get请求是将参数拼接在url上,没有content-type字段;post/put/delete 请求有content-type字段
content-type
代表发送端发送的实体数据的数据类型,表示后面的文档属于什么MIME类型。
常见的content-type有:
- ``application/x-www-form-urlencoded` 这种就是一般的文本表单用 post 传递数据。浏览器的原生 form 表单,如果不设置 enctype 属性,那么最终就会以 application/x-www-form-urlencoded 方式提交数据。
multipart/form-data
,用于文件上传,此时 form表单 的 enctype 属性必须指定为 multipart/form-data;application/json
,将数据以json对象的格式传递;text/xml
,XML 作为编码方式。
二、spring mvc接收参数相关注解
1、@RequestParam
@RequestParam
注解主要 用于 Get 和 Post 请求,用于接受:
- URL 查询参数 (如 ?name=test)
- 表单数据 (form-data)
- x-www-form-urlencoded 格式的数据
// GET: /api/test?name=test
// POST: form-data 或 x-www-form-urlencoded
@RequestParam("name") String name
INFO
**对于请求:**http://example.com/api?param1=value1¶m2=value2:
使用@RequestParam("param1") String param1
,这将获取名为param1的请求参数的值,并将其存储在param1变量中。
2、@RequestBody
@RequestBody
注解用于接收请求体的参数,通常用于content-type为application/json
或XML
,主要用于Post/put/delete。
INFO
例子:
public ResponseEntity<User> createUser(@RequestBody User user)
,这里的User是一个自定义的Java类,用于表示请求体中的数据。
3、不加注解
⚠️ 不加注解会依赖 Spring mvc 的默认行为,推荐明确使用注解。
如果不加任何注解,Spring MVC 会根据参数名称和请求的不同方式进行默认的参数绑定
- 简单参数
@PostMapping("/test")
public R<String> test(String name, Integer age) {
// 可以接收:
// 1. URL参数 (?name=test&age=18)
// 2. form-data
// 3. x-www-form-urlencoded
}
- 对象参数
public class UserDTO {
private String name;
private Integer age;
// getter/setter
}
@PostMapping("/test")
public R<String> test(UserDTO user) {
// 可以接收:
// 1. URL参数 (?name=test&age=18)
// 2. form-data
// 3. x-www-form-urlencoded
// 注意:不能直接接收 JSON 格式
}
- 特殊类型(如 MultipartFile)
@PostMapping("/upload")
public R<String> upload(MultipartFile file) { // 必须加 @RequestParam
// 这样是无法正常工作的!
// MultipartFile 必须使用 @RequestParam 注解
}
4、@PathVariable
@PathVariable
主要用于将 URL 中占位符参数绑定到控制器处理方法的入参中。
/**
* 例:
* localhost:8080/pathVariable/1
* 这些URL 都会 执行此方法 并且将 1 作为参数传递到id字段
* @param id
* @return
*/
@RequestMapping("/pathVariable/{id}")
public String pathVariable(@PathVariable("id") String id){
return id;
}
总结
- get/post/delete/put本质上都是基于http协议,区别主要在与报文格式上。
- content-type代表发送端发送的实体数据的数据类型,常见的有
multipart/form-data
、application/x-www-form-urlencoded
、application/json
、text/xml
- @RequestParam、@RequestBody等注解接收参数主要是根据url和content-type,和请求方法无关。例如:@RequestParam也可以用于POST请求。
参考
灵活运用的@RequestParam和@RequestBody