Spring MVC常用十大注解

一，什么要使用注解

使用注解可以简化配置，提高代码的可读性和可维护性。通过注解可以实现依赖注入，减少手动管理对象的代码量。注解还支持面向切面编程，实现切面、切入点和通知等。此外，注解提供了声明式事务管理的支持，简化了事务配置和管理。注解还可以用于组件扫描和自动装配，提高开发效率。最后，注解在测试时也有很好的支持。总之，注解使得代码更简洁、灵活，并能更好地利用框架的功能和特性。

1.@Controller

1.作用

在使用 Spring MVC 框架开发 Web 应用程序时，@Controller 注解是用来标识一个类为控制器（Controller）的注解。控制器层负责接收用户请求，并根据请求处理逻辑选择合适的业务逻辑进行处理，最终返回响应给用户。

2.示例代码

控制器的主要作用包括：

1. 接收用户请求：控制器负责接收用户发起的请求，可以通过注解中的 @RequestMapping 来定义请求的 URL 地址和请求方法（如 GET、POST 等），从而将请求映射到相应的处理方法。

2. 处理请求：控制器包含多个处理方法，每个方法用于处理不同的请求或请求路径。这些方法通常返回数据模型、视图名称或者响应体，完成请求的处理逻辑。

3. 调用业务逻辑：控制器通过调用合适的服务层或业务逻辑组件来处理业务逻辑，以满足用户请求的需求。

4. 返回响应：控制器根据处理结果，可以选择返回数据模型给视图进行渲染，或者直接返回响应体给客户端。可以通过注解如 @ResponseBody 或 @RestController 来标识方法返回的是响应体。

下面是一个示例代码，展示了一个简单的 Spring MVC 控制器类：

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.ResponseBody;

@Controller
@RequestMapping("/example")
public class ExampleController {

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

上述代码中，通过 @Controller 注解将类标识为控制器，并使用 @RequestMapping 注解定义了请求路径的前缀为 “/example”。方法 hello() 使用 @RequestMapping 注解来定义了处理 “/hello” 路径的 GET 请求，@ResponseBody 则表示将返回的字符串直接作为响应体返回给客户端。

通过以上示例代码，可以看到控制器的作用是接收并处理用户请求，并根据请求的逻辑选择合适的处理方法进行处理，并最终返回响应给客户端。

2.@RequestMapping

1.作用

@RequestMapping 注解是 Spring MVC 框架中的一个核心注解，用于将请求映射到相应的处理方法。它可以用在类级别和方法级别上，具体作用如下：

1. 类级别的 @RequestMapping： 用于指定该类中所有处理方法的公共请求路径前缀。当用户请求的 URL 匹配该前缀时，会进入该类中的处理方法进行处理。

2. 方法级别的 @RequestMapping： 用于指定处理请求的方法和请求路径。当用户请求的 URL 匹配该路径时，会调用该方法进行处理。

2.示例代码

下面是一个示例代码：

@Controller
@RequestMapping("/example")
public class ExampleController {

    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    @ResponseBody
    public String hello() {
        return "Hello, World!";
    }
}

以上示例代码展示了类级别和方法级别的 @RequestMapping 的使用。类级别的 @RequestMapping 指定了公共请求路径前缀为 “/example”，而方法级别的 @RequestMapping 指定了处理 “/hello” 路径的 GET 请求。

这意味着，当用户访问 “/example/hello” 路径时，会由 hello() 方法来处理该请求，并将返回的字符串 “Hello, World!” 作为响应体返回给客户端。

使用 @RequestMapping 注解可以灵活地定义请求的路径和处理方法，同时支持多种请求方法（如 GET、POST、PUT、DELETE 等），以满足不同的业务需求。

3.@RequestParam

1.作用

@RequestParam 注解用于将 HTTP 请求中的参数绑定到控制器方法的参数上，即获取请求中的参数值并映射到方法参数。它支持几乎所有的数据类型，包括基本数据类型和复杂数据类型。

2.示例代码

下面是一个使用 @RequestParam 注解的示例代码：

@Controller
@RequestMapping("/example")
public class ExampleController {

    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    @ResponseBody
    public String hello(@RequestParam("name") String name) {
        return "Hello, " + name + "!";
    }
}

以上示例代码中，@RequestParam("name") 表示方法参数 name 与请求参数 name 相对应，Spring MVC 框架会自动将请求参数 name 的值注入到方法参数 name 中。

当用户访问 “/example/hello?name=world” 时，框架会将请求参数 name 的值 “world” 绑定到方法参数 name 上，并执行 hello() 方法，返回 “Hello, world!”。

此外，@RequestParam 还支持一些可选属性，例如 required 属性可以指定该参数是否是必须的，默认为 true；defaultValue 属性可以指定当参数未传递时的默认值。

总之，@RequestParam 注解是用来获取请求参数并在控制器方法中使用的重要注解，可以让我们方便地获取 HTTP 请求参数，并进行相应的处理。

4.@PathVariable

1.作用

@PathVariable 注解用于获取 URL 中的动态参数，即将 URL 中的变量映射到控制器方法的参数上。这样就可以通过 URL 传递参数，而不是通过查询字符串的方式来传递参数。

2.示例代码

下面是一个使用 @PathVariable 注解的示例代码：

@Controller
@RequestMapping("/example")
public class ExampleController {

