集成Spring Redis缓存的实现

2023-09-02 12:38:05 66

这里的缓存主要是用于Service层的，所以下面的配置，都是针对service模块的。

本文来自内部分享，对特殊信息进行了简单处理。

本文都是在以缓存来讲Redis的使用，实际上Redis不仅仅用于缓存，本身还是NoSQL数据库，大家可以自己查找学习Redis的常用场景。

一、添加依赖



org.springframework
spring-context-support
4.3.14.RELEASE



org.springframework.data
spring-data-redis
1.8.10.RELEASE


org.apache.commons
commons-pool2
2.4.3


redis.clients
jedis
2.9.0

二、配置

增加spring-redis.xml配置文件，内容如下：

在src/main/resources/下面如果没有META-INF/spring/目录就创建一个，然后增加redis.properties配置，示例如下：

#缓存名=有效时间
halfHour=1800
oneHour=3600
oneDay=86400
webSession=1800
user=1800

除了上面配置外，在系统的application.properties中还需要提供下面几个配置：

#redis连接配置
redis.master.ip=10.10.10.100
redis.master.port=6379
#redis连接池配置
redis.pool.maxIdle=200
redis.pool.maxTotal=1024
redis.pool.maxWaitMillis=1000
redis.pool.testOnBorrow=true
redis.pool.testOnReturn=true

三、通过注解方式使用缓存

示例中，redis.propreties配置如下：

#数据库定义，缓存30天
databaseDef=2592000
#数据库元数据，缓存1小时
databaseMeta=3600

这个示例在数据库服务上配置的，数据库服务中，查询次数远远大于新增、修改、删除的次数，非常适合使用缓存。

1.缓存数据@Cacheable

@Override
@Cacheable(value="databaseDef",key="'all'")
publicListselectAll(){
returndatabaseDefinitionDao.selectAllVo();
}

特别注意：所有这些注解中，key的值是Spel表达式，必须按照Spel要求来写。上面这个例子中，直接定义返回值的key是all字符串，需要加上单引号'括起来，下面还有其他用法。

在例子中，下面的方法也使用了这个注解：

@Override
@Cacheable(value="databaseDef",key="#id.toString()")
publicDatabaseDefinitionselectByPrimaryKey(Longid){
Assert.notNull(id,"数据库ID不能为空!");
DatabaseDefinitiondefinition=databaseDefinitionDao.selectByPrimaryKey(id);
Assert.notNull(definition,"数据库定义不存在!");
returndefinition;
}

在上面注解中，key中的#id指的是参数中的id，在IDEA中会有自动提示。.toString()是调用id的方法，在系统中规定了key必须是字符串类型，所以当类型是Long的时候，需要转换。

使用缓存的目的就是为了减少上面两个方法调用时减少和数据库的交互，减小数据库的压力，这是两个主要的缓存数据的方法，下面的几个操作都和上面这两个方法有一定的关系。

重点：这里以及下面几个注解中，都指定了value="databaseDef"，这里的意思是说，要使用前面配置中的databaseDef对应的配置，也就是会缓存30天。

2.更新缓存@CachePut

@Override
@CachePut(value="databaseDef",key="#result.id.toString()")
publicDatabaseDefinitionsave(DatabaseDefinitiondefinition,CurrentUseruserModel)
throwsServiceException{
//代码
returndefinition;
}

更新缓存的方法需要注意的是返回值，在上面save方法中，有可能是新增，有可能是更新，不管是那个操作，当操作完成后，上面注解会根据key的值生成key，然后将方法的返回值作为value保存到缓存中。

这里key的写法中#result指代返回值，.id是返回值的属性，.toString()是调用id属性的方法，在系统中规定了key必须是字符串类型，所以当类型是Long的时候，需要转换。

这个方法上加的缓存还有问题，当新增或者更新后，通过selectAll()返回的值已经发生了变化，但是这里没有清除all的缓存值，会导致selectAll()出现脏数据，下面会通过@Caching注解改造这里。

3.清除缓存@CacheEvict

@Override
@CacheEvict(value="databaseDef",key="#id.toString()")
publicvoiddeleteByPrimaryKey(Longid)throwsServiceException{
DatabaseDefinitiondefinition=selectByPrimaryKey(id);
if(definition.getLoadState().equals(DatabaseDefinition.LoadState.UP)){
thrownewServiceException("请先卸载数据库!");
}
databaseDefinitionDao.deleteByPrimaryKey(id);
}

