springmvc和encache集成關鍵代碼和總結

基于注解的spring緩存配置 了解更多與spring集成的Echache  還有分布式的mencache讓我更好學習了oscache

介紹二者集成之前,先介紹下GoogleCode上的ehcache-spring-annotations項目


    /**
     * ehcache-spring-annotations簡介
     * @see ----------------------------------------------------------------------------------------------------------------
     * @see 關于Spring與Ehcache的集成,googlecode上有一個經Apache認證的開源項目叫做ehcache-spring-annotations
     * @see 目前已經到了1.2.0版本,它只是簡化了Spring和Ehcache集成的復雜性(事實上我覺得完全沒必要,因為它倆集成并不復雜)
     * @see 盡管如此還是要提一下,它的項目主頁為https://code.google.com/p/ehcache-spring-annotations/
     * @see 這篇文章中描述了其用法http://blog.goyello.com/2010/07/29/quick-start-with-ehcache-annotations-for-spring/
     * @see ----------------------------------------------------------------------------------------------------------------
     * @see 1)使用時在項目中引入ehcache-spring-annotations-1.2.0.jar和guava-r09.jar兩個jar文件
     * @see 2)然后在applicationContext.xml按照如下配置
     * @see   <beans xmlns:ehcache="http://ehcache-spring-annotations.googlecode.com/svn/schema/ehcache-spring"
     * @see         xsi:schemaLocation="http://ehcache-spring-annotations.googlecode.com/svn/schema/ehcache-spring
     * @see         http://ehcache-spring-annotations.googlecode.com/svn/schema/ehcache-spring/ehcache-spring-1.2.xsd">
     * @see   <ehcache:annotation-driven/>
     * @see   <ehcache:config cache-manager="cacheManager">
     * @see       <ehcache:evict-expired-elements interval="60"/>
     * @see   </ehcache:config>
     * @see   <bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean">
     * @see       <property name="configLocation" value="classpath:ehcache.xml"/>
     * @see   </bean>
     * @see 3)最后在需要緩存的方法上使用@Cacheable和@TriggersRemove注解即可
     * @see   經我親測,@TriggersRemove(cacheName="..", when="..", removeAll=true)可移除緩存中的全部對象
     * @see   但若寫成@TriggersRemove(cacheName="..", when="..")則不會移除緩存中的單一的或所有的對象,即緩存中的對象無變化
     * @see ----------------------------------------------------------------------------------------------------------------
     * @create Oct 3, 2013 4:56:35 PM
     * @author 玄玉<http://blog.csdn.net/jadyer>
     */

下面開始羅列示例代碼,首先是web.xml

 
    <?xml version="1.0" encoding="UTF-8"?>
    <web-app version="2.5"
        xmlns="http://java.sun.com/xml/ns/javaee"
        xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
        http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd">
        <!-- SpringMVC核心分發(fā)器 -->
        <servlet>
            <servlet-name>SpringMVC</servlet-name>
            <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
            <init-param>
                <param-name>contextConfigLocation</param-name>
                <param-value>classpath:applicationContext.xml</param-value>
            </init-param>
            <load-on-startup>1</load-on-startup>
        </servlet>
        <servlet-mapping>
            <servlet-name>SpringMVC</servlet-name>
            <url-pattern>/</url-pattern>
        </servlet-mapping>
    </web-app>

