基于Ehcache如何实现Spring缓存

这篇文章主要介绍了基于Ehcache如何实现Spring缓存，具有一定借鉴价值，感兴趣的朋友可以参考下，希望大家阅读完这篇文章之后大有收获，下面让小编带着大家一起了解一下。

成都创新互联公司专注于企业成都全网营销、网站重做改版、溧阳网站定制设计、自适应品牌网站建设、H5技术、成都商城网站开发、集团公司官网建设、外贸营销网站建设、高端网站制作、响应式网页设计等建站业务，价格优惠性价比高，为溧阳等各大城市提供网站开发制作服务。

一 简介

缓存，通过将数据保存在缓冲区中，可以为以后的相同请求提供更快速的查询，同时可以避免方法的多次执行，从而提高应用的性能。

在企业级应用中，为了提升性能，Spring提供了一种可以在方法级别上进行缓存的缓存抽象。通过使用AOP原则，Spring对使用缓存的方法自动生成相应代理类，如果已经为提供的参数执行过该方法，那么就不必重新执行实际方法而是直接返回被缓存的结果。在基于Spring的Web应用中，为了启用缓存功能，需要使用缓存注解对待使用缓存的方法进行标记。

Spring缓存仅仅提供了一种抽象，一般在企业级的Java应用中我们通常选择使用第三方的缓存框架与Spring进行集成，比如：Ehcache、Guava和Hazelcast等。接下来我将使用Ehcache框架来详细说明在SSM开发模式下的缓存配置和使用

二 SSM开发环境的搭建

（1）新建Java Web项目，并导入相应jar包：

最后的项目结构图如下所示：

（2）在web.xml中配置SpringMVC需要处理的请求：

	
		springmvc
		org.springframework.web.servlet.DispatcherServlet
		
			contextConfigLocation
			classpath:context/jsp-dispatcher.xml
		
		1
	

	
		springmvc
		*.html
	

（3）准备项目后面需要用到的数据库环境：

我这里使用了MySQL5.x，数据库名是“ehcache_db”，建表语句如下所示：

/*
Navicat MySQL Data Transfer

Source Server         : sel
Source Server Version : 50519
Source Host           : localhost:3306
Source Database       : ehcache_db

Target Server Type    : MYSQL
Target Server Version : 50519
File Encoding         : 65001

Date: 2016-05-05 22:41:46
*/

SET FOREIGN_KEY_CHECKS=0;

-- ----------------------------
-- Table structure for user
-- ----------------------------
DROP TABLE IF EXISTS `user`;
CREATE TABLE `user` (
  `id` int(11) NOT NULL AUTO_INCREMENT,
  `name` varchar(32) DEFAULT NULL,
  `password` varchar(64) DEFAULT NULL,
  `email` varchar(64) DEFAULT NULL,
  `birthday` date DEFAULT NULL,
  PRIMARY KEY (`id`)
) ENGINE=InnoDB AUTO_INCREMENT=6 DEFAULT CHARSET=utf8;

-- ----------------------------
-- Records of user
-- ----------------------------
INSERT INTO `user` VALUES ('1', 'admin', '123456', 'admin@zifangsky.cn', '2009-06-30');
INSERT INTO `user` VALUES ('2', 'test', '123456', 'test@zifangsky.cn', '1990-12-12');
INSERT INTO `user` VALUES ('3', '333', '333', 'eee@zifangsky.cn', '2016-05-01');
INSERT INTO `user` VALUES ('4', '444', '444', '444@zifangsky.cn', '2016-06-14');
INSERT INTO `user` VALUES ('5', '555', '555', '555@zifangsky.cn', '2016-05-12');

（4）配置数据源以及Mybatis相关配置：

