ehcache3-jcache

原生的ehcache只需关注CacheManager和Cache即可，而jcache多了一个cachingProvider，其是用来发现cachingProvider实现的，比如ehcache的EhcacheCachingProvider，然后再通过特定实现的CachingProvider得到特定实现的CacheManager。总的来说，关键就是得到合适cachingProvider，之后就与特定的cache框架耦合了。

 

ehcache的xml配置

<config
    xmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'
    xmlns='http://www.ehcache.org/v3'
    xsi:schemaLocation="
        http://www.ehcache.org/v3 http://www.ehcache.org/schema/ehcache-core-3.0.xsd">

  <cache alias="ready-cache">
    <key-type>java.lang.Long</key-type>
    <value-type>com.pany.domain.Product</value-type>
    <loader-writer>
      <class>com.pany.ehcache.integration.ProductCacheLoaderWriter</class>
    </loader-writer>
    <heap unit="entries">100</heap>
  </cache>

</config>

ehcache的jcache api

//如果依赖中有多个jcache实现，这里可以指定ehcache实现Caching.getCachingProvider(“org.ehcache.jsr107.EhcacheCachingProvider”);，如果只有一个jcache实现，则Caching.getCachingProvider()可以找到对应的实现，查找逻辑后面有提到
CachingProvider cachingProvider = Caching.getCachingProvider();
//getCacheManager第一个参数为一个uri，对于ehcache来说该uri应该是ehcache的配置文件，ehcache实现在这里就会初始化配置文件中的cache
        CacheManager manager = cachingProvider.getCacheManager(
                getClass().getResource("/org/ehcache/docs/ehcache-jsr107-config.xml").toURI(),
                getClass().getClassLoader());
//从manager获得已配置的cache
        Cache<Long, Product> readyCache = manager.getCache("ready-cache", Long.class, Product.class);

下面就来看一下ehcache是如何适配jcache的。

getCachingProvider：

getCachingProviders的主要逻辑：

public synchronized Iterable<CachingProvider> getCachingProviders(ClassLoader classLoader) {

  final ClassLoader serviceClassLoader = classLoader == null ? getDefaultClassLoader() : classLoader;
  LinkedHashMap<String, CachingProvider> providers = cachingProviders.get(serviceClassLoader);

  if (providers == null) {
        //如果系统参数中设置了javax.cache.spi.CachingProvider相关值，则加载该值对应的类
    if (System.getProperties().containsKey(JAVAX_CACHE_CACHING_PROVIDER)) {
      String className = System.getProperty(JAVAX_CACHE_CACHING_PROVIDER);
      providers = new LinkedHashMap<String, CachingProvider>();
      providers.put(className, loadCachingProvider(className, serviceClassLoader));

    } else {
      providers = AccessController.doPrivileged(new PrivilegedAction<LinkedHashMap<String, CachingProvider>>() {
        @Override
        public LinkedHashMap<String, CachingProvider> run() {
          LinkedHashMap<String, CachingProvider> result = new LinkedHashMap<String, CachingProvider>();
                    //ServiceLoader.load会lazy加载所以符合条件的类
          ServiceLoader<CachingProvider> serviceLoader = ServiceLoader.load(CachingProvider.class, serviceClassLoader);
          //这里serviceLoader.iterator().next()会真正进行加载，
          //如果依赖中包含多个jcache实现，最终的result就会有多个元素
          for (CachingProvider provider : serviceLoader) {
            result.put(provider.getClass().getName(), provider);
          }
          return result;
        }
      });

    }

    cachingProviders.put(serviceClassLoader, providers);
  }

  return providers.values();
}

ServiceLoader.load的主要逻辑：

注意，Class的getResource的路径可以以“/”开头，以“/”开头代表相对于运行环境的根路径（通常是com的父目录），不以“/”开头代表相对于该Class所在路径的路径；而ClassLoader的getResource的路径不能以“/”开头，与Class以“/”开头类似。

 

ehcache类库下的META-INF/services/

 打开该文件，发现ehcache的cachingProvider实现类的全限定名：

CachingProvider.getCacheManager有这样一个重载方法，将ehcache配置文件路径传入uri即可，这样ehcache就可以使用jcache的api，并使用自己的配置文件了：

总结一下，Caching.getCachingProvider会去找特定的配置文件META-INF/services/javax.cache.spi.CachingProvider，特定的实现会在该文件内写入CachingProvider实现类的全限定名，Caching.getCachingProvider得到类名后就可以加载该类，最终返回特定实现的CachingProvider，如EhcacheCachingProvider，再之后就是Ehcache的事了。

为什么要有CachingProvider呢？jcache直接提供CacheManager的api不行吗？我觉得是可以的，只不过没有了CachingProvider就没有了对CacheManager的统一管理，我们来看CachingProvider接口，它提供了get（获取CacheManager）、close（关闭CacheManager）的方法，这样我们就可以对CacheManager统一管理。