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

相关文章
|
11天前
|
XML Java 数据格式
SpringBoot入门(8) - 开发中还有哪些常用注解
SpringBoot入门(8) - 开发中还有哪些常用注解
30 0
|
1月前
|
Java Spring 容器
如何解决spring EL注解@Value获取值为null的问题
本文探讨了在使用Spring框架时,如何避免`@Value("${xxx.xxx}")`注解导致值为null的问题。通过具体示例分析了几种常见错误场景,包括类未交给Spring管理、字段被`static`或`final`修饰以及通过`new`而非依赖注入创建对象等,提出了相应的解决方案,并强调了理解框架原理的重要性。
136 4
|
28天前
|
JSON 安全 算法
|
30天前
|
Java Spring
在使用Spring的`@Value`注解注入属性值时,有一些特殊字符需要注意
【10月更文挑战第9天】在使用Spring的`@Value`注解注入属性值时,需注意一些特殊字符的正确处理方法,包括空格、引号、反斜杠、新行、制表符、逗号、大括号、$、百分号及其他特殊字符。通过适当包裹或转义,确保这些字符能被正确解析和注入。
|
18天前
|
XML JSON Java
SpringBoot必须掌握的常用注解!
SpringBoot必须掌握的常用注解!
42 4
SpringBoot必须掌握的常用注解!
|
1月前
|
XML Java 数据格式
Spring从入门到入土(bean的一些子标签及注解的使用)
本文详细介绍了Spring框架中Bean的创建和使用,包括使用XML配置文件中的标签和注解来创建和管理Bean,以及如何通过构造器、Setter方法和属性注入来配置Bean。
69 9
Spring从入门到入土(bean的一些子标签及注解的使用)
|
20天前
|
存储 缓存 Java
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
Spring缓存注解【@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig】使用及注意事项
65 2
|
20天前
|
JSON Java 数据库
SpringBoot项目使用AOP及自定义注解保存操作日志
SpringBoot项目使用AOP及自定义注解保存操作日志
34 1
|
1月前
|
架构师 Java 开发者
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
在40岁老架构师尼恩的读者交流群中,近期多位读者成功获得了知名互联网企业的面试机会,如得物、阿里、滴滴等。然而,面对“Spring Boot自动装配机制”等核心面试题,部分读者因准备不足而未能顺利通过。为此,尼恩团队将系统化梳理和总结这一主题,帮助大家全面提升技术水平,让面试官“爱到不能自已”。
得物面试:Springboot自动装配机制是什么?如何控制一个bean 是否加载,使用什么注解?
|
15天前
|
存储 安全 Java
springboot当中ConfigurationProperties注解作用跟数据库存入有啥区别
`@ConfigurationProperties`注解和数据库存储配置信息各有优劣,适用于不同的应用场景。`@ConfigurationProperties`提供了类型安全和模块化的配置管理方式,适合静态和简单配置。而数据库存储配置信息提供了动态更新和集中管理的能力,适合需要频繁变化和集中管理的配置需求。在实际项目中,可以根据具体需求选择合适的配置管理方式,或者结合使用这两种方式,实现灵活高效的配置管理。
12 0
下一篇
无影云桌面