跳至主要内容

Spring Caching


Spring cache abstraction

Spring provides its own cache solution in 3.x. And it defines a CacheManager SPI for third party cache solutions. By default, in the Spring core, it provides two built-in implementations, which based on JDK ConcurrentMap, Ehcache, Guava, etc.
ConcurrentMap is an in-memory cache solution, it is useful in the development stage.

Enable Spring Caching

Add @EnableCaching(mode=AdviceMode.ASPECTJ) annotation on the configuration class if you are using Java based configuration.
@Configuration
...
@EnableCaching(mode=AdviceMode.ASPECTJ)
public class JpaConfig {...}
Then, specify a CacheManager provider in your configuration.
@Override
@Bean
public CacheManager cacheManager() {
 return new ConcurrentMapCacheManager();
}

@Override
@Bean
public KeyGenerator keyGenerator() {
 return new SimpleKeyGenerator();
}

Code sample

Spring provides some annotations for applying the cache in your classes, @Cacheable, @CachePut, @CacheEvict, the former two are use for creating cache, and the last is for remove caches. @CachePut always replace the current cache value even there is no change.
@Repository
public class JpaConferenceDaoImpl implements ConferenceDao {

 @Override
 @Cacheable(value="conference", key="#id")
 public Conference findById(Long id) {
 ...
 }

 @Override
 @CacheEvict(value="conference", allEntries=true)
 public void deleteAll() {
 ...
 }

 @Override
 @CachePut(value="conference", key="#result.id")
 public Conference findBySlug(String slug) {
 ...
 }
}
Test it now.
@Test
@Transactional
public void retrieveConference() {

 Long id = conferenceDao.save(newConference());

 entityManager.flush();
 assertTrue(id != null);
 log.debug("id @=" + id);
 Conference conference = conferenceDao.findById(id);

 assertTrue(conference != null);

 assertTrue("JUD2013".equals(conference.getName()));

 // query by slug
 conference = conferenceDao.findBySlug("jud-2013");

 assertTrue(conference !=  null);

 assertTrue("JUD2013".equals(conference.getName()));

 log.debug("@@@@@@@@@@@@@@loading from cache@@@@@@@@@@@@@@@@@@@@");

 Conference conference2 = conferenceDao.findById(conference.getId());
 assertTrue(conference2 != null);
}
The last query operation does not hint database at all, it is loaded from cache.

Summary

Compare to the JPA 2nd level cache, the Spring solutions has some advantages.
  • It is more flexible.
You can define which methods you create and evict caches. In JPA, the cache is created when the object is persisted, you can change the strategy. As the above example codes, creating cache happens when fetching a conference from database, and do nothing when saving a conference into database.
  • Spring cache can be used in any data persistence solutions. As the above example codes, we are using cache on methods, it does not depend on JPA at all, so cache can be used in Jdbc and other data persistence solution.
Besides the built-in cache implementations, Spring Data project provides CacheManager for GemFire and Redis. And JBoss infinispan(Maven artifact is infinispan-spring) also provides an CacheManager implementation.
The example codes are hosted on my Github account.
发表评论

此博客中的热门博文

JPA 2.1: Attribute Converter

JPA 2.1: Attribute Converter If you are using Hibernate, and want a customized type is supported in your Entity class, you could have to write a custom Hibernate Type. JPA 2.1 brings a new feature named attribute converter, which can help you convert your custom class type to JPA supported type. Create an Entity Reuse thePostentity class as example. @Entity @Table(name="POSTS") public class Post implements Serializable { private static final long serialVersionUID = 1L; @Id @GeneratedValue(strategy = GenerationType.AUTO) @Column(name="ID") private Long id; @Column(name="TITLE") private String title; @Column(name="BODY") private String body; @Temporal(javax.persistence.TemporalType.DATE) @Column(name="CREATED") private Date created; @Column(name="TAGS") private List<String> tags=new ArrayList<>(); } Create an attribute converter In this example…

Auditing with Hibernate Envers

Auditing with Hibernate Envers The approaches provided in JPA lifecyle hook and Spring Data auditing only track the creation and last modification info of an Entity, but all the modification history are not tracked. Hibernate Envers fills the blank table. Since Hibernate 3.5, Envers is part of Hibernate core project. Configuration Configure Hibernate Envers in your project is very simple, just need to addhibernate-enversas project dependency. <dependency> <groupId>org.hibernate</groupId> <artifactId>hibernate-envers</artifactId> </dependency> Done. No need extra Event listeners configuration as the early version. Basic Usage Hibernate Envers provides a simple@Auditedannotation, you can place it on an Entity class or property of an Entity. @Audited private String description; If@Auditedannotation is placed on a property, this property can be tracked.

Spring Data Mongo: bridge MongoDB and Spring

Spring Data Mongo: bridge MongoDB and SpringMongoDBis one of the most popular NoSQL products, Spring Data Mongo(Maven archetype id is spring-data-mongodb) tries to provides a simple approach to access MongoDB. Configuration Add the following code fragments in your Spring configuration. <!-- Mongo config --> <mongo:db-factory id="mongoDbFactory" host="localhost" port="27017" dbname="conference-db" /> <bean id="mongoTemplate" class="org.springframework.data.mongodb.core.MongoTemplate"> <constructor-arg ref="mongoDbFactory" /> </bean> <mongo:repositories base-package="com.hantsylabs.example.spring.mongo" /> Firstly, declare aDbFactorywhich is responsible for connecting to the MongoDB server. Then, register theMongoTemplateobject which envelop the data operations on MongoDB. Lastly addmongo:repositorieswith an essentialbase-packageattribute, Spring will discovery your d…