SpringCache与redis集成，优雅的缓存解决方案

时间 2019-12-04

标签 springcache redis 集成优雅缓存解决方案栏目 Redis 繁體版

原文原文链接

　　缓存能够说是加速服务响应速度的一种很是有效而且简单的方式。在缓存领域，有不少知名的框架，如EhCache 、Guava、HazelCast等。Redis做为key-value型数据库，因为他的这一特性，Redis也成为一种流行的数据缓存工具。java

　　在传统方式下对于缓存的处理代码是很是臃肿的。redis

　　例如：咱们要把一个查询函数加入缓存功能，大体须要三步。spring

　　　　1、在函数执行前，咱们须要先检查缓存中是否存在数据，若是存在则返回缓存数据数据库

　　　　2、若是不存在，就须要在数据库的数据查询出来。apache

　　　　3、最后把数据存放在缓存中，当下次调用此函数时，就能够直接使用缓存数据，减轻了数据库压力。spring-mvc

　　那么实现上面的三步须要多少代码呢？下面是一个示例：缓存

　　上图中的红色部分都是模板代码，真正与这个函数有关的代码却只占了1/5，对于全部须要实现缓存功能的函数，都须要加上臃肿的模板代码。可谓是一种极不优雅的解决方案。mvc

　　那么如何让臃肿的代码重回清新的当初呢？app

　　AOP不就是专门解决这种模板式代码的最佳方案吗，幸运的是咱们不须要再本身实现切面了，SpringCache已经为咱们提供好了切面，咱们只须要进行简单的配置，就能够重回当初了，像下面这样：框架

　　只须要加一个注解就能够了，对于原来的代码连改都不须要改，是否是已经跃跃欲试了？

　　对于配置SpringCache只须要三步：

第一步：加入相关依赖：

<dependency>  
   <groupId>redis.clients</groupId>  
   <artifactId>jedis</artifactId>  
　　<version>2.9.0</version>  
</dependency>  
<dependency>  
   <groupId>org.springframework.data</groupId>  
   <artifactId>spring-data-redis</artifactId>  
   <version>1.6.0.RELEASE</version>  
</dependency> 
<dependency>
　　<groupId>org.apache.commons</groupId>
　　<artifactId>commons-lang3</artifactId> 
　　<version>3.3.2</version>
</dependency>

第二步：配置SpringCache，Redis链接等信息

applicationContext-redis.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"    
    xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns:p="http://www.springframework.org/schema/p"    
    xmlns:context="http://www.springframework.org/schema/context"    
    xmlns:mvc="http://www.springframework.org/schema/mvc"    
    xmlns:cache="http://www.springframework.org/schema/cache"  
    xsi:schemaLocation="http://www.springframework.org/schema/beans      
                        http://www.springframework.org/schema/beans/spring-beans-4.2.xsd      
                        http://www.springframework.org/schema/context      
                        http://www.springframework.org/schema/context/spring-context-4.2.xsd      
                        http://www.springframework.org/schema/mvc      
                        http://www.springframework.org/schema/mvc/spring-mvc-4.2.xsd  
                        http://www.springframework.org/schema/cache   
                        http://www.springframework.org/schema/cache/spring-cache-4.2.xsd">

　　<context:property-placeholder location="classpath:*.properties"/>

<cache:annotation-driven cache-manager="cacheManager"/>
    <!-- redis链接池 -->
    <bean id="poolConfig" class="redis.clients.jedis.JedisPoolConfig">
        <property name="maxIdle" value="${redis.maxIdle}" />     
         <property name="maxWaitMillis" value="${redis.maxWait}" />    
         <property name="testOnBorrow" value="${redis.testOnBorrow}" /> 
    </bean>
    <!-- 链接工厂 -->
    <bean id="JedisConnectionFactory" class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory"    
       p:host-name="${redis.host}" p:port="${redis.port}" p:password="${redis.pass}" p:pool-config-ref="poolConfig"/>
    <!-- redis模板 -->
    <bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate">    
         <property name="connectionFactory" ref="JedisConnectionFactory" />    
    </bean>
     
    <bean id="cacheManager" class="org.springframework.cache.support.SimpleCacheManager">    
         <property name="caches">    
            <set>    
                <!-- 这里能够配置多个redis -->  
                <bean class="com.cky.rest.utils.RedisCache">    
                     <property name="redisTemplate" ref="redisTemplate" />    
                     <property name="name" value="content"/>    
                     <!-- name对应的名称要在类或方法的注解中使用 -->  
                </bean>  
            </set>    
         </property>    
     </bean>    
</beans>

redis.properties文件：

# Redis settings  
# server IP  
redis.host=192.168.100.55 
# server port  
redis.port=6379  
# server pass  
redis.pass=
# use dbIndex  
redis.database=0 
#max idel instance of jedis
redis.maxIdle=300  
#if wait too long ,throw JedisConnectionException
redis.maxWait=3000  
#if true,it will validate before borrow jedis instance,what you get instance is all usefull
redis.testOnBorrow=true

第三步，编写Cache接口实现类

