一文掌握 Spring Boot 常用注解,保姆级整理,建议收藏!

亲兄弟篇:   SpringBoot注解大全(超详细)_Maiko Star的博客-CSDN博客

一、SpringBoot常用注解

二、Bean处理注解

2.1 @Resource

依赖注入,自动导入标注的对象到当前类中,比如我们的 Controller 类通常要导入 Service 类(需要注意这里 Service 类要被 Spring 容器管理)。

2.2 @Component、@Repository、@Service、@Controller、@RestController

我们一般使用 @Resource 注解让 Spring 容器帮我们自动装配 bean。要想把类标识成可用于 @Resource 注解自动装配的 bean 就需要我们使用这几个注解了,它们表示对应的类将被 Spring 容器管理。

  • @Component :通用的注解,可标注任意类为 Spring 组件。如果一个 Bean 不知道属于哪个层,可以使用@Component 注解标注;

  • @Repository : 对应持久层即 Dao 层,主要用于数据库相关操作;

  • @Service : 对应服务层,主要涉及一些复杂的逻辑,需要用到 Dao 层;

  • @Controller : 对应 Spring MVC 控制层,一般需要注入 Service 类返回结果数据;

  • @RestController : 继承于 @Controller,区别在于标注后整个类所有方法将直接返回 JSON 数据,不再需要视图解析处理,目前前后端分离的项目后端都是直接用这个注解的;

2.3  @Configuration

标注是 Java 代码的配置类, Spring Boot 中推荐这种做法不再使用 xml 配置了;

2.4   @Scope

声明 Spring Bean 的作用域,作用于一共有以下几种:

  • singleton:唯一 bean 实例,Spring 中的 bean 默认都是单例的。

  • prototype:每次请求都会创建一个新的 bean 实例。

  • request:每一次 HTTP 请求都会产生一个新的 bean,该 bean 仅在当前 HTTP request 内有效。

  • session:每一次 HTTP 请求都会产生一个新的 bean,该 bean 仅在当前 HTTP session 内有效。

三、HTTP请求注解

3.1  @GetMapping

等价于 @RequestMapping(value="/test",method=RequestMethod.GET)

3.2  @PostMapping

 3.3  @PutMapping

put 方式的请求,常用语更新服务器上的资源。举个例子:PUT /users/7(更新编号为 7 的学生)

3.4  @DeleteMapping

DELETE 请求,从服务器删除特定的资源。

四、前后端参数传递注解

4.1  @RequestParam & @PathVariable

@RequestParam 用在方法的参数前面,获取请求中表单类型的key=value格式的数据。

@PathVariable 用于获取请求路径中的参数。

4.2  @RequestBody

获取请求 body 中的数据,常用于搭配 @PostMapping 请求来提交对象数据.  请求体 的Content-Type 必须为 application/json 格式的数据,接收到数据之后会自动将数据绑定到 Java 对象上去。

系统会使用 HttpMessageConverter 或者自定义的 HttpMessageConverter将请求的 body 中的 json 字符串转换为 java 对象。

强调一下:请求方法只可以有一个@RequestBody,但是可以有多个 @RequestParam 和 @PathVariable。 如果你的方法必须要用两个 @RequestBody 来接受数据的话,那你就只思考下你的设计了,或者套娃形式的。

4.3  @ResponseBody

表示该方法的返回结果直接写入 HTTP response body 中,格式为 json。上面我们提到的 @RestController 其实就是 @Controller 和 @ResponseBody 两个结合起来的。

五、读取配置注解

5.1  @value

可以在任意 Spring 管理的 Bean 中通过这个注解获取任何来源配置的属性值。比如我们的 application.properties 或者 application.yml 配置文件中配置的属性值,当然也可以是 JVM 属性配置或者系统环境变量配置的值,如果对 Spring Boot 应用程序都有哪些属性配置源以及它们之间的优先级不了解的小伙伴可以看我之前的文章:Spring Boot 属性配置你所不知道的细节。

5.2  @ConfigurationProperties(重点)

