百度360必应搜狗淘宝本站头条
当前位置:网站首页 > IT知识 > 正文

Spring Boot中最常用的 100 个注解

liuian 2025-07-27 21:58 5 浏览

以下是 Spring Boot 中最常用的 100 个注解(按功能分类整理),适用于配置、控制层、数据访问、安全、测试等常见场景:


一、核心注解(Core Annotations)

  1. @SpringBootApplication:标记主类,启用自动配置和组件扫描。
  2. @Component:通用组件,自动扫描注入 Spring 容器。
  3. @Service:业务逻辑层组件。
  4. @Repository:数据访问层组件,自动处理异常。
  5. @Configuration:声明配置类,替代 XML 配置。
  6. @Bean:在配置类中定义一个 Bean。
  7. @ComponentScan:指定 Spring 要扫描的包路径。
  8. @PropertySource:加载外部属性文件。
  9. @Value:注入属性值。
  10. @Autowired:自动装配 Bean。
  11. @Qualifier:配合 @Autowired 解决多个同类型 Bean 冲突。
  12. @Primary:标记首选 Bean。
  13. @Scope:定义 Bean 的作用域(如 prototype、singleton)。
  14. @Lazy:延迟初始化 Bean。
  15. @Profile:根据环境激活配置。

二、Web 相关(Web & REST)

  1. @RestController:组合 @Controller + @ResponseBody。
  2. @Controller:定义控制器类,返回视图名称。
  3. @RequestMapping:映射请求 URL 到类或方法。
  4. @GetMapping:映射 GET 请求。
  5. @PostMapping:映射 POST 请求。
  6. @PutMapping:映射 PUT 请求。
  7. @DeleteMapping:映射 DELETE 请求。
  8. @PatchMapping:映射 PATCH 请求。
  9. @PathVariable:获取 URL 中的变量。
  10. @RequestParam:绑定请求参数。
  11. @RequestBody:将请求体转为对象。
  12. @ResponseBody:将返回值直接写入 HTTP 响应体。
  13. @RequestHeader:获取请求头信息。
  14. @CookieValue:获取 Cookie 值。
  15. @SessionAttribute:从会话中获取属性。
  16. @CrossOrigin:允许跨域请求。
  17. @ResponseStatus:设置响应状态码。
  18. @ExceptionHandler:处理控制器内异常。
  19. @ControllerAdvice:全局异常处理器。
  20. @RestControllerAdvice:结合 @ControllerAdvice 和 @ResponseBody。
  21. @Valid:触发对 Bean 的校验。
  22. @InitBinder:用于自定义数据绑定与验证规则。

三、数据访问(Data Access / JPA / MyBatis)

  1. @Entity:JPA 实体类。
  2. @Table:指定实体对应的数据库表名。
  3. @Id:标识主键字段。
  4. @GeneratedValue:主键自动生成策略。
  5. @Column:映射字段到数据库列。
  6. @Transient:忽略该字段持久化。
  7. @OneToOne:一对一关联。
  8. @OneToMany:一对多关联。
  9. @ManyToOne:多对一关联。
  10. @ManyToMany:多对多关联。
  11. @JoinColumn:指定外键字段。
  12. @JoinTable:多对多关系中的连接表。
  13. @Query:自定义 JPQL 或原生 SQL 查询。
  14. @Modifying:执行更新操作。
  15. @Transactional:声明事务边界。
  16. @EnableJpaRepositories:启用 JPA Repository 扫描。
  17. @RepositoryRestResource:暴露 Repository 为 REST 接口。
  18. @Select:MyBatis 查询注解。
  19. @Insert:MyBatis 插入注解。
  20. @Update:MyBatis 更新注解。
  21. @Delete:MyBatis 删除注解。
  22. @Options:MyBatis 操作选项,如生成主键。
  23. @Results:结果映射。
  24. @ResultMap:引用已有的结果映射。
  25. @Param:命名参数传递给 SQL。
  26. @Mapper:标记接口为 MyBatis Mapper。
  27. @MapperScan:启用 MyBatis Mapper 扫描。
  28. @EnableTransactionManagement:启用事务管理支持。

四、安全相关(Security)

  1. @EnableWebSecurity:启用 Spring Security。
  2. @EnableGlobalMethodSecurity:启用方法级安全控制。
  3. @PreAuthorize:前置权限判断。
  4. @PostAuthorize:后置权限判断。
  5. @Secured:基于角色的访问控制。
  6. @RolesAllowed:Java EE 标准权限注解。
  7. @AuthenticationPrincipal:获取认证用户信息。
  8. @EnableOAuth2Sso:启用 OAuth2 单点登录。
  9. @EnableResourceServer:启用资源服务器。
  10. @EnableAuthorizationServer:启用授权服务器。

五、测试相关(Testing)

  1. @RunWith(SpringRunner.class):JUnit 测试集成 Spring 上下文。
  2. @SpringBootTest:启动完整 Spring Boot 应用上下文。
  3. @DataJpaTest:仅加载 JPA 相关配置。
  4. @WebMvcTest:仅测试 Web 层(控制器)。
  5. @MockBean:模拟 Bean。
  6. @InjectMocks:注入被测试的类。
  7. @Before:JUnit 测试前准备。
  8. @After:JUnit 测试后清理。
  9. @Test:JUnit 测试方法。
  10. @DataMongoTest:仅加载 MongoDB 相关配置。
  11. @RestClientTest:测试 REST 客户端。
  12. @SpringBootTest(webEnvironment = WebEnvironment.RANDOM_PORT):启动随机端口 Web 环境。
  13. @DirtiesContext:测试后重置应用上下文。
  14. @Sql:执行 SQL 脚本。
  15. @DataRedisTest:仅加载 Redis 配置。

