请求参数:Header 参数,Body 参数,Path 参数,Query 参数分别是什么意思,什么样的,分别通过哪个注解获取其中的信息

在API开发中(如Spring Boot),请求参数可以通过不同方式传递,对应不同的注解获取。以下是 Header参数、Body参数、Path参数、Query参数 的区别及对应的注解:


Header 参数

​

• 含义:通过HTTP请求头(Headers)传递的参数,通常用于认证(如Authorization)、客户端信息(如User-Agent)等。

• 示例:

java 复制代码
GET /api/user HTTP/1.1
Authorization: Bearer xxxx

• Spring注解:

• @RequestHeader:获取单个Header值。

• @RequestHeader Map<String, String>:获取所有Headers。

• 代码示例:

java 复制代码
@GetMapping("/user")
public String getUser(@RequestHeader("Authorization") String token) {
    return "Token: " + token;
}

Body 参数

​ ​

• 含义:通过HTTP请求体(Body)传递的参数,通常用于提交JSON/XML格式的复杂数据(如创建资源)。

• 示例:

java 复制代码
POST /api/user HTTP/1.1
Content-Type: application/json

{"name": "Alice", "age": 25}

• Spring注解:

• @RequestBody:将请求体反序列化为Java对象(需指定Content-Type为application/json)。

• 代码示例:

java 复制代码
@PostMapping("/user")
public User createUser(@RequestBody User user) {
    return userService.save(user);
}

Path 参数

​ ​

• 含义:通过URL路径传递的参数(RESTful风格),用于标识资源(如用户ID)。

• 示例:

java 复制代码
GET /api/user/123

• Spring注解:

• @PathVariable:从URL模板中提取变量值。

• 代码示例:

java 复制代码
@GetMapping("/user/{id}")
public User getUser(@PathVariable Long id) {
    return userService.findById(id);
}

Query 参数

​ ​

• 含义:通过URL问号后拼接的参数(?key=value),用于过滤、分页等非必选参数。

• 示例:

java 复制代码
GET /api/user?name=Alice&age=25

• Spring注解:

• @RequestParam:获取单个Query参数。

• @RequestParam Map<String, String>:获取所有Query参数。

• @RequestParam(required = false):标记参数为可选。

• 代码示例:

java 复制代码
@GetMapping("/user")
public List<User> searchUsers(
    @RequestParam String name,
    @RequestParam(required = false) Integer age
) {
    return userService.search(name, age);
}

总结对比表

参数类型 传递方式 典型用途 Spring注解
Header HTTP请求头 认证、客户端信息 @RequestHeader
Body HTTP请求体(JSON/XML) 提交复杂数据 @RequestBody
Path URL路径(如/user/1) 标识资源 @PathVariable
Query URL问号后(?name=xx) 过滤、分页等可选参数 @RequestParam

其他注意事项

  1. 混合使用:一个接口可以同时使用多种参数类型(如Path + Query + Header)。
java 复制代码
@PutMapping("/user/{id}")
public User updateUser(
    @PathVariable Long id,
    @RequestBody User user,
    @RequestHeader("X-Request-From") String source
) { ... }
  1. 默认值:@RequestParam和@RequestHeader支持设置默认值:
java 复制代码
@RequestParam(defaultValue = "1") int page
  1. RESTful设计:优先使用Path参数标识资源,Query参数用于辅助操作(如排序、搜索)。
相关推荐
Highcharts.js13 分钟前
Highcharts智能数据分析平台Orbit 多语言配置技术文档
java·前端·javascript·highcharts·orbit·智能数据分析·设置文档
Rain的Java大神之路21 分钟前
设计一套生产级 API 接口:从契约、安全、幂等到限流,我踩过的坑都在这了
java·后端·面试
SimonKing22 分钟前
零配置也能白嫖前沿大模型!dsh-our-free-model插件真香警告
java·后端·程序员
nice_lcj52023 分钟前
【从零理解 Spring AI · 15】让检索更准:先宽召回,再精排序
java·后端·rag·spring ai·ai应用开发·检索优化·重排序
回家路上绕了弯26 分钟前
要人确认的那一步,在确认什么?
后端
IT_陈寒1 小时前
JavaScript项目实战经验分享:从内存泄漏到性能优化的血泪史
前端·人工智能·后端
杨凯凡2 小时前
Spring Boot 链路追踪实战:Micrometer、TraceId 与异步线程上下文传播
java·spring boot·后端
计算机毕设定制辅导-无忧学长2 小时前
《基于Spring Boot的迷游哈游戏综合服务平台的开发》
java·vue.js·spring boot·mysql·迷游哈游戏综合服务平台
非优秀程序员11 小时前
第07章 孙德良的阳谋|《互联网产品恩仇录》
javascript·后端
非优秀程序员11 小时前
第06章 浙江帮的内战|《互联网产品恩仇录》
后端