在上面新增或者修改的时候根据id缓存或者更新了缓存数据，这里当删除数据的时候，还需要清空对应的缓存数据。

在上面注解中，key中的#id指的是参数中的id，在IDEA中会有自动提示。

这个方法上加的缓存还有问题，当删除后，通过selectAll()返回的值已经发生了变化，但是这里没有清除all的缓存值，会导致selectAll()出现脏数据，下面会通过@Caching注解改造这里。

4.组合使用@Caching

上面两个注解中，都提到了脏数据，通过@Caching注解可以解决这个问题。

先修改第二个注解，来解决save时的脏数据：

@Override
@Caching(put=@CachePut(value="databaseDef",key="#result.id.toString()"),
evict=@CacheEvict(value="databaseDef",key="'all'"))
publicDatabaseDefinitionsave(DatabaseDefinitiondefinition,CurrentUseruserModel)
throwsServiceException{
//其他代码
returndefinition;
}

前面说明，新增或者修改的时候，all缓存中的数据已经不对了，因此这里在put的同时，使用evict将'all'中的数据清除，这就保证了selelctAll下次调用时，会重新从库中读取数据。

对上面的删除方法，也进行类似的修改：

@Override
@Caching(evict={
@CacheEvict(value="databaseDef",key="#id.toString()"),
@CacheEvict(value="databaseDef",key="'all'")
})
publicvoiddeleteByPrimaryKey(Longid)throwsServiceException{
DatabaseDefinitiondefinition=selectByPrimaryKey(id);
if(definition.getLoadState().equals(DatabaseDefinition.LoadState.UP)){
thrownewServiceException("请先卸载数据库!");
}
databaseDefinitionDao.deleteByPrimaryKey(id);
}

注意这里的evict是个数组，里面配置了两个清除缓存的配置。

5.全局配置@CacheConfig

在上面所有例子中，都指定了value="databaseDef"，实际上可以通过在类上使用@CacheConfig注解配置当前类中的cacheNames值，配置后，如果和类上的value一样就不需要在每个注解单独配置。只有不同时再去指定，方法上的value值优先级更高。

@Service
@CacheConfig(cacheNames="databaseDef")
publicclassDatabaseDefinitionServiceImplimplements
DatabaseDefinitionService,DatabaseSqlExecuteService,ApplicationListener{

有了上面配置后，其他缓存名字相同的地方可以简化，例如删除方法修改后如下：

@Override
@Caching(evict={
@CacheEvict(key="#id.toString()"),
@CacheEvict(key="'all'")
})
publicvoiddeleteByPrimaryKey(Longid)throwsServiceException{
DatabaseDefinitiondefinition=selectByPrimaryKey(id);
if(definition.getLoadState().equals(DatabaseDefinition.LoadState.UP)){
thrownewServiceException("请先卸载数据库!");
}
databaseDefinitionDao.deleteByPrimaryKey(id);
}

其他例子

除了上面针对databaseDef的缓存外，还有databaseMeta的配置：

@Override
@Cacheable(value="databaseMeta",key="#databaseId.toString()")
publicListselectTablesByDatabaseId(LongdatabaseId)
throwsException{
//代码
}
@Override
@Cacheable(value="databaseMeta",key="#databaseId+'_'+#tableName")
publicTableVoselectTableByDatabaseIdAndTableName(LongdatabaseId,StringtableName)
throwsException{
//代码
}

这两个方法是获取数据库元数据的，只有修改数据库表的时候才会变化，因此不存在清除缓存的情况，但是万一修改表后，想要新的元数据，该怎么办？

因此增加了一个空的方法来清空数据，方法如下：

@Override
@CacheEvict(value="databaseMeta",allEntries=true)
publicvoidcleanTablesCache(){
}

这里指定了databaseMeta，通过allEntries=true清空所有key的缓存。通过这个方法可以保证在有需要的时候清空所有元数据的缓存。

实际上如果想要更精确的清除，可以传入要清除的databaseId和tableName来更精确的清除。

增加缓存后的效果

调用selectTablesByDatabaseId多次时，输出的日志如下：

INFO c.n.d.u.DynamicDataSource-当前数据源：默认数据源
DEBUGc.n.d.DataScopeContextProviderFilter-服务调用返回前清除数据权限信息
INFO c.n.d.u.DynamicDataSource-当前数据源：默认数据源
DEBUGc.n.d.d.D.selectByPrimaryKey-==> Preparing:SELECTxxx(隐藏完整SQL)
DEBUGc.n.d.d.D.selectByPrimaryKey-==>Parameters:1(Long)
DEBUGc.n.d.d.D.selectByPrimaryKey-<== Total:1
INFO c.n.d.u.DynamicDataSource-当前数据源：10.10.10.130/datareporting
DEBUGc.n.d.DataScopeContextProviderFilter-服务调用返回前清除数据权限信息
INFO c.n.d.u.DynamicDataSource-当前数据源：默认数据源
DEBUGc.n.d.DataScopeContextProviderFilter-服务调用返回前清除数据权限信息
INFO c.n.d.u.DynamicDataSource-当前数据源：默认数据源
DEBUGc.n.d.DataScopeContextProviderFilter-服务调用返回前清除数据权限信息

从日志可以看出来，只有第一次进行了数据库查询，后续通过日志看不到数据库操作。

调用清空缓存后，会再次查询数据库。

初次调用时，WEB请求花了700多ms，后面再次调用时，平均不到30ms，这就是缓存最明显的作用。

连接到redis服务后，查看所有key，结果如下：

redis@redissvr:~$redis-cli
127.0.0.1:6379>keys*
1)"databaseMeta:1"
2)"databaseDef:all"
127.0.0.1:6379>