上面 @Value 在每个类中获取属性配置值的做法其实是不推荐的,我们一般在企业项目开发中,不会使用那么杂乱无章的写法而且维护也麻烦,通过就是一次性读取到一个 Java 配置类,然后需要使用的地方直接引用这个类就可以多次访问了,方便维护。

5.3  @PropertySource

这个注解是用来指定读取我们自定义的配置文件的。

六、参数校验注解

数据的校验的重要性就不用说了,即使在前端对数据进行校验的情况下,我们还是要对传入后端的数据再进行一遍校验,避免用户绕过浏览器直接通过一些 HTTP 工具直接向后端请求一些违法数据。

JSR(Java Specification Requests) 是一套 JavaBean 参数校验的标准,它定义了很多常用的校验注解,我们可以直接将这些注解加在我们 JavaBean 的属性上面,这样就可以在需要校验的时候进行校验了,非常方便!

校验的时候我们实际用的是 Hibernate Validator 框架。Hibernate Validator 是 Hibernate 团队最初的数据校验框架,Hibernate Validator 4.x 是 Bean Validation 1.0(JSR 303)的参考实现,Hibernate Validator 5.x 是 Bean Validation 1.1(JSR 349)的参考实现,目前最新版的 Hibernate Validator 6.x 是 Bean Validation 2.0(JSR 380)的参考实现。

需要注意的是从 Spring Boot 2.3开始,我们还需要显式地添加 spring-boot-starter-validation 依赖项,在此之前的 Spring Boot 版本是在 spring-boot-starter-web 依赖项中包含的不需要额外引入。

我现在使用的是 Spring Boot 2.5.2 版本了,所以手动增加依赖:

👉 需要注意的是: 所有的注解,推荐使用 JSR 注解,即 javax.validation.constraints,而不是 org.hibernate.validator.constraints

6.1  Bean字段验证注解

  • @NotEmpty 被注释的字符串的不能为 null 也不能为空

  • @NotBlank 被注释的字符串非 null,并且必须包含一个非空白字符

  • @Null 被注释的元素必须为 null

  • @NotNull 被注释的元素必须不为 null

  • @AssertTrue 被注释的元素必须为 true

  • @AssertFalse 被注释的元素必须为 false

  • @Pattern(regex=,flag=)被注释的元素必须符合指定的正则表达式

  • @Email 被注释的元素必须是 Email 格式。

  • @Min(value)被注释的元素必须是一个数字,其值必须大于等于指定的最小值

  • @Max(value)被注释的元素必须是一个数字,其值必须小于等于指定的最大值

  • @DecimalMin(value)被注释的元素必须是一个数字,其值必须大于等于指定的最小值

  • @DecimalMax(value) 被注释的元素必须是一个数字,其值必须小于等于指定的最大值

  • @Size(max=, min=)被注释的元素的大小必须在指定的范围内

  • @Digits (integer, fraction)被注释的元素必须是一个数字,其值必须在可接受的范围内

  • @Past被注释的元素必须是一个过去的日期

  • @Future 被注释的元素必须是一个将来的日期

验证请求体(RequestBody)

只需要在请求处理方法中需要验证的参数前加上 @Valid 注解就会开启校验了,如果验证失败将抛出异常:MethodArgumentNotValidException

6.2  @Validated

如果你的入参不是用一个 Java 对象来接收的话,比如用 @PathVariables 和 @RequestParam 注解来获取入参,这种情况下要校验参数不要忘记在类的头上加 @Validated 注解,这个参数可以告诉 Spring 去校验方法参数。

七、统一异常处理注解

异常处理通常也是我们在开发中一定要做的,因为不可能将一些程序员才能看懂的异常抛出到前端去(总会有不靠谱的同事忘记捕获异常的),所以一般都会加上统一的异常处理,在对用户不友好的错误堆栈转换为普通用户可以看懂的文案提示。

这里涉及到的注解只有两个:

  1. @ControllerAdvice : 定义全局异常处理类,包含 @Component 所以可以被 Spring 扫描到。

  2. @ExceptionHandler : 声明异常处理方法,表示遇到这个异常,就执行标注的方法。

