原创 Springboot实战案例锦集 Spring全家桶实战案例源码 2023-10-14 12:34 发表于新疆
Spring全家桶实战案例源码
spring, springboot, springcloud 案例开发详解
376篇原创内容
公众号
环境:springboot2.6.12 + JSR107 + Ehcache + JPA
Spring Cache是一个框架,实现了基于注解的缓存功能。它通过CacheManager接口来统一不同的缓存技术,为业务操作缓存提供了简化。具体来说,使用Spring Cache的注解,如@Cacheable、@CacheEvict和@CachePut等,可以非常方便地实现缓存的操作,如缓存的创建、更新和删除等。
为什么要使用Spring Cache?主要有以下几个原因:
-
简化操作:通过注解的方式,可以大大简化我们在业务中操作缓存的代码。不需要编写大量的手动缓存处理逻辑,可以更加专注于业务逻辑的处理。
-
提高性能:使用缓存可以大幅提高应用的性能。通过将常用的数据或计算结果存储在缓存中,可以减少对数据库或其他外部数据源的访问次数,从而提高应用的响应速度和性能。
-
扩展性:Spring Cache提供了抽象层,使得我们可以根据需要切换不同的缓存实现。例如,我们可以使用Redis作为缓存,也可以使用EhCache或其他缓存技术。这种扩展性使得我们的应用更加灵活,可以根据具体的需求选择最合适的缓存解决方案。
-
安全性:Spring Cache还提供了缓存一致性的保证。例如,在分布式系统中,多个应用节点可能会有对同一数据的并发访问和修改。使用Spring Cache的注解可以保证这些操作的一致性,避免了数据不一致的问题。
总的来说,Spring Cache的使用可以提高应用的性能和可维护性,使得应用更加健壮和灵活。
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
publicclass StorageService {
@Resource
private StorageRepository sr ;
// 这里的keyGenerator是你自定义Key生成的Bean名称
@Cacheable(value = {"cache_storage"}, keyGenerator = "storageKey")
public Storage getStorage(Long id) {
return sr.findById(id).get() ;
}
}
@Component("storageKey")
publicclass StorageKeyGenerator implements KeyGenerator {
privatestatic final String KEY_PREFIX = "storage_" ;
@Override
publicObject generate(Object target, Method method, Object... params) {
StringBuilder sb = new StringBuilder() ;
for (Object param : params) {
sb.append(param) ;
}
return KEY_PREFIX + sb.toString() ;
}
}
测试访问接口
@RestController
@RequestMapping("/storages")
public class StorageController {
@Resource
private StorageService storageService ;
@GetMapping("/{id}")
public Object get(@PathVariable("id") Long id) {
returnstorageService.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) {
returnsr.saveAndFlush(storage) ;
}
@CacheResult(cacheName = "cache_storage", cacheKeyGenerator = JCacheKeyGenerator.class)
publicStoragegetStorage(Long id) {
returnsr.findById(id).get() ;
}
@Transactional
@CacheRemove(cacheName = "cache_storage", cacheKeyGenerator = JCacheKeyGenerator.class)
publicvoidremoveStorage(Long id) {
sr.deleteById(id) ;
}
@Transactional
@CachePut(cacheName = "cache_storage", cacheKeyGenerator = JCacheKeyGenerator.class)
publicStorageupdateStorage(@CacheValue Storage storage) {
returnsr.saveAndFlush(storage) ;
}
}
// 注意这里的cacheKeyGenerator 必须全部用同一个,
// 跟踪了下源码是用的对应的类名key来查找对应的缓存的;一开始我没有用同一个始终不正确。。
源码调试
这里必须要一样cacheKeyGenerator
缓存Key:JCacheKeyGenerator.java
publicclass 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()) ;
}
}
application.yml配置
spring:
cache:
cacheNames:
- cache_storage
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="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的删除了,接下来再做查询看看:
这说明删除了数据后,缓存也做了删除。这里生成了查询语句。
完毕!!!!