SpringBoot常用注解与注意事项

SpringBoot常用注解与注意事项

Spring Boot 是一个用于快速开发、运行和管理 Spring 应用程序的框架。它大量使用了注解（Annotati）来简化配置和开发流程。

以下是一些 Spring Boot 中常用的注解及其注意事项：

1.常用注解

1. @SpringBootApplication
   • 这是一个组合注解，用于启动 Spring Boot 应用。它包括 @Configuration、@EnableAutoConfiguration 和 @ComponentScan。
   • 注意：它通常放在主类上。
   • @Configuration
     • @Configuration 注解表示一个类作为 Spring 的配置类，它的作用等同于 Spring 的 XML 配置文件。在这个类中，你可以通过声明 @Bean 注解的方法来定义 Bean。
     • 被 @Configuration 标记的类会被 Spring 容器处理，以检测类内部的 @Bean 方法。
     • 这个注解的作用是简化 Spring 的 Java 配置，使得配置更加直观和类型安全。
   • @EnableAutoConfiguration
     • @EnableAutoConfiguration 注解告诉 Spring Boot 根据添加的 jar 依赖自动配置你的 Spring 应用。例如，如果类路径下有 Spring MVC 的依赖，Spring Boot 会自动配置你的应用为一个 Spring MVC 应用。
     • 这个注解会自动载入应用程序所需的所有 Bean，这依赖于 Spring Boot 在类路径中的查。
     • 如果你想要关闭特定的自动配置，可以使用 @EnableAutoConfiguration(exclude={, }) 来排除它们。
   • @ComponentScan
     • @ComponentScan 注解用于自动检测和注册 Spring 组件（如 @Component、@Service、@Repository、@Controller 等）。
     • 这个注解会扫描指定包路径下的类，并检测这些类上是否有 Spring 的组件注解，如果有，则将其注册为 Spring 容器中的 Bean。
     • 你可以通过 basePackages 属性或者 basePackageClasses 属性来指定 @ComponentScan 的扫描范围。
2. @Component, @Service, @Repository
   • 用于标记类作为 Spring 的组件，@Service 和 @Repository 是 @Component 的特化。
   • 注意：这些类会被自动扫描并注册为 Spring 应用上下文中的 Bean。
3. @Autowired
   • 用于自动装配依赖。
   • 注意：过度使用可能会导致依赖关系不明确。
4. @RestController 和 @Controller
   • @RestController 是 @Controller 和 @RespeBody 的组合，表示该类的所有方法返回值直接作为 HTTP 响应体。
   • 注意：@Controller 需要配合 @RespeBody 或返回 View 对象。
5. @RequestMapping 和 @GetMapping, @PostMapping
   • 用于映射 HTTP 请求到控制器方法。
   • 注意：@GetMapping 和 @PostMapping 是 @RequestMapping 的特化。
6. @PathVariable, @RequestParam, @RequestBody
   • 用于处理请求参数。
   • 注意：@PathVariable 用于 URL 路径，@RequestParam 用于查询参数，@RequestBody 用于请求体。
7. @Configuration
   • 用于标记配置类。
   • 注意：该类中的方法会被认为是 Bean 定义，并注册到 Spring 应用上下文中。
8. @Bean
   • 用于在配置类中定义 Bean。
   • 注意：方法名默认为 Bean 的 ID。
9. @Profile
   • 用于指定配置文件。
   • 注意：只有在该配置文件激活时，标记的 Bean 或配置才会生效。
10. @EnableAutoConfiguration
    • 启用自动配置。
    • 注意：这可能会导致一些不期望的自动配置，可以通过 @SpringBootApplication(exclude={...}) 来排除。

2.注意事项

1. 依赖注入
   • 推荐使用构造器注入，它能够保证所需的依赖不会被忽略，并且构造器注入的组件总是被完全初始化。
2. 配置文件
   • Spring Boot 支持多种外部化配置，如 YAML、属性文件等。推荐使用 YAML 因为它的结构更加清晰。
3. 条件注解
   • 如 @ConditionalOnProperty、@ConditionalOnClass 等，用于在满足特定条件时创建 Bean 或启用配置。
4. 测试
   • Spring Boot 提供了 @SpringBootTest 等注解，用于测试。注意测试时模拟环境和真实环境可能会有所不同。
5. 性能
   • 使用 @Async 标记异步方法，但要注意线程管理和异步结果的处理。
6. 安全性
   • 使用 @EnableGlobalMethodSecurity 等注解来增强方法的安全性。
7. 细节方面
8. 需要添加@EnableAutoConfiguration注解或@SpringBootApplication注解启动自动配置。
9. 需要在pom.xml文件中引入相应的依赖。
10. 需要配置application.properties或application.yml文件来配置应用程序的属性。
11. 需要使用@RestController注解而不是@Controller注解来标注Controller类，以便自动将方法的返回值转换为JSO数据。
12. 需要在方法上添加@RespeBody注解以便将方法的返回值转换为JSO数据返回给客户端。
13. 需要在方法上添加@RequestMapping注解来标注请求的URL路径。
14. 需要在方法的参数上添加@RequestParam、@PathVariable或@RequestBody注解来标注请求的参数。

这些只是 Spring Boot 中注解的一部分，实际使用时还需要结合具体场景和需求。