Spring Redis 缓存注解使用

87次阅读

共计 3705 个字符，预计需要花费 10 分钟才能阅读完成。

由于最近新上的项目很多模块没有做数据缓存，大量的请求都会到数据库去查询, 为了减轻数据库的压力以及提高网站响应速度, 所以在这里采用了 spring 提供的注解 +redis 实现对数据的缓存，主要针对非热点数据，例如省市, 银行卡列表等做缓存, 在这里主要是查询做一个缓存实例。

pom.xml（加入 spring 和 reids jar 包）

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

spring-redis.xml 配置（通过配置线程池方式连接 redis, 提供操作 redis 的 api）

<!-- jedis 配置 -->

    <!-- redis 连接池的配置 -->
    <bean id="jedisPoolConfig" class="redis.clients.jedis.JedisPoolConfig">
        <property name="maxTotal" value="100" />
        <property name="maxIdle" value="${redis.maxIdle}"/>
        <property name="minIdle" value="${redis.minIdle}"/>
        <property name="maxWaitMillis" value="${redis.maxWaitMillis}"/>
        <property name="testOnBorrow" value="${redis.testOnBorrow}"/>
        <property name="testOnReturn" value="${redis.testOnReturn}"/>
    </bean>

    <!-- redis 的连接池 pool，不是必选项：timeout/password  -->
    <bean id="connectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory" >
        <property name="usePool" value="true"></property>
        <property name="hostName" value="${redis.host}" />
        <property name="port" value="${redis.port}" />
        <property name="password" value="${redis.password}" />
        <property name="timeout" value="100000" />
        <property name="database" value="0"></property>
        <constructor-arg index="0" ref="jedisPoolConfig" />
    </bean>
  <!-- 配置 redis 模板, 需要注入到 RedisCacheManager by dada -->
    <bean id="redisTemplate" class="org.springframework.data.redis.core.StringRedisTemplate">
        <property name="connectionFactory"   ref="connectionFactory" />
        <property name="keySerializer">
            <bean class="org.springframework.data.redis.serializer.StringRedisSerializer" />
            </property>
        <property name="valueSerializer">
            <bean  class="org.springframework.data.redis.serializer.JdkSerializationRedisSerializer" />
        </property>
    </bean>

    <!-- 配置缓存 by dada -->
    <bean id="cacheManager" class="org.springframework.data.redis.cache.RedisCacheManager">
        <constructor-arg ref="redisTemplate" />
        <!--<property name="defaultExpiration" value="300"></property>-->
        <property name="usePrefix" value="true"></property>
        <property name="expires">
            <util:map>
                <!-- 指定 key 的时间为 1500 秒 --> 
                <entry key="get_bank_province_list" value="1500"></entry>
                <entry key="get_areas_bypid_list" value="1500"></entry>
            </util:map>
        </property>
    </bean>

由于使用注解方式实现 redis 缓存, 需要在 spring 初始化的时候配置缓存注解

<!-- 启用缓存注解功能，这个是必须的，否则注解不会生效，另外，该注解一定要声明在 spring 主配置文件中才会生效, 这个 cacheManager
     必须指向 redis 配置里面的 RedisCacheManager-->
    <cache:annotation-driven cache-manager="cacheManager" />

在需要缓存的 service 实现类方法加上对应的缓存注解, 需要注意的是下面方法中我并没有传入参数, 如果查询没有传入参数则需要默认指定一个 key，否则运行时候会出现无法找到 key 的错误。
#root.methodName 代表的是默认使用 getBankProvince 作为 key 的后缀, 则拼接后的完整 key 为 get_bank_province_list:getBankProvince
在这个过程中由于第一次请求 redis 没有这个 key, 则会查询数据库, 查询完成后会将数据存到 redis。第二次查询发现 key 存在则直接取 redis 数据, 不会再查询数据库。

@Cacheable(value = "get_bank_province_list",key = "#root.methodName")
    public List<SAreasEntity> getBankProvince() {System.out.println("get_bank_province_listget_bank_province_listget_bank_province_listget_bank_province_listget_bank_province_listget_bank_province_list");
        List<SAreasEntity> list = new ArrayList<SAreasEntity>();
        List<SAreasItem> listItem = sAreasMapper.getBankProvince();
        for(int i=0;i<listItem.size();i++){SAreasEntity sareasEntity=new SAreasEntity();
            SAreasItem sareasItem=listItem.get(i);
            sareasEntity.setId(sareasItem.getId());
            sareasEntity.setName(sareasItem.getName());
            sareasEntity.setPid(sareasItem.getPid());
            sareasEntity.setCity_name(sareasItem.getCity_name());
            list.add(sareasEntity);
        }
        return list;
    }

应用到读取数据的方法上，即可缓存的方法，如查找方法：先从缓存中读取，如果没有再调用方法获取数据，然后把数据添加到缓存中。

除了上述使用方法参数作为 key 之外，Spring 还为我们提供了一个 root 对象可以用来生成 key。通过该 root 对象我们可以获取到以下信息。

属性名称	描述	示例
methodName	当前方法名	#root.methodName
method	当前方法	#root.method.name
target	当前被调用的对象	#root.target
targetClass	当前被调用的对象的 class	#root.targetClass
args	当前方法参数组成的数组	#root.args[0]
caches	当前被调用的方法使用的 Cache	#root.caches[0].name