Spring Casheable返回缓存对象失败等式检查

时间:2017-06-21 12:43:11

标签: spring caching redis

我面临的问题是,使用相同密钥的spring cacheable方法返回的两个对象会失败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存储库接口,使用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我理解在第一次调用时从存储库中检索对象,然后稍后调用将从缓存中获取此对象,前提是提供了相同的“密钥”。我在上面的测试用例中做了同样的事情,但是assertSame失败了。 Spring cacheable必须在内存中缓存对象,该对象是为给定请求获取的。为什么每次都会为同一个请求的密钥发送不同的对象。

我试图有一个替代解决方案,我在服务类上使用spy并根据相同的密钥请求验证方法调用。但是,我在这方面遇到了不同的问题。在服务类上创建间谍甚至不使用缓存机制,即使提供了相同的密钥,它也会调用服务getCIDomain方法。我跟踪了thisthisthisthisthis以及许多其他帖子以进行进一步分析,但无法通过断言的断言来使其工作

真的很感激任何帮助。

1 个答案:

答案 0 :(得分:0)

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

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

我在上面的评论和原始问题中提到,由于序列化的工作方式和assertEquals虽然有效,但assertSame不起作用,但它有点不能满足我的测试要求。

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

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

这很明显,因为模拟似乎不适用于CIDomainDAO在其弹簧生成的JPARepository实现中可能具有的最终方法。  This帖子帮助我了解了mockito的这种行为。

总结说我需要以某种方式模拟CIDomainDAO,我最终在CIDomainService类中注入了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);
      }
    }