Spring Casheable返回的缓存对象未通过相等性检查

Question

我面临的问题是，从具有相同键的Spring可缓存方法返回的两个对象不能断言相同的测试。为什么这些对象不共享同一个存储区域？

详细信息：我正在使用redis缓存机制在spring boot REST api中实现缓存。缓存工作正常，它首先从外部提供的源（访问数据库的JPS存储库）检索数据，然后对同一缓存键的后续调用从缓存返回数据。但是，我无法在JUnit测试用例中完全模拟这种行为。My assertEquals或assertSame在从缓存返回的2个对象上失败。

我的代码库如下所示：mvn依赖关系：

<dependency>
    <groupId>org.springframework.data</groupId>
    <artifactId>spring-data-redis</artifactId>
    <version>1.7.6.RELEASE</version>
</dependency>
<dependency>
    <groupId>redis.clients</groupId>
    <artifactId>jedis</artifactId>
    <version>2.9.0</version>
</dependency>

Spring应用程序配置：

@SpringBootApplication
@EnableCaching
public class Application {
@Value("${redis.host}")
private String redisHost;

public static void main(String[] args) {
    SpringApplication.run(Application.class, args);
}

@Bean
JedisConnectionFactory jedisConnectionFactory() {
    JedisConnectionFactory jedisConFactory = new JedisConnectionFactory();
    jedisConFactory.setHostName(redisHost);
    jedisConFactory.setPort(6379);
    return jedisConFactory;
}

@Bean
public RedisTemplate<String, Object> redisTemplate() {
    RedisTemplate<String, Object> template = new RedisTemplate<String, Object>();
    template.setConnectionFactory(jedisConnectionFactory());

    return template;
}

@Bean
CacheManager cacheManager() {
    return new RedisCacheManager(redisTemplate());
}

服务类别：

@Service
public class CIDomainService {
private RedisTemplate<String, Object> redisTemplate;
private CIDomainDAO ciDomainDAO;

@Autowired
public CIDomainService(CIDomainDAO ciDomainDAO, RedisTemplate<String, Object> redisTemplate) {
    this.ciDomainDAO = ciDomainDAO;
    this.redisTemplate = redisTemplate;
}

@Cacheable(value = "ciDomain", key = "#id")
public CIDomain getCIDomain(int id) {
    CIDomain ciDomain = new CIDomain();
    ciDomain.setId(id);
    ciDomain.setName("SomeName");
    return ciDomain;
}


public void clearAllCache() {
    redisTemplate.delete("listCIDomains");
    redisTemplate.delete("ciDomain");
}

}

上述服务中的ciDomainDAO只是一个JPS存储库接口，使用findAll（）方法从外部数据库或内存数据库检索数据。我的测试班：

@RunWith(SpringJUnit4ClassRunner.class)
@ActiveProfiles("local")
@SpringBootTest
public class CIDomainServiceIntegrationTest {

@Autowired
CIDomainService ciDomainServiceSpy;

@Before
public void setUp(){
   ciDomainServiceSpy.clearAllCache();
}

@Test
public void listCIDomains_ShouldRetrieveCIDomainsWithCachingPluggedIn() {
    CIDomain domain1 = ciDomainServiceSpy.getCIDomain(1);
    CIDomain domain2 = ciDomainServiceSpy.getCIDomain(2);
    CIDomain domain3 = ciDomainServiceSpy.getCIDomain(1);
    assertSame(domain1, domain3);   //fails
}

我的域名类：

@Entity
@Table(name = "CI_DOMAIN")
public class CIDomain implements Serializable{
@Id
@GeneratedValue(strategy = GenerationType.IDENTITY)
@Column(name = "id")
private int id;

@Column(name = "name")
private String name;

public int getId() {
    return id;
}

public void setId(int id) {
    this.id = id;
}

public String getName() {
    return name;
}

public void setName(String name) {
    this.name = name;
}

根据这篇文章，我了解到第一次调用是从存储库中检索对象的，如果提供了相同的“键”，那么稍后的调用将从缓存中获取该对象。我在上面的测试用例中做了同样的事情，但是assertSame失败了。Spring cacheable必须是为给定请求获取的内存中的缓存对象。为什么每次都会为同一个请求的密钥发送不同的对象。

我曾尝试过另一种解决方案，在该方案中，我在服务类上使用了spy，并基于相同的密钥请求验证方法调用。然而，我在这样做时遇到了不同的问题。在服务类上创建间谍甚至不使用缓存机制，即使提供了相同的密钥，它也会调用服务getCIDomain方法。我跟着这个，这个，这个，这个，这个和很多其他的帖子做进一步的分析，但是通过spy的assertSame也无法让它工作。

任何帮助都将不胜感激。

Answer 1

我已经解决了这个问题，并能够设计测试用例，因为它应该验证Spring缓存机构。

下面提供我的分析和解决方案，以帮助那些面临同样问题的人。

我在上面的评论和原始问题中提到，由于序列化的工作方式，断言相同不起作用，断言相等虽然起作用，但它有点不满足我的测试要求。

我得出的结论（基于注释），我实际上应该测试方法调用的数量，而不是结果。我试图嘲笑CIDomainDAO仓库道在我的问题，但我面临的几个问题。创建CIDomainDAO的mocked对象并在CIDomainService构造函数中传递它没有触发Spring缓存，我的测试失败了。如果我不嘲笑CIDomainDAO并试图监视CIDomainService以检查没有方法调用并运行我的测试，那么我最终会得到

org.mockito.exceptions.misusing.UnfinishedVerificationException: Missing 
method call for verify(mock).

这是显而易见的，因为模仿似乎不适用于CIDomainDAO在其spring生成的JPARepository实现中可能拥有的最终方法。这篇文章帮助我理解了莫基托的这种行为。

我认为我需要以某种方式模拟CIDomainDAO，最后在CIDomainService类中注入了CIDomainDAO respository的模拟版本。为此，我必须在CIDomainService类中定义一个CIDomainDAO setter。在那之后，我没有尝试任何方法调用，它按预期工作，即服务调用了两次，但CIDomainDAO调用了一次，因为数据在第二次调用中从缓存返回。

下面提供了我在上面的原始问题中修改过的类。

服务类别：

@Service
public class CIDomainService {
    private RedisTemplate<String, Object> redisTemplate;
    private CIDomainDAO ciDomainDAO;

