Redis整合Spring结合使用缓存实例

         林炳文Evankaka原创作品。转载请注明出处http://blog.csdn.net/evankaka

         摘要：本文介绍了怎样在Spring中配置redis。并通过Spring中AOP的思想。将缓存的方法切入到有须要进入缓存的类或方法前面。

一、Redis介绍

什么是Redis？

      redis是一个key-value存储系统。

和Memcached相似，它支持存储的value类型相对很多其它，包含string(字符串)、list(链表)、set(集合)、zset(sorted set --有序集合)和hash（哈希类型）。

这些数据类型都支持push/pop、add/remove及取交集并集和差集及更丰富的操作。并且这些操作都是原子性的。

在此基础上，redis支持各种不同方式的排序。

与memcached一样，为了保证效率，数据都是缓存在内存中。差别的是redis会周期性的把更新的数据写入磁盘或者把改动操作写入追加的记录文件，并且在此基础上实现了master-slave(主从)同步。

它有什么特点？

（1）Redis数据库全然在内存中，使用磁盘仅用于持久性。

（2）相比很多键值数据存储。Redis拥有一套较为丰富的数据类型。

（3）Redis能够将数据拷贝到随意数量的从server。

Redis 优势？
 （1）异常高速：Redis的速度很快，每秒能运行约11万集合。每秒约81000+条记录。
 （2）支持丰富的数据类型：Redis支持最大多数开发者已经知道像列表，集合，有序集合。散列数据类型。这使得它很easy解决各种各样的问题，由于我们知道哪些问题是能够处理通过它的数据类型更好。
（3）操作都是原子性：全部Redis操作是原子的，这保证了假设两个客户端同一时候訪问的Redisserver将获得更新后的值。
（4）多功能有用工具：Redis是一个多有用的工具，能够在多个用比如缓存，消息，队列使用(Redis原生支持公布/订阅)，不论什么短暂的数据。应用程序，如Web应用程序会话，网页命中计数等。

Redis 缺点？

（1）单线程

（2）耗内存

二、使用实例

本文使用maven+eclipse+sping

1、引入jar包

      <!--Redis start -->
		<dependency>
			<groupId>org.springframework.data</groupId>
			<artifactId>spring-data-redis</artifactId>
			<version>1.6.1.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>redis.clients</groupId>
			<artifactId>jedis</artifactId>
			<version>2.7.3</version>
		</dependency>
     <!--Redis end -->

2、配置bean

在application.xml增加例如以下配置

 <!-- jedis 配置 -->
    <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 >
   <!-- redisserver中心 -->
    <bean id="connectionFactory"  class="org.springframework.data.redis.connection.jedis.JedisConnectionFactory" >
          <property name="poolConfig" ref="poolConfig" />
          <property name="port" value="${redis.port}" />
          <property name="hostName" value="${redis.host}" />
          <property name="password" value="${redis.password}" />
          <property name="timeout" value="${redis.timeout}" ></property>
    </bean >
    <bean id="redisTemplate" class="org.springframework.data.redis.core.RedisTemplate" >
          <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 >
    
     <!-- cache配置 -->
    <bean id="methodCacheInterceptor" class="com.mucfc.msm.common.MethodCacheInterceptor" >
          <property name="redisUtil" ref="redisUtil" />
    </bean >
    <bean id="redisUtil" class="com.mucfc.msm.common.RedisUtil" >
          <property name="redisTemplate" ref="redisTemplate" />
    </bean >

当中配置文件redis一些配置数据redis.properties例如以下：

#redis中心
redis.host=10.75.202.11
redis.port=6379
redis.password=123456
redis.maxIdle=100
redis.maxActive=300
redis.maxWait=1000
redis.testOnBorrow=true
redis.timeout=100000

# 不须要增加缓存的类
targetNames=xxxRecordManager,xxxSetRecordManager,xxxStatisticsIdentificationManager
# 不须要缓存的方法
methodNames=

#设置缓存失效时间
com.service.impl.xxxRecordManager= 60
com.service.impl.xxxSetRecordManager= 60
defaultCacheExpireTime=3600

fep.local.cache.capacity =10000

要扫这些properties文件。在application.xml增加例如以下配置

     <!-- 引入properties配置文件 -->  
     <bean id="propertyConfigurer" class="org.springframework.beans.factory.config.PropertyPlaceholderConfigurer">
        <property name="locations">
            <list>
               <value>classpath:properties/*.properties</value>
                <!--要是有多个配置文件，仅仅需在这里继续增加就可以 -->
            </list>
        </property>
    </bean>

3、一些工具类

（1）RedisUtil

上面的bean中。RedisUtil是用来缓存和去除数据的实例

package com.mucfc.msm.common;

import java.io.Serializable;
import java.util.Set;
import java.util.concurrent.TimeUnit;

import org.apache.log4j.Logger;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.ValueOperations;

/**
 * redis cache 工具类
 * 
 */