缓存中的数据都有value前缀，上面缓存了all和id为1的数据。

缓存注解是一种最简单的缓存方式，但是需要配合value属性的配置来使用，许多时候我们可能需要更精确的控制缓存，此时可以使用RedisTemplate来控制。

四、通过RedisTemplate使用缓存

有关这部分的详细用法可以从网上搜索相关内容进行学习，这里列举一个简单的例子。

针对前面的selectAll我们换一种方式进行缓存。

首先注入下面的接口：

@Resource(name="redisTemplate")
privateValueOperationsvalueOper;

修改selectAll方法如下：

@Override
//@Cacheable(key="'all'")
publicListselectAll(){
Listvos=valueOper.get("databaseDef:all");
if(vos!=null){
returnvos;
}
vos=databaseDefinitionDao.selectAllVo();
//缓存1小时
valueOper.set("databaseDef:all",vos,1,TimeUnit.HOURS);
returnvos;
}

首先通过valueOper.get("databaseDef:all")尝试获取缓存信息，如果存在就直接返回。

如果不存在，就查询数据库，然后将查询结果通过set进行缓存。

特别注意：上面的key，写的是"databaseDef:all"，也就是前缀需要自己加上，如果直接写成all，在Redis中的key就是all，不会自动增加前缀。

如果没有前缀，那么当不同系统都使用all时，数据就会混乱！

五、Redis服务器配置注意事项

内网使用的服务器，特殊配置如下：

#Bydefaultprotectedmodeisenabled.Youshoulddisableitonlyif
#youaresureyouwantclientsfromotherhoststoconnecttoRedis
#evenifnoauthenticationisconfigured,noraspecificsetofinterfaces
#areexplicitlylistedusingthe"bind"directive.
#protected-modeyes
protected-modeno

关闭了保护模式。

#IFYOUARESUREYOUWANTYOURINSTANCETOLISTENTOALLTHEINTERFACES
#JUSTCOMMENTTHEFOLLOWINGLINE.
#~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~~
#bind127.0.0.1

注释了绑定的IP，这样可以让所有电脑访问Redis。

总结

以上就是这篇文章的全部内容了，希望本文的内容对大家的学习或者工作具有一定的参考学习价值，谢谢大家对毛票票的支持。如果你想了解更多相关内容请查看下面相关链接

声明：本文内容来源于网络，版权归原作者所有，内容由互联网用户自发贡献自行上传，本网站不拥有所有权，未作人工编辑处理，也不承担相关法律责任。如果您发现有涉嫌版权的内容，欢迎发送邮件至：czq8825#qq.com（发邮件时，请将#更换为@）进行举报，并提供相关证据，一经查实，本站将立刻删除涉嫌侵权内容。

集成Spring Redis缓存的实现

热门推荐

随机推荐