hibernate-redis

Hibernate (4.2.x.Final, 4.3.x.Final) 2nd level cache using Redis server. with Jedis 2.4.1 or higher

Reduce cache size by Fast-Serialization and snappy-java. Thanks!

See serialization benchmark.

NOTE

Don't use Hibernate 4.3.2.Final, 4.2.9.Final!!! It has bug in CacheKey! Recommend use 4.3.4.Final or 4.2.10.Final

Hibernate 4.3.2.Final CacheKey eliminate entityOrRoleName property for reduce CacheKey size. if multiple entity cached in same region, can't figure out wanted entity.

Maven Repository

Add dependency

<dependency>
    <groupId>com.github.hibernate-redis</groupId>
    <artifactId>hibernate-redis</artifactId>
    <version>1.6.4</version>
</dependency>

Setup hibernate configuration

Setup hibernate configuration

// Secondary Cache
props.put(Environment.USE_SECOND_LEVEL_CACHE, true);
props.put(Environment.USE_QUERY_CACHE, true);
props.put(Environment.CACHE_REGION_FACTORY, SingletonRedisRegionFactory.class.getName());
props.put(Environment.CACHE_REGION_PREFIX, "hibernate");

// optional setting for second level cache statistics
props.setProperty(Environment.GENERATE_STATISTICS, "true");
props.setProperty(Environment.USE_STRUCTURED_CACHE, "true");

props.setProperty(Environment.TRANSACTION_STRATEGY, JdbcTransactionFactory.class.getName());

// configuration for Redis that used by hibernate
props.put(Environment.CACHE_PROVIDER_CONFIG, "hibernate-redis.properties");

Also same configuration for using Spring Framework or Spring Data JPA

Redis settings for hibernate-redis

Sample for hibernate-redis.properties

 ##########################################################
 #
 # properties for hibernate-redis
 #
 ##########################################################

 # Redis Server for hibernate 2nd cache
 redis.host=localhost
 redis.port=6379

 # use redis-sentinel cluster as opposed to a single redis server (use only if not using host/port)
 # redis.sentinels = host1:26379,host2:26379,host3:26379
 # redis.masterName = mymaster

 # redis.timeout=2000
 # redis.password=

 # database for hibernate cache
 # redis.database=0
 redis.database=1

 # Hibernate 2nd cache default expiry (seconds)
 redis.expiryInSeconds=120

 # expiry of hibernate.common region (seconds) // hibernate is prefix, region name is common
 redis.expiryInSeconds.hibernate.common=0

 # expiry of hibernate.account region (seconds) // hibernate is prefix, region name is account
 redis.expiryInSeconds.hibernate.account=1200

Setup Hibernate entity to use cache

Add @org.hibernate.annotations.Cache annotation to your Entity class

@Entity
@Cache(region="common", usage = CacheConcurrencyStrategy.READ_WRITE)  // or @Cacheable(true) for JPA
@Getter
@Setter
public class Item implements Serializable {
    @Id
    @GeneratedValue
    private Long id;

    private String name;

    private String description;

    private static final long serialVersionUID = -281066218676472922L;
}

How to monitor hibernate-cache is running

Run "redis-cli monitor" command in terminal. you can see putting cached items, retrieving cached items.

Sample code

Read HibernateCacheTest.java for more usage.