public final class RedisUtil {
	private Logger logger = Logger.getLogger(RedisUtil.class);
	private RedisTemplate<Serializable, Object> redisTemplate;

	/**
	 * 批量删除相应的value
	 * 
	 * @param keys
	 */
	public void remove(final String... keys) {
		for (String key : keys) {
			remove(key);
		}
	}

	/**
	 * 批量删除key
	 * 
	 * @param pattern
	 */
	public void removePattern(final String pattern) {
		Set<Serializable> keys = redisTemplate.keys(pattern);
		if (keys.size() > 0)
			redisTemplate.delete(keys);
	}

	/**
	 * 删除相应的value
	 * 
	 * @param key
	 */
	public void remove(final String key) {
		if (exists(key)) {
			redisTemplate.delete(key);
		}
	}

	/**
	 * 推断缓存中是否有相应的value
	 * 
	 * @param key
	 * @return
	 */
	public boolean exists(final String key) {
		return redisTemplate.hasKey(key);
	}

	/**
	 * 读取缓存
	 * 
	 * @param key
	 * @return
	 */
	public Object get(final String key) {
		Object result = null;
		ValueOperations<Serializable, Object> operations = redisTemplate
				.opsForValue();
		result = operations.get(key);
		return result;
	}

	/**
	 * 写入缓存
	 * 
	 * @param key
	 * @param value
	 * @return
	 */
	public boolean set(final String key, Object value) {
		boolean result = false;
		try {
			ValueOperations<Serializable, Object> operations = redisTemplate
					.opsForValue();
			operations.set(key, value);
			result = true;
		} catch (Exception e) {
			e.printStackTrace();
		}
		return result;
	}

	/**
	 * 写入缓存
	 * 
	 * @param key
	 * @param value
	 * @return
	 */
	public boolean set(final String key, Object value, Long expireTime) {
		boolean result = false;
		try {
			ValueOperations<Serializable, Object> operations = redisTemplate
					.opsForValue();
			operations.set(key, value);
			redisTemplate.expire(key, expireTime, TimeUnit.SECONDS);
			result = true;
		} catch (Exception e) {
			e.printStackTrace();
		}
		return result;
	}

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

（2）MethodCacheInterceptor

切面MethodCacheInterceptor。这是用来给不同的方法来增加推断假设缓存存在数据，从缓存取数据。否则第一次从数据库取，并将结果保存到缓存 中去。

package com.mucfc.msm.common;

import java.io.File;
import java.io.FileInputStream;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.List;
import java.util.Properties;

import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
import org.apache.log4j.Logger;


public class MethodCacheInterceptor implements MethodInterceptor {
	private Logger logger = Logger.getLogger(MethodCacheInterceptor.class);
	private RedisUtil redisUtil;
	private List<String> targetNamesList; // 不增加缓存的service名称
	private List<String> methodNamesList; // 不增加缓存的方法名称
	private Long defaultCacheExpireTime; // 缓存默认的过期时间
	private Long xxxRecordManagerTime; //
	private Long xxxSetRecordManagerTime; //

	/**
	 * 初始化读取不须要增加缓存的类名和方法名称
	 */
	public MethodCacheInterceptor() {
		try {
			 File f = new File("D:\lunaJee-workspace\msm\msm_core\src\main\java\com\mucfc\msm\common\cacheConf.properties"); 
			 //配置文件位置直接被写死。有须要自己改动下
		     InputStream in = new FileInputStream(f); 
//			InputStream in = getClass().getClassLoader().getResourceAsStream(
//					"D:\lunaJee-workspace\msm\msm_core\src\main\java\com\mucfc\msm\common\cacheConf.properties");
			Properties p = new Properties();
			p.load(in);
			// 切割字符串
			String[] targetNames = p.getProperty("targetNames").split(",");
			String[] methodNames = p.getProperty("methodNames").split(",");

			// 载入过期时间设置
			defaultCacheExpireTime = Long.valueOf(p.getProperty("defaultCacheExpireTime"));
			xxxRecordManagerTime = Long.valueOf(p.getProperty("com.service.impl.xxxRecordManager"));
			xxxSetRecordManagerTime = Long.valueOf(p.getProperty("com.service.impl.xxxSetRecordManager"));
			// 创建list
			targetNamesList = new ArrayList<String>(targetNames.length);
			methodNamesList = new ArrayList<String>(methodNames.length);
			Integer maxLen = targetNames.length > methodNames.length ? targetNames.length
					: methodNames.length;
			// 将不须要缓存的类名和方法名增加到list中
			for (int i = 0; i < maxLen; i++) {
				if (i < targetNames.length) {
					targetNamesList.add(targetNames[i]);
				}
				if (i < methodNames.length) {
					methodNamesList.add(methodNames[i]);
				}
			}
		} catch (Exception e) {
			e.printStackTrace();
		}
	}

