查看: 1777|回复: 0

[Java代码] spring-boot整合ehcache实现缓存机制的方法

发表于 2018-2-25 08:00:00

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

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

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

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

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

  1. <dependency>
  2. <groupId>org.springframework</groupId>
  3. <artifactId>spring-context-support</artifactId>
  4. </dependency>
  5. <dependency>
  6. <groupId>net.sf.ehcache</groupId>
  7. <artifactId>ehcache</artifactId>
  8. <version>2.8.3</version>
  9. </dependency>
复制代码

    具体pom.xml文件如下

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
  3. xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
  4. <modelVersion>4.0.0</modelVersion>
  5. <groupId>com.lclc.boot</groupId>
  6. <artifactId>boot-cache</artifactId>
  7. <version>0.0.1-SNAPSHOT</version>
  8. <!-- Inherit defaults from Spring Boot -->
  9. <parent>
  10. <groupId>org.springframework.boot</groupId>
  11. <artifactId>spring-boot-starter-parent</artifactId>
  12. <version>1.1.3.RELEASE</version>
  13. </parent>
  14. <dependencies>
  15. <dependency>
  16. <groupId>org.springframework.boot</groupId>
  17. <artifactId>spring-boot-starter-web</artifactId>
  18. </dependency>
  19. <dependency>
  20. <groupId>org.springframework.boot</groupId>
  21. <artifactId>spring-boot-starter-data-jpa</artifactId>
  22. </dependency>
  23. <dependency>
  24. <groupId>org.springframework.boot</groupId>
  25. <artifactId>spring-boot-starter-thymeleaf</artifactId>
  26. </dependency>
  27. <dependency>
  28. <groupId>mysql</groupId>
  29. <artifactId>mysql-connector-java</artifactId>
  30. </dependency>
  31. <dependency>
  32. <groupId>com.google.guava</groupId>
  33. <artifactId>guava</artifactId>
  34. <version>17.0</version>
  35. </dependency>
  36. <dependency>
  37. <groupId>org.springframework</groupId>
  38. <artifactId>spring-context-support</artifactId>
  39. </dependency>
  40. <dependency>
  41. <groupId>net.sf.ehcache</groupId>
  42. <artifactId>ehcache</artifactId>
  43. <version>2.8.3</version>
  44. </dependency>
  45. </dependencies>
  46. <dependencyManagement>
  47. <dependencies>
  48. </dependencies>
  49. </dependencyManagement>
  50. <build>
  51. <plugins>
  52. <plugin>
  53. <groupId>org.springframework.boot</groupId>
  54. <artifactId>spring-boot-maven-plugin</artifactId>
  55. </plugin>
  56. </plugins>
  57. </build>
  58. <repositories>
  59. <repository>
  60. <id>spring-snapshots</id>
  61. <url>http://repo.spring.io/snapshot</url>
  62. <snapshots>
  63. <enabled>true</enabled>
  64. </snapshots>
  65. </repository>
  66. <repository>
  67. <id>spring-milestones</id>
  68. <url>http://repo.spring.io/milestone</url>
  69. </repository>
  70. </repositories>
  71. <pluginRepositories>
  72. <pluginRepository>
  73. <id>spring-snapshots</id>
  74. <url>http://repo.spring.io/snapshot</url>
  75. </pluginRepository>
  76. <pluginRepository>
  77. <id>spring-milestones</id>
  78. <url>http://repo.spring.io/milestone</url>
  79. </pluginRepository>
  80. </pluginRepositories>
  81. </project>
复制代码

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

  1. <?xml version="1.0" encoding="UTF-8"?>
  2. <ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd"
  3. updateCheck="false">
  4. <diskStore path="java.io.tmpdir/Tmp_EhCache" />
  5. <defaultCache eternal="false" maxElementsInMemory="1000" overflowToDisk="false" diskPersistent="false"
  6. timeToIdleSeconds="0" timeToLiveSeconds="600" memoryStoreEvictionPolicy="LRU" />
  7. <cache name="demo" eternal="false" maxElementsInMemory="100" overflowToDisk="false" diskPersistent="false"
  8. timeToIdleSeconds="0" timeToLiveSeconds="300" memoryStoreEvictionPolicy="LRU" />
  9. </ehcache>
复制代码

  解释下这个xml文件中的标签。

  (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的上下文容器,

  1. @Configuration
  2. // 标注启动了缓存
  3. @EnableCaching
  4. public class CacheConfiguration {
  5. /*
  6. * ehcache 主要的管理器
  7. */
  8. @Bean(name = "appEhCacheCacheManager")
  9. public EhCacheCacheManager ehCacheCacheManager(EhCacheManagerFactoryBean bean){
  10. return new EhCacheCacheManager (bean.getObject ());
  11. }
  12. /*
  13. * 据shared与否的设置,Spring分别通过CacheManager.create()或new CacheManager()方式来创建一个ehcache基地.
  14. */
  15. @Bean
  16. public EhCacheManagerFactoryBean ehCacheManagerFactoryBean(){
  17. EhCacheManagerFactoryBean cacheManagerFactoryBean = new EhCacheManagerFactoryBean ();
  18. cacheManagerFactoryBean.setConfigLocation (new ClassPathResource ("conf/ehcache-app.xml"));
  19. cacheManagerFactoryBean.setShared (true);
  20. return cacheManagerFactoryBean;
  21. }
  22. }
复制代码

    @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

  不多说,直接上代码:

  1. @Service
  2. public class CacheDemoServiceImpl implements CacheDemoService {
  3. /**
  4. * 缓存的key
  5. */
  6. public static final String THING_ALL_KEY = "\"thing_all\"";
  7. /**
  8. * value属性表示使用哪个缓存策略,缓存策略在ehcache.xml
  9. */
  10. public static final String DEMO_CACHE_NAME = "demo";
  11. @CacheEvict(value = DEMO_CACHE_NAME,key = THING_ALL_KEY)
  12. @Override
  13. public void create(Thing thing){
  14. Long id = getNextId ();
  15. thing.setId (id);
  16. data.put (id, thing);
  17. }
  18. @Cacheable(value = DEMO_CACHE_NAME,key = "#thing.getId()+'thing'")
  19. @Override
  20. public Thing findById(Long id){
  21. System.err.println ("没有走缓存!" + id);
  22. return data.get (id);
  23. }
  24. @Cacheable(value = DEMO_CACHE_NAME,key = THING_ALL_KEY)
  25. @Override
  26. public List<Thing> findAll(){
  27. return Lists.newArrayList (data.values ());
  28. }
  29. @Override
  30. @CachePut(value = DEMO_CACHE_NAME,key = "#thing.getId()+'thing'")
  31. @CacheEvict(value = DEMO_CACHE_NAME,key = THING_ALL_KEY)
  32. public Thing update(Thing thing){
  33. System.out.println (thing);
  34. data.put (thing.getId (), thing);
  35. return thing;
  36. }
  37. @CacheEvict(value = DEMO_CACHE_NAME)
  38. @Override
  39. public void delete(Long id){
  40. data.remove (id);
  41. }
  42. }
复制代码

    5.只需要通过注解在service层方法上打注解便可以使用缓存,在find**上存入缓存,在delete**,update**上清除缓存。

总结

以上所述是小编给大家介绍的spring-boot整合ehcache实现缓存机制的方法,希望对大家有所帮助,如果大家有任何疑问请给我留言,小编会及时回复大家的。在此也非常感谢大家对程序员之家网站的支持!



回复

使用道具 举报