然后是//src//applicationContext.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:mvc="http://www.springframework.org/schema/mvc"
        xmlns:cache="http://www.springframework.org/schema/cache"
        xmlns:context="http://www.springframework.org/schema/context"
        xsi:schemaLocation="http://www.springframework.org/schema/beans
                            http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
                            http://www.springframework.org/schema/mvc
                            http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd
                            http://www.springframework.org/schema/cache
                            http://www.springframework.org/schema/cache/spring-cache-3.2.xsd
                            http://www.springframework.org/schema/context
                            http://www.springframework.org/schema/context/spring-context-3.2.xsd">
        <context:component-scan base-package="com.jadyer"/>
       
        <!-- SpringMVC配置 -->
        <mvc:annotation-driven/>
        <bean class="org.springframework.web.servlet.view.InternalResourceViewResolver">
            <property name="prefix" value="/"/>
            <property name="suffix" value=".jsp"/>
        </bean>
        <mvc:view-controller path="/" view-name="forward:/index.jsp"/>
       
        <!-- 緩存配置 -->
        <!-- 啟用緩存注解功能(請將其配置在Spring主配置文件中) -->
        <cache:annotation-driven cache-manager="cacheManager"/>
        <!-- Spring自己的基于java.util.concurrent.ConcurrentHashMap實現(xiàn)的緩存管理器(該功能是從Spring3.1開始提供的) -->
        <!--
        <bean id="cacheManager" class="org.springframework.cache.support.SimpleCacheManager">
            <property name="caches">
                <set>
                    <bean name="myCache" class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean"/>
                </set>
            </property>
        </bean>
         -->
        <!-- 若只想使用Spring自身提供的緩存器,則注釋掉下面的兩個關于Ehcache配置的bean,并啟用上面的SimpleCacheManager即可 -->
        <!-- Spring提供的基于的Ehcache實現(xiàn)的緩存管理器 -->
        <bean id="cacheManagerFactory" class="org.springframework.cache.ehcache.EhCacheManagerFactoryBean">
            <property name="configLocation" value="classpath:ehcache.xml"/>
        </bean>
        <bean id="cacheManager" class="org.springframework.cache.ehcache.EhCacheCacheManager">
            <property name="cacheManager" ref="cacheManagerFactory"/>
        </bean>
    </beans>

下面是//src//ehcache.xml

 
    <!-- Ehcache2.x的變化(取自https://github.com/springside/springside4/wiki/Ehcache) -->
    <!-- 1)最好在ehcache.xml中聲明不進行updateCheck -->
    <!-- 2)為了配合BigMemory和Size Limit,原來的屬性最好改名 -->
    <!--   maxElementsInMemory->maxEntriesLocalHeap -->
    <!--   maxElementsOnDisk->maxEntriesLocalDisk -->
    <ehcache>
        <diskStore path="java.io.tmpdir"/>
        <defaultCache
               maxElementsInMemory="1000"
               eternal="false"
               timeToIdleSeconds="120"
               timeToLiveSeconds="120"
               overflowToDisk="false"/>
        <cache name="myCache"
               maxElementsOnDisk="20000"
               maxElementsInMemory="2000"
               eternal="true"
               overflowToDisk="true"
               diskPersistent="true"/>
    </ehcache>
    <!--
    <diskStore>==========當內存緩存中對象數(shù)量超過maxElementsInMemory時,將緩存對象寫到磁盤緩存中(需對象實現(xiàn)序列化接口)
    <diskStore path="">==用來配置磁盤緩存使用的物理路徑,Ehcache磁盤緩存使用的文件后綴名是*.data和*.index
    name=================緩存名稱,cache的唯一標識(ehcache會把這個cache放到HashMap里)
    maxElementsOnDisk====磁盤緩存中最多可以存放的元素數(shù)量,0表示無窮大
    maxElementsInMemory==內存緩存中最多可以存放的元素數(shù)量,若放入Cache中的元素超過這個數(shù)值,則有以下兩種情況
                         1)若overflowToDisk=true,則會將Cache中多出的元素放入磁盤文件中
                         2)若overflowToDisk=false,則根據(jù)memoryStoreEvictionPolicy策略替換Cache中原有的元素
    eternal==============緩存中對象是否永久有效,即是否永駐內存,true時將忽略timeToIdleSeconds和timeToLiveSeconds
    timeToIdleSeconds====緩存數(shù)據(jù)在失效前的允許閑置時間(單位:秒),僅當eternal=false時使用,默認值是0表示可閑置時間無窮大,此為可選屬性
                         即訪問這個cache中元素的最大間隔時間,若超過這個時間沒有訪問此Cache中的某個元素,那么此元素將被從Cache中清除
    timeToLiveSeconds====緩存數(shù)據(jù)在失效前的允許存活時間(單位:秒),僅當eternal=false時使用,默認值是0表示可存活時間無窮大
                         即Cache中的某元素從創(chuàng)建到清楚的生存時間,也就是說從創(chuàng)建開始計時,當超過這個時間時,此元素將從Cache中清除
    overflowToDisk=======內存不足時,是否啟用磁盤緩存(即內存中對象數(shù)量達到maxElementsInMemory時,Ehcache會將對象寫到磁盤中)
                         會根據(jù)標簽中path值查找對應的屬性值,寫入磁盤的文件會放在path文件夾下,文件的名稱是cache的名稱,后綴名是data
    diskPersistent=======是否持久化磁盤緩存,當這個屬性的值為true時,系統(tǒng)在初始化時會在磁盤中查找文件名為cache名稱,后綴名為index的文件
                         這個文件中存放了已經持久化在磁盤中的cache的index,找到后會把cache加載到內存
                         要想把cache真正持久化到磁盤,寫程序時注意執(zhí)行net.sf.ehcache.Cache.put(Element element)后要調用flush()方法
    diskExpiryThreadIntervalSeconds==磁盤緩存的清理線程運行間隔,默認是120秒
    diskSpoolBufferSizeMB============設置DiskStore(磁盤緩存)的緩存區(qū)大小,默認是30MB
    memoryStoreEvictionPolicy========內存存儲與釋放策略,即達到maxElementsInMemory限制時,Ehcache會根據(jù)指定策略清理內存
                                     共有三種策略,分別為LRU(最近最少使用)、LFU(最常用的)、FIFO(先進先出)
    -->

