SpringBoot中使用Cache提升接口性能详解

2023-08-03 微信公众号实战案例锦集

Spring 框架从 3.1 开始，对 Spring 应用程序提供了透明式添加缓存的支持。和事务支持一样，抽象缓存允许一致地使用各种缓存解决方案，并对代码的影响最小。

环境：springboot2.3.12.RELEASE + JSR107 + Ehcache + JPA

Spring 框架从 3.1 开始，对 Spring 应用程序提供了透明式添加缓存的支持。和事务支持一样，抽象缓存允许一致地使用各种缓存解决方案，并对代码的影响最小。从 Spring4.1 版本开始，缓存抽象支持了 JSR-107 注释和更多自定义选项，从而得到了显著的改进。

方式1：直接使用spring的注解来实现缓存

spring提供了如下注解：

@Cacheable 触发缓存机制

@CacheEvict 触发缓存回收

@CachePut 更新缓存，而不会影响方法的执行

@Caching 组合多个缓存操作到一个方法

@CacheConfig 类级别共享系诶常见的缓存相关配置

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-cache</artifactId>
</dependency>

首先在Service对应的方法是添加注解：

@Service
public class StorageService {
  
  @Resource
  private StorageRepository sr ;
  
  @Cacheable(value = {"cache_storage"}, keyGenerator = "storageKey")
  public Storage getStorage(Long id) {
    return sr.findById(id).get() ;
  }
  
}

// 这里的keyGenerator是你自定义Key生成的Bean名称
@Component("storageKey")
public class StorageKeyGenerator implements KeyGenerator {


  private static final String  KEY_PREFIX = "storage_" ;
  
  @Override
  public Object generate(Object target, Method method, Object... params) {
    StringBuilder sb = new StringBuilder() ;
    for (Object param : params) {
      sb.Append(param) ;
    }
    return KEY_PREFIX + sb.toString() ;
  }


}

web接口：

@RestController
@RequestMapping("/storages")
public class StorageController {
  
  @Resource
  private StorageService storageService ;


  @GetMapping("/{id}")
  public Object get(@PathVariable("id") Long id) {
    return storageService.getStorage(id) ;
  }
}

测试：

第一次访问接口，查看控制台输出了sql语句：

图片

再次访问接口，发现控制台没有再输出任何sql，说明我们的缓存生效了（这里你也可以把这里的注解注释了来看效果）。关于这里的更新缓存，删除缓存就不演示了。接下来完整的演示下JSR107规范中的注解演示：

注意在这些注释中我们是可以使用SpEL表达式的：

图片

方式2：使用JSR107和Ehcache

先来看看Spring与JSR107注解的对照表：

图片

pom.xml中加入依赖：

<dependency>
  <groupId>org.springframework.boot</groupId>
  <artifactId>spring-boot-starter-cache</artifactId>
</dependency>
<dependency>
  <groupId>MySQL</groupId>
  <artifactId>mysql-connector-JAVA</artifactId>
</dependency>
<dependency>
  <groupId>org.ehcache</groupId>
  <artifactId>ehcache</artifactId>
</dependency>
<dependency>
  <groupId>javax.cache</groupId>
  <artifactId>cache-api</artifactId>
</dependency>

Service类：

@Service
public class StorageService {
  
  @Resource
  private StorageRepository sr ;
  
  // 这里的 @CacheValue 说明是要缓存的参数值。
  @Transactional
  @CachePut(cacheName = "cache_storage", cacheKeyGenerator = JCacheKeyGenerator.class)
  public Storage save(@CacheValue Storage storage) {
    return sr.saveAndFlush(storage) ;
  }
  @CacheResult(cacheName = "cache_storage", cacheKeyGenerator = JCacheKeyGenerator.class)
  public Storage getStorage(Long id) {
    return sr.findById(id).get() ;
  }
  
  @Transactional
  @CacheRemove(cacheName = "cache_storage", cacheKeyGenerator = JCacheKeyGenerator.class)
  public void removeStorage(Long id) {
    sr.deleteById(id) ;
  }
  
  @Transactional
  @CachePut(cacheName = "cache_storage", cacheKeyGenerator = JCacheKeyGenerator.class)
  public Storage updateStorage(@CacheValue Storage storage) {
    return sr.saveAndFlush(storage) ;
  }
}
// 注意这里的cacheKeyGenerator 必须全部用同一个，
// 跟踪了下源码是用的对应的类名key来查找对应的缓存的；一开始我没有用同一个始终不正确。。
// 看下图跟踪的代码：

图片

这里必须要一样哦cacheKeyGenerator

缓存Key：JCacheKeyGenerator.java

public class JCacheKeyGenerator implements CacheKeyGenerator {


  private static final String  KEY_PREFIX = "storage_" ;
  
  @Override
  public GeneratedCacheKey generateCacheKey(
      CacheKeyInvocationContext<? extends Annotation> cacheKeyInvocationContext) {
    CacheInvocationParameter[] params = cacheKeyInvocationContext.getAllParameters() ;
    StringBuilder sb = new StringBuilder() ;
    for (CacheInvocationParameter param : params) {
      if (param.getValue() instanceof Storage) {
        Storage s = (Storage) param.getValue() ;
        sb.append(s.getId()) ;
      } else {
        sb.append((Long)param.getValue()) ;
      }
    }
    return new StorageGeneratedCacheKey(KEY_PREFIX + sb.toString()) ;
  }
  
  private static class StorageGeneratedCacheKey implements GeneratedCacheKey {
    private static final long serialVersionUID = 1L;
    
    private String key ;
    
    public StorageGeneratedCacheKey(String key) {
      this.key = key ;
    }


    @Override
    public int hashCode() {
      final int prime = 31;
      int result = 1;
      result = prime * result + ((key == null) ? 0 : key.hashCode());
      return result;
    }


    @Override
    public boolean equals(Object obj) {
      if (this == obj)
        return true;
      if (obj == null)
        return false;
      if (getClass() != obj.getClass())
        return false;
      StorageGeneratedCacheKey other = (StorageGeneratedCacheKey) obj;
      if (key == null) {
        if (other.key != null)
          return false;
        } else if (!key.equals(other.key))
          return false;
      return true;
      }
    
    }


}

application.yml配置：

spring:
  cache:
    cacheNames:
    - cache_storage
    ehcache:
      config: classpath:ehcache.xml

ehcache.xml

<?xml versinotallow="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="10000"  overflowToDisk="false" diskPersistent="false" timeToIdleSeconds="1800" timeToLiveSeconds="259200" memoryStoreEvictionPolicy="LRU" />


  <cache name="cache_storage" eternal="false" maxElementsInMemory="5000"  overflowToDisk="false" diskPersistent="false" timeToIdleSeconds="1800" timeToLiveSeconds="1800" memoryStoreEvictionPolicy="LRU" />
 
</ehcache>

测试增删改：

先添加个数据：

图片

成功添加ID为4的信息，Service中的save方法中我们添加了@CachePut注解，接下来我们查询ID为4的信息，看看控制台是否会生成SQL语句。

图片

控制台没有增加任何的SQL语句，说明save方法加的@CachePut生效了。

接着做删除操作：

图片

ID为4的删除了，接下来再做查询看看：

图片

这说明删除了数据后，缓存也做了删除。这里生成了查询语句。