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

Question

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

详细信息:我正在使用 redis 缓存机制在 spring boot REST api 中实现缓存。缓存的正确工作方式是它首先从外部提供的源(JPS 存储库访问数据库)检索数据，然后对相同缓存键的后续调用从缓存返回数据。但是，我无法在 JUnit 测试用例中完全模仿这种行为。我的 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 存储库接口(interface)，使用 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;
}

基于 this post我知道对象是在第一次调用时从存储库中检索的，然后稍后调用将从缓存中获取该对象，前提是提供了相同的“ key ”。我在上面的测试用例中做了同样的事情，但是 assertSame 失败了。 Spring 可缓存必须在内存中缓存对象，该对象是为给定请求获取的。为什么它每次都会为相同的请求 key 发送不同的对象。

我尝试了一个替代解决方案，我在服务类上使用了 spy ，并根据相同的 key 请求验证方法调用。但是，我在这样做时遇到了不同的问题。在服务类上创建 spy 甚至不使用缓存机制，即使提供了相同的 key ，它也会调用服务 getCIDomain 方法。我关注了this , this , this , this , this和许多其他帖子进行进一步分析，但无法通过 assertSame of spy 使其正常工作。

我们将不胜感激任何帮助。

Answer 1

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

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

我在上面的评论和原始问题中提到，由于序列化的工作方式，assertSame 将无法工作，而 assertEquals 虽然可以工作，但有点不能满足我的测试要求。

我得出的结论(基于评论)是我应该实际测试方法调用的数量而不是结果。我试图像我的问题一样模拟 CIDomainDAO 存储库 dao，但我遇到了几个问题。创建 CIDomainDAO 的模拟对象并将其传递到 CIDomainService 构造函数中不会触发 spring 缓存，我的测试失败了。如果我不模拟 CIDomainDAO 并尝试监视 CIDomainService 以检查没有方法调用并运行我的测试，那么我最终会得到

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

这是显而易见的，因为模拟似乎不适用于 CIDomainDAO 在其 spring 生成的 JPARepository 实现中可能具有的 final方法。 This帖子帮助我理解了 mockito 的这种行为。

结论是我需要以某种方式模拟 CIDomainDAO，我最终在 CIDomainService 类中注入(inject)了 CIDomainDAO 存储库的模拟版本。为此，我必须专门在 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);
      }
    }