    @RequestMapping(value = "/hello/{name}", method = RequestMethod.GET)
    @ResponseBody
    public String hello(@PathVariable("name") String name) {
        return "Hello, " + name + "!";
    }
}

以上示例代码中，@PathVariable("name") 表示将 URL 中的变量 name 映射到方法参数 name 上。

当用户访问 “/example/hello/world” 时，框架会将 URL 中的动态变量 world 绑定到方法参数 name 上，并执行 hello() 方法，返回 “Hello, world!”。

另外，@PathVariable 还支持一些可选属性，例如 required 属性可以指定该参数是否是必须的，默认为 true。如果没有提供该路径变量，则将设置为 null 值。

总之，@PathVariable 注解是用于获取 URL 中动态参数值并在控制器方法中使用的重要注解，可以方便地将 URL 中的动态变量转换为对应的方法参数值。

5.@RequestBody

1.作用

@RequestBody 注解用于将 HTTP 请求体中的数据绑定到控制器方法的参数上，即获取 POST 请求中的数据并映射到方法参数。它通常用于处理 JSON 或 XML 格式的请求体数据。

2.示例代码

下面是一个使用 @RequestBody 注解的示例代码：

@Controller
@RequestMapping("/example")
public class ExampleController {

    @RequestMapping(value = "/addUser", method = RequestMethod.POST)
    @ResponseBody
    public String addUser(@RequestBody User user) {
        // 处理用户数据
        return "User added successfully!";
    }
}

在上述示例代码中，@RequestBody 用于将 HTTP 请求体中的数据转换成 User 对象，并将其作为参数传递给 addUser() 方法进行处理。

当用户提交 POST 请求时，将会包含一个 JSON 或 XML 格式的请求体数据，然后框架会使用 Jackson 或 JAXB 等工具将其转换成 User 对象。

注意，使用 @RequestBody 注解时需要确保请求体数据的格式与方法参数类型匹配。例如，如果控制器方法的参数是 String 类型，那么请求体中的数据应该是纯文本格式的。

总之，@RequestBody 注解是用于获取 POST 请求体中的数据并在控制器方法中使用的重要注解，可以方便地将请求体中的数据转换成 Java 对象并进行相应的处理。

6.@ResponesBody

1.作用

@ResponseBody 注解用于将方法的返回值直接作为 HTTP 响应的内容，而不是通过视图解析器返回一个视图。它通常与 @RequestMapping 注解一起使用。

2.示例代码

下面是一个使用 @ResponseBody 注解的示例代码：

@Controller
@RequestMapping("/example")
public class ExampleController {

    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    @ResponseBody
    public String hello() {
        return "Hello, World!";
    }
}

在上述示例代码中，@ResponseBody 注解表示将方法的返回值直接作为 HTTP 响应的内容返回。

当用户访问 “/example/hello” 时，框架会执行 hello() 方法，并将方法返回的字符串 “Hello, World!” 作为 HTTP 响应的内容返回给客户端。

@ResponseBody 注解不仅可以返回纯文本响应，还可以返回其他类型的数据，例如 JSON 或 XML。

总之，@ResponseBody 注解用于将方法的返回值直接作为 HTTP 响应的内容返回给客户端，提供了方便的方式来返回不需要通过视图解析器进行处理的响应内容。

7.@RestController

1.作用

@RestController 是一个组合注解，它是 @Controller 和 @ResponseBody 两个注解的整合。它表示控制器类中的所有方法都会返回 JSON、XML 或其他格式的数据，而不是视图。

2.示例代码

下面是一个使用 @RestController 注解的示例代码：

@RestController
@RequestMapping("/example")
public class ExampleController {

    @RequestMapping(value = "/hello", method = RequestMethod.GET)
    public String hello() {
        return "Hello, World!";
    }
}

在上述示例代码中，@RestController 表示该控制器类中的所有方法都将返回数据（可以是 JSON、XML 等格式），而不是视图。

当用户访问 “/example/hello” 时，框架会执行 hello() 方法，并将其返回的字符串 “Hello, World!” 作为 HTTP 响应的内容返回给客户端。

与 @Controller 注解不同的是，如果使用 @RestController 注解，则不必为每个方法都添加 @ResponseBody 注解，因为该注解已经包含在 @RestController 中了。

总之，@RestController 注解是用于表示控制器类中所有方法都将返回数据的注解，方便快捷地返回 JSON、XML 或其他格式的响应内容，减少了在控制器方法中添加 @ResponseBody 注解的重复性工作。

8.@ModelAttribute

1.作用

@ModelAttribute 注解用于绑定请求参数到方法的参数或方法级别的模型属性上。

2.示例代码

1. 绑定请求参数到方法的参数上：

