1 Star 9 Fork 7

开源小组 / ehcache-spring-boot

加入 Gitee
与超过 1200万 开发者一起发现、参与优秀开源项目,私有仓库也完全免费 :)
免费加入
克隆/下载
贡献代码
同步代码
取消
提示: 由于 Git 不支持空文件夾,创建文件夹后会生成空的 .keep 文件
Loading...
README
Apache-2.0

ehcache-spring-boot

springboot ehcache自动配置 starter

在spring官方cache starter基础上,通过简单的yml或properties配置,而无需配置ehcache.xml即可开启ehcache配置

同时支持rmi自动配置(组播)和手工配置(点对点)两种集群配置方式。

使用方法

1. 执行 mvn install 安装至仓库

2. springboot应用引入maven依赖

<dependency>
	<groupId>com.lhy</groupId>
	<artifactId>ehcache-spring-boot-starter</artifactId>
	<version>1.0.0</version>
</dependency>

3. 无集群application.yml文件配置如下

ehcache:
  caches:
    - name: userCache #缓存名称
      eternal: false #是否永不过期 默认false 如果为false那么还要根据timeToIdleSeconds,timeToLiveSeconds判断。
      max-elements-in-memory: 100 #cache 中最多可以存放的元素的数量 默认值100
      time-to-idle-seconds: 0 #对象空闲时间,指对象在多长时间没有被访问就会失效。只对eternal为false的有效。默认值0,表示一直可以访问。以秒为单位。
      time-to-live-seconds: 0 #对象存活时间,指对象从创建到失效所需要的时间。只对eternal为false的有效。默认值0,表示一直可以访问。以秒为单位。
      overflow-to-disk: true #如果内存中数据超过内存限制,是否要缓存到磁盘上。默认false
      disk-persistent: false #否在磁盘上持久化。指重启jvm后,数据是否有效。默认为false。
      max-elements-on-disk: 100 #在磁盘上缓存的element的最大数目,默认值为0,表示不限制。
      disk-spool-buffer-size-mB: 30 #DiskStore使用的磁盘大小,默认值30MB。每个cache使用各自的DiskStore。
      disk-expiry-thread-interval-seconds: 120 #对象检测线程运行时间间隔。标识对象状态的线程多长时间运行一次。以秒为单位。默认120 秒
    - name: roleCache #缓存名称
      eternal: false #是否永不过期 默认false 如果为false那么还要根据timeToIdleSeconds,timeToLiveSeconds判断。
      max-elements-in-memory: 100 #cache 中最多可以存放的元素的数量 默认值100
      time-to-idle-seconds: 0 #对象空闲时间,指对象在多长时间没有被访问就会失效。只对eternal为false的有效。默认值0,表示一直可以访问。以秒为单位。
      time-to-live-seconds: 0 #对象存活时间,指对象从创建到失效所需要的时间。只对eternal为false的有效。默认值0,表示一直可以访问。以秒为单位。
      overflow-to-disk: true #如果内存中数据超过内存限制,是否要缓存到磁盘上。默认false
      disk-persistent: false #否在磁盘上持久化。指重启jvm后,数据是否有效。默认为false。
      max-elements-on-disk: 100 #在磁盘上缓存的element的最大数目,默认值为0,表示不限制。
      disk-spool-buffer-size-mB: 30 #DiskStore使用的磁盘大小,默认值30MB。每个cache使用各自的DiskStore。
      disk-expiry-thread-interval-seconds: 120 #对象检测线程运行时间间隔。标识对象状态的线程多长时间运行一次。以秒为单位。默认120 秒  

4. 自动配置方式application.yml文件配置如下(组播)

