SpringMVC框架中的常用注解
目录标题
- 一、在控制器层（Controller）使用的注解：
-
- 1、@Controller：
- 2、@RequestMapping：
- 3、@RequestParam：
- 4、@PathVariable：
- 5、@PatchMapping：
- 二、CURD
-
- 1、@GetMapping: (查询)
- 2、@PostMapping: (新增)
- 3、@PutMapping:(更新)
- 4、@DeleteMapping:(删除)
- 5、@PatchMapping:
- 三、在服务层（Service）使用的注解：
-
- 1、@Service：
- 四、在数据访问层（Repository）使用的注解：
-
- 1、@Repository：
- 五、在实体类（Entity）使用的注解：
-
- 1、@Entity：
- 六、请求参数相关注解：
-
- 1、@RequestBody：
- 2、@ResponseBody：
- 七、@Autowired：
- 、八@ComponentScan：
- 九、@Configuration：
- 十、@Bean：
Spring MVC 框架中的常用注解主要包括在控制器层（Controller）、服务层（Service）、数据访问层（Repository）、实体类（Entity）、请求参数（Request Parameters）等方面。以下是这些注解的主要含义和用例
@Autowired、@ComponentScan、@Configuration 和 @Bean 是 Spring 框架中常用的注解，用于实现依赖注入和配置管理。
一、在控制器层（Controller）使用的注解：
1、@Controller：
- 含义： 标识一个类为 Spring MVC 控制器。
用例：
@Controller
public class MyController {
// Controller methods
}
2、@RequestMapping：
- 含义： 映射 HTTP 请求的 URL 到一个具体的处理方法。
用例：
@Controller
@RequestMapping("/example")
public class MyController {
@RequestMapping("/hello")
public String hello() {
return "hello";
}
}
3、@RequestParam：
- 含义： 用于提取请求中的参数值。
- 客户端发送请求 /example/greet?name=John
用例：
@Controller
@RequestMapping("/example")
public class MyController {
@RequestMapping("/greet")
public String greet(@RequestParam("name") String name) {
return "Hello, " + name + "!";
}
}
4、@PathVariable：
- 含义： 用于将 URI 模板变量映射到处理方法的参数。
- 客户端发送请求 /example/user/123
用例：
@Controller
@RequestMapping("/example")
public class MyController {
@RequestMapping("/user/{id}")
public String getUserById(@PathVariable("id") Long userId) {
// Retrieve user with the specified ID
return "userDetails";
}
}
5、@PatchMapping：
- 含义：用于映射PATCH请求到控制器方法。@PatchMapping是一个用于映射HTTP PATCH请求到控制器方法的注解，在SpringMVC中也可以使用。它可以用于方法级别，用于指定处理PATCH请求的方法。
用例：
@Controller
@RequestMapping("/users")
public class UserController {
@PatchMapping("/{id}")
public String updateUser(@PathVariable Long id, @RequestBody User user) {
// ...
}
}
二、CURD
1、@GetMapping: (查询)
- 含义：处理 HTTP GET 请求。
用例：
@Controller
@RequestMapping("/users")
public class UserController {
@GetMapping("/{id}")
public String getUser(@PathVariable Long id) {
// ...
}
}
}
2、@PostMapping: (新增)
- 含义：处理 HTTP POST 请求。
用例：
@Controller
@RequestMapping("/users")
public class UserController {
@PostMapping
public String createUser(@ModelAttribute User user) {
// ...
}
}
3、@PutMapping:(更新)
- 含义：处理 HTTP PUT 请求。
用例：
@Controller
@RequestMapping("/users")
public class UserController {
@PutMapping("/{id}")
public String updateUser(@PathVariable Long id, @ModelAttribute User user) {
// ...
}
}
4、@DeleteMapping:(删除)
- 含义：处理 HTTP DELETE 请求。
用例：
@Controller
@RequestMapping("/users")
public class UserController {
@DeleteMapping("/{id}")
public String deleteUser(@PathVariable Long id) {
// ...
}
}
5、@PatchMapping:
- 含义：处理 HTTP PATCH 请求。
用例：
@Controller
@RequestMapping("/users")
public class UserController {
@PatchMapping("/{id}")
public String updateUser(@PathVariable Long id, @RequestBody User user) {
// ...
}
}
三、在服务层（Service）使用的注解：
1、@Service：
- 含义： 标识一个类为服务层的组件。
用例：
@Service
public class MyService {
// Service methods
}
@Service 是 Spring Framework 中的一个注解，用于标识一个类为服务层（Service Layer）的组件。服务层通常包含应用程序的业务逻辑，负责处理业务规则、调用数据访问层（Repository 或 DAO）执行数据库操作，并协调应用程序的不同部分
-
组件扫描： @Service 是 Spring 的组件扫描机制的一部分，标识带有该注解的类为一个服务层组件。在应用程序启动时，Spring 会扫描包路径下的所有组件，并注册为 Spring 容器中的 Bean。
-
依赖注入： 通过将 @Service 注解添加到类上，Spring IoC 容器会自动将该类的实例注入到其他需要依赖的组件中，例如控制器（Controller）或其他服务层组件。
-
事务管理： 在服务层执行的方法通常涉及数据库操作，@Service 注解通常与 @Transactional 注解一起使用，以启用事务管理。这确保了在业务方法中的一系列操作要么全部成功，要么全部失败（回滚）。
用例：
@Service
public class MyService {
@Autowired
private MyRepository myRepository;
public String performBusinessLogic() {
// Business logic implementation
return "Business logic executed successfully";
}
public List<MyEntity> getAllEntities() {
return myRepository.findAll();
}
}
四、在数据访问层（Repository）使用的注解：
1、@Repository：
- 含义： 标识一个类为数据访问层的组件，通常与 Spring 的数据访问异常转换一起使用。
用例：
@Repository
public class MyRepository {
// Repository methods
}
五、在实体类（Entity）使用的注解：
1、@Entity：
- 含义： 标识一个类为 JPA 实体类。
用例：
@Entity
public class User {
// Entity properties and methods
}
@Entity 注解是 Java Persistence API (JPA) 的一部分，用于标识一个类为 JPA 实体类。JPA 是一种规范，用于描述如何通过 Java 对象与关系型数据库进行映射。@Entity 注解告诉 JPA，被注解的类将映射到数据库中的一个表。
-
数据库映射： @Entity 注解告诉 JPA 这个类与数据库中的表存在映射关系。类中的字段（成员变量）通常与表中的列相对应。
-
主键标识： 实体类通常需要一个主键，用于唯一标识每个实体对象。通过 @Entity 注解，JPA 可以识别实体类中的主键。
-
实体类识别： 当应用程序使用 JPA 进行持久化操作时，JPA 需要知道哪些类是实体类。@Entity 注解是 JPA 识别实体类的标志。
-
持久性操作： 通过实体类，可以执行 CRUD（Create, Read, Update, Delete）操作。JPA 提供了 EntityManager 接口，可以用于执行这些操作。
-
关系映射： 实体类之间的关系可以通过 JPA 进行映射，包括一对一、一对多、多对一、多对多等关系。
示例：
@Entity
public class User {
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
private Long id;
@Column(name = "username")
private String username;
@Column(name = "email")
private String email;
// Getters and setters
}
六、请求参数相关注解：
1、@RequestBody：
- 含义： 用于将 HTTP 请求的正文映射到方法参数。
用例：
@Controller
@RequestMapping("/example")
public class MyController {
@RequestMapping("/processJson")
public String processJson(@RequestBody MyJsonModel jsonModel) {
// Process JSON data
return "result";
}
}
2、@ResponseBody：
- 含义： 表示方法的返回值直接作为响应体，而不是视图名称。
用例：
@Controller
@RequestMapping("/example")
public class MyController {
@RequestMapping("/getJson")
@ResponseBody
public MyJsonModel getJson() {
// Return JSON data directly
}
}
七、@Autowired：
- 含义： 用于自动装配，将指定类型的 Bean 注入到属性、构造函数或方法参数中。
用例：
@Service
public class MyService {
private final MyRepository repository;
@Autowired
public MyService(MyRepository repository) {
this.repository = repository;
}
}
在上例中，MyService 类通过 @Autowired 注解将 MyRepository 类型的 Bean 自动注入到构造函数中。
、八@ComponentScan：
- 含义： 扫描指定包路径，寻找标有 @Component、@Service、@Repository、@Controller 注解的类，并将其注册为 Spring Bean。
用例：
@Configuration
@ComponentScan(basePackages = "com.example")
public class AppConfig {
// Configuration content
}
在上例中，@ComponentScan 注解扫描 com.example 包路径下的所有类，将带有相应注解的类注册为 Spring Bean。
九、@Configuration：
- 含义： 声明当前类是一个配置类，通常与 @Bean 注解一起使用，用于配置 Spring 应用上下文。
用例：
@Configuration
public class AppConfig {
// Bean declarations using @Bean
}
在上例中，AppConfig 被声明为配置类，用于定义 Spring Bean。
十、@Bean：
- 含义： 在配置类中使用，用于声明一个 Bean。
用例：
@Configuration
public class AppConfig {
@Bean
public MyService myService() {
return new MyService(myRepository());
}
@Bean
public MyRepository myRepository() {
return new MyRepository();
}
}
在上例中，@Bean 注解用于声明两个 Bean：MyService 和 MyRepository。