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);
    }
相关推荐
AppleWebCoder3 分钟前
Java大厂面试实录:AIGC与虚拟互动场景下的微服务与AI落地(附知识详解)
java·spring boot·微服务·ai·消息队列·aigc·虚拟互动
kida_yuan15 分钟前
【从零开始】13. 数据增强(Data Augmentation)
数据结构·python·nlp
xuejianxinokok34 分钟前
PostgreSQL 18 新功能:虚拟生成列
数据库·后端
未来影子35 分钟前
SpringAI(GA):Neo4j向量数据库存储快速上手
后端
武子康36 分钟前
大数据-95 Spark 集群 SparkSQL Action与Transformation操作 详细解释与测试案例
大数据·后端·spark
知其然亦知其所以然38 分钟前
MySQL8.x 面试高频题:为什么一定要有主键?99%的人答不全
后端·mysql·面试
FE_C_P小麦41 分钟前
Git 常用指令
前端·后端·github
某某祺1 小时前
向量存储、检索及 Qdrant 浅析
后端