SpringBoot常用注解与注意事项

简介: SpringBoot常用注解与注意事项

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

以下是一些 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 的依赖,SpringBoot 会自动配置你的应用为一个 Spring MVC 应用。
  • 这个注解会自动载入应用程序所需的所有 Bean,这依赖于 Spring Boot 在类路径中的查找。
  • 如果你想要关闭特定的自动配置,可以使用 @EnableAutoConfiguration(exclude={Class1.class, Class2.class}) 来排除它们。
  • @ComponentScan
  • @ComponentScan 注解用于自动检测和注册 Spring 组件(如 @Component@Service@Repository@Controller 等)。
  • 这个注解会扫描指定包路径下的类,并检测这些类上是否有 Spring 的组件注解,如果有,则将其注册为 Spring 容器中的 Bean。
  • 你可以通过 basePackages 属性或者 basePackageClasses 属性来指定 @ComponentScan 的扫描范围。
  1. @Component, @Service, @Repository
  • 用于标记类作为 Spring 的组件,@Service@Repository@Component 的特化。
  • 注意:这些类会被自动扫描并注册为 Spring 应用上下文中的 Bean。
  1. @Autowired
  • 用于自动装配依赖。
  • 注意:过度使用可能会导致依赖关系不明确。

@RestController@Controller

  • @RestController@Controller@ResponseBody 的组合,表示该类的所有方法返回值直接作为 HTTP 响应体。
  • 注意:@Controller 需要配合 @ResponseBody 或返回 View 对象。
  1. @RequestMapping@GetMapping, @PostMapping
  • 用于映射 HTTP 请求到控制器方法。
  • 注意:@GetMapping@PostMapping@RequestMapping 的特化。
  1. @PathVariable, @RequestParam, @RequestBody
  • 用于处理请求参数。
  • 注意:@PathVariable 用于 URL 路径,@RequestParam 用于查询参数,@RequestBody 用于请求体。
  1. @Configuration
  • 用于标记配置类。
  • 注意:该类中的方法会被认为是 Bean 定义,并注册到 Spring 应用上下文中。
  1. @Bean
  • 用于在配置类中定义 Bean。
  • 注意:方法名默认为 Bean 的 ID。
  1. @Profile
  • 用于指定配置文件。
  • 注意:只有在该配置文件激活时,标记的 Bean 或配置才会生效。
  1. @EnableAutoConfiguration
  • 启用自动配置。
  • 注意:这可能会导致一些不期望的自动配置,可以通过 @SpringBootApplication(exclude={...}) 来排除。

2.注意事项

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

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

相关文章
|
5天前
|
XML 安全 Java
Spring高手之路19——Spring AOP注解指南
在本文中,我们将深入探索Spring AOP(面向切面编程)的核心概念及其在现代Spring应用中的实际应用。从基本的注解使用到复杂的切面配置,本文将一步步指导你如何利用Spring AOP提升代码的模块化,帮助你在Spring开发路上更进一步。
19 3
Spring高手之路19——Spring AOP注解指南
|
3天前
|
XML Java 数据格式
Spring Boot自动配置是通过`@EnableAutoConfiguration`注解启用的
【6月更文挑战第18天】Spring Boot的`@EnableAutoConfiguration`启动自动配置,基于类路径扫描和条件注解(如@ConditionalOnClass)选择性应用配置。当检测到特定依赖时,自动配置模块会将对应的bean添加到应用上下文,简化了XML或Java配置。只需添加依赖,即可自动配置功能。
15 4
|
1天前
|
Java Spring
在Spring Boot中,可以通过控制`@PostConstruct`注解方法的执行顺序来实现初始化时的顺序控制
在Spring Boot中,可以通过控制`@PostConstruct`注解方法的执行顺序来实现初始化时的顺序控制
9 1
|
1天前
|
Java Spring 容器
在 Spring Boot 中,条件装配(Conditional Configuration)和条件注解(Conditional Annotations)
在 Spring Boot 中,条件装配(Conditional Configuration)和条件注解(Conditional Annotations)
7 1
|
3天前
|
缓存 NoSQL Java
在 SSM 架构(Spring + SpringMVC + MyBatis)中,可以通过 Spring 的注解式缓存来实现 Redis 缓存功能
【6月更文挑战第18天】在SSM(Spring+SpringMVC+MyBatis)中集成Redis缓存,涉及以下步骤:添加Spring Boot的`spring-boot-starter-data-redis`依赖;配置Redis连接池(如JedisPoolConfig)和连接工厂;在Service层使用`@Cacheable`注解标记缓存方法,指定缓存名和键生成策略;最后,在主配置类启用缓存注解。通过这些步骤,可以利用Spring的注解实现Redis缓存。
19 2
|
7天前
|
前端开发 Java 开发者
深入理解 Spring Boot 注解:核心功能与高级用法详解
深入理解 Spring Boot 注解:核心功能与高级用法详解
13 1
|
28天前
|
Java Spring 容器
Spring注解开发,bean的作用范围及生命周期、Spring注解开发依赖注入
Spring注解开发,bean的作用范围及生命周期、Spring注解开发依赖注入
34 1
Spring注解开发,bean的作用范围及生命周期、Spring注解开发依赖注入
|
12天前
|
Java 调度 Spring
SpringBoot多个@Scheduled注解的方法,会阻塞吗
【6月更文挑战第9天】SpringBoot多个@Scheduled注解的方法,会阻塞吗
20 5
|
14天前
|
前端开发 Java 关系型数据库
在Spring3 MVC中五步配置集成注解方式Hibernate3
在Spring3 MVC中五步配置集成注解方式Hibernate3
22 3
|
16天前
|
缓存 Java 数据库连接
探究Spring Boot中@PostConstruct注解的使用场景
【6月更文挑战第2天】在Spring Boot开发过程中,了解和合理利用@PostConstruct注解是非常重要的。这个简单却强大的注解能够帮助开发者在依赖注入完成之后执行初始化逻辑,从而确保组件在使用前已经完全准备就绪。
27 4