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

Question

我已经开发了一个Spring Data仓库，MemberRepository扩展了接口org.springframework.data.jpa.repository.JpaRepository。MemberRepository有一个方法：

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

结果由Spring缓存抽象（由ConcurrentMapCache）支持缓存。

我的问题是，我想要写一个集成测试（针对HSQLDB）断言结果被从数据库第一次检索，并从缓存中的第二次。

我最初想到模拟jpa基础结构（实体管理器等），并以某种方式断言第二次不调用实体管理器，但似乎太难/麻烦了）。

然后有人可以提供有关如何测试带有注释的Spring Data Repository方法的缓存行为的建议@Cacheable吗？

Answer 1

如果你想测试诸如缓存之类的技术方面，请不要使用任何数据库。了解你要在此处测试的内容非常重要。你要确保避免使用完全相同的参数进行方法调用。面向数据库的存储库是与该主题完全正交的方面。

这是我的建议：

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

Sample

@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. 我们通过检查缓存实际上是否具有第一个键的值来增强测试用例。甚至可以将其扩展为检查实际值。另一方面，我也认为避免这样做是很好的，因为你倾向于测试更多的内部机制而不是应用程序级别的行为。
   重要要点
   
3. 你不需要任何基础结构即可测试容器行为。
4. 设置测试用例很简单。
5. 精心设计的组件使你可以编写简单的测试用例，并需要较少的集成工作来进行测试。