下面是需要被緩存處理的UserService.java


    package com.jadyer.service;
     
    import java.util.Map;
    import java.util.concurrent.ConcurrentHashMap;
     
    import org.springframework.cache.annotation.CacheEvict;
    import org.springframework.cache.annotation.Cacheable;
    import org.springframework.stereotype.Service;
     
    /**
     * Cacheable注解負責將方法的返回值加入到緩存中
     * CacheEvict注解負責清除緩存(它的三個參數(shù)與@Cacheable的意思是一樣的)
     * @see ----------------------------------------------------------------------------------------------------------
     * @see value------緩存位置的名稱,不能為空,若使用EHCache則其值為ehcache.xml中的<cache name="myCache"/>
     * @see key--------緩存的Key,默認為空(表示使用方法的參數(shù)類型及參數(shù)值作為key),支持SpEL
     * @see condition--只有滿足條件的情況才會加入緩存,默認為空(表示全部都加入緩存),支持SpEL
     * @see ----------------------------------------------------------------------------------------------------------
     * @see 該注解的源碼位于spring-context-3.2.4.RELEASE-sources.jar中
     * @see Spring針對Ehcache支持的Java源碼位于spring-context-support-3.2.4.RELEASE-sources.jar中
     * @see ----------------------------------------------------------------------------------------------------------
     * @create Oct 3, 2013 6:17:54 PM
     * @author 玄玉<http://blog.csdn.net/jadyer>
     */
    @Service
    public class UserService {
        private Map<String, String> usersData = new ConcurrentHashMap<String, String>();
       
        public UserService(){
            System.out.println("用戶數(shù)據(jù)初始化..開始");
            usersData.put("2", "玄玉");
            usersData.put("3", "我的博客:http://blog.csdn.net/jadyer");
            System.out.println("用戶數(shù)據(jù)初始化..完畢");
        }
       
        //將查詢到的數(shù)據(jù)緩存到myCache中,并使用方法名稱加上參數(shù)中的userNo作為緩存的key
        //通常更新操作只需刷新緩存中的某個值,所以為了準確的清除特定的緩存,故定義了這個唯一的key,從而不會影響其它緩存值
        @Cacheable(value="myCache", key="'get'+#userNo")
        public String get(String userNo){
            System.out.println("數(shù)據(jù)庫中查到此用戶號[" + userNo + "]對應的用戶名為[" + usersData.get(userNo) + "]");
            return usersData.get(userNo);
        }
       
        @CacheEvict(value="myCache", key="'get'+#userNo")
        public void update(String userNo){
            System.out.println("移除緩存中此用戶號[" + userNo + "]對應的用戶名[" + usersData.get(userNo) + "]的緩存");
        }
       
        //allEntries為true表示清除value中的全部緩存,默認為false
        @CacheEvict(value="myCache", allEntries=true)
        public void removeAll(){
            System.out.println("移除緩存中的所有數(shù)據(jù)");
        }
    }

