扒一扒@Retryable注解,很优雅,有点意思

2024-02-23 07:20

本文主要是介绍扒一扒@Retryable注解,很优雅,有点意思,希望对大家解决编程问题提供一定的参考价值,需要的开发者们随着小编来一起学习吧!

你好呀,我是动作缓慢的程序猿

可关注公众号 :动作缓慢的程序猿    领取最新大厂面试题

前几天我 Review 代码的时候发现项目里面有一坨逻辑写的非常的不好,一眼望去简直就是丑陋之极。

我都不知道为什么会有这样的代码存在项目里面,于是我看了一眼提交记录准备叫对应的同事问问,为什么会写出这样的代码。

然后...

那一坨代码是我 2019 年的时候提交的。

我细细的思考了一下,当时好像由于对项目不熟悉,然后其他的项目里面又有一个类似的功能,我就直接 CV 大法搞过来了,里面的逻辑也没细看。

嗯,原来是历史原因,可以理解,可以理解。

代码里面主要就是一大坨重试的逻辑,各种硬编码,各种辣眼睛的补丁。

特别是针对重试的逻辑,到处都有。所以我决定用一个重试组件优化一波。

今天就带大家卷一下 Spring-retry 这个组件。

 

丑陋的代码

先简单的说一下丑陋的代码大概长什么样子吧。

给你一个场景,假设你负责支付服务,需要对接外部的一个渠道,调用他们的订单查询接口。

他们给你说:由于网络问题,如果我们之间交互超时了,你没有收到我的任何响应,那么按照约定你可以对这个接口发起三次重试,三次之后还是没有响应,那就应该是有问题了,你们按照异常流程处理就行。

假设你不知道 Spring-retry 这个组件,那么你大概率会写出这样的代码:

逻辑很简单嘛,就是搞个 for 循环,然后异常了就发起重试,并对重试次数进行检查。

然后搞个接口来调用一下:

 发起调用之后,日志的输出是这样的,一目了然,非常清晰:

 

正常调用一次,重试三次,一共可以调用 4 次。在第五次调用的时候抛出异常。

完全符合需求,自测也完成了,可以直接提交代码,交给测试同学了。

非常完美,但是你有没有想过,这样的代码其实非常的不优雅。

你想,如果再来几个类似的“超时之后可以发起几次重试”需求。

那你这个 for 循环是不是得到处的搬来搬去。就像是这样似的,丑陋不堪:

 实话实说,我以前也写过这样的丑代码。

 

但是我现在是一个有代码洁癖的人,这样的代码肯定是不能忍的。

重试应该是一个工具类一样的通用方法,是可以抽离出来的,剥离到业务代码之外,开发的时候我们只需要关注业务代码写的巴巴适适就行了。

那么怎么抽离呢?

你说巧不巧,我今天给你分享这个的东西,就把重试功能抽离的非常的好:

 用上 spring-retry 之后,我们上面的代码就变成了这样:

只是加上了一个 @Retryable 注解,这玩意简直简单到令人发指。

一眼望去,非常的优雅!

所以,我决定带大家扒一扒这个注解。看看别人是怎么把“重试”这个功能抽离成一个组件的,这比写业务代码有意思。

我这篇文章不会教大家怎么去使用 spring-retry,它的功能非常的丰富,写用法的文章已经非常多了。我想写的是,当我会使用它之后,我是怎么通过源码的方式去了解它的。

怎么把它从一个只会用的东西,变成简历上的那一句:翻阅过相关源码。

 

可添加公众号领取免费大厂面试资料:动作缓慢的程序猿

但是你要压根都不会用,都没听过这个组件怎么办呢?

没关系,我了解一个技术点的第一步,一定是先搭建出一个非常简单的 Demo。

没有跑过 Demo 的一律当做一无所知处理。

先搭 Demo

我最开始也是对这个注解一无所知的。

所以,对于这种情况,废话少说,先搞个 Demo 跑起来才是王道。

但是你记住搭建 Demo 也是有技巧的:直接去官网或者 github 上找就行了,那里面有最权威的、最简洁的 Demo。

比如 spring-retry 的 github 上的 Quick Start 就非常简洁易懂。

它分别提供了注解式开发和编程式开发的示例。

我们这里主要看它的注解式开发案例:

里面涉及到三个注解:

  • @EnableRetry:加在启动类上,表示支持重试功能。

  • @Retryable:加在方法上,就会给这个方法赋能,让它有用重试的功能。

  • @Recover:重试完成后还是不成功的情况下,会执行被这个注解修饰的方法。