八、JPA数据持久化注解

上面是百度百科给的概念,只能说在实际项目开发中还是用的不多,大家还是喜欢用 Mybatis,不过相比更加简洁的技术还是要学习下的。

创建表
  • @Entity

  • @Table

这俩是放在 Java Bean 上面用来标注数据库实体对象和表明之间的映射关系的。

创建主键
  • @Id

  • @GeneratedValue

这俩主键放在 Bean 的字段上,用来标识数据库的主键以及主键自动生成的。通过 @GeneratedValue直接使用 JPA 内置提供的四种主键生成策略来指定。

  • GenerationType.TABLE 持久化引擎通过关系数据库的一张特定的表格来生成主键;

  • GenerationType.SEQUENCE 随机序列;

  • GenerationType.IDENTITY 主键自增长;

  • GenerationType.AUTO 持久化引擎会根据数据库在以上三种主键生成策略中选择,默认选择的就是这个策略;

设置字段类型

@Column 声明字段。

比如:Java Bean 属性名为 nickName 对应的数据库字段名为 user_name,长度为 32,非空。

设置字段类型并且加默认值,这个还是挺常用的。

指定不持久化特定字段

@Transient :有一些字段我们有时间不需要落库,就可以加上这个注解就好了。

@声明事务

这个注解可以作用于类上,也可以作用于方法上。前者表示所有该类的 public 方法都配置相同的事务属性信息,后者表示当类配置了@Transactional,方法也配置了@Transactional,方法的事务会覆盖类的事务配置信息。

Exception 分为运行时异常 RuntimeException 和非运行时异常。在 @Transactional 注解中如果不配置 rollbackFor 属性,那么事物只会在遇到 RuntimeException 的时候才会回滚,加上 rollbackFor=Exception.class ,可以让事物在遇到非运行时异常时也回滚。

九、 JSON格式处理注解

9.1  指定过滤字段

  • @JsonIgnoreProperties 作用在类上用于过滤掉特定字段不返回或者不解析。

  • @JsonIgnore一般用于类的属性上,作用和上面的@JsonIgnoreProperties 一样。

9.2  格式化 json 数据

要注意的是,它只会在类似 @ResponseBody 返回 json 数据的时候,才会返回格式化的 yyyy-MM-dd HH:mm:ss 时间,你直接使用System.out.println()输出的话,仍然是类似 Fri Dec 01 21:05:20 CST 2017 这样的时间样式。

9.3  扁平化对象

@JsonUnwrapped

这个可能不太好说,大家直接看代码就懂了:

未扁平化之前:

使用 @JsonUnwrapped 扁平对象之后:

十、测试处理注解

@ActiveProfiles一般作用于测试类上, 用于声明生效的 Spring 配置文件。

@Test声明一个方法为测试方法。

@Transactional被声明的测试方法执行后数据会被回滚,避免污染测试数据。

@WithMockUser Spring Security 提供的,用来模拟一个真实用户,并且可以赋予权限。

十一、配置启动注解

@SpringBootApplication : 等价于使用 @Configuration、@EnableAutoConfiguration、@ComponentScan  三个注解。

@Configuration:声明是是一个 Java 形式的配置类,Spring Boot 提倡基于 Java 的配置,相当于你之前在 xml 中配置 bean;

@EnableAutoConfiguration:类级别的注解,这个注解告诉 Spring Boot 根据添加的 jar 依赖猜测你想如何配置 Spring,也就是 Spring 实现自动配置的开关。

@ComponentScan:标注哪些路径下的类需要被Spring扫描。

@Conditional:Spring4 新提供的注解,通过 @Conditional 注解可以根据代码中设置的条件装载不同的 bean,也是SpringBoot实现自动配置的基石。

