springboot2.3.4集成EhCache缓存框架完整代码

谁借莪１个温暖的怀抱￠ 2022-09-14 01:55 168阅读 0赞

# 代码部分 #

## pom ##

<?xml version="1.0" encoding="UTF-8"?>
    <project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
        <modelVersion>4.0.0</modelVersion>
    
        <groupId>com.zxl.ehcache</groupId>
        <artifactId>springboot-ehcache-demo</artifactId>
        <version>1.0-SNAPSHOT</version>
    
        <parent>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-parent</artifactId>
            <version>2.3.4.RELEASE</version>
            <relativePath/> 
        </parent>
    
        <properties>
            <maven.compiler.source>8</maven.compiler.source>
            <maven.compiler.target>8</maven.compiler.target>
            <project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
            <java.version>1.8</java.version>
        </properties>
    
        <dependencies>
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-web</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.projectlombok</groupId>
                <artifactId>lombok</artifactId>
                <version>1.18.10</version>
                <scope>provided</scope>
            </dependency>
    
            
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-cache</artifactId>
            </dependency>
            
            <dependency>
                <groupId>net.sf.ehcache</groupId>
                <artifactId>ehcache</artifactId>
            </dependency>
    
            <dependency>
                <groupId>org.springframework.boot</groupId>
                <artifactId>spring-boot-starter-test</artifactId>
                <scope>test</scope>
                <exclusions>
                    <exclusion>
                        <groupId>org.junit.vintage</groupId>
                        <artifactId>junit-vintage-engine</artifactId>
                    </exclusion>
                </exclusions>
            </dependency>
        </dependencies>
    
        <build>
            <plugins>
                <plugin>
                    <groupId>org.springframework.boot</groupId>
                    <artifactId>spring-boot-maven-plugin</artifactId>
                    <version>2.5.5</version>
                </plugin>
            </plugins>
        </build>
    
    </project>

## 启动类 ##

package com.zxl.ehcache;
    
    import org.springframework.boot.SpringApplication;
    import org.springframework.boot.autoconfigure.SpringBootApplication;
    import org.springframework.cache.annotation.EnableCaching;
    
    /* * 在启动类前加上@EnableCaching注解；这样的话，启动类启动时会去启动缓存启动器 * */
    @SpringBootApplication
    @EnableCaching
    public class CacheApplication { 
    
        public static void main(String[] args) { 
            SpringApplication.run(CacheApplication.class, args);
        }
    
    }

## controller ##

package com.zxl.ehcache.controller;
    
    import com.zxl.ehcache.model.ProductInfo;
    import com.zxl.ehcache.service.CacheService;
    import org.springframework.beans.factory.annotation.Autowired;
    import org.springframework.web.bind.annotation.*;
    
    /** * 缓存Controller * * @author zxl */
    @RestController
    public class CacheController { 
    
        @Autowired
        private CacheService cacheService;
    
        @PostMapping("/testPutCache")
        public String testPutCache(@RequestBody ProductInfo productInfo) { 
            cacheService.saveLocalCache(productInfo);
            return "success";
        }
    
        @GetMapping("/testGetCache")
        public ProductInfo testGetCache(Long id) { 
            return cacheService.getLocalCache(id);
        }
    
    }

## model ##

package com.zxl.ehcache.model;
    
    import lombok.AllArgsConstructor;
    import lombok.Data;
    import lombok.NoArgsConstructor;
    
    import java.io.Serializable;
    
    /** * 实体类实现可序列化接口Serializable；由于需要实体类支持缓存中的磁盘存储，所以需要实体类实现可序列化接口 * * @author zxl */
    @Data
    @NoArgsConstructor
    @AllArgsConstructor
    public class ProductInfo implements Serializable { 
    
        private Long id;
        private String name;
        private Double price;
    }

## service ##

package com.zxl.ehcache.service;
    
    import com.zxl.ehcache.model.ProductInfo ;
    
    /** * 缓存service接口 * @author zxl * */
    public interface CacheService { 
    
    	/** * 将商品信息保存到本地缓存中 * @param productInfo * @return */
    	ProductInfo saveLocalCache(ProductInfo productInfo);
    
    	/** * 从本地缓存中获取商品信息 * @param id * @return */
    	ProductInfo getLocalCache(Long id);
    
    }

