Spring MVC注解大全，让你的代码更简洁优雅！

2023-08-19 01:01:43

掌握 Spring MVC 注解：提升 Web 开发技能的终极指南

拥抱注解的力量

Spring MVC 是一款久负盛名的 Web 开发框架，其易用性和强大功能深受开发人员青睐。而注解，作为一种简化代码和提高效率的工具，在 Spring MVC 中扮演着至关重要的角色。通过掌握这些注解，您可以轻松驾驭 Spring MVC，打造优雅而高效的 Web 应用程序。

1. @RequestMapping：请求映射的基石

@RequestMapping 是 Spring MVC 的核心注解，用于映射 Web 请求。您可以将其应用于类或方法，以便指定请求路径和相应的处理程序。

代码示例：

@RequestMapping("/hello")
public String hello() {
    return "Hello, world!";
}

2. @GetMapping、@PostMapping、@PutMapping 和 @DeleteMapping：针对 HTTP 动词的映射

这些注解是 @RequestMapping 的子注解，专门用于映射特定 HTTP 动词：GET、POST、PUT 和 DELETE。它们简化了不同 HTTP 请求的处理。

代码示例：

@GetMapping("/users")
public List<User> getAllUsers() {
    // ...
}

@PostMapping("/users")
public User createUser(@RequestBody User user) {
    // ...
}

3. @RequestParam 和 @PathVariable：绑定请求参数和路径变量

@RequestParam 用于将请求参数绑定到方法参数，而 @PathVariable 则用于绑定 URL 路径中的占位符。这使得访问请求数据变得简单便捷。

代码示例：

public String greet(@RequestParam String name) {
    return "Hello, " + name + "!";
}

public User getUser(@PathVariable Long id) {
    // ...
}

4. @RequestBody：从请求体中解析 JSON

@RequestBody 注解用于将请求体中的 JSON 数据绑定到方法参数。它简化了从客户端接收复杂数据的处理。

代码示例：

public User createUser(@RequestBody User user) {
    // ...
}

5. @ModelAttribute：向模型添加数据

@ModelAttribute 注解用于向请求上下文中添加模型数据。这允许您轻松地将数据传递到视图或其他控制器方法中。

代码示例：

@ModelAttribute("currentUser")
public User getCurrentUser() {
    // ...
}

6. @Valid：数据验证

@Valid 注解用于对方法参数进行数据验证。它可以与 JSR-303 Bean Validation 框架一起使用，以确保传入的数据符合预定义的约束。

代码示例：

public User createUser(@Valid @RequestBody User user) {
    // ...
}

7. @ExceptionHandler 和 @ControllerAdvice：异常处理

@ExceptionHandler 注解用于处理方法中抛出的异常，而 @ControllerAdvice 则用于全局处理异常。这些注解提供了灵活且强大的方式来处理意外情况。

代码示例：

@ExceptionHandler(Exception.class)
public String handleException(Exception e) {
    // ...
}

8. @RestController 和 @ResponseBody：响应 JSON

@RestController 是一个组合注解，相当于 @Controller 和 @ResponseBody。它用于指示该控制器中的所有方法都返回 JSON 数据。@ResponseBody 注解用于将方法的返回值转换为 JSON。

代码示例：

@RestController
public class UserController {
    
    @GetMapping("/users")
    public List<User> getAllUsers() {
        // ...
    }
}

9. @EnableWebMvc 和 @SpringBootApplication：Spring MVC 启用和配置

@EnableWebMvc 注解用于启用 Spring MVC，而 @SpringBootApplication 是一个组合注解，用于配置 Spring Boot 应用程序。这些注解提供了 Spring MVC 的基本配置。

代码示例：

@SpringBootApplication
public class MyApp {
    
    @EnableWebMvc
    public static void main(String[] args) {
        SpringApplication.run(MyApp.class, args);
    }
}