SpringBoot整合EHcache学习笔记

Posted 躲猫猫的猫

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了SpringBoot整合EHcache学习笔记相关的知识,希望对你有一定的参考价值。

为了提高系统的运行效率,引入缓存机制,减少数据库访问和磁盘IO。下面说明一下ehcache和SpringBoot整合配置

前言介绍

  EhCache 是一个纯Java的进程内缓存框架,具有快速、精干等特点,是Hibernate中默认的CacheProvider。

  ehcache提供了多种缓存策略,主要分为内存和磁盘两级,所以无需担心容量问题。

  spring-boot是一个快速的集成框架,其设计目的是用来简化新Spring应用的初始搭建以及开发过程。该框架使用了特定的方式来进行配置,从而使开发人员不再需要定义样板化的配置。

  由于spring-boot无需任何样板化的配置文件,所以spring-boot集成一些其他框架时会有略微的不同。

1.spring-boot是一个通过maven管理的jar包的框架,集成ehcache需要的依赖如下

<dependency>
    <groupId>org.springframework</groupId>
     <artifactId>spring-context-support</artifactId>
</dependency>
<dependency>
         <groupId>net.sf.ehcache</groupId>
      <artifactId>ehcache</artifactId>
</dependency> 

2.使用ehcache,我们需要一个ehcache.xml来定义一些cache的属性。

<?xml version="1.0" encoding="UTF-8"?>
<ehcache>
    <!-- 指定一个文件目录,当EhCache把数据写到硬盘上时,将把数据写到这个文件目录下 -->
    <diskStore path="java.io.tmpdir"/>

    <!-- 设定缓存的默认数据过期策略 -->
    <defaultCache
            maxElementsInMemory="10000" 
            eternal="false" 
            overflowToDisk="true"
            timeToIdleSeconds="10"
            timeToLiveSeconds="20"
            diskPersistent="false"
            diskExpiryThreadIntervalSeconds="120"/>

    <cache name="cacheTest"
        maxElementsInMemory="1000"
        eternal="false"
        overflowToDisk="true"
        timeToIdleSeconds="10"
        timeToLiveSeconds="20"/>

</ehcache>

关键参数说明

  (1).diskStore: 为缓存路径,ehcache分为内存和磁盘两级,此属性定义磁盘的缓存位置。参数解释如下:    
             user.home – 用户主目录
             user.dir  – 用户当前工作目录
             java.io.tmpdir – 默认临时文件路径

  (2).defaultCache:默认缓存策略,当ehcache找不到定义的缓存时,则使用这个缓存策略。只能定义一个。

       (3).cache:自定缓存策略,为自定义的缓存策略。参数解释如下:

    cache元素的属性:   
            name:缓存名称                  
            maxElementsInMemory:内存中最大缓存对象数                  
            maxElementsOnDisk:硬盘中最大缓存对象数,若是0表示无穷大                  
            eternal:true表示对象永不过期,此时会忽略timeToIdleSeconds和timeToLiveSeconds属性,默认为false                
            overflowToDisk:true表示当内存缓存的对象数目达到了maxElementsInMemory界限后,会把溢出的对象写到硬盘缓存中。注意:如果缓存的对象要写入到硬盘中的话,则该对象必须实现了Serializable接口才行。                  
            diskSpoolBufferSizeMB:磁盘缓存区大小,默认为30MB。每个Cache都应该有自己的一个缓存区。               
            diskPersistent:是否缓存虚拟机重启期数据                  
            diskExpiryThreadIntervalSeconds:磁盘失效线程运行时间间隔,默认为120秒     
            timeToIdleSeconds: 设定允许对象处于空闲状态的最长时间,以秒为单位。当对象自从最近一次被访问后,如果处于空闲状态的时间超过了timeToIdleSeconds属性值,这个对象就会过期,EHCache将把它从缓存中清空。只有当eternal属性为false,该属性才                                            有效。如果该属性值为0,则表示对象可以无限期地处于空闲状态                  
            timeToLiveSeconds:设定对象允许存在于缓存中的最长时间,以秒为单位。当对象自从被存放到缓存中后,如果处于缓存中的时间超过了 timeToLiveSeconds属性值,这个对象就会过期,EHCache将把它从缓存中清除。只有当eternal属性为false,该属性才有                                          效。如果该属性值为0,则表示对象可以无限期地存在于缓存中。timeToLiveSeconds必须大于timeToIdleSeconds属性,才有意义     
            memoryStoreEvictionPolicy:当达到maxElementsInMemory限制时,Ehcache将会根据指定的策略去清理内存。可选策略有:LRU(最近最少使用,默认策略)、FIFO(先进先出)、LFU(最少访问次数)。  