Spring Boot 源码中大量扩展了 @Condition 注解,用于实现智能的自动化配置,满足各种使用场景。下面我给大家列举下:

  • @ConditionalOnBean :配置了某个特定的Bean时条件为真。

  • @ConditionalOnMissingBean :没有配置特定的Bean时条件为真。

  • @ConditionalOnClass:Classpath里有指定的类时条件为真。

  • @ConditionalOnMissingClass:Classpath里没有指定的类时条件为真。

  • @ConditionalOnExpression:给定的SpEL表达式计算结果为true。

  • @ConditionalOnJava:Java的版本匹配特定值或者一个范围值。

  • @ConditionalOnJndi:参数中给定的 JNDI 位置必须存在一个,如果没有给参数,则要有 JNDI InitialContext。

  • @ConditionalOnProperty:指定的配置属性要有一个明确的值。

  • @ConditionalOnResource:Classpath里没有指定的资源。

  • @ConditionalOnWebApplication:这是一个Web应用程序。

  • @ConditionalOnNotWebApplication:这不是一个Web应用程序。

本文来自互联网用户投稿,该文观点仅代表作者本人,不代表本站立场。本站仅提供信息存储空间服务,不拥有所有权,不承担相关法律责任。如若转载,请注明出处:http://www.mzph.cn/news/163318.shtml

如若内容造成侵权/违法违规/事实不符,请联系多彩编程网进行投诉反馈email:809451989@qq.com,一经查实,立即删除!

相关文章

前端编码技巧须知

前端开发中可能会使用到以下软件,它们各自具有不同的作用: 代码编辑器:例如Sublime Text、Atom、Visual Studio Code等,用于编写和编辑HTML、CSS和JavaScript等前端代码。网页浏览器:例如Chrome、Firefox、Safari等&a…

来聊聊JVM中的类加载过程以及双亲委派模型(学习Java必知内容)

文章目录 1. 类加载过程加载验证准备解析初始化 2. 双亲委派模型一个类的加载流程双亲委派模型的优点 总结 1. 类加载过程 在整个 JVM 执行过程中, 和我们程序员关系最密切的就是类加载的过程, 所以接下来我们来看下类加载的执行流程. 对于一个类来说, 它的生命周期是这样的:…

python pymodbus库使用教程(以Modbus RTU为例)

文档: https://pymodbus.readthedocs.io/en/latest/ 源码: https://github.com/riptideio/pymodbus/ 文章目录 Python PyModbus库使用教程:以Modbus RTU为例介绍安装PyModbus配置串行连接导入必要的模块创建Modbus客户端实例 建立连接连接…

UEC++ day8

