当前位置：首页 > article >正文

SpringMVC 中的常用注解和用法

article 2024/10/23 4:59:52

SpringMVC是一个基于Java的Web框架，它提供了丰富的注解来简化开发。以下是一些SpringMVC中常用的注解及其用法：

一、控制器层（Controller）注解

@Controller
- 含义：标识一个类为Spring MVC控制器。
- 用法：通常用于类级别，表示该类是一个控制器，负责处理HTTP请求。
@RestController
- 含义：标识一个类是RESTful Web服务的控制器，其本身不会做视图解析，而是直接将对象写入到HTTP响应正文中。
- 用法：通常用于类级别，是@Controller和@ResponseBody的结合体，简化了RESTful服务的开发。
@RequestMapping
- 含义：映射HTTP请求的URL到一个具体的处理方法。可以处理GET、POST、PUT、DELETE等多种请求方法。
- 用法：可以用于类级别和方法级别。类级别的注解可以定义通用的请求映射前缀，方法级别的注解则定义具体的请求路径和请求方法类型。
@GetMapping、@PostMapping、@PutMapping、@DeleteMapping
- 含义：分别用于处理GET、POST、PUT、DELETE请求，是@RequestMapping的简化形式。
- 用法：通常用于方法级别，直接指定请求路径和请求方法类型。
@PatchMapping
- 含义：用于映射PATCH请求到控制器方法。
- 用法：用于方法级别，可以处理部分更新操作。

二、请求参数注解

@RequestParam
- 含义：用于提取请求中的参数值，并将其绑定到方法的参数上。
- 用法：在方法参数前使用，可以指定参数名、是否必需等属性。如果请求参数名与@RequestParam声明的名称不一致，则无法进行参数绑定和赋值。
@PathVariable
- 含义：用于将URI模板变量映射到处理方法的参数上。
- 用法：在方法参数前使用，与URI中的占位符对应。
@RequestBody
- 含义：用于将HTTP请求体中的JSON或XML数据绑定到方法的参数上，通常用于处理非表单数据。
- 用法：在方法参数前使用，通常与@PostMapping或@PutMapping等注解结合使用。
@RequestPart
- 含义：用于处理文件上传，将请求中的文件部分绑定到MultipartFile类型的参数上。
- 用法：在方法参数前使用，通常与@PostMapping注解结合使用。
@CookieValue
- 含义：用于获取HTTP请求中的Cookie值，并将其绑定到方法的参数上。
- 用法：在方法参数前使用，可以指定Cookie的名称。
@SessionAttribute
- 含义：用于将模型中的属性存储到会话中，以便多个请求之间共享相同的模型属性。
- 用法：只能用于类上，无法用于方法上。可以指定要存储的属性名称或类型。
@RequestHeader
- 含义：提供了一种方便的方式来获取并绑定HTTP请求头信息到方法参数上。
- 用法：在方法参数前使用，可以指定请求头的名称。

三、服务层（Service）和数据访问层（Repository）注解

@Service
- 含义：标识一个类为服务层的组件。
- 用法：通常用于类级别，表示该类包含业务逻辑，负责处理业务规则和调用数据访问层执行数据库操作。
@Repository
- 含义：表示持久层的注解，用于标识数据访问组件。
- 用法：通常用于类级别，表示该类负责数据访问和数据库操作。

四、其他常用注解

@Autowired
- 含义：用于实现依赖注入，自动装配Spring容器中的bean。
- 用法：可以用于字段、方法或构造函数上。
@ComponentScan
- 含义：用于指定Spring在初始化时需要扫描的包路径，以便找到带有@Component、@Service、@Repository等注解的类，并将其注册为Spring容器中的bean。
- 用法：通常用于配置类上。
@Component
- 含义：通用的组件注解，标识一个类为Spring组件，会被自动扫描并创建Bean。
- 用法：通常用于类级别。
@ResponseBody
- 含义：指示方法返回的对象应该直接写入HTTP响应体中，而不是视图渲染。
- 用法：通常用于方法级别，与@RequestMapping等注解结合使用。