	@Override
	public Object invoke(MethodInvocation invocation) throws Throwable {
		Object value = null;

		String targetName = invocation.getThis().getClass().getName();
		String methodName = invocation.getMethod().getName();
		// 不须要缓存的内容
		//if (!isAddCache(StringUtil.subStrForLastDot(targetName), methodName)) {
		if (!isAddCache(targetName, methodName)) {
			// 运行方法返回结果
			return invocation.proceed();
		}
		Object[] arguments = invocation.getArguments();
		String key = getCacheKey(targetName, methodName, arguments);
		System.out.println(key);

		try {
			// 推断是否有缓存
			if (redisUtil.exists(key)) {
				return redisUtil.get(key);
			}
			// 写入缓存
			value = invocation.proceed();
			if (value != null) {
				final String tkey = key;
				final Object tvalue = value;
				new Thread(new Runnable() {
					@Override
					public void run() {
						if (tkey.startsWith("com.service.impl.xxxRecordManager")) {
							redisUtil.set(tkey, tvalue, xxxRecordManagerTime);
						} else if (tkey.startsWith("com.service.impl.xxxSetRecordManager")) {
							redisUtil.set(tkey, tvalue, xxxSetRecordManagerTime);
						} else {
							redisUtil.set(tkey, tvalue, defaultCacheExpireTime);
						}
					}
				}).start();
			}
		} catch (Exception e) {
			e.printStackTrace();
			if (value == null) {
				return invocation.proceed();
			}
		}
		return value;
	}

	/**
	 * 是否增加缓存
	 * 
	 * @return
	 */
	private boolean isAddCache(String targetName, String methodName) {
		boolean flag = true;
		if (targetNamesList.contains(targetName)
				|| methodNamesList.contains(methodName)) {
			flag = false;
		}
		return flag;
	}

	/**
	 * 创建缓存key
	 *
	 * @param targetName
	 * @param methodName
	 * @param arguments
	 */
	private String getCacheKey(String targetName, String methodName,
			Object[] arguments) {
		StringBuffer sbu = new StringBuffer();
		sbu.append(targetName).append("_").append(methodName);
		if ((arguments != null) && (arguments.length != 0)) {
			for (int i = 0; i < arguments.length; i++) {
				sbu.append("_").append(arguments[i]);
			}
		}
		return sbu.toString();
	}

	public void setRedisUtil(RedisUtil redisUtil) {
		this.redisUtil = redisUtil;
	}
}

4、配置须要缓存的类或方法

在application.xml增加例如以下配置，有多个类或方法能够配置多个

    <!-- 须要增加缓存的类或方法 -->
    <bean id="methodCachePointCut"  class="org.springframework.aop.support.RegexpMethodPointcutAdvisor" >
          <property name="advice" >
              <ref local="methodCacheInterceptor" />
          </property>
          <property name="patterns" >
              <list>
               <!-- 确定正則表達式列表 -->
                 <value>com.mucfc.msm.service.impl...*ServiceImpl.*</value >
              </list>
          </property>
    </bean >

5、运行结果:

写了一个简单的单元測试例如以下：

    @Test
    public void getSettUnitBySettUnitIdTest() {
        String systemId = "CES";
        String merchantId = "133";
        SettUnit configSettUnit = settUnitService.getSettUnitBySettUnitId(systemId, merchantId, "ESP");
        SettUnit configSettUnit1 = settUnitService.getSettUnitBySettUnitId(systemId, merchantId, "ESP");
        boolean flag= (configSettUnit == configSettUnit1);
        System.out.println(configSettUnit);
        logger.info("查找结果" + configSettUnit.getBusinessType());
      
      //  localSecondFIFOCache.put("configSettUnit", configSettUnit.getBusinessType());
     //  String string = localSecondFIFOCache.get("configSettUnit");
//        logger.info("查找结果" + string);
    }

这是第一次运行单元測试的过程：

MethodCacheInterceptor这个类中打了断点，然后每次查询前都会先进入这种方法

依次运行。发现没有缓存，所以会直接去查数据库

打印了出来的SQL语句：

第二次运行：

由于第一次运行时，已经写入缓存了。所以第二次直接从缓存中取数据

3、取两次的结果进行地址的对照：

发现两个不是同一个对象。没错，是对的。假设是使用ehcache的话。那么二者的内存地址会是一样的。那是由于redis和ehcache使用的缓存机制是不一样的。ehcache是基于本地电脑的内存使用缓存，所以使用缓存取数据时直接在本地电脑上取。转换成java对象就会是同一个内存地址，而redis它是在装有redis服务的电脑上（通常是还有一台电脑），所以取数据时经过传输到本地，会相应到不同的内存地址，所以用==来比較会返回false。可是它确实是从缓存中去取的，这点我们从上面的断点能够看到。