Ehcache 3.7文档—基础篇—XML Configuration
你可以使用xml配置创建CacheManager，根据这个schema definition ( http://www.ehcache.org/documentation/3.7/xsds.html#core )
一. 配置元素
<config> 根元素
config是我们xml配置文件的根元素。它代表了CacheManager的配置。
注意：Ehcache允许创建多个CacaheManager使用相同的XML配置文件。与JSR-107 javax.cache.spi.CachingProvider相对比，Ehcache不维护已创建的CacheManager的实例。
<service>元素
service元素是CacheManager所管理服务的扩展点。
用这种方式定义的service他的生命周期和管理他的CacheManger生命周期一样。对于这样的service，当CacheManager.init被调用时会触发Service.start方法。当CacheManger.close被调用时会触发Service.stop方法。
CacaheManger管理的那些Cache可以使用这些Service的实例。
JSR-107使用XML配置的扩展点在[ http://www.ehcache.org/documentation/3.7/107.html#supplement-jsr-107-configurations ]这里有介绍。
<default-serializers>元素
default-serializers元素代表了CacheManger级别的序列化配置。它是<serializer>元素的集合，<serializer>元素包含了一个type和Serializer类的全限定名。
<default-copiers>元素
default-copiers元素代表了CacheManger级别的Copiers配置，它是<copier>元素的集合，<copier>元素包含了一个type和Copier类的全限定名。
<persistence>元素
persistence元素代表了持久化，当创建PersistentCacheManager时使用它。它包含一个数据存储到Disk时的目录。
<cache>元素
一个cache元素代表一个Cache实例，这个实例被CacheManager创建并管理。每个cache元素需要一个alias属性，根据这个alias属性去调用org.ehcache.CacheManager.getCache(String,Class<K>,Class<V>)，获得相应的cache实例。也可以使用uses-template属性去引用一个<cache-template>。了解详情参见[ http://www.ehcache.org/documentation/3.7/xml.html#cache-template-elements ]
如下元素是可选的：
- <key-type>: Cache<K,V>中K的全限定类名，默认是java.lang.Object
- <value-type>: Cache<K,V>中V的全限定类名，默认是java.lang.Object
- <expiry>: 控制expiry的类型和他的参数
- <eviction-advisor>: 实现org.ehcache.config.EvictionAdvisor<K,V>类的全限定名，默认是null
- <integration>: 用于配置cache-through模式的CacheLoaderWriter
- <resources>: 配置层的信息和层的容量，当只是用heap层时，你可以使用<heap>元素代替它
<cache-template>元素
cache-template元素是<cache>元素的模板，它具有唯一性，可以通过name属性设置名字。cache元素通过使用uses-template属性指定cache-template的名字可以继承该模板中所有的属性值。当然<cache>也可以重写模板中的属性。
注意：Processing of cache template configurations can be triggered lazily by actions that dynamically bind new caches to existing cache templates. Errors within such templates may not be revealed until this lazy processing is triggered.
二. XML配置文件中属性替换
在XML配置文件内部可以引用java system properties值，在配置解析时这些引用会被替换为value。
使用的语法格式为${prop.name}，他可以用在所有attributes和elements的值上，目前这个规则不包含用来调整大小的数字和标识符，例如cache和cache-template的名字。
注意：如果这个系统属性不存在，那么会导致配置解析失败。
一个典型的应用是在<persistence>标签中的directory属性上，配置file路径
<persistence directory="${user.home}/cache-data"/>(1)这里的user.home将会被系统中的属性替换，比如说替换成/home/user
三. XML配置解析
如果你能通过JSP-107API获取CacheManager，当你在调用javax.cache.spi.CachingProvider.getCacheManager(java.net.URI,java.lang.ClassLoader)后，接下来的事情会自动完成。
final URL myUrl = getClass().getResource("/configs/docs/getting-started.xml"); (1)
XmlConfiguration xmlConfig = new XmlConfiguration(myUrl); (2)
CacheManager myCacheManager = CacheManagerBuilder.newCacheManager(xmlConfig); (3)
myCacheManager.init(); (4)(1). 获取xml文件的位置
(2). 通过xml文件的url实例化一个XmlConfiguration
(3). 使用静态方法CacheManagerBuilder.newCacheManager(Configuration)创建CacheManager
(4). 在使用之前要初始化cacheManager
我们也可以使用<cache-template>来作为CacheConfigurationBuilder的配置，为了使用<cache-template>元素你需要创建一个xml文件，包含如下内容：
<cache-template name="example"><key-type>java.lang.Long</key-type><value-type>java.lang.String</value-type><heap unit="entries">200</heap> </cache-template>
用如下的方式创建CacheConfigurationBuilder
XmlConfiguration xmlConfiguration = new XmlConfiguration(getClass().getResource("/configs/docs/template-sample.xml"));
CacheConfigurationBuilder<Long, String> configurationBuilder = xmlConfiguration.newCacheConfigurationBuilderFromTemplate("example", Long.class, String.class); (1)
configurationBuilder = configurationBuilder.withResourcePools(ResourcePoolsBuilder.heap(1000)); (2)(1). 创建builder，继承cache-template的属性，heap的大小为200个entry。
(2). 重写继承的属性
四. 编程的方式配置XML文件
就像根据xml文件创建cache manager一样，反向翻译也是支持的。
CacheManager cacheManager = CacheManagerBuilder.newCacheManagerBuilder().with(CacheManagerBuilder.persistence(tmpDir.newFile("myData"))).withCache("threeTieredCache",CacheConfigurationBuilder.newCacheConfigurationBuilder(Long.class, String.class,ResourcePoolsBuilder.newResourcePoolsBuilder().heap(10, EntryUnit.ENTRIES).offheap(1, MemoryUnit.MB).disk(20, MemoryUnit.MB, true)).withExpiry(ExpiryPolicyBuilder.timeToIdleExpiration(Duration.ofSeconds(20)))).build(false);Configuration configuration = cacheManager.getRuntimeConfiguration();
XmlConfiguration xmlConfiguration = new XmlConfiguration(configuration); (1)
String xml = xmlConfiguration.toString(); (2)(1). 通过CacheManager的configuration来实例化一个XmlConfiguration
(2). 通过使用toString方法来获得xml内容
不是所有的编程式的配置都可以转换成xml文件的，如果cache manager中包含了如下的内容就不可以转换：
- EvictionAdvisor
- 自定义的ExpiryPolicy，而不是从ExpiryPolicyBuilder从获取的timeToLiveExpiration或者是timeToIdleExpiration
- 使用实例代替他们的classes:
a. Serializer
b. Copier
c. CacheLoaderWriter
d. CacheEventListener
e. ResilienceStrategy
五. 在一个文件中配置多个CacheManager
使用该特性最简单配置就是嵌套多个cache manager configurations在同一个xml文件中。
<multi:configurationsxmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'xmlns='http://www.ehcache.org/v3'xmlns:multi='http://www.ehcache.org/v3/multi'xsi:schemaLocation='http://www.ehcache.org/v3 http://www.ehcache.org/schema/ehcache-core.xsdhttp://www.ehcache.org/v3/multi http://www.ehcache.org/schema/ehcache-multi.xsd'> <!--1--><multi:configuration identity="foo-manager"> <!--2--><config><cache alias="foo"><key-type>java.lang.String</key-type><value-type>java.lang.String</value-type><resources><heap unit="entries">20</heap><offheap unit="MB">10</offheap></resources></cache></config></multi:configuration><multi:configuration identity="bar-manager"><config><cache alias="bar"><key-type>java.lang.String</key-type><value-type>java.lang.String</value-type><resources><heap unit="entries">20</heap><offheap unit="MB">10</offheap></resources></cache></config></multi:configuration> </multi:configurations>
(1). 最顶级的元素<configurations>包含了namespace和一些核心schema。
(2). 每个Ehcache的配置都包含在configuration标签中，并且他需要一个唯一的标识identity属性。
通过xml文档创建XmlMultiConfiguration实例。
XmlMultiConfiguration multipleConfiguration = XmlMultiConfiguration.from(getClass().getResource("/configs/docs/multi/multiple-managers.xml")) (1).build(); (2)Configuration fooConfiguration = multipleConfiguration.configuration("foo-manager"); (3)(1). XmlMultiConfiguration是XML文件中resource的集合
(2). 构建这个配置
(3). 可以通过他们的identites获取Configuration实例
多个CacheManager的变体
对于给定的manager，可以通过包含一系列<variant>标签来提供变体配置，每个标签中都需要一个type属性。
<multi:configurationsxmlns:xsi='http://www.w3.org/2001/XMLSchema-instance'xmlns='http://www.ehcache.org/v3'xmlns:multi='http://www.ehcache.org/v3/multi'xsi:schemaLocation='http://www.ehcache.org/v3 http://www.ehcache.org/schema/ehcache-core.xsdhttp://www.ehcache.org/v3/multi http://www.ehcache.org/schema/ehcache-multi.xsd'><!-- tag::variants[] --><multi:configuration identity="foo-manager"><multi:variant type="heap"><config><cache alias="foo"><key-type>java.lang.String</key-type><value-type>java.lang.String</value-type><resources><heap unit="entries">1000</heap></resources></cache></config></multi:variant><multi:variant type="offheap"><config><cache alias="foo"><key-type>java.lang.String</key-type><value-type>java.lang.String</value-type><resources><heap unit="entries">1000</heap><offheap unit="MB">128</offheap></resources></cache></config></multi:variant></multi:configuration><!-- end::variants[] --><multi:configuration identity="bar-manager"><config><cache alias="bar"><key-type>java.lang.String</key-type><value-type>java.lang.String</value-type><resources><heap unit="entries">1000</heap></resources></cache></config></multi:configuration> </multi:configurations>
可以通过指定variant和identity来获取一个cache configuration
Configuration fooConfiguration = variantConfiguration.configuration("foo-manager", "offheap"); 上面的仅仅是一个例子，variant的类型可以有很多种：development vs production，clustered vs unclustered，red vs blue等等。
注意：当Configurations中有多个variant时必须有一个variant指定type，否则在获取时会抛出IllegalStateException异常。当Configurations中没有多个variants时将始终为所有的请求返回单个的配置。
获取多个CacheManager
通过遍历identites，可以从XmlMultiConfiguration中获取多个CacheManager
Map<String, Configuration> allConfigurations = multipleConfiguration.identities().stream() // <1>.collect(Collectors.toMap(i -> i, i -> multipleConfiguration.configuration(i))); // <2>Map<String, Configuration> offheapConfigurations = variantConfiguration.identities().stream().collect(Collectors.toMap(i -> i, i -> variantConfiguration.configuration(i, "offheap"))); // <3>
(1). 多个配置中identites集合的stream
(2). 映射每个identity到他的唯一配置上
(3). 另一种选择为映射每个identity到指定的variant配置上
构建多个配置的XML
XmlMultiConfiguration实例可以被组装和修改通过使用相关的API，之前解析XML Multi-Configuration的例子仅仅是一个简单的调用。
Configurations可以从头被构建，像下面那样：
XmlMultiConfiguration multiConfiguration = XmlMultiConfiguration.fromNothing() // <1>.withManager("bar", barConfiguration) // <2>.withManager("foo").variant("heap", heapConfiguration).variant("offheap", offheapConfiguration) // <3>.build(); // <4>(1). 创建一个空的XmlMultiConfiguration
(2). 添加configuration，不带variants
(3). 添加一个configuration带两个不同的variants：heap和offheap
(4). 构建最终的configuration实例
他们也可以通过已经存在的配置中构建
XmlMultiConfiguration modified = XmlMultiConfiguration.from(multiConfiguration) // <1>.withManager("foo") // <2>.build();(1). multiConfiguration是一个已经存在配置
(2). Remove the configuration with identity "foo"
以xml的格式获取一个已经构建的multi-configuration
String xmlString = multiConfiguration.asRenderedDocument(); // <1>Document xmlDocument = multiConfiguration.asDocument(); // <2>
(1). 以字符串的形式获取xml
(2). 以DOM的形式获取xml
转载于:https://www.cnblogs.com/Sicwen/p/10588047.html
Ehcache 3.7文档—基础篇—XML Configuration相关推荐
- PHP学习文档——基础篇
PHP学习文档--基础篇 PHP学习文档--基础篇 标记 短标记 脚本标记 标准标记(常用) PHP注释 行注释 块注释 PHP语句分隔符 变量 变量命名规则 预定义变量 可变变量 变量传值 常量 定 ...
- java 使用 POI 操作 XWPFDocumen 创建和读取 Office Word 文档基础篇
注:有不正确的地方还望大神能够指出,抱拳了 老铁! 参考 API:http://poi.apache.org/apidocs/org/apache/poi/xwpf/usermodel/XWPFDoc ...
- TypeScript学习文档-基础篇（完结）
Python微信订餐小程序课程视频 https://edu.csdn.net/course/detail/36074 Python实战量化交易理财系统 https://edu.csdn.net/cou ...
- FreeMarker中文帮助手册API文档,基础入门学习文档
FreeMarker中文帮助手册API文档,基础入门学习文档 分类: 编程技术 发布: bywei 浏览: 7 日期: 2011年5月28日 分享到: QQ空间 新浪微博 腾讯微博 人人网 什么是Fr ...
- go读取excel_Excelize 2.3.0 发布，Go 语言 Excel 文档基础库
github.com/xuri/excelize Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库,基于 ECMA-376,ISO/IEC 29500 国际标准.可 ...
- XML——生成 XML 文档（读入 XML的反向过程）
[0]README 0.1) 本文文字描述转自 core java volume 2 , 旨在理解 XML--生成 XML 文档(读入 XML的反向过程) 的基础知识 : 0.2) for sourc ...
- python：操作文档——TXT篇
python:操作文档--TXT篇 一.前言: 文档操作是任何web应用程序的组成部分,我们可以将一些保密级别不高的数据存储在文档中,这样就使得数据永久保存,而不是像全局变量一样,当程序结束后自动 ...
- Python-docx 模块读写 Word 文档基础（一）：创建文档、段落格式、字体格式设置方法
Python-docx 模块读写 Word 文档基础(一):创建文档.段落格式.字体格式设置方法 前言: 1.创建 Word 文档及基础用法: 2.段落格式设置: 3.字体格式设置: 结尾: [Pyt ...
- python的openpyxl库如何读取特定列_Excelize 2.3.2 发布，Go 语言 Excel 文档基础库，2021 年首个更新...
Excelize 是 Go 语言编写的用于操作 Office Excel 文档基础库,基于 ECMA-376,ISO/IEC 29500 国际标准.可以使用它来读取.写入由 Microsoft Exc ...
- JavaScript读写.txt文档 - 方法篇
JavaScript读写.txt文档:分析与方法 详情参考完整教程: Javascript本地写入txt和读取txt文件示例 案例篇:求HTML或者JS读取TXT文件内容的代码 以上就是关于 &quo ...
最新文章
- 在Yolov5 Yolov4 Yolov3 TensorRT 实现Implementation
- 数据中心网络架构 — 传统数据中心网络 — 胖树型三层网络架构
- php 定义数组使用逗号,
- “chaos”的算法--之Floyd算法详解(求最短路径)
- Android开发之Android studio代码版本回退教程
- bootstrap表单拖拽生成器插件_web前端常用插件、工具类库汇总，新手必收藏！！！...
- Bootstrap基础二 网格系统
- Xshell6 Xftp6 破解
- Excel冻结窗格纪要
- 轻量易用的网站bug与性能监控平台——灵雀应用监控平台
- 详细讲解电脑怎么录屏 电脑录制视频的方法
- EMV L2 - 应用选择
- 马王堆汉墓帛书‧老子乙本——德经
- idea设置svn上传或下拉代码
- 当你凝视深渊时，深渊也在凝视着你。
- 若A、B为同阶矩阵且A、B均可逆，则AB亦可逆
- AB Testing
- 我的世界mod开发（5）做一把无敌的剑
- C语言编译全过程【转】
- Fortran教程1：安装和编译
热门文章
- Exchange管理界面
- 微博中的长链接与短链接
- 在更新.net 4.5补丁后，VS2012突然不能打开项目，卸载补丁之后解决。
- CSS 布局 - 水平 amp;amp; 垂直对齐,全面的水平垂直居中方案
- background的认识（一）
- 已有一个名为“frmadd”的组件。组件的名称必须是唯一的,而且名称必须不区分大小
- Spring - 理解BeanPostProcessor
- 腾讯滑块验证码识别和加速度模拟(1)
- matlab脉冲补偿,基于LabVIEW和Matlab的纳秒脉冲测量信号补偿研究
- 如何做爬虫python在线观看_Python爬虫实战：利用scrapy，短短50行代码下载整站短视频...