   @RequestMapping(value = "/example", method = RequestMethod.GET)
   public String example(@ModelAttribute("name") String name) {
       // 处理请求参数
       return "Hello, " + name + "!";
   }
   

   在上述示例代码中，@ModelAttribute("name") 表示将名为 “name” 的请求参数绑定到方法的 name 参数上。当用户发送一个 GET 请求时，例如 /example?name=John，框架会自动将请求参数中的 “name” 值赋值给 name 参数。

2. 绑定请求参数到方法级别的模型属性：

   @ModelAttribute("user")
   public User getDefaultUser() {
       User user = new User();
       user.setName("John");
       user.setAge(20);
       return user;
   }
   

   在上述示例代码中，@ModelAttribute("user") 表示将方法返回的 User 对象绑定为模型属性，并使用 “user” 作为模型属性的名称。

   当在视图中需要访问该模型属性时，可以直接使用 ${user} 进行访问。例如，在 JSP 视图中，可以使用 ${user.name} 获取用户的名称。

总之，@ModelAttribute 注解用于绑定请求参数到方法的参数或方法级别的模型属性上，提供了方便的方式来获取请求参数或预设模型属性的值，并在控制器方法中进行处理或在视图中使用。

9.@SessionAttributes

1.作用

@SessionAttributes 注解是用于将模型属性暂时存储在会话（Session）中的注解。它可以用在控制器类级别或控制器方法级别。

2.示例代码

1. 在控制器类级别使用 @SessionAttributes：

   @Controller
   @SessionAttributes("user")
   public class UserController {
   
       // ...
   }
   

   在上述示例代码中，@SessionAttributes("user") 表示将名为 “user” 的模型属性存储在会话中。当请求处理方法返回时，存储在会话中的模型属性将保留下来，直到会话结束或被清除。

2. 在控制器方法级别使用 @SessionAttributes：

   @Controller
   @SessionAttributes("user")
   public class UserController {
   
       @RequestMapping(value = "/user", method = RequestMethod.GET)
       public String getUser(@RequestParam("id") int id, Model model) {
           User user = userService.getUserById(id);
           model.addAttribute("user", user);
           return "user";
       }
   }
   

   在上述示例代码中，@SessionAttributes("user") 表示将控制器方法中添加的名为 “user” 的模型属性存储在会话中。在这个例子中，getUser() 方法从数据库中获取用户信息，并将其添加到模型中。模型属性 “user” 将存储在会话中，并在后续请求中仍然可用。

需要注意的是，@SessionAttributes 注解只能用于存储模型属性，不能用于存储任意类型的对象。

总结来说，@SessionAttributes 注解用于将模型属性存储在会话中。通过在控制器类或方法上添加该注解，可以方便地管理会话中的模型属性，并在多个请求之间共享数据。

10.@ExceptionHandler

1.作用

@ExceptionHandler 注解用于定义一个处理异常的方法。它可以用在控制器类级别或控制器方法级别。

2.示例代码

1. 在控制器类级别使用 @ExceptionHandler：

   @ControllerAdvice
   public class GlobalExceptionHandler {
       
       @ExceptionHandler(Exception.class)
       public ModelAndView handleException(Exception e) {
           ModelAndView mv = new ModelAndView();
           mv.addObject("errMsg", "系统异常：" + e.getMessage());
           mv.setViewName("error");
           return mv;
       }
   }
   

   在上述示例代码中，@ControllerAdvice 注解用于定义一个全局的异常处理器，可以处理所有控制器中抛出的异常。@ExceptionHandler(Exception.class) 注解表示该方法用于处理所有类型的异常。当控制器中抛出异常时，就会调用该方法来处理异常，并返回错误页面。

2. 在控制器方法级别使用 @ExceptionHandler：

   @Controller
   public class UserController {
       
       @ExceptionHandler(UserNotFoundException.class)
       public ModelAndView handleUserNotFoundException(UserNotFoundException e) {
           ModelAndView mv = new ModelAndView();
           mv.addObject("errMsg", "用户不存在：" + e.getMessage());
           mv.setViewName("error");
           return mv;
       }
       
       @RequestMapping(value = "/user/{id}", method = RequestMethod.GET)
       public String getUser(@PathVariable("id") int id) {
           User user = userService.getUserById(id);
           if (user == null) {
               throw new UserNotFoundException("id=" + id);
           }
           return "user";
       }
   }
   

   在上述示例代码中，@ExceptionHandler(UserNotFoundException.class) 注解表示该方法用于处理 UserNotFoundException 类型的异常。当控制器方法中抛出该异常时，就会调用该方法来处理异常，并返回错误页面。

总之，@ExceptionHandler 注解用于定义一个处理异常的方法，可以用在控制器类级别或控制器方法级别。通过添加该注解，可以方便地处理控制器中抛出的异常，并返回错误信息或错误页面。