正确测试Spring Retry组件:避免空指针与Mockito误用


正确测试Spring Retry组件:避免空指针与Mockito误用

在单元测试spring retry功能时,开发者常遇到依赖注入为空或mockito用法不当的问题。本文将深入探讨如何正确配置spring测试环境,特别是如何有效模拟依赖,避免在测试系统核心逻辑时将真实对象误作模拟对象,以及如何规范使用`argumentmatchers.any()`,确保`@autowired`的bean能够正确注入,并使spring retry机制在测试中按预期工作。

理解Spring Retry的测试需求

Spring Retry通过AOP(面向切面编程)实现,这意味着它需要在Spring应用上下文中运行才能生效。因此,简单的JUnit测试无法激活其重试机制。我们需要借助Spring的测试工具,如SpringRunner(或Spring Boot的@SpringBootTest),并配置一个最小化的Spring应用上下文。

当使用@RunWith(SpringRunner.class)和@ContextConfiguration时,Spring会加载指定的配置类,并管理Bean的生命周期和依赖注入。然而,在测试中,我们往往需要隔离被测单元(System Under Test, SUT)的外部依赖,以便控制其行为并专注于SUT本身的逻辑。

常见测试陷阱与解决方案

在测试包含@Retryable注解的Spring组件时,开发者常会遇到以下两个主要问题:

陷阱一:将SUT误作Mock对象进行行为设置