在数据源配置这里我采用了C3P0连接池，当然也可以使用其他的连接池，这里就不多说了，不熟悉的话可以把本测试项目的×××下来参考一下即可。同时，由于在本测试项目中使用了Mybatis框架，因此可以使用mybatis-generator插件来自动生成一些基本的xxModel、xxMapper.java和xxMapper.xml等文件，如果关于这个插件不熟悉的话可以参考下我以前写过的这篇文章：http://www.zifangsky.cn/431.html

（5）在UserMapper.xml中添加一段根据用户ID查用户名的SQL语句：

  
    select name
    from user
    where id = #{id,jdbcType=INTEGER}
  

（6）对应的在UserMapper.java中添加上这个功能的接口：

    /**
	 * 通过用户Id查用户名
	 * 
	 * @param id
	 *            用户id
	 * @return 用户名
	 */
	String selectUserNameById(Integer id);

（7）UserManager.java和UserManagerImpl.java：

实际上这两个类处于业务逻辑层，跟我们通常见到的xxService这种类是一样的功能

i）UserManager.java：

package cn.zifangsky.manager;

import cn.zifangsky.model.User;

public interface UserManager {
	int deleteByPrimaryKey(Integer id);

    int insert(User record);

    int insertSelective(User record);

    User selectByPrimaryKey(Integer id);

    User updateByPrimaryKeySelective(User record);

    int updateByPrimaryKey(User record);
    
    /**
	 * 通过用户Id查用户名
	 * 
	 * @param id
	 *            用户id
	 * @return 用户名
	 */
	String selectUserNameById(Integer id);
}

几个基本的增删改查接口，跟UserMapper.java这个类是差不多的

ii）UserManagerImpl.java：

package cn.zifangsky.manager.impl;

import javax.annotation.Resource;

import org.springframework.stereotype.Service;

import cn.zifangsky.manager.UserManager;
import cn.zifangsky.mapper.UserMapper;
import cn.zifangsky.model.User;

@Service(value = "userManagerImpl")
public class UserManagerImpl implements UserManager {
	@Resource(name = "userMapper")
	private UserMapper userMapper;

	public int deleteByPrimaryKey(Integer id) {
		System.out.println("deleteByPrimaryKey方法开始执行：");
		
		return userMapper.deleteByPrimaryKey(id);
	}

	public int insert(User record) {
		return userMapper.insert(record);
	}

	public int insertSelective(User record) {
		return userMapper.insertSelective(record);
	}

	public User selectByPrimaryKey(Integer id) {
		System.out.println("selectByPrimaryKey方法开始执行：");
		
		return userMapper.selectByPrimaryKey(id);
	}

	public User updateByPrimaryKeySelective(User user) {
		System.out.println("updateByPrimaryKeySelective方法开始执行：");
				
		userMapper.updateByPrimaryKeySelective(user);

		return userMapper.selectByPrimaryKey(user.getId());  
	}

	public int updateByPrimaryKey(User record) {
		return userMapper.updateByPrimaryKey(record);
	}

	public String selectUserNameById(Integer id) {
		System.out.println("selectUserNameById方法开始执行：");
		
		String resultName = userMapper.selectUserNameById(id);

		System.out.println("用户Id：" + id + "， 对应的用户名是： " + resultName);
		return resultName;
	}

}

在这个实现类中针对每个方法通过调用userMapper中的对应方法来完成了一些基本的增删改查功能。当然如果对这里出现的@Service和@Resource这两个基本的SpringMVC注解不熟悉的话可以参考下我以前写过的这篇文章：http://www.zifangsky.cn/459.html

实际上，我们后面在启用缓存功能时就是在这个类上的一些方法上添加注解，当然现在可以不用管，待会再说。

（8）在UserController.java中添加一个测试方法，用于测试基于SSM框架的开发环境是否搭建成功：

package cn.zifangsky.controller;

import javax.annotation.Resource;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.servlet.ModelAndView;

import cn.zifangsky.manager.UserManager;
import cn.zifangsky.model.User;

@Controller
public class UserController {
	@Resource(name="userManagerImpl")
	private UserManager userManager;

