Springboot常用方法参数注解及示例

文章目录

      • Springboot常用方法参数注解及示例
        • [一、`@RequestParam`: 从URL查询参数中提取数据。](#一、@RequestParam: 从URL查询参数中提取数据。)
        • [二、`@PathVariable`: 从URL路径中提取数据。](#二、@PathVariable: 从URL路径中提取数据。)
        • [三、`@RequestBody`: 从请求体中提取数据,并映射到对象。](#三、@RequestBody: 从请求体中提取数据,并映射到对象。)
        • [四、`@RequestHeader`: 从请求头中提取数据。](#四、@RequestHeader: 从请求头中提取数据。)
        • [五、`@Validated` / `@Valid`: 启用方法参数校验,确保参数满足校验规则。](#五、@Validated / @Valid: 启用方法参数校验,确保参数满足校验规则。)
        • [六、`@ModelAttribute`: 从请求参数或表单数据中提取数据,并映射到对象。](#六、@ModelAttribute: 从请求参数或表单数据中提取数据,并映射到对象。)
        • [七、`@RequestPart`: 从`multipart/form-data`类型的请求中提取数据。](#七、@RequestPart: 从multipart/form-data类型的请求中提取数据。)

Springboot常用方法参数注解及示例

一、@RequestParam: 从URL查询参数中提取数据。

java 复制代码
@GetMapping("/greet")
public ResponseEntity<String> greet(@RequestParam String name) {
    return ResponseEntity.ok("Hello, " + name + "!");
}

二、@PathVariable: 从URL路径中提取数据。

java 复制代码
@GetMapping("/users/{userId}")
public ResponseEntity<User> getUserById(@PathVariable Long userId) {
    User user = userService.getUserById(userId);
    return ResponseEntity.ok(user);
}

三、@RequestBody: 从请求体中提取数据,并映射到对象。

java 复制代码
@PostMapping("/create-user")
public ResponseEntity<String> createUser(@RequestBody User user) {
    userService.createUser(user);
    return ResponseEntity.ok("User created successfully");
}

四、@RequestHeader: 从请求头中提取数据。

java 复制代码
@GetMapping("/user-agent")
public ResponseEntity<String> getUserAgent(@RequestHeader("User-Agent") String userAgent) {
    return ResponseEntity.ok("User Agent: " + userAgent);
}

五、@Validated / @Valid: 启用方法参数校验,确保参数满足校验规则。

java 复制代码
@PostMapping("/register")
public ResponseEntity<String> registerUser(@Validated @RequestBody UserRegistrationDTO registrationDTO) {
    // 执行用户注册逻辑
    return ResponseEntity.ok("用户注册成功");
}

六、@ModelAttribute: 从请求参数或表单数据中提取数据,并映射到对象。

java 复制代码
@PostMapping("/update-user")
public ResponseEntity<String> updateUser(@ModelAttribute UserUpdateDTO updateDTO) {
    userService.updateUser(updateDTO);
    return ResponseEntity.ok("User updated successfully");
}

七、@RequestPart: 从multipart/form-data类型的请求中提取数据。

java 复制代码
@PostMapping("/upload")
    public ResponseEntity<String> uploadImage(@Validated @RequestPart ImageUploadDTO uploadDTO) {
        MultipartFile imageFile = uploadDTO.getImage();
        String description = uploadDTO.getDescription();
        return ResponseEntity.ok("图片上传成功:" + description);
    }
相关推荐
白仑色1 小时前
Spring Cloud Gateway 实战指南
spring boot·微服务·路由转发·限流熔断
江沉晚呤时5 小时前
在 C# 中调用 Python 脚本:实现跨语言功能集成
python·microsoft·c#·.net·.netcore·.net core
FreeBuf_6 小时前
黄金旋律IAB组织利用暴露的ASP.NET机器密钥实施未授权访问
网络·后端·asp.net
电脑能手6 小时前
如何远程访问在WSL运行的Jupyter Notebook
ide·python·jupyter
Edward-tan7 小时前
CCPD 车牌数据集提取标注,并转为标准 YOLO 格式
python
老胖闲聊7 小时前
Python I/O 库【输入输出】全面详解
开发语言·python
张小洛7 小时前
Spring AOP 是如何生效的(入口源码级解析)?
java·后端·spring
倔强青铜三7 小时前
苦练Python第18天:Python异常处理锦囊
人工智能·python·面试
倔强青铜三7 小时前
苦练Python第17天:你必须掌握的Python内置函数
人工智能·python·面试
迷路爸爸1808 小时前
让 VSCode 调试器像 PyCharm 一样显示 Tensor Shape、变量形状、变量长度、维度信息
ide·vscode·python·pycharm·debug·调试