大家好，又见面了，我是你们的朋友全栈君。

hibernate二级缓存（二）二级缓存实现原理简单剖析

在前面我们将过hibernate二级缓存类似于一个插件，将缓存的具体实现分离，缓存的具体实现是通过hibernate.cache.region.factory_class参数配置指定。本文只是对hibernate二级缓存的部分接口进行简单的解析，大致了解二级缓存的整体结构，二级缓存的内部实现很复杂，如要深究请阅读hibernate源码。

1. hibernate二级缓存结构

hibernate二级缓存涉及到如下几个重要的接口：

• RegionFactory
• DomainDataRegion
• EntityDataAccess
• StorageAccess

1.1 RegionFactory获取缓存的工厂，RegionFactory有如下几个重要的方法：

public interface RegionFactory extends Service, Stoppable {
	//初始化方法
	void start(SessionFactoryOptions settings, Map configValues) throws CacheException;
	
	boolean isMinimalPutsEnabledByDefault();

	//缓存策略
	AccessType getDefaultAccessType();

	String qualify(String regionName);

	default CacheTransactionSynchronization createTransactionContext(SharedSessionContractImplementor session) {
		return new StandardCacheTransactionSynchronization( this );
	}
	
	long nextTimestamp();

	default long getTimeout() {
		// most existing providers defined this as 60 seconds.
		return 60000;
	}

	DomainDataRegion buildDomainDataRegion(
			DomainDataRegionConfig regionConfig,
			DomainDataRegionBuildingContext buildingContext);

	QueryResultsRegion buildQueryResultsRegion(String regionName, SessionFactoryImplementor sessionFactory);

	TimestampsRegion buildTimestampsRegion(String regionName, SessionFactoryImplementor sessionFactory);
}

• start 初始化RegionFactory
• getDefaultAccessType 获得缓存策略，前面说过的CacheConcurrencyStrategy内部是基于AccessType
• nextTimestamp 生成时间戳，用于时间戳缓存
• buildDomainDataRegion 创建一个实体领域模型的Region，使用该对象来缓存实体，可以理解为实体缓存的holder
• buildQueryResultsRegion 创建查询缓存
• buildTimestampsRegion 创建时间戳缓存。时间戳缓存Region存放了对于查询结果相关的表进行插入, 更新或删除操作的时间戳。Hibernate 通过时间戳缓存Region来判断被缓存的查询结果是否过期

RegionFactory 是创建缓存的工厂，所有的缓存都是通过RegionFactory 来获取的，而RegionFactory 是在EnabledCaching构造方法中初始化的。RegionFactory 的初始化过程如下图所示：

sessionFactory = new MetadataSources(registry).buildMetadata().buildSessionFactory()；可以看到是在初始化sessionFactory的时候来初始化RegionFactory 。

1.2 DomainDataRegion缓存区域

DomainDataRegion可以理解为缓存的wraper或者holder。接口如下：

public interface DomainDataRegion extends Region {

    EntityDataAccess getEntityDataAccess(NavigableRole var1);

    NaturalIdDataAccess getNaturalIdDataAccess(NavigableRole var1);

    CollectionDataAccess getCollectionDataAccess(NavigableRole var1);
}

getEntityDataAccess 获得一个EntityDataAccess，对缓存的操作实际上是代理给EntityDataAccess，由EntityDataAccess来真正的管理缓存。

1.3 EntityDataAccess 缓存实际的访问者，用于管理对缓存实体数据的事务性和并发访问的协定

public interface EntityDataAccess extends CachedDomainDataAccess {
	//生成缓存key
	Object generateCacheKey(
			Object id,
			EntityPersister rootEntityDescriptor,
			SessionFactoryImplementor factory,
			String tenantIdentifier);
	//获取缓存key
	Object getCacheKeyId(Object cacheKey);
	//在查询后，是否将查询结果插入缓存
	boolean insert(SharedSessionContractImplementor session, Object key, Object value, Object version);
	//插入后是否更新缓存
	boolean afterInsert(SharedSessionContractImplementor session, Object key, Object value, Object version);
	
	boolean update(
			SharedSessionContractImplementor session,
			Object key,
			Object value,
			Object currentVersion,
			Object previousVersion);

	boolean afterUpdate(
			SharedSessionContractImplementor session,
			Object key,
			Object value,
			Object currentVersion,
			Object previousVersion,
			SoftLock lock);
}

在上面的接口中我们并没有看到实际操作缓存的接口，那么EntityDataAccess 又是怎么访问和管理缓存的呢，下面来看一下EntityDataAccess 的接口继承和实现关系：

从上面的图我们可以看到EntityDataAccess 有一个抽象类，4个实现类。4个实现类分别对应了4中缓存访问类型，READ_ONLY，TRANSACTIONAL，READ_WRITE，NONSTRICT_READ_WRITE。抽象类AbstractEntityDataAccess实现了
EntityDataAccess 继承了AbstractCachedDomainDataAccess。AbstractCachedDomainDataAccess的部分代码如下：

AbstractCachedDomainDataAccess里面包含了一个DomainDataStorageAccess，DomainDataStorageAccess继承自StorageAccess，StorageAccess的接口如下：

public interface StorageAccess {
	/**
	 * Get an item from the cache.
	 */
	Object getFromCache(Object key, SharedSessionContractImplementor session);

	/**
	 * Put an item into the cache
	 */
	void putIntoCache(Object key, Object value, SharedSessionContractImplementor session);

	/**
	 * Remove an item from the cache by key
	 */
	default void removeFromCache(Object key, SharedSessionContractImplementor session) {
		evictData( key );
	}

	/**
	 * Clear data from the cache
	 */
	default void clearCache(SharedSessionContractImplementor session) {
		evictData();
	}

	/**
	 * Does the cache contain this key?
	 */
	boolean contains(Object key);

	/**
	 * Clear all data regardless of transaction/locking
	 */
	void evictData();

	/**
	 * Remove the entry regardless of transaction/locking
	 */
	void evictData(Object key);

	/**
	 * Release any resources.  Called during cache shutdown
	 */
	void release();
}

到这里我们终于发现了操作缓存的实际接口。而DomainDataStorageAccess接口是缓存操作必须实现的接口，ehchche的实现类是StorageAccessImpl。当然通过扩展该接口我们还可以将缓存放置到redis，memcache。

2. 缓存的初始化和调用

2.1 从上面的接口关系我们大致可以得到如下的一个缓存初始化关系链：

sessionFactory —–>EnabledCaching —–>RegionFactory —–>DomainDataRegion —–>EntityDataAccess —–>AbstractEntityDataAccess —–>AbstractCachedDomainDataAccess —–>StorageAccess

2.2 获取cache的调用栈

SessionImpl获取实体对象，然后通过一系列的调用，最终会落到AbstractCachedDomainDataAccess.get(SharedSessionContractImplementor session, Object key)，前面已经说过该方法实际上是调用的DomainDataStorageAccess.getFromCache( key, session )。

3. 自定义hibernate缓存

通过前面的一系列分析，我们大致了解了hibernate缓存的一些重要的接口。如果要自定义hibernate缓存那么我们必须实现上面的这些接口。好在hibernate内部为实现了大多数的扩展，我们只需要扩展RegionFactory和DomainDataStorageAccess接口既可以自定义hibernate的二级缓存。
hibernate为实现RegionFactory提供了一个模版类RegionFactoryTemplate，我们直接通过实现该类和DomainDataStorageAccess，即可自定义hibernate二级缓存。