　　Spring对于缓存只是提供了抽象的接口，而且经过接口来调用功能，没有具体的实现类，因此须要咱们本身实现具体的操做。

　　在上面配置中可知，每一个实现类都会注入一个redisTemplate实例，咱们就能够经过redisTemplate来操做redis

package com.cky.rest.utils;

import java.io.Serializable;

import org.apache.commons.lang3.SerializationUtils;
import org.springframework.cache.Cache;
import org.springframework.cache.support.SimpleValueWrapper;
import org.springframework.dao.DataAccessException;
import org.springframework.data.redis.connection.RedisConnection;
import org.springframework.data.redis.core.RedisCallback;
import org.springframework.data.redis.core.RedisTemplate;

public class RedisCache implements Cache {

    private RedisTemplate<String, Object> redisTemplate;
    private String name;

    @Override
    public void clear() {
        System.out.println("-------緩存清理------");
        redisTemplate.execute(new RedisCallback<String>() {
            @Override
            public String doInRedis(RedisConnection connection) throws DataAccessException {
                connection.flushDb();
                return "ok";
            }
        });
    }

    @Override
    public void evict(Object key) {
        System.out.println("-------緩存刪除------");
        final String keyf=key.toString();
        redisTemplate.execute(new RedisCallback<Long>() {
            @Override
            public Long doInRedis(RedisConnection connection) throws DataAccessException {
                return connection.del(keyf.getBytes());
            }
            
        });

    }

    @Override
    public ValueWrapper get(Object key) {
        System.out.println("------缓存获取-------"+key.toString());
        final String keyf = key.toString();
        Object object = null;
        object = redisTemplate.execute(new RedisCallback<Object>() {
            @Override
            public Object doInRedis(RedisConnection connection) throws DataAccessException {
                byte[] key = keyf.getBytes();
                byte[] value = connection.get(key);
                if (value == null) {
                    System.out.println("------缓存不存在-------");
                    return null;
                }
                return SerializationUtils.deserialize(value);
            }
        });
        ValueWrapper obj=(object != null ? new SimpleValueWrapper(object) : null);
        System.out.println("------获取到内容-------"+obj);
        return  obj;
    }

    @Override
    public void put(Object key, Object value) {
        System.out.println("-------加入缓存------");
        System.out.println("key----:"+key);
        System.out.println("key----:"+value);
        final String keyString = key.toString();
        final Object valuef = value;
        final long liveTime = 86400;
        redisTemplate.execute(new RedisCallback<Long>() {
            @Override
            public Long doInRedis(RedisConnection connection) throws DataAccessException {
                byte[] keyb = keyString.getBytes();
                byte[] valueb = SerializationUtils.serialize((Serializable) valuef);
                connection.set(keyb, valueb);
                if (liveTime > 0) {
                    connection.expire(keyb, liveTime);
                }
                return 1L;
            }
        });

    }
    
    @Override
    public <T> T get(Object arg0, Class<T> arg1) {
        // TODO Auto-generated method stub
        return null;
    }
    
    @Override
    public String getName() {
        return this.name;
    }

    @Override
    public Object getNativeCache() {
        return this.redisTemplate;
    }
    
    @Override
    public ValueWrapper putIfAbsent(Object arg0, Object arg1) {
        // TODO Auto-generated method stub
        return null;
    }

    public RedisTemplate<String, Object> getRedisTemplate() {
        return redisTemplate;
    }

    public void setRedisTemplate(RedisTemplate<String, Object> redisTemplate) {
        this.redisTemplate = redisTemplate;
    }

    public void setName(String name) {
        this.name = name;
    }
}

View Code

在配置过程当中曾经出现过两次错误：

1.Xxxx.ClassNotFoundException 最后发现是jar下载不完整，把maven本地仓库的对应jar包文件夹删除完重新下载就行了

2.Xxxx.MethodNotFoundException 这种状况是版本不对，换成第一步中的版本就能够了

SpringCache中常见注解的使用：

@Cacheable注解

　　最经常使用的注解，会把被注解方法的返回值缓存。工做原理是：首先在缓存中查找，若是没有执行方法并缓存结果，而后返回数据。此注解的缓存名必须指定，和cacheManager中的caches中的某一个Cache的name值相对应。能够使用value或cacheNames指定。

　　若是没有指定key属性，spring会使用默认的主键生成器产生主键。也能够自定义主键，在key中能够使用SpEL表达式。以下：

    @Cacheable(cacheNames=”content”,key=”#user.userId”)
　　Public User getUser(User user){
        xxxxx
    }

　　能够使用condition属性，来给缓存添加条件，以下：

@Cacheable(cacheNames=”content”,key=”#user.userId”,condition=”#user.age<40”)
Public User getUser(User user){xxxxx}

@CachePut注解

　　先执行方法，而后将返回值放回缓存。能够用做缓存的更新。

@CacheEvict注解

　　该注解负责从缓存中显式移除数据，一般缓存数据都有有效期，当过时时数据也会被移除。

　　此注解多了两个属性：

　　　　allEntries是否移除全部缓存条目。

　　　　beforeInvocation：在方法调用前仍是调用后完成移除操做。true/false