看完 git 上的 Quick Start 之后,我很快就搭了一个 Demo 出来。

如果你之前不了解这个组件的使用方法的话,我强烈建议你也搭一个,非常的简单。

首先是引入 maven 依赖:

<dependency>
    <groupId>org.springframework.retry</groupId>
    <artifactId>spring-retry</artifactId>
    <version>1.3.1</version>
</dependency>

由于该组件是依赖于 AOP 给你的,所以还需要引入这个依赖:

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-aop</artifactId>
    <version>2.6.1</version>
</dependency>

然后是代码,就这么一点,就够够的了:

 

 最后把项目跑起来,调用一笔,确实是生效了,执行了 @Recover 修饰的方法:

<

这篇关于扒一扒@Retryable注解,很优雅,有点意思的文章就介绍到这儿,希望我们推荐的文章对编程师们有所帮助!



http://www.chinasem.cn/article/737900

相关文章

SpringRetry重试机制之@Retryable注解与重试策略详解

《SpringRetry重试机制之@Retryable注解与重试策略详解》本文将详细介绍SpringRetry的重试机制,特别是@Retryable注解的使用及各种重试策略的配置,帮助开发者构建更加健... 目录引言一、SpringRetry基础知识二、启用SpringRetry三、@Retryable注解

SpringValidation数据校验之约束注解与分组校验方式

《SpringValidation数据校验之约束注解与分组校验方式》本文将深入探讨SpringValidation的核心功能,帮助开发者掌握约束注解的使用技巧和分组校验的高级应用,从而构建更加健壮和可... 目录引言一、Spring Validation基础架构1.1 jsR-380标准与Spring整合1

SpringBoot条件注解核心作用与使用场景详解

《SpringBoot条件注解核心作用与使用场景详解》SpringBoot的条件注解为开发者提供了强大的动态配置能力,理解其原理和适用场景是构建灵活、可扩展应用的关键,本文将系统梳理所有常用的条件注... 目录引言一、条件注解的核心机制二、SpringBoot内置条件注解详解1、@ConditionalOn

SpringBoot利用@Validated注解优雅实现参数校验

《SpringBoot利用@Validated注解优雅实现参数校验》在开发Web应用时,用户输入的合法性校验是保障系统稳定性的基础,​SpringBoot的@Validated注解提供了一种更优雅的解... 目录​一、为什么需要参数校验二、Validated 的核心用法​1. 基础校验2. php分组校验3

Spring Security方法级安全控制@PreAuthorize注解的灵活运用小结

《SpringSecurity方法级安全控制@PreAuthorize注解的灵活运用小结》本文将带着大家讲解@PreAuthorize注解的核心原理、SpEL表达式机制,并通过的示例代码演示如... 目录1. 前言2. @PreAuthorize 注解简介3. @PreAuthorize 核心原理解析拦截与

SpringCloud动态配置注解@RefreshScope与@Component的深度解析

《SpringCloud动态配置注解@RefreshScope与@Component的深度解析》在现代微服务架构中,动态配置管理是一个关键需求,本文将为大家介绍SpringCloud中相关的注解@Re... 目录引言1. @RefreshScope 的作用与原理1.1 什么是 @RefreshScope1.

Spring事务中@Transactional注解不生效的原因分析与解决

《Spring事务中@Transactional注解不生效的原因分析与解决》在Spring框架中,@Transactional注解是管理数据库事务的核心方式,本文将深入分析事务自调用的底层原理,解释为... 目录1. 引言2. 事务自调用问题重现2.1 示例代码2.2 问题现象3. 为什么事务自调用会失效3

Java常用注解扩展对比举例详解

《Java常用注解扩展对比举例详解》:本文主要介绍Java常用注解扩展对比的相关资料,提供了丰富的代码示例,并总结了最佳实践建议,帮助开发者更好地理解和应用这些注解,需要的朋友可以参考下... 目录一、@Controller 与 @RestController 对比二、使用 @Data 与 不使用 @Dat

基于@RequestParam注解之Spring MVC参数绑定的利器

《基于@RequestParam注解之SpringMVC参数绑定的利器》:本文主要介绍基于@RequestParam注解之SpringMVC参数绑定的利器,具有很好的参考价值,希望对大家有所帮助... 目录@RequestParam注解:Spring MVC参数绑定的利器什么是@RequestParam?@

Spring Security注解方式权限控制过程

《SpringSecurity注解方式权限控制过程》:本文主要介绍SpringSecurity注解方式权限控制过程,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教... 目录一、摘要二、实现步骤2.1 在配置类中添加权限注解的支持2.2 创建Controller类2.3 Us