问题描述: 开发者有时会尝试直接对被测类(SUT)的实例进行when()调用设置,例如 when(deltaHelper.restService.call(...)).thenThrow(...)。如果deltaHelper是真实的SUT实例,其内部的restService也是一个真实对象,那么when()方法将无法对其进行行为模拟,因为when()只能用于Mock对象。这会导致deltaHelper.restService`在测试执行时表现出真实行为,而不是我们期望的模拟行为,甚至可能因为未正确注入而导致空指针。

解决方案: 正确的做法是模拟SUT的依赖,而不是SUT本身。SUT应该是一个真实的Spring Bean,其依赖则应被替换为Mock对象。这样,我们可以在Mock依赖上设置期望的行为(例如抛出异常以触发重试),从而测试SUT在不同依赖行为下的响应。

陷阱二:在SUT的实际方法调用中使用ArgumentMatchers.any()

问题描述:ArgumentMatchers.any()(如any()、anyString()等)是Mockito提供的一种匹配器,用于在设置Mock行为(when())或验证Mock交互(verify())时匹配任何参数。然而,any()方法在被调用时会直接返回null(或对应基本类型的默认值)。如果在对SUT的实际方法调用中(即“act”阶段)使用any(),例如 deltaHelper.process(any(), any()),那么SUT接收到的参数将是null,这很可能导致空指针异常或其他非预期行为。

解决方案: 在调用SUT的实际方法时,必须传入真实的、有意义的参数值。any()仅应用于Mock对象的行为设置或验证。

优化Spring Retry组件的单元测试

结合上述解决方案,以下是针对DeltaHelper类的优化测试示例。我们将确保DeltaHelper是一个真实的Spring Bean,但其内部依赖MyRestService和MyStorageService将被替换为Mock对象。

首先,我们假设DeltaHelper、MyRestService和MyStorageService等业务组件已按常规Spring方式定义:

// DeltaHelper.j*a
@Component
public class DeltaHelper {

    @Autowired
    MyRestService restService;

    @Autowired
    MyStorageService myStorageService;

    @NotNull
    @Retryable(
            value = Exception.class,
            maxAttemptsExpression = "${delta.process.retries}"
    )
    public String process(String api, HttpEntity<?> entity) {
        System.out.println("Attempting process for API: " + api); // 方便观察重试
        return restService.call(api, entity);
    }

    @Recover
    public String recover(Exception e, String api, HttpEntity<?> entity) {
        System.out.println("Recovering from exception for API: " + api + " - " + e.getMessage());
        myStorageService.s*e(api);
        return "recover";
    }
}

// MyRestService.j*a
@Service
public class MyRestService extends org.springframework.web.client.RestTemplate {
    // 假设call方法存在并被DeltaHelper调用
    public String call(String api, HttpEntity<?> entity) {
        // 实际的REST调用逻辑
        throw new UnsupportedOperationException(";Not implemented for real usage in test");
    }
}

// MyStorageService.j*a
@Service
public class MyStorageService {

    @Autowired
    MyRepo myRepo;

    @Async
    public MyEntity s*e(String api) {
        System.out.println("S*ing API: " + api + " to storage.");
        return myRepo.s*e(new MyEntity(api, System.currentTimeMillis()));
    }
}

// MyRepo.j*a (接口或抽象类)
public interface MyRepo {
    MyEntity s*e(MyEntity entity);
}

// MyEntity.j*a
public class MyEntity {
    private String api;
    private long timestamp;

    public MyEntity(String api, long timestamp) {
        this.api = api;
        this.timestamp = timestamp;
    }
    // getters, setters
}

接下来是修正后的测试类:

import org.junit.After;
import org.junit.Before;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.mockito.Mockito;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.EnableAspectJAutoProxy;
import org.springframework.http.HttpEntity;
import org.springframework.retry.annotation.EnableRetry;
import org.springframework.test.context.ContextConfiguration;
import org.springframework.test.context.junit4.SpringRunner;

import static org.mockito.ArgumentMatchers.any;
import static org.mockito.Mockito.*;

@RunWith(SpringRunner.class)
@ContextConfiguration
public class DeltaHelperTest {

    @Autowired
    private DeltaHelper deltaHelper; // SUT,由Spring管理并注入Mock依赖

    @Autowired
    private MyRestService mockRestService; // 注入Mock对象,用于设置行为和验证

    @Autowired
    private MyStorageService mockMyStorageService; // 注入Mock对象

    @Autowired
    private MyRepo mockMyRepo; // 注入Mock对象

    @Before
    public void setUp() {
        // 设置重试次数,确保@Retryable的maxAttemptsExpression能正确解析
        System.setProperty("delta.process.retries", "2");
        // 重置所有Mock,确保每个测试方法都是干净的环境
        Mockito.reset(mockRestService, mockMyStorageService, mockMyRepo);
    }

    @After
    public void validate() {
        // 验证Mock的使用,确保没有未验证的交互
        validateMockitoUsage();
    }

    @Test
    public void retriesAfterOneFailAndThenPass() throws Exception {
        String testApi = "test-api-path";
        HttpEntity<?> testEntity = new HttpEntity<>("test-body");

        // 模拟restService的第一次调用抛出异常,第二次成功
        when(mockRestService.call(eq(testApi), eq(testEntity)))
                .thenThrow(new RuntimeException("Simulated first call failure")) // 第一次失败
                .thenReturn("success-response"); // 第二次成功

        // 调用SUT的方法,传入真实的参数
        String result = deltaHelper.process(testApi, testEntity);

        // 验证restService的call方法被调用了两次(一次失败,一次成功)
        verify(mockRestService, times(2)).call(eq(testApi), eq(testEntity));
        // 验证重试成功后返回的是第二次调用的结果
        assert "success-response".equals(result);
        // 验证recover方法没有被调用,因为重试成功了
        verify(mockMyStorageService, never()).s*e(anyString());
    }

    @Test
    public void retriesFailAndThenRecover() throws Exception {
        String testApi = "fail-api-path";
        HttpEntity<?> testEntity = new HttpEntity<>("fail-body");

        // 模拟restService的两次调用都抛出异常,触发recover
        when(mockRestService.call(eq(testApi), eq(testEntity)))
                .thenThrow(new RuntimeException("Simulated first call failure"))
                .thenThrow(new RuntimeException("Simulated second call failure")); // 第二次也失败

        // 调用SUT的方法,传入真实的参数
        String result = deltaHelper.process(testApi, testEntity);

        // 验证restService的call方法被调用了两次(达到maxAttemptsExpression设定的次数)
        verify(mockRestService, times(2)).call(eq(testApi), eq(testEntity));
        // 验证recover方法被调用了,因为重试失败
        verify(mockMyStorageService, times(1)).s*e(eq(testApi));
        // 验证返回的是recover方法的结果
        assert "recover".equals(result);
    }

    @Configuration
    @EnableRetry // 启用Spring Retry
    @EnableAspectJAutoProxy(proxyTargetClass = true) // 启用AspectJ代理,确保@Retryable生效
    public static class Application {

        // DeltaHelper作为SUT,让Spring正常创建和注入
        @Bean
        public DeltaHelper deltaHelper() {
            return new DeltaHelper();
        }

        // 提供MyRestService的Mock Bean
        @Bean
        public MyRestService restService() {
            return mock(MyRestService.class);
        }

        // 提供MyStorageService的Mock Bean
        @Bean
        public MyStorageService myStorageService() {
            return mock(MyStorageService.class);
        }

        // 提供MyRepo的Mock Bean
        @Bean
        public MyRepo myRepository() {
            return mock(MyRepo.class);
        }
    }
}

代码解释与改进点:

MCP市场 MCP市场

中文MCP工具聚合与分发平台

MCP市场 211 查看详情 MCP市场
  1. SUT作为真实Bean,依赖作为Mock Bean:

    • 在Application配置类中,deltaHelper()方法现在直接返回 new DeltaHelper()。由于DeltaHelper类上带有@Component注解,Spring会扫描并将其作为Bean管理。
    • restService()、myStorageService() 和 myRepository() 方法现在返回 mock(...) 创建的Mock对象。这些Mock对象会被注入到DeltaHelper中。
    • @Autowired DeltaHelper deltaHelper; 会注入由Spring创建的真实DeltaHelper实例。
    • @Autowired MyRestService mockRestService; 等会注入我们定义的Mock对象,允许我们在测试中直接控制它们的行为。
  2. 正确使用when()和verify():

    • when(mockRestService.call(eq(testApi), eq(testEntity))):现在我们对mockRestService这个Mock对象设置行为。eq()匹配器用于精确匹配参数值。
    • deltaHelper.process(testApi, testEntity):调用SUT时,传入了真实的testApi和testEntity,而不是any()。
  3. @EnableAspectJAutoProxy(proxyTargetClass = true):

    • 这个注解确保Spring能够为带有@Retryable等AOP注解的类生成CGLIB代理(即使没有接口),从而使重试逻辑生效。
  4. System.setProperty("delta.process.retries", "2"):

    • 在setUp方法中设置系统属性,以确保@Retryable的maxAttemptsExpression = "${delta.process.retries}"能够正确解析重试次数。
  5. Mockito.reset(...):

    • 在setUp中重置所有Mock对象,确保每个测试方法都在一个干净的状态下运行,避免测试之间的状态污染。

注意事项与总结

  • 测试边界: 单元测试应聚焦于SUT的逻辑,而不是Spring框架本身的功能。我们假定@Retryable注解本身是正确的,我们测试的是当依赖抛出异常时,SUT的重试逻辑是否按预期执行。
  • 清晰的职责分离: 明确哪些是SUT,哪些是SUT的依赖。SUT是我们要测试的核心业务逻辑,它应该是真实的。依赖则是我们为了隔离SUT而需要模拟的部分。
  • 有意义的测试数据: 避免在SUT的实际调用中使用any()。提供具体的、有意义的参数,使测试场景更真实,也更容易调试。
  • Spring Boot Test的便利性: 如果项目是Spring Boot应用,可以使用@SpringBootTest结合@MockBean来更简洁地替换依赖。@MockBean会自动将指定的类替换为Mock对象并注入到Spring上下文中。

通过遵循这些原则和实践,您可以更有效地对包含Spring Retry功能的组件进行单元测试,确保代码的健壮性和正确性。

以上就是正确测试Spring Retry组件:避免空指针与Mockito误用的详细内容,更多请关注其它相关文章!


# app  # 工具  # java  # 有意义  # 刷关键词排名 十佳宙va斯环境有  # 芜湖seo公司服务  # 营销型seo网站推广还原细节  # 微博微信问答营销推广  # 都是  # 测试中  # 单元测试  # 是一个  # 而不是  # 两次  # 抛出  # 的是  # 重试  # red  # spring框架  # springboot  # proxy  # ai  # 杭州哪里学seo最好  # 白云全网营销推广  # 浪潮式营销推广  # 任务平台网站建设  # 台江区市场推广营销招聘  # 搜索关键词排名怎么收费 


相关栏目: 【 Google疑问12 】 【 Facebook疑问10 】 【 优化推广96088 】 【 技术知识133117 】 【 IDC资讯59369 】 【 网络运营7196 】 【 IT资讯61894


相关推荐: 顺丰快递单号查询寄件人 顺丰寄件人查询入口  发博客与长微博技巧  百度网盘网页入口链接分享 百度网盘官网入口网页登录  vivo手机视频通话美颜怎么设置_vivo视频通话美颜开启方法  如何查找哪个composer包引入了特定的依赖?  《饿了么》拼好饭点外卖教程2025  腾讯QQ邮箱官方入口 QQ邮箱网页版登录平台  Win10锁屏时间怎么设置 Win10调整自动锁屏时间方法  c++类和对象到底是什么_c++面向对象编程基础  小红书网页版在线直达 小红书网页版免费登录入口  微信客户端怎么查看二维码_微信客户端个人二维码查看方法  word表格如何按某一列内容进行排序_Word表格按列排序方法  《东方航空》添加乘机人方法  《procreate》绘制渐变效果教程  咸鱼怎么设置仅粉丝可见的动态_咸鱼动态粉丝可见设置方法  一点万象签到领积分指南  在XML中嵌入二进制数据(如图片)的最佳实践是什么? Base64编码与解析注意事项  Safari浏览器自动填表功能失效怎么办 Safari表单管理修复  sublime text 4如何安装_最新版sublime下载与汉化教程  汽车之家网页版免费登录_汽车之家官网首页直接进入  视频转蓝光m2ts格式  oppo手机如何通过下拉通知栏截图_oppo手机通知栏快捷截图方法  基于键值条件高效映射 Pandas DataFrame 多列数据  电子白板帮助菜单使用指南  Python高效统计字典嵌套列表值在目标列表中的出现次数  CSS过渡如何实现按钮悬停效果_transition属性控制背景颜色变化  win11怎么设置默认终端为Windows Terminal Win11替代CMD和PowerShell【技巧】  Eclipse开发J*a快速入门  英雄联盟争者留名活动介绍  如何在mysql中使用索引提示_mysql索引提示优化方法  Lar*el 中高效执行多列更新:单次查询实现  《地下城堡4:骑士与破碎编年史》墓穴挑战125攻略  口腔诊所管理软件推荐  在Flask应用中安全高效地更新SQLAlchemy用户数据  vivo云服务一直提示空间不足怎么办 怎么办vivo云服务老是提示空间不足  优化2xN网格最大路径和的动态规划算法实践  顺丰快递怎么查物流_顺丰快递物流信息实时查询操作指南  《小黑盒》删除历史浏览方法  Sublime怎么自动添加CSS前缀_Sublime安装Autoprefixer插件  铁拳8在线玩 铁拳8在线秒玩入口  J*aScript类型数组_TypedArray使用  被称为海蜈蚣的海洋动物是  Win10关闭UAC用户账户控制的方法 Win10降低安全提示等级【技巧】  《海贝音乐》均衡器设置方法  如何在Python中安全地将环境变量转换为整数并满足Mypy类型检查  包子漫画官网链接官方地址 包子漫画在线观看官网首页入口  Golang如何实现HTTP请求重试机制_Golang HTTP请求错误处理策略  使用AI在VS Code中将代码从一种语言翻译成另一种  解决CSS容器溢出问题:使用calc()实现精确布局与边距控制  百度网盘如何设置上传限额 

 2025-12-14

了解您产品搜索量及市场趋势,制定营销计划

同行竞争及网站分析保障您的广告效果

点击免费数据支持

提交您的需求,1小时内享受我们的专业解答。

运城市盐湖区信雨科技有限公司


运城市盐湖区信雨科技有限公司

运城市盐湖区信雨科技有限公司是一家深耕海外推广领域十年的专业服务商,作为谷歌推广与Facebook广告全球合作伙伴,聚焦外贸企业出海痛点,以数字化营销为核心,提供一站式海外营销解决方案。公司凭借十年行业沉淀与平台官方资源加持,打破传统外贸获客壁垒,助力企业高效开拓全球市场,成为中小企业出海的可靠合作伙伴。

 8156699

 13765294890

 8156699@qq.com

Notice

We and selected third parties use cookies or similar technologies for technical purposes and, with your consent, for other purposes as specified in the cookie policy.
You can consent to the use of such technologies by closing this notice, by interacting with any link or button outside of this notice or by continuing to browse otherwise.