3.将ehcache的管理器暴露给spring的上下文容器

package com.ww.ehcache;

import org.springframework.cache.ehcache.EhCacheCacheManager;
import org.springframework.cache.ehcache.EhCacheManagerFactoryBean;
import org.springframework.context.annotation.Bean;
import org.springframework.core.io.ClassPathResource;

public class CacheConf {

    /*
     * ehcache 主要的管理器
     */
    @Bean(name = "appEhCacheCacheManager")
    public EhCacheCacheManager ehCacheCacheManager(EhCacheManagerFactoryBean bean){
        return new EhCacheCacheManager (bean.getObject ());
    }
    
    /*
     * 据shared与否的设置,Spring分别通过CacheManager.create()或new CacheManager()方式来创建一个ehcache基地.
     */
    @Bean
    public EhCacheManagerFactoryBean ehCacheManagerFactoryBean(){
        EhCacheManagerFactoryBean cacheManagerFactoryBean = new EhCacheManagerFactoryBean ();
        cacheManagerFactoryBean.setConfigLocation (new ClassPathResource ("ehcache-setting.xml"));
        cacheManagerFactoryBean.setShared (true);
        return cacheManagerFactoryBean;
    }
    
}

解释一下注解

    @Configuration:为spring-boot注解,主要标注此为配置类,优先扫描。

      @Bean:向spring容器中加入bean。

至此所有的配置都做好了,通过spring-boot进行集成框架就是这么简单。

4.使用ehcache

    使用ehcache主要通过spring的缓存机制,上面我们将spring的缓存机制使用了ehcache进行实现,所以使用方面就完全使用spring缓存机制就行了。
    具体牵扯到几个注解:

    @Cacheable:负责将方法的返回值加入到缓存中,参数3
    @CacheEvict:负责清除缓存,参数4

     参数解释:

    value:缓存位置名称,不能为空,如果使用EHCache,就是ehcache.xml中声明的cache的name
    key:缓存的key,默认为空,既表示使用方法的参数类型及参数值作为key,支持SpEL
    condition:触发条件,只有满足条件的情况才会加入缓存,默认为空,既表示全部都加入缓存,支持SpEL

    allEntries:CacheEvict参数,true表示清除value中的全部缓存,默认为false

接口类

package com.ww.service;

public interface Cache {
    public String getTimestamp(String param);
}

实现类

package com.ww.service;

import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;

//记得加注解 @Service
public class Wehcache implements Cache{ @Cacheable(value="cacheTest",key="#param") @Override public String getTimestamp(String param) { Long timestamp = System.currentTimeMillis(); return timestamp.toString(); } @CacheEvict(value="cacheTest") public boolean delUserRole(String param) { //清理缓存操作 return false; } }

Controller层调用

package com.ww.controller;

import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.ui.ModelMap;
import org.springframework.web.bind.annotation.RequestMapping;

import com.ww.service.Cache;

@Controller 
public class WebController {
    
    @Autowired  
    private Cache wehcache;
    
    @RequestMapping("/index") 
    public String index(ModelMap map) throws InterruptedException{  
        
        System.out.println("第一次调用:" + wehcache.getTimestamp("param"));
        Thread.sleep(2000);
        System.out.println("2秒之后调用:" + wehcache.getTimestamp("param"));
        Thread.sleep(5000);
        System.out.println("再过5秒之后调用:" + wehcache.getTimestamp("param"));
        
        return "index";  
    } 
    
}

 




















以上是关于SpringBoot整合EHcache学习笔记的主要内容,如果未能解决你的问题,请参考以下文章

SpringBoot整合Ehcache3

Shiro整合Springboot缓存之EhCache实现

Springboot整合ehcache缓存

SpringBoot2 整合Ehcache组件,轻量级缓存管理

Spring Boot整合EhCache

SpringBootsad整合EhCache做缓存处理