ehcache:
  caches:
    - name: userCache 
      eternal: false
      max-elements-in-memory: 1000
      time-to-idle-seconds: 1800
      time-to-live-seconds: 1800
      overflow-to-disk: true
      disk-persistent: false
      max-elements-on-disk: 100
      disk-spool-buffer-size-mB: 30
      disk-expiry-thread-interval-seconds: 1
      
  cluster-enabled: true #是否启用集群
  cluster: 
    provider:
      peer-discovery: automatic
      automatic:
        multicast-group-address:  224.1.1.1 #组播缓存提供者广播组地址 默认:224.1.1.1
        multicast-group-port: 41000 #组播缓存提供者广播组端口 默认:41000
        #time-to-live: 32 #存活时间 默认32
    listener:
      #host-name: 127.0.0.1  #缓存监听者端口地址 默认:127.0.0.1
      #port: 40002 #缓存监听者默认端口 默认:127.0.0.1 仅当random-port-enabled为false是生效
      #random-port-enabled: true #开启随机监听端口
      #max-random-port: 43000 #随机端口范围上限 默认 40999
      #min-random-port: 42000 #随机端口范围下限 默认 40000
      #socket-timeout-millis: 2000 #监听socket连接超时时间 默认2000毫秒
 

5. 手工配置application.yml文件配置如下(点对点)

ehcache:
  caches:
    - name: userCache
      eternal: false
      max-elements-in-memory: 1000
      time-to-idle-seconds: 1800
      time-to-live-seconds: 1800
      overflow-to-disk: true
      disk-persistent: false
      max-elements-on-disk: 100
      disk-spool-buffer-size-mB: 30
      disk-expiry-thread-interval-seconds: 1
  cluster-enabled: true
  cluster:
    provider:
      peer-discovery: manual 
      manual:
        rmi-urls: 127.0.0.1:40002|127.0.0.0:40001  #缓存提供者需要通知的rmi地址 多个 | 分隔
    listener:
      #host-name: 127.0.0.1  #缓存监听者端口地址 默认:127.0.0.1 
      port: 40001 
      #socket-timeout-millis: 2000 #监听socket连接超时时间 默认2000毫秒

6.自定义ehcache CacheConfiguration合并规则

如果不满足yml或properties属性配置,可以添加ehcache.xml文件,自动配置将合并ehcache.xml上配置的属性到application.xml,默认的规则是无则新增,有则覆盖。 如果默认规则不满足要求,可以自定义配置合并类:

@Bean
public EhCacheConfigurationMarger ehCacheConfigurationMarger() {
	return new CustomEhCacheConfigurationMarger(ehCacheProperties);//CustomEhCacheConfigurationMarger为自定义配置合并类,需要实现EhCacheConfigurationMarger 接口
}

7.进行测试 以手工方式为例

启动两个springboot应用ehcache-app1(端口8080),ehcache-app2(端口8081)需要提前加入上述缓存相关配置

通过spirngmvc restful接口测试缓存

核心代码如下:
  package com.lhy.boot;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;

import net.sf.ehcache.Cache;
import net.sf.ehcache.CacheManager;
import net.sf.ehcache.Element;

@SpringBootApplication
@RestController
@EnableCaching
public class Application{

    public static void main(String[] args) {
        SpringApplication.run(Application.class, args);
    }
    
    @Autowired
    CacheManager cacheManager;
    
    @RequestMapping("add/{name}")
    public String add(@PathVariable String name){
    	Cache cache = cacheManager.getCache("user");
    	cache.put(new Element("name", name));
    	return "success add:"+name;
    }
    
    @RequestMapping("get")
    public String get(){
    	Cache cache = cacheManager.getCache("user");
    	Element element = cache.get("name");
    	if (element == null) {
    	return "no cache: name";
	}
    	return (String)element.getObjectValue();
    }
}
访问http://127.0.0.1:8080/add/1 节点1 添加一个缓存:

输入图片说明

访问http://127.0.0.1:8081/get 节点2 查看添加的缓存 :

输入图片说明

可见缓存同步完成!

8. demo

https://gitee.com/luanhaoyu/ehcache-app1-test automatic-application.yml为自动发现方式

说明

自动发现配置更为简单 但要注意

在多网卡的主机,或同一网卡多IP的主机上,尽管地址可能是一个网段内的,但其实地址间已经存在跳数了(hop),其实就是从一个地址向另一个地址跳. 这时广播/组播就容易被阻断. 谨慎使用

其他集群配置方式参考:https://www.cnblogs.com/duwanjiang/p/6230113.html