impl:

package com.zxl.ehcache.service.impl;
    
    import com.zxl.ehcache.model.ProductInfo;
    import com.zxl.ehcache.service.CacheService;
    import org.springframework.cache.annotation.CacheEvict;
    import org.springframework.cache.annotation.CachePut;
    import org.springframework.cache.annotation.Cacheable;
    import org.springframework.stereotype.Service;
    
    /** * 缓存Service实现类 * 使用@CachePut存数据到缓存 * 使用@Cacheable读取缓存 * @author zxl */
    @Service
    public class CacheServiceImpl implements CacheService { 
    
        public static final String CACHE_NAME = "local";
    
        /** * 将商品信息保存到本地缓存中 * * @param productInfo * @return */
        @CachePut(value = CACHE_NAME, key = "'key_'+#productInfo.getId()")
        public ProductInfo saveLocalCache(ProductInfo productInfo) { 
            return productInfo;
        }
    
        /** * 从本地缓存中获取商品信息 * * @param id * @return */
        @Cacheable(value = CACHE_NAME, key = "'key_'+#id")
        public ProductInfo getLocalCache(Long id) { 
            return null;
        }
    
        // 使用@CacheEvict清除缓存
        /*@CacheEvict(value="users",allEntries=true) public void saveUsers(Users users) { this.usersRepository.save(users); }*/
        // @CacheEvict是用来标注在需要清除缓存元素的方法或类上的。当标记在一个类上时表示其中所有的方法的执行都会触发缓存的清除操作。@CacheEvict可以指定的属性有value、key、condition、allEntries和beforeInvocation。
        // 其中value、key和condition的语义与@Cacheable对应的属性类似；allEntries是boolean类型，表示是否需要清除缓存中的所有元素。默认为false，表示不需要。
        // 当指定了allEntries为true时，Spring Cache将忽略指定的key。有的时候我们需要Cache一下清除所有的元素，这比一个一个清除元素更有效率
        // 使用@CachePut标注的方法在执行前不会去检查缓存中是否存在之前执行过的结果，而是每次都会执行该方法，并将执行结果以键值对的形式存入指定的缓存中。
        // @Cacheable:类或者方法上,类代表所有的方法都使用它,方法上针对特定的方法，作用就是先查询缓存是否有值,有的话就直接返回缓存结果
    
    
    }

# 配置文件 #

## application.yml ##

server:
      port: 8080
    
    spring:
      cache:
        type: ehcache
        ehcache:
          config: classpath:ehcache.xml

## ehcache.xml ##

<?xml version="1.0" encoding="UTF-8"?>
    <ehcache xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:noNamespaceSchemaLocation="http://ehcache.org/ehcache.xsd" updateCheck="false">
    
        
        
        <diskStore path="java.io.tmpdir/Tmp_EhCache" />
    
        
        
        
        
        
        
        
        
        
        <defaultCache eternal="false" maxElementsInMemory="1000" overflowToDisk="false" diskPersistent="false" timeToIdleSeconds="300" timeToLiveSeconds="0" memoryStoreEvictionPolicy="LRU" />
    
        
        
        
        <cache name="local" eternal="false" maxElementsInMemory="1000" overflowToDisk="false" diskPersistent="false" timeToIdleSeconds="300" timeToLiveSeconds="0" memoryStoreEvictionPolicy="LRU" />
    
        
        
    
    </ehcache>

# 测试 #

> @Cacheable(value = CACHE\_NAME, key = “‘key\_’+\#id”)  
> public ProductInfo getLocalCache(Long id) \{  
> return null;  
> \}  
> 可以看到返回的是null，但是依然可以查询到数据，就说明是从缓存中获取到的

[zxl@zxl-pc:~]$ curl -H "Content-Type:application/json" -X POST -d '{"id":123,"name":"zhangsan","price":100}' "http://localhost:8080/testPutCache"
    success
    [zxl@zxl-pc:~]curl "localhost:8080/testGetCache?id=123"
    { "id":123,"name":"zhangsan","price":100.0}