    @Autowired
    public CIDomainService(CIDomainDAO ciDomainDAO, RedisTemplate<String, 
    Object> redisTemplate) {
        this.ciDomainDAO = ciDomainDAO;
        this.redisTemplate = redisTemplate;
    }

    @Cacheable(value = "ciDomain", key = "#id")
    public CIDomain getCIDomain(int id) {
        CIDomain ciDomain = new CIDomain();
        ciDomain.setId(id);
        ciDomain.setName("SomeName");
        return ciDomain;
    }


    public void clearAllCache() {
        redisTemplate.delete("listCIDomains");
        redisTemplate.delete("ciDomain");
    }

    public void setCIDomainDAO(CIDomainDAO ciDomainDAO ) {
        this.ciDomainDAO = ciDomainDAO;
    }
}

这是更新的测试用例：

@RunWith(SpringJUnit4ClassRunner.class)
@ActiveProfiles("local")
@SpringBootTest
public class CIDomainServiceIntegrationTest {

    @Autowired
    @InjectMocks
    CIDomainService ciDomainService;

    @Mock
    CIDomainDAO ciDomainDAO;

    @Before
    public void setUp() {
        Mockito.reset(ciDomainDAO);
        ciDomainService.clearAllCache();
    }


    @Test
    public void listCIDomains_ShouldNotAttemptToCallRepositoryWhenCachingEnabledAfterFirstCallOfRetrievingCIDomains() {
        List<CIDomain> domains1 = ciDomainService.listCIDomains();
        List<CIDomain> domains2 = ciDomainService.listCIDomains();
        Mockito.verify(ciDomainDAO, Mockito.times(1)).findAll();
    }

    @Test
    public void listCIDomains_ShouldAttemptToCallRepositoryWhenCachingIsClearedAfterFirstCallOfRetrievingCIDomains() {
    List<CIDomain> domains1 = ciDomainService.listCIDomains();
        ciDomainService.clearAllCache();
        List<CIDomain> domains2 = ciDomainService.listCIDomains();
        Mockito.verify(ciDomainDAO, Mockito.times(2)).findAll();
    }

    @After
    public void postSetUp() {
        Mockito.validateMockitoUsage();
        ciDomainService.clearAllCache();
        Mockito.reset(ciDomainDAO);
      }
    }