六、其他常用注解

  1. @ConditionalOnClass:当类路径存在某个类时生效。
  2. @ConditionalOnMissingBean:当容器中没有该 Bean 时生效。
  3. @ConditionalOnProperty:根据配置属性是否设置决定是否加载。
  4. @ConditionalOnExpression:根据 SpEL 表达式决定是否加载。
  5. @RefreshScope:配合 Spring Cloud Config 支持动态刷新配置。
  6. @EnableAsync:启用异步方法调用。
  7. @Async:标记异步方法。
  8. @Scheduled:定时任务注解。
  9. @EnableSwagger2:启用 Swagger 文档。
  10. @OpenAPIDefinition:OpenAPI 文档定义(Swagger 3+)。

提示:

  • 实际开发中并不需要掌握全部,根据项目需求选择使用。
  • 大部分注解来源于 Spring Framework、Spring Boot、Spring Data、Spring Security 等模块。
  • 如果你需要具体某个注解的详细说明或示例,可以告诉我。

相关推荐

快速上手maven

Maven的作用在开发过程中需要用到各种各样的jar包,查找和下载这些jar包是件费时费力的事,特别是英文官方网站,可以将Maven看成一个整合了所有开源jar包的合集,我们需要jar包只需要从Mav...

Windows系统——配置java环境变量

怎么配置java环境变量呢?首先是安装好jdk然后我的电脑右键选择属性然后选择左侧高级系统设置高级然后点环境变量然后在用户变量或系统变量中配置,用户变量指的是只有当前用户可用,系统变量指的是系统中...

ollama本地部署更改默认C盘,Windows配置环境变量方法

ollama是一个大语言模型(LLM——LargeLanguageModel),本地电脑安装网上也要很多教程,看上去非常简单,一直下一步,然后直接就可以使用了。但是我在实操的时候并不是这样,安装完...

# Windows 环境变量 Path 显示样式更改

#怎样学习Java##Windows环境变量Path显示样式更改##1、传统Path环境变量显示:```---》键盘上按【WIN+I】打开系统【设置】---》依次点击---》【系统...

如何在Windows中创建用户和系统环境变量

在Windows中创建环境变量之前您应该了解的事情在按照本指南中所示的任何步骤创建指向文件夹、文件或其他任何内容的用户和系统变量之前,您应该了解两件事。第一个也是最重要的一个是了解什么是环境变量。...

Windows 中的环境变量是什么?

Windows中的环境变量是什么?那么,Windows中的环境变量是什么?简而言之,环境变量是描述应用程序和程序运行环境的变量。所有类型的程序都使用环境变量来回答以下问题:我安装的计算机的名称是什么...

【Python程序开发系列】谈一谈Windows环境变量:系统和用户变量

这是我的第350篇原创文章。一、引言环境变量(environmentvariables)一般是指在操作系统中用来指定操作系统运行环境的一些参数,如:临时文件夹位置和系统文件夹位置等。环境变量是在操作...

系统小技巧:还原Windows10路径环境变量

有时,我们在Windows10的“运行”窗口中执行一些命令或运行一些程序,这时即便没有指定程序的具体路径,只输入程序的名称(如notepad.exe),便可以迅速调用成功。这是因为Windows默认...

Windows10系统的“环境变量”在哪里呢?

当我们在操作系统是Windows10的电脑里安装了一些软件,要通过配置环境变量才能使用软件时,在哪里能找到“环境变量”窗口呢?可以按照下面的步骤找到“环境变量”。说明:下面的步骤和截图是在Window...

系统小技巧:彻底弄懂Windows 10环境变量

每当我们进行系统清理时,清理软件总能自动找到Windows的临时文件夹之所在,然后加以清理,即便是我们重定向了TEMP目录也是如此。究其原因,是因为清理软件会根据TEMP环境变量来判断现有临时文件夹的...

MySQL 5.7 新特性大全和未来展望

本文转自微信公众号:高可用架构作者:杨尚刚引用美图公司数据库高级DBA,负责美图后端数据存储平台建设和架构设计。前新浪高级数据库工程师,负责新浪微博核心数据库架构改造优化,以及数据库相关的服务器存...

MySQL系列-源码编译安装(v8.0.25)

一、前言生产环境建议使用二进制安装法,其优点是部署简单、快速、方便,并且相对"yum/rpm安装"方法能更方便地自定义文件存放的目录结构,方便用脚本批量部署,方便日后运维管理。在生产...

MySQL如何实时同步数据到ES?试试这款阿里开源的神器!

前几天在网上冲浪的时候发现了一个比较成熟的开源中间件——Canal。在了解了它的工作原理和使用场景后,顿时产生了浓厚的兴趣。今天,就让我们跟随我的脚步,一起来揭开它神秘的面纱吧。简介canal翻译为...

技术老兵十年专攻MySQL:编写了763页核心总结,90%MySQL问题全解

MySQL是开放源码的关系数据库管理系统,由于性能高、成本低、可靠性好,成为现在最流行的开源数据库。MySQL学习指南笔记领取方式:关注、转发后私信小编【111】即可免费获得《MySQL进阶笔记》的...

Mysql和Hive之间通过Sqoop进行数据同步

文章回顾理论大数据框架原理简介大数据发展历程及技术选型实践搭建大数据运行环境之一搭建大数据运行环境之二本地MAC环境配置CPU数和内存大小查看CPU数sysctl machdep.cpu...