下面是UserController.java

 
    package com.jadyer.controller;
     
    import javax.annotation.Resource;
     
    import org.springframework.stereotype.Controller;
    import org.springframework.ui.Model;
    import org.springframework.web.bind.annotation.PathVariable;
    import org.springframework.web.bind.annotation.RequestMapping;
    import org.springframework.web.bind.annotation.RequestMethod;
     
    import com.jadyer.service.UserService;
     
    /**
     * 這里用到的jar如下
     * aopalliance.jar
     * commons-logging-1.1.2.jar
     * ehcache-2.7.4.jar
     * slf4j-api-1.7.5.jar
     * spring-aop-3.2.4.RELEASE.jar
     * spring-beans-3.2.4.RELEASE.jar
     * spring-context-3.2.4.RELEASE.jar
     * spring-context-support-3.2.4.RELEASE.jar
     * spring-core-3.2.4.RELEASE.jar
     * spring-expression-3.2.4.RELEASE.jar
     * spring-web-3.2.4.RELEASE.jar
     * spring-webmvc-3.2.4.RELEASE.jar
     * @create Oct 3, 2013 6:22:43 PM
     * @author 玄玉<http://blog.csdn.net/jadyer>
     */
    @Controller
    @RequestMapping("cacheTest")
    public class UserController {
        @Resource
        private UserService userService;
       
        @RequestMapping(value="/get/{userNo}", method=RequestMethod.GET)
        public String get(@PathVariable String userNo, Model model){
            String username = userService.get(userNo);
            model.addAttribute("username", username);
            return "getUser";
        }
       
        @RequestMapping(value="/update/{userNo}", method=RequestMethod.GET)
        public String update(@PathVariable String userNo, Model model){
            userService.update(userNo);
            model.addAttribute("userNo", userNo);
            return "updateUser";
        }
       
        @RequestMapping(value="/removeAll", method=RequestMethod.GET)
        public String removeAll(){
            userService.removeAll();
            return "removeAllUser";
        }
    }

最后把剩下的4個jsp頁面列出來,首先是index.jsp


    <%@ page language="java" pageEncoding="UTF-8"%>
    查看<a href="<%=request.getContextPath()%>/cacheTest/get/2" target="_blank">2號</a>用戶名
    <br/>
    <br/>
    查看<a href="<%=request.getContextPath()%>/cacheTest/get/3" target="_blank">3號</a>用戶名
    <br/>
    <br/>
    更新<a href="<%=request.getContextPath()%>/cacheTest/update/3" target="_blank">3號</a>用戶名
    <br/>
    <br/>
    移除<a href="<%=request.getContextPath()%>/cacheTest/removeAll" target="_blank">所有</a>用戶名

下面是getUser.jsp


    <%@ page language="java" pageEncoding="UTF-8"%>
    當前用戶名為${username}


下面是updateUser.jsp


    <%@ page language="java" pageEncoding="UTF-8"%>
    已更新${userNo}號用戶

最后是removeAllUser.jsp


    <%@ page language="java" pageEncoding="UTF-8"%>
    已移除所有用戶

 

spring.xml里面的文件配置


    xmlns:cache="http://www.springframework.org/schema/cache"
    http://www.springframework.org/schema/cache/spring-cache-3.2.xsd
     
     
    <!-- 啟用緩存注解功能,這個是必須的,否則注解不會生效,另外,該注解一定要聲明在spring主配置文件中才會生效 -->
    <cache:annotation-driven cache-manager="cacheManager" />
    <!-- spring自己的換管理器,這里定義了兩個緩存位置名稱 ,既注解中的value -->
    <bean id="cacheManager" class="org.springframework.cache.support.SimpleCacheManager">
    <property name="caches">
    <set>
    <bean
    class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean"
    p:name="default" />
    <bean
    class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean"
    p:name="config" />
    <bean
    class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean"
    p:name="folder" />
    <bean
    class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean"
    p:name="acticle" />
    <bean
    class="org.springframework.cache.concurrent.ConcurrentMapCacheFactoryBean"
    p:name="attachment" />
    </set>
    </property>
    </bean>


 

測試時,訪問index.jsp之后點擊各個鏈接并依次觀察控制臺輸出即可
緩存有效果的特征是:第二次查詢數(shù)據(jù)時不會訪問數(shù)據(jù)庫(即不打印日志)

 




作者:chen.yu
深信服三年半工作經驗,目前就職游戲廠商,希望能和大家交流和學習,
微信公眾號:編程入門到禿頭 或掃描下面二維碼
零基礎入門進階人工智能(鏈接)