伤害系统 给敌人创建血条 首先添加一个UI界面用来显示敌人血条设置背景图像为黑色半透明 填充颜色 给敌人类添加两种状态表示血量与最大血量,添加一个UWidegtComponet组件与UProgressBar组件 UPROPERTY(EditAnywhere, BlueprintReadWrite, Category "Enemy …

TikTok历史探秘:短视频中的时间之旅

在数字时代的浪潮中,TikTok崭露头角,成为社交媒体领域的一颗耀眼新星。这款短视频应用以其独特的创意、时尚和娱乐性质,吸引了全球数以亿计的用户。 然而,TikTok并非一夜之间的奇迹,它背后蕴藏着丰富而有趣的历史故事…

[ChatGPT]ChatGPT免费,不用翻墙!?——你需要的装备

系列文章目录 【AIGC】服务于人类|一种新的人工智能技术-CSDN博客 文章目录 目录 系列文章目录 文章目录 前言 一、天意云网站 ​编辑 二、使用步骤 可以看到有云服务器、Rstudio以及我们的ChatGPT,我这次主要分享ChatGPT,其他的有机会我再给…

常用服务注册中心与发现(Eurake、zookeeper、Nacos)笔记(一)基础概念

基础概念 注册中心 在服务治理框架中,通常都会构建一个注册中心,每个服务单元向注册中心登记自己提供的服务,将主机与端口号、版本号、通信协议等一些附加信息告知注册中心,注册中心按照服务名分类组织服务清单,服务…

设计师不能忽视的几个宝藏图标设计工具

在这个快速变化的时代,设计师对创新和实用工具的需求越来越大。这就要求我们及时跟上潮流,不断探索和尝试最新、最有价值的图标设计工具。只有这样,我们才能在竞争激烈的设计市场中脱颖而出。以下是我们精心挑选的2024年值得一试的图标设计工…

服务器安全如何保障

主机安全是指保护计算机主机(也称为服务器、终端或主机设备)免受潜在的安全威胁和攻击的一系列措施和实践。主机安全旨在防止未经授权的访问、数据泄露、恶意软件感染和其他安全漏洞的利用,主机一旦被黑客入侵,企业会面临很多安全…

相比其他关系型数据库,AntDB JDBC驱动特性有哪些不同之处

摘要:使用Java语言进行各类应用程序的快速开发成为目前比较主要且流行的开发方式。JDBC是 Java 语言中用来连接和操作关系型数据库的 API,在业务程序与关系型数据库通信时,必然会使用JDBC驱动。 本文将通过国产关系型数据库AntDB中的JDBC为大…

【Effective C++】 (六) 继承与面向对象设计

【六】继承与面向对象设计 条款32 : 确保public继承是"is a"的关系 Item 32: Make sure public inheritance models “is-a”. C面向对象程序设计中,最重要的规则便是:public继承应当是"is-a"的关系。当Derived public继…

【uniapp】部分图标点击事件无反应

比如:点击这个图标在h5都正常,在小程序上无反应 css:也设置z-index,padding 页面上也试过click.native.stop.prevent"changePassword()" 时而可以时而不行, 最后发现是手机里输入键盘的原因,输…

大型养殖场需要哪些污水处理设备

大型养殖场是一个涉及环境保护和可持续发展的关键行业,对于处理养殖场产生的污水有着明确的要求和标准。为了确保污水得到有效处理和处理效果达到国家排放标准,大型养殖场需要配备一系列污水处理设备。以下是几种常见的污水处理设备: 1. 水解…

Python入门指南之基本概率和语法基础

文章目录 一、基本概念二、控制流三、函数四、模块五、数据结构六、面向对象的编程七、输入输出八、异常九、Python标准库关于Python技术储备一、Python所有方向的学习路线二、Python基础学习视频三、精品Python学习书籍四、Python工具包项目源码合集①Python工具包②Python实战…

快速排序演示和代码介绍

快速排序的核心是(以升序为例):在待排序的数据中指定一个数做为基准数,把所有小于基准数的数据放到基准数的左边,所有大于基准数的数据放在右边,这样的话基准数的位置就确定了,然后在两边的数据中重复上述操作

使用 Pinia 的五个技巧

在这篇文章中,想与大家分享使用 Pinia 的五大技巧。 以下是简要总结: 不要创建无用的 getter在 Option Stores 中使用组合式函数(composables)对于复杂的组合式函数,使用 Setup Stores使用 Setup Stores 注入全局变量…

2 使用React构造前端应用

文章目录 简单了解React和Node搭建开发环境React框架JavaScript客户端ChallengeComponent组件的主要结构渲染与应用程序集成 第一次运行前端调试将CORS配置添加到Spring Boot应用使用应用程序部署React应用程序小结 前端代码可从这里下载: 前端示例 后端使用这里介…

冷链运输车辆GPS定位及温湿度管理案例

1.项目背景 项目名称:山西冷链运输车辆GPS定位及温湿度管理案例 项目需求:随着经济发展带动物流行业快速发展,运输规模逐步扩大,集团为了适应高速发展的行业现象,物流管理系统的完善成了现阶段发展的重中之重。因此&…

eNSP-直连通信实验

实验拓扑: 实验需求: 1. 按照图中的设备名称,配置各设备名称 2. 按照图中的IP地址规划,配置IP地址 3. 测试R1与R2是否能ping通 4. 测试R2与R3是否能ping通 5. 测试R1与R3是否能ping通 实验步骤: 1. 加入设备&…

Astute Graphics 2023(ai创意插件合集)

Astute Graphics 2023是一家专注于图形编辑软件的公司,以制作高质量、功能强大的图像编辑工具而闻名。如Poser Pro、Poser 3D、Smart Shapes、Astute Sketch Pro等。 Astute Graphics的软件具有以下特点: 强大的图像编辑功能:Astute Graphi…