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 中注解的一部分,实际使用时还需要结合具体场景和需求。

目录
打赏
0
0
0
0
30
分享
相关文章
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
78 0
Spring IOC—基于注解配置和管理Bean 万字详解(通俗易懂)
Spring 第三节 IOC——基于注解配置和管理Bean 万字详解!
153 26
SpringBoot缓存注解使用
Spring Boot 提供了一套方便的缓存注解,用于简化缓存管理。通过 `@Cacheable`、`@CachePut`、`@CacheEvict` 和 `@Caching` 等注解,开发者可以轻松地实现方法级别的缓存操作,从而提升应用的性能和响应速度。合理使用这些注解可以大大减少数据库的访问频率,优化系统性能。
213 89
SpringBoot+@Async注解一起用,速度提升
本文介绍了异步调用在高并发Web应用性能优化中的重要性,对比了同步与异步调用的区别。同步调用按顺序执行,每一步需等待上一步完成;而异步调用无需等待,可提升效率。通过Spring Boot示例,使用@Async注解实现异步任务,并借助Future对象处理异步回调,有效减少程序运行时间。
【Spring】方法注解@Bean,配置类扫描路径
@Bean方法注解,如何在同一个类下面定义多个Bean对象,配置扫描路径
198 73
|
1月前
|
SpringBoot:SpringBoot通过注解监测Controller接口
本文详细介绍了如何通过Spring Boot注解监测Controller接口,包括自定义注解、AOP切面的创建和使用以及具体的示例代码。通过这种方式,可以方便地在Controller方法执行前后添加日志记录、性能监控和异常处理逻辑,而无需修改方法本身的代码。这种方法不仅提高了代码的可维护性,还增强了系统的监控能力。希望本文能帮助您更好地理解和应用Spring Boot中的注解监测技术。
72 16
【SpringFramework】Spring IoC-基于注解的实现
本文主要记录基于Spring注解实现IoC容器和DI相关知识。
71 21
【Spring】获取Bean对象需要哪些注解
@Conntroller,@Service,@Repository,@Component,@Configuration,关于Bean对象的五个常用注解
100 12
【Spring配置】idea编码格式导致注解汉字无法保存
问题一:对于同一个项目,我们在使用idea的过程中,使用汉字注解完后,再打开该项目,汉字变成乱码问题二:本来a项目中,汉字注解调试好了,没有乱码了,但是创建出来的新的项目,写的注解又成乱码了。
|
4月前
|
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
208 4
SpringBoot必须掌握的常用注解!

热门文章

最新文章

AI助理

你好,我是AI助理

可以解答问题、推荐解决方案等