Spring Boot 常用注解 · 概要笔记

文章目录

  • [Spring Boot 常用注解 · 概要笔记](#Spring Boot 常用注解 · 概要笔记)
    • [一、数据库表映射(MyBatis-Plus / JPA 风格)](#一、数据库表映射(MyBatis-Plus / JPA 风格))
    • [二、Lombok 简化代码](#二、Lombok 简化代码)
    • [三、Spring Bean 注入与声明](#三、Spring Bean 注入与声明)
    • 四、配置取值
    • [五、Web 请求参数](#五、Web 请求参数)
    • 六、异常处理
    • [七、Swagger 接口文档](#七、Swagger 接口文档)
    • [八、缓存与 WebSocket](#八、缓存与 WebSocket)
    • 九、元注解(自定义注解用)
    • [十、安全与权限(Spring Security)](#十、安全与权限(Spring Security))
    • 十一、定时任务与事务

Spring Boot 常用注解 · 概要笔记

一、数据库表映射(MyBatis-Plus / JPA 风格)

注解 作用
@Table 设置实体类对应数据库表名,如 @Table(name="tab_user")
@TableName 同上,MyBatis-Plus 风格,如 @TableName("book")
@TableId 设置主键字段及生成策略,如 @TableId(value="id", type=IdType.AUTO) 表示自增
@TableField 设置普通字段映射

二、Lombok 简化代码

  • @Data:生成 getter/setter、equals、canEqual、hashCode、toString
  • @Builder:构造器模式,优雅构建对象
  • @NoArgsConstructor / @AllArgsConstructor:无参 / 全参构造
  • @EqualsAndHashCode / @ToString:生成对应方法
  • @Setter / @Getter:为属性生成 setter / getter
  • @Log4j:为类提供名为 log 的 log4j 日志对象

三、Spring Bean 注入与声明

  • 注入相关
    • @Autowired:按类型自动注入
    • @Qualifier:指定 bean 名称
    • @Resource(name="..."):≈ @Qualifier + @Autowired 组合
    • @Primary:多个候选 bean 时优先选择
  • 声明 Bean(分层)
    • @Component:通用组件
    • @Repository:持久层
    • @Mapper:持久层(MyBatis)
    • @Service:服务层
    • @Controller:表现层
    • @Bean:方法返回一个对象 bean
    • @Import:向容器导入 bean/组件

四、配置取值

  • @Value:获取单个配置值
  • @ConfigurationProperties:批量绑定配置值

五、Web 请求参数

  • @PathVariable:路径传参
  • @RequestParam:方法参数名传参
  • @RequestBody:请求体传参(仅 POST)
  • @SessionAttributes:跨请求共享参数
  • @CrossOrigin:支持 CORS 跨域

六、异常处理

  • @ControllerAdvice:全局优雅处理异常
  • @ExceptionHandler:指定要处理的异常

七、Swagger 接口文档

  • @Api:类上,标识 Swagger 资源
  • @ApiOperation:方法上,接口说明
  • @ApiParam:方法/参数上,参数元数据说明
  • @ApiModel:类上,实体类说明
  • @ApiModelProperty:方法/字段上,model 属性说明

八、缓存与 WebSocket

  • @Cacheable:开启缓存
  • @ServerEndpoint:将类定义为 WebSocket 服务端,可通过 URL 访问

九、元注解(自定义注解用)

  • @Documented:生成 javadoc 时显示
  • @Target:描述注解使用范围(类/方法/属性等)
  • @Retention:注解保留时长(编译期/运行期等)

十、安全与权限(Spring Security)

  • @EnableWebSecurity:开启 Web Security
  • @EnableGlobalMethodSecurity(securedEnabled=true, prePostEnabled=true):开启方法级安全
  • @Secured({"ROLE_sale","ROLE_manager"}):直接判定角色
  • @PreAuthorize("hasAnyAuthority('admins')"):方法执行前判权限
  • @PostAuthorize(...):方法执行后判权限
  • @PreFilter(filterTarget="ids", value="filterObject%2==0"):对传入参数过滤
  • @PostFilter("filterObject.username=='admin1'"):对返回结果过滤

十一、定时任务与事务

  • @EnableScheduling:开启定时任务支持(配置类上)
  • @Scheduled:声明一个定时任务
  • @EnableTransactionManagement:开启事务管理

记忆提示:可按「数据映射 → Lombok → Bean 注入/分层 → 配置 → Web 参数 → 异常 → Swagger → 缓存/WS → 元注解 → 安全 → 定时/事务」这条主线串起来,共 53 个注解,分组记忆比逐条背更高效。

相关推荐
宋冠巡13 分钟前
Spring Boot 4 + OpenTelemetry + Spring Cloud Gateway:全链路 TraceId 传播验证
spring boot·可观测性·traceid
我不会起名字32230 分钟前
仅 Web 主动 ping:30 秒读超时与各平台保活
前端·后端·websocket·go·即时通讯·im·故障排查
Mh1 小时前
AI 的模型能力越来越强,为什么我的编码能力越来越弱?
前端·javascript·后端
下一站春风里1 小时前
Spring IoC 控制反转 完整技术笔记
java·spring boot·笔记·spring
新*1 小时前
Elasticsearch 索引别名入门:创建、路由、原子切换与几个常见误解
运维·后端·elasticsearch·索引别名
挖掘狂人1 小时前
用户连点两次「确认支付」,你的后端凭什么只扣一次钱?
java·后端·面试
卷无止境1 小时前
AI 加速开发之后,如何应对尚未发现的代码安全威胁
后端·python
Rain的Java大神之路1 小时前
面试官问"MySQL 大表 COUNT(*) 怎么优化",90% 的人第一步就答错了
java·后端·面试
小码哥0681 小时前
Spring Boot在线租房系统源码:UniApp找房、VR展示与预约管理落地解析
spring boot·租房小程序·租房系统·在线租房