Apache License Version 2.0, January 2004 http://www.apache.org/licenses/ TERMS AND CONDITIONS FOR USE, REPRODUCTION, AND DISTRIBUTION 1. Definitions. "License" shall mean the terms and conditions for use, reproduction, and distribution as defined by Sections 1 through 9 of this document. "Licensor" shall mean the copyright owner or entity authorized by the copyright owner that is granting the License. "Legal Entity" shall mean the union of the acting entity and all other entities that control, are controlled by, or are under common control with that entity. For the purposes of this definition, "control" means (i) the power, direct or indirect, to cause the direction or management of such entity, whether by contract or otherwise, or (ii) ownership of fifty percent (50%) or more of the outstanding shares, or (iii) beneficial ownership of such entity. "You" (or "Your") shall mean an individual or Legal Entity exercising permissions granted by this License. "Source" form shall mean the preferred form for making modifications, including but not limited to software source code, documentation source, and configuration files. "Object" form shall mean any form resulting from mechanical transformation or translation of a Source form, including but not limited to compiled object code, generated documentation, and conversions to other media types. "Work" shall mean the work of authorship, whether in Source or Object form, made available under the License, as indicated by a copyright notice that is included in or attached to the work (an example is provided in the Appendix below). "Derivative Works" shall mean any work, whether in Source or Object form, that is based on (or derived from) the Work and for which the editorial revisions, annotations, elaborations, or other modifications represent, as a whole, an original work of authorship. For the purposes of this License, Derivative Works shall not include works that remain separable from, or merely link (or bind by name) to the interfaces of, the Work and Derivative Works thereof. "Contribution" shall mean any work of authorship, including the original version of the Work and any modifications or additions to that Work or Derivative Works thereof, that is intentionally submitted to Licensor for inclusion in the Work by the copyright owner or by an individual or Legal Entity authorized to submit on behalf of the copyright owner. For the purposes of this definition, "submitted" means any form of electronic, verbal, or written communication sent to the Licensor or its representatives, including but not limited to communication on electronic mailing lists, source code control systems, and issue tracking systems that are managed by, or on behalf of, the Licensor for the purpose of discussing and improving the Work, but excluding communication that is conspicuously marked or otherwise designated in writing by the copyright owner as "Not a Contribution." "Contributor" shall mean Licensor and any individual or Legal Entity on behalf of whom a Contribution has been received by Licensor and subsequently incorporated within the Work. 2. Grant of Copyright License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable copyright license to reproduce, prepare Derivative Works of, publicly display, publicly perform, sublicense, and distribute the Work and such Derivative Works in Source or Object form. 3. Grant of Patent License. Subject to the terms and conditions of this License, each Contributor hereby grants to You a perpetual, worldwide, non-exclusive, no-charge, royalty-free, irrevocable (except as stated in this section) patent license to make, have made, use, offer to sell, sell, import, and otherwise transfer the Work, where such license applies only to those patent claims licensable by such Contributor that are necessarily infringed by their Contribution(s) alone or by combination of their Contribution(s) with the Work to which such Contribution(s) was submitted. If You institute patent litigation against any entity (including a cross-claim or counterclaim in a lawsuit) alleging that the Work or a Contribution incorporated within the Work constitutes direct or contributory patent infringement, then any patent licenses granted to You under this License for that Work shall terminate as of the date such litigation is filed. 4. Redistribution. You may reproduce and distribute copies of the Work or Derivative Works thereof in any medium, with or without modifications, and in Source or Object form, provided that You meet the following conditions: You must give any other recipients of the Work or Derivative Works a copy of this License; and You must cause any modified files to carry prominent notices stating that You changed the files; and You must retain, in the Source form of any Derivative Works that You distribute, all copyright, patent, trademark, and attribution notices from the Source form of the Work, excluding those notices that do not pertain to any part of the Derivative Works; and If the Work includes a "NOTICE" text file as part of its distribution, then any Derivative Works that You distribute must include a readable copy of the attribution notices contained within such NOTICE file, excluding those notices that do not pertain to any part of the Derivative Works, in at least one of the following places: within a NOTICE text file distributed as part of the Derivative Works; within the Source form or documentation, if provided along with the Derivative Works; or, within a display generated by the Derivative Works, if and wherever such third-party notices normally appear. The contents of the NOTICE file are for informational purposes only and do not modify the License. You may add Your own attribution notices within Derivative Works that You distribute, alongside or as an addendum to the NOTICE text from the Work, provided that such additional attribution notices cannot be construed as modifying the License. You may add Your own copyright statement to Your modifications and may provide additional or different license terms and conditions for use, reproduction, or distribution of Your modifications, or for any such Derivative Works as a whole, provided Your use, reproduction, and distribution of the Work otherwise complies with the conditions stated in this License. 5. Submission of Contributions. Unless You explicitly state otherwise, any Contribution intentionally submitted for inclusion in the Work by You to the Licensor shall be under the terms and conditions of this License, without any additional terms or conditions. Notwithstanding the above, nothing herein shall supersede or modify the terms of any separate license agreement you may have executed with Licensor regarding such Contributions. 6. Trademarks. This License does not grant permission to use the trade names, trademarks, service marks, or product names of the Licensor, except as required for reasonable and customary use in describing the origin of the Work and reproducing the content of the NOTICE file. 7. Disclaimer of Warranty. Unless required by applicable law or agreed to in writing, Licensor provides the Work (and each Contributor provides its Contributions) on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied, including, without limitation, any warranties or conditions of TITLE, NON-INFRINGEMENT, MERCHANTABILITY, or FITNESS FOR A PARTICULAR PURPOSE. You are solely responsible for determining the appropriateness of using or redistributing the Work and assume any risks associated with Your exercise of permissions under this License. 8. Limitation of Liability. In no event and under no legal theory, whether in tort (including negligence), contract, or otherwise, unless required by applicable law (such as deliberate and grossly negligent acts) or agreed to in writing, shall any Contributor be liable to You for damages, including any direct, indirect, special, incidental, or consequential damages of any character arising as a result of this License or out of the use or inability to use the Work (including but not limited to damages for loss of goodwill, work stoppage, computer failure or malfunction, or any and all other commercial damages or losses), even if such Contributor has been advised of the possibility of such damages. 9. Accepting Warranty or Additional Liability. While redistributing the Work or Derivative Works thereof, You may choose to offer, and charge a fee for, acceptance of support, warranty, indemnity, or other liability obligations and/or rights consistent with this License. However, in accepting such obligations, You may act only on Your own behalf and on Your sole responsibility, not on behalf of any other Contributor, and only if You agree to indemnify, defend, and hold each Contributor harmless for any liability incurred by, or claims asserted against, such Contributor by reason of your accepting any such warranty or additional liability. END OF TERMS AND CONDITIONS APPENDIX: How to apply the Apache License to your work To apply the Apache License to your work, attach the following boilerplate notice, with the fields enclosed by brackets "{}" replaced with your own identifying information. (Don't include the brackets!) The text should be enclosed in the appropriate comment syntax for the file format. We also recommend that a file or class name and description of purpose be included on the same "printed page" as the copyright notice for easier identification within third-party archives. Copyright 2018 尼罗河的赠礼 Licensed under the Apache License, Version 2.0 (the "License"); you may not use this file except in compliance with the License. You may obtain a copy of the License at http://www.apache.org/licenses/LICENSE-2.0 Unless required by applicable law or agreed to in writing, software distributed under the License is distributed on an "AS IS" BASIS, WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied. See the License for the specific language governing permissions and limitations under the License.

简介

springboot starter集成ehcache 展开 收起
Java
Apache-2.0
取消

发行版

暂无发行版

贡献者

全部

近期动态

加载更多
不能加载更多了
Java
1
https://gitee.com/luanhaoyu/ehcache-spring-boot.git
git@gitee.com:luanhaoyu/ehcache-spring-boot.git
luanhaoyu
ehcache-spring-boot
ehcache-spring-boot
master

搜索帮助

53164aa7 5694891 3bd8fe86 5694891