如何在Spring数据存储库上测试Spring的声明式缓存支持？

Question

@Cacheable(CacheConfiguration.DATABASE_CACHE_NAME)
Member findByEmail(String email);

我最初想嘲弄一下jpa基础结构（实体管理器等），并以某种方式断言实体管理器不是第二次调用的，但它似乎太难/太累赘了（参见https://stackoverflow.com/A/23442457/536299)。

那么，有人能提供建议，如何测试用@cacheable注释的Spring数据存储库方法的缓存行为吗？

Answer 1

如果您想测试像缓存这样的技术方面，完全不要使用数据库。了解您想在这里测试什么是很重要的。您希望确保使用相同参数的调用避免方法调用。数据库前面的存储库是本主题的一个完全正交的方面。

以下是我的建议：

1. 设置配置声明式缓存的集成测试（或从生产配置中导入必要的位和片段。
2. 配置存储库的模拟实例。
3. 编写一个测试用例来设置模拟的预期行为，调用方法并相应地验证输出。

@RunWith(SpringJUnit4ClassRunner.class)
@ContextConfiguration
public class CachingIntegrationTest {

  // Your repository interface
  interface MyRepo extends Repository<Object, Long> {

    @Cacheable("sample")
    Object findByEmail(String email);
  }

  @Configuration
  @EnableCaching
  static class Config {

    // Simulating your caching configuration
    @Bean
    CacheManager cacheManager() {
      return new ConcurrentMapCacheManager("sample");
    }

    // A repository mock instead of the real proxy
    @Bean
    MyRepo myRepo() {
      return Mockito.mock(MyRepo.class);
    }
  }

  @Autowired CacheManager manager;
  @Autowired MyRepo repo;

  @Test
  public void methodInvocationShouldBeCached() {

    Object first = new Object();
    Object second = new Object();

    // Set up the mock to return *different* objects for the first and second call
    Mockito.when(repo.findByEmail(Mockito.any(String.class))).thenReturn(first, second);

    // First invocation returns object returned by the method
    Object result = repo.findByEmail("foo");
    assertThat(result, is(first));

    // Second invocation should return cached value, *not* second (as set up above)
    result = repo.findByEmail("foo");
    assertThat(result, is(first));

    // Verify repository method was invoked once
    Mockito.verify(repo, Mockito.times(1)).findByEmail("foo");
    assertThat(manager.getCache("sample").get("foo"), is(notNullValue()));

    // Third invocation with different key is triggers the second invocation of the repo method
    result = repo.findByEmail("bar");
    assertThat(result, is(second));
  }
}

正如您所看到的，我们在这里做了一些过度测试：

1. 最相关的检查，我认为是第二个调用返回第一个对象。这就是缓存的意义所在。使用相同键的前两次调用返回相同的对象，而使用不同键的第三次调用将导致对存储库的第二次实际调用。
2. 我们通过检查缓存实际上有第一个键的值来加强测试用例。甚至可以扩展它来检查实际值。另一方面，我也认为最好避免这样做，因为您倾向于测试机制的更多内部内容，而不是应用程序级别的行为。

1. 测试容器行为不需要任何基础结构。
2. 设置测试用例很简单，也很简单。
3. 设计良好的组件使您能够编写简单的测试用例，并且在测试中需要较少的集成部分工作。