1. 首页
  2. 软件开发
  3. springboot常用注解

springboot常用注解

  • 发布于 2024-08-16
  • 0 次阅读

本文由 简悦 SimpRead 转码, 原文地址 blog.csdn.net* @SpringBootApplication:这是 Spring Boot 应用的核心注解,它是一个组合注解,包含了 @SpringBootConfiguration、@EnableAutoConfiguration 和 @ComponentScan。主要用于标记一个主类作为 Spring Boot 应用程序的入口,自动扫描并配置 Spring 组件。

  • @ComponentScan:用于自动扫描并加载指定包路径下的所有组件(如 @Service、@Repository、@Controller、@Component 等)。

  • @Component: 用于标记一个 Java 类为 Spring 中的 Bean。通常与 @ComponentScan 一起使用,后者会自动扫描带有此注解的类并将其注册为 Bean。

  • @Service, @Repository, @Controller: 这些是 @Component 的特化,分别用于标记服务层、数据访问层和控制层的类。它们提供了更多的语义化信息,便于区分不同类型的 Bean。

  • @RestController:用于标记一个控制器类,相当于 @Controller + @ResponseBody 的组合,表示该类中的方法会直接返回数据给前端,通常用于构建 RESTful API。

  • @RequestMapping, @GetMapping, @PostMapping, @PutMapping, @DeleteMapping: 控制器层注解,用于映射 HTTP 请求到处理方法上,分别对应 HTTP 的 GET、POST、PUT、DELETE 方法。

  • @PathVariable, @RequestParam, @RequestBody, @RequestHeader: 用于从 HTTP 请求中提取数据,如路径变量、查询参数、请求体和请求头信息。

  • @Autowired: 用于自动装配 Bean。Spring 会根据类型自动将匹配的 Bean 注入到标记了此注解的字段、构造函数或方法中。

  • @Value:用于读取 properties 文件中的配置值,并将其注入到 Bean 中。例如,@Value("${property.name}") 会读取配置文件中的 property.name 属性值。

  • @ConfigurationProperties:配合 @EnableConfigurationProperties 或 @Component 使用,用于绑定配置文件中的配置到 Bean 的属性上,方便集中管理应用的配置。

  • @Profile:指定组件在哪些环境下生效。例如,@Profile("dev") 表示该组件只在激活 "dev" 环境时生效。

  • @EnableAutoConfiguration:启用 Spring Boot 的自动配置功能,尝试根据添加的 jar 依赖自动配置 Spring 应用上下文。

  • @EnableScheduling:启用定时任务支持,配合 @Scheduled 注解使用,可以方便地创建定时任务。

  • @Entity / @Table / @Id / @GeneratedValue:这些是 JPA(Java Persistence API)相关的注解,用于实体类和数据库表的映射,如 @Entity 标记一个类为实体类,@Table 指定对应的数据库表名,@Id 标记主键字段,@GeneratedValue 定义主键生成策略。

  • @Qualifier: 当有多个相同类型的 Bean 时,与 @Autowired 一起使用,指定要注入哪一个具体的 Bean。

  • @MapperScan 是 MyBatis-Spring-Boot-Starter 提供的一个注解,用于扫描并注册 MyBatis 的 Mapper 接口。当你在 Spring Boot 项目中使用 MyBatis 作为持久层框架时,这个注解非常有用。它可以帮助你自动发现并配置 Mapper 接口,而不需要为每个 Mapper 接口单独使用 @Mapper 注解或在配置类中手动添加 @Bean 定义。

  • @Configuration: 用于标记一个类作为配置类,可以包含 @Bean 定义来生产 Bean 实例。

  • @Bean: 在 @Configuration 类中使用,标记在方法上,表明该方法将返回一个对象,该对象应该被注册为 Spring 应用上下文中的 Bean。

  • @Scope: 用于定义 Bean 的作用域,如 singleton(默认,单例)、prototype(每次请求都创建新实例)等。

  • @Cacheable, @CacheEvict, @CachePut: 这些注解用于 Spring Cache,分别用于缓存方法的结果、清除缓存项和更新缓存项。

  • @Profile: 指定组件在特定的环境配置文件中生效,比如开发环境 (dev) 或生产环境(prod)。

  • @EnableTransactionManagement 是 Spring Framework 提供的一个注解,用于启用基于注解的事务管理。当你在 Spring Boot 或任何 Spring 应用中需要管理数据库事务时,这个注解就显得非常重要。它告诉 Spring 自动检测并配置事务管理器,让你可以通过 @Transactional 注解在业务方法或类级别上轻松控制事务的边界。

  • @Transactional: 用于声明方法或类需要事务处理。Spring 会自动管理事务的开启和提交或回滚。

  • @Resource 是 Java EE 规范中提供的一个注解,用于依赖注入。虽然它不是 Spring 框架特有的注解,但 Spring 完全支持使用 @Resource 来进行依赖注入,与 Spring 自己的 @Autowired 注解类似。主要区别在于它们的注入方式和默认行为有所不同。