常见用于从 HTTP 请求中提取数据的注解

在 Spring 框架中,处理 HTTP 请求并从中提取数据的注解有很多,具体取决于请求的类型(如 GET、POST、PUT 等)以及数据的来源(如请求头、路径、查询参数、请求体等)。以下是一些常见的注解,用于从 HTTP 请求中提取不同的数据。

1. @RequestParam

用于从 URL 查询参数 或 表单数据 中提取参数。常用于 GET 请求或表单提交的 POST 请求。

用法:用于从查询字符串(例如 ?name=John&age=30)或表单数据中提取参数。

示例:

java 复制代码
@GetMapping("/search")
public String search(@RequestParam String name, @RequestParam int age) {
    return "Searching for " + name + " aged " + age;
}

通过 URL 查询字符串传递数据:

sql 复制代码
GET /search?name=John&age=30

常见选项:

required: 设置为 false 时,参数可以是可选的。

defaultValue: 设置默认值,当请求中没有该参数时使用。

2. @PathVariable

用于从 URL 路径 中提取数据。适用于 RESTful 风格的 API,通常用于动态路径参数。

用法:从 URL 路径中提取变量部分。

示例:

java 复制代码
@GetMapping("/user/{id}")
public String getUser(@PathVariable String id) {
    return "User ID: " + id;
}

通过 URL 路径传递数据:

java 复制代码
GET /user/123

常见选项:

可以使用多个 @PathVariable 注解提取多个路径参数。

3. @RequestBody

用于从 HTTP 请求的请求体 中提取数据,通常用于处理 JSON 或 XML 格式的数据。

用法:提取请求体中的内容并将其转换为 Java 对象(通常是 JSON)。

示例:

java 复制代码
@PostMapping("/user")
public String createUser(@RequestBody User user) {
    return "Created user: " + user.getName();
}

请求体的示例(JSON 格式):

json 复制代码
{
  "name": "John",
  "age": 30
}

常见选项:

需要配置 HttpMessageConverter(如 Jackson)来自动转换请求体的 JSON 数据为 Java 对象。

4. @RequestHeader

用于从 HTTP 请求头 中提取数据。常用于获取请求中的元数据,如认证信息、内容类型、语言设置等。

用法:用于提取请求头中的信息。

示例:

java 复制代码
@GetMapping("/header")
public String getHeader(@RequestHeader("User-Agent") String userAgent) {
    return "User-Agent: " + userAgent;
}

请求头的示例:

json 复制代码
User-Agent: Mozilla/5.0

常见选项:

required: 设置为 false 时,表示请求头参数是可选的。

5. @CookieValue

用于从 HTTP 请求的 Cookie 中提取数据。通常用于获取存储在客户端浏览器中的 Cookie 值。

用法:用于提取 Cookie 中的数据。

示例:

java 复制代码
@GetMapping("/cookie")
public String getCookie(@CookieValue("session_id") String sessionId) {
    return "Session ID: " + sessionId;
}

请求头的示例:

json 复制代码
Cookie: session_id=abcd1234

常见选项:

defaultValue: 如果 Cookie 中没有值,可以设置默认值。

6. @ModelAttribute

用于将 表单数据(或请求参数)绑定到一个 Java 对象。通常用于处理表单提交的 POST 请求。

用法:将多个请求参数绑定到一个 Java 对象中,通常用于表单数据提交。

示例:

java 复制代码
@PostMapping("/user")
public String createUser(@ModelAttribute User user) {
    return "Created user: " + user.getName();
}

表单提交的示例:

html 复制代码
<form method="post" action="/user">
    <input type="text" name="name">
    <input type="number" name="age">
    <button type="submit">Submit</button>
</form>
7. @RequestMapping

这是一个通用的注解,通常与 method 属性一起使用,来映射请求路径和 HTTP 方法。它可以与其他注解(如 @RequestParam、@PathVariable 等)结合使用来提取请求参数。

用法:@RequestMapping 可以处理各种 HTTP 方法,如 GET、POST、PUT、DELETE 等。

示例:

java 复制代码
@RequestMapping(value = "/product/{id}", method = RequestMethod.GET)
public String getProduct(@PathVariable String id, @RequestParam String name) {
    return "Product ID: " + id + ", Product Name: " + name;
}
8. @RequestParam 和 @PathVariable 的结合使用

你可以同时使用 @RequestParam 和 @PathVariable 来提取不同来源的数据。

示例:

java 复制代码
@GetMapping("/product/{id}")
public String getProduct(@PathVariable String id, @RequestParam String name) {
    return "Product ID: " + id + ", Product Name: " + name;
}

请求 URL:

bash 复制代码
GET /product/123?name=ProductA

总结

@RequestParam:用于从查询参数或表单数据中提取数据。

@PathVariable:用于从 URL 路径中提取数据。

@RequestBody:用于从请求体中提取数据(如 JSON 或 XML 格式)。

@RequestHeader:用于从请求头中提取数据。

@CookieValue:用于从请求的 Cookie 中提取数据。

@ModelAttribute:用于将多个请求参数绑定到一个 Java 对象。

@RequestMapping:用于映射 HTTP 请求到控制器方法,可以结合其他注解使用。

这些注解可以灵活地与 Spring 的控制器方法结合使用,帮助你从 HTTP 请求的不同部分提取所需的数据。

相关推荐
山甫aa3 小时前
JavaWeb后端开发学习手册
java·开发语言·数据库·学习·mysql·springboot·web
小博测试成长之路2 天前
55分钟能用飞算JavaAI搭完JWT REST API吗?
springboot·ai编程·java开发·飞算javaai·ai coding·java代码生成
努力就够了2 天前
搭建属于自己的 AI 智能体以及多 Agent 协作
springboot·ai agent·ai 智能体·多 agent 协作
chaser&upper2 天前
飞算JavaAI能听懂食品安全召回系统的复杂业务吗?
springboot·crud·vibe coding·飞算javaai·ai coding模型
承渊政道2 天前
10:30提交预约会不会撞上10:00的会议?我用飞算JavaAI3.9.1和3.9.9跑了四个时间段
java·springboot·ai编程·飞算javaai·java代码生成
坐吃山猪3 天前
WebClient内存配置解析
开发语言·springboot·webflux
Pocker_Spades_A3 天前
飞算JavaAI 48分钟能做完Java全栈项目吗?
java·springboot·#ai编程·#飞算javaai·#java代码生成·#aicoding模型·#java开发
孔明click333 天前
Sa-Token v1.46.0 发布 🚀,来看看有没有令你心动的功能!
java·sa-token·开源·springboot·权限认证
云边有个稻草人4 天前
飞算JavaAI能处理SaaS套餐变更业务吗?
java·springboot·ai编程·java开发·飞算javaai·java代码生成·ai coding模型
todoitbo4 天前
飞算JavaAI的多租户权限隔离实测
java·springboot·ai编程·java开发·飞算javaai·java代码生成