	@RequestMapping(value="/test.html")
	public String user(@RequestParam(name="userId",required=false) Integer userId){
		User user = userManager.selectByPrimaryKey(userId);
	
		System.out.println("用户名： " + user.getName());
		System.out.println("邮箱： " + user.getEmail());
		
		return "success";
	}
	
}

（9）测试基于SSM框架的开发环境：

启动项目后在浏览器中访问：http://localhost:9080/EhcacheDemo/test.html?userId=1

如果出现在控制台中打印出了以下内容，则说明我们的测试环境已经搭建成功了

用户名： admin
邮箱： admin@zifangsky.cn

三 Ehcache框架与Spring的集成

（1）导入相关jar包

这里就不多说了，下载Ehcache的jar包并导入进去即可，也可以参考上面的项目结构图

（2）新建ehcache.xml：

这个文件是缓存的一些具体配置，有不懂的地方可以参考下注释中的内容

（3）在context.xml中添加缓存相关的配置：

（4）测试缓存效果：

i）在UserManagerImpl.java的selectUserNameById方法上添加@Cacheable注解，表示启用缓存：

	// 测试，自定义了key：'selectUserNameById_' + #id
	// 同时设置了id=2才启动缓存，当然实际开发并不会设置这种条件
	// @Cacheable(value="myCache",key="'selectUserNameById_' + #id"
	// ,condition="#id == 2")
	// @Cacheable(value="myCache",key="'selectUserNameById_' + #id" ,unless="#id
	// != 2")
	@Cacheable(value = "myCache", key = "'selectUserNameById_' + #id")
	public String selectUserNameById(Integer id) {
		System.out.println("selectUserNameById方法开始执行：");
		
		String resultName = userMapper.selectUserNameById(id);

		System.out.println("用户Id：" + id + "， 对应的用户名是： " + resultName);
		return resultName;
	}

从上面的代码可以看出，为了使用缓存，我们在这个方法上添加了一个@Cacheable注解。这个注解的含义是：有这个注解的方法将启用缓存功能，Spring将会自动生成代理类，根据这里的key值来判断此次查询是否已经被缓存过，如果被缓存过则直接从缓存中取得该方法的执行结果，如果没被缓存过那么将会实际执行这个方法并将结果进行缓存。这里的value对应的是我们在ehcache.xml文件中配置的一项具体的缓存参数配置。还要说明的是，这里的key值使用了Spring表达式语言（即：SpEL），为的就是通过一个唯一的id对每条user表中的数据建立不同的缓存，以此避免多个查询结果混淆。

同时，从我上面的注释可以看出，condition和unless参数可以用于生成有条件的缓存，可以根据在满足一定条件的情况下才对执行结果进行缓存。这里就不多说了，自己尝试一下就懂了。

当然，Spring的缓存除了@Cacheable这个注解外，还有@CacheEvict和@CachePut这两个常用注解，分别表示删除指定缓存和更新指定缓存。这两个注解的使用方法我们下面再说

ii）在UserController.java中添加一个测试方法：

	@RequestMapping(value="/ehcache.html")
	public ModelAndView testEhcache(@RequestParam(name="userId") Integer userId){
		ModelAndView modelAndView = new ModelAndView("TestCache");
		String userName = userManager.selectUserNameById(userId);
		
		modelAndView.addObject("userId", userId);
		if(userName != null){
			modelAndView.addObject("userName", userName);
		}
		else{
			modelAndView.addObject("userName", "null_ehcache");
		}
		
		return modelAndView;
	}

iii）对应的WebContent/WEB-INF/jsp/TestCache.jsp：

<%@ page language="java" contentType="text/html; charset=UTF-8"
    pageEncoding="UTF-8"%>
<%
String path = request.getContextPath();
String basePath = request.getScheme()+"://"+request.getServerName()+":"+request.getServerPort()+path+"/";
%>    



">



	
		用户Id是${userId }，对应的用户名是 ${userName }