Spring/SpringBoot 常用注解总结

2024-01-30 22:01:01

Spring/SpringBoot 中的注解指南：掌握代码的元数据

在 Spring/SpringBoot 开发中，注解扮演着至关重要的角色，它们为代码提供元信息和指示，简化了开发过程。本文将深入探讨 Spring/SpringBoot 中常用的注解，帮助开发者快速上手并提升开发效率。

@SpringBootApplication：项目的基石

@SpringBootApplication 注解是 Spring Boot 项目的基石，它通常用于启动类上。它相当于同时使用 @SpringBootConfiguration、@EnableAutoConfiguration 和 @ComponentScan(basePackages = "com.example") 注解。

@SpringBootConfiguration：标记为 Spring 配置类，用于定义 Bean 和组件。
@EnableAutoConfiguration：启用自动配置，根据依赖项自动配置 Spring Bean。
@ComponentScan(basePackages = "com.example")：扫描指定的包，查找 Spring 组件。

核心配置注解：定义 Bean 和组件

@Configuration：标记一个类为 Spring 配置类。
@Bean：在方法上使用，用于声明一个 Spring Bean，方法的返回值即为 Bean 的实例。
@Autowired：用于在字段或方法参数上，自动注入一个 Bean。
@Qualifier：当有多个候选 Bean 时，用于指定要注入的 Bean。
@Primary：当有多个候选 Bean 时，用于指定默认要注入的 Bean。

Web 开发注解：处理 HTTP 请求

@Controller：标记一个类为 Web 控制器，用于处理 HTTP 请求。
@RequestMapping：用于映射请求路径到控制器的方法。
@RequestParam：用于获取请求参数。
@RequestBody：用于获取请求体中的 JSON 或 XML 等数据。

业务逻辑和数据访问注解

@Service：用于标记一个服务类，提供业务逻辑。
@Repository：用于标记一个 DAO 类，提供数据访问操作。
@RestController：等同于同时使用 @Controller 和 @ResponseBody，简化 Web 开发。

其他常用注解

@JsonIgnore：用于在序列化和反序列化 JSON 时忽略一个字段。
@Override：用于覆盖父类的同名方法。
@SuppressWarnings：用于抑制编译器警告。

注解使用最佳实践

谨慎使用注解，避免滥用。
确保注解与实际代码语义一致。
遵循命名约定，例如使用大写字母开头。

常见问题解答

什么是注解？
注解是添加到代码中的元数据，提供有关代码的信息和指示。
@SpringBootApplication 注解有什么作用？
它将 Spring 配置类、自动配置和包扫描功能组合在一个注解中，简化了 Spring Boot 项目的启动。
如何自动注入 Bean？
使用 @Autowired 注解在字段或方法参数上自动注入 Bean。
如何指定要注入的 Bean？
当有多个候选 Bean 时，使用 @Qualifier 注解指定要注入的 Bean。
@Service 和 @Repository 注解有什么区别？
@Service 用于标记服务类，提供业务逻辑，而 @Repository 用于标记 DAO 类，提供数据访问操作。