Spring Cache 系列 & 0x01 开篇

Spring Cache 系列 & 0x01 开篇
Spring Cache 系列 & 0x02 组件
Spring Cache 系列 & 0x03 注解

Spring 缓存对现存的缓存框架做了进一步封装，使得接入和使用第三方缓存框架更加简便，同时可以实现自定义缓存。

接下来会参考 Spring Framework(4.3.16.RELEASE) 源码来介绍 Spring Cache。

Spring Cache Mode

  • Proxy
  • AspectJ

如果不理解介绍的这两种模式，可以去了解一下 Spring Aop。

这里为什么会提到 AOP 呢？不是在讲 Cache 吗？

进入正题......

Spring 如何实现缓存的？

传统实现方式
public class ExampleService {
    @Autowire
    private Cache cache;
    @Autowire
    private ExampleDao exampleDao;

    public List<T> getResult() {
        List<T> result = cache.get("cache-key");
        if (result == null) {
            result = exampleDao.getResult();
            cache.put("cache-key", result);
        }
        return result;
    }
}

相信上面的伪代码大家都能理解吧；
ExampleService#getResult方法先去缓存中取数据，如果缓存中没有，查询数据库，并且把查询结果放到缓存中。

如果业务中使用缓存的地方很多的话，每次都会getCache、putCache是不是会让你觉得不是很舒服。不但这些代码完全和业务没有关系，而且还破坏面向对象 - 单一原则。

我们知道 java 有三大特性：封装、继承、多态。是不是可以考虑把getCache、putCache的部分封装起来，提供公共服务，避免业务中充斥着无关的代码。

Spring 实现方式

Spring Cache 要做的就是，把和业务无关的getCache、putCache代码封装成更简便的服务。

在看一下上面提到的伪代码ExampleService#getResult()，如果要封装，该如何封装？

一点一点分解代码.....

  • 方式一

我们上面讲过了，侵入代码的方式

  • 方式二

组合；也可以看作静态代理

业务代码

import java.util.List;

public interface ExampleService {
    <T> List<T> getResult();
}

import org.springframework.stereotype.Component;

import java.util.List;

@Component("ExampleServiceImpl")
public class ExampleServiceImpl implements ExampleService {

    @Override
    public <T> List<T> getResult() {
        return null;
    }
}
  1. 创建一个接口 ExampleService，只有一个方法
  2. 创建ExampleServiceImpl 去实现 ExampleService 
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.cache.Cache;
import org.springframework.context.annotation.Primary;
import org.springframework.stereotype.Component;

import java.util.List;

@Primary
@Component
public class ExampleProxyService implements ExampleService {

    @Autowired
    @Qualifier("ExampleServiceImpl")
    private ExampleService exampleService;

    @Autowired
    private Cache cache;

    @Override
    public <T> List<T> getResult() {
        Cache.ValueWrapper key = cache.get("key");
        if (key.get() == null) {
            List<Object> result = exampleService.getResult();
            cache.put("key", result);
        }
        return (List<T>) key.get();
    }
}
  1. 重新建一个实现类
  2. 原来侵入代码的部分，放到这了代理类里；这种方式可以自由的注入ExampleService
  3. 如果一个类里要使用缓存，都需要建立这样一个代理类，不但增加了开发成本，还带来维护难；这种方式也不是最佳方案。

但是通过这种方式，我们是不是可以联想到使用动态代理（dynamic proxy）的方式来做。

  • 方式三

代理

** 创建代理入口 **

import com.keng.spring.cache.proxy.aop.advisor.CacheAdvisor;
import org.springframework.aop.framework.ProxyFactoryBean;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;

public class CacheBeanPostProcessor implements BeanPostProcessor {

    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        Class<?> clazz = bean.getClass();
        Class<?>[] interfaces = clazz.getInterfaces();
        ProxyFactoryBean proxyFactoryBean = new ProxyFactoryBean();
        proxyFactoryBean.setInterfaces(interfaces);
        proxyFactoryBean.setTarget(bean);
        proxyFactoryBean.addAdvisor(new CacheAdvisor());
        return proxyFactoryBean.getObject();
    }

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        return null;
    }
}

** 增强 **

public class CacheAdvisor implements Advisor {
    @Override
    public Advice getAdvice() {
        return new CacheInterptor();
    }

    @Override
    public boolean isPerInstance() {
        return false;
    }
}

** 通知 **

import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
import org.springframework.cache.Cache;

import java.lang.reflect.Method;

public class CacheInterptor implements MethodInterceptor {

    private Cache cache;

    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        Method method = invocation.getMethod();

        // key 如何获取
        Cache.ValueWrapper valueWrapper = cache.get("key");
        if (valueWrapper == null || valueWrapper.get() == null) {
            return invocation.proceed();
        }
        return valueWrapper.get();
    }

    public Cache getCache() {
        return cache;
    }
}

以上是使用 Spring Aop 实现的一个简易版缓存机制。

  • BeanPostProcessor

该接口会在 Spring 容器初始化完 Bean 调用，我们拿来对初始化后的 Bean 创建代理

  • Advisor

Aop 接口

  • MethodInterceptor

Aop 接口

但是上面有个问题，在类CacheInterptor中注释的地方；我们如何知道当前方法返回值要缓存的 key 呢？

注解，一个很简单的实现方式。

改造最终版......

import java.lang.annotation.*;

@Target({ElementType.METHOD, ElementType.TYPE})
@Retention(RetentionPolicy.RUNTIME)
@Inherited
@Documented
public @interface CacheKey {

    String value();

}

import java.util.List;

public interface ExampleService {
    <T> List<T> getResult();
}

import com.keng.spring.cache.annotation.CacheKey;
import org.springframework.stereotype.Component;

import java.util.List;

@Component("ExampleServiceImpl")
public class ExampleServiceImpl implements ExampleService {

    @Override
    @CacheKey(value = "getResult")
    public <T> List<T> getResult() {
        return null;
    }
}

import com.keng.spring.cache.annotation.CacheKey;
import org.aopalliance.intercept.MethodInterceptor;
import org.aopalliance.intercept.MethodInvocation;
import org.springframework.cache.Cache;

import java.lang.reflect.Method;

public class CacheInterptor implements MethodInterceptor {

    private Cache cache;

    @Override
    public Object invoke(MethodInvocation invocation) throws Throwable {
        Method method = invocation.getMethod();
        CacheKey cacheKey = method.getAnnotation(CacheKey.class);
        if (cacheKey == null) {
            return invocation.proceed();
        }

        Cache.ValueWrapper valueWrapper = cache.get(cacheKey.value());
        if (valueWrapper == null || valueWrapper.get() == null) {
            return invocation.proceed();
        }
        return valueWrapper.get();
    }

    public Cache getCache() {
        return cache;
    }
}

import com.keng.spring.cache.proxy.aop.interceptor.CacheInterptor;
import org.aopalliance.aop.Advice;
import org.springframework.aop.Advisor;

public class CacheAdvisor implements Advisor {
    @Override
    public Advice getAdvice() {
        return new CacheInterptor();
    }

    @Override
    public boolean isPerInstance() {
        return false;
    }
}

import com.keng.spring.cache.proxy.aop.advisor.CacheAdvisor;
import org.springframework.aop.framework.ProxyFactoryBean;
import org.springframework.beans.BeansException;
import org.springframework.beans.factory.config.BeanPostProcessor;

public class CacheBeanPostProcessor implements BeanPostProcessor {

    @Override
    public Object postProcessBeforeInitialization(Object bean, String beanName) throws BeansException {
        Class<?> clazz = bean.getClass();
        Class<?>[] interfaces = clazz.getInterfaces();
        ProxyFactoryBean proxyFactoryBean = new ProxyFactoryBean();
        proxyFactoryBean.setInterfaces(interfaces);
        proxyFactoryBean.setTarget(bean);
        proxyFactoryBean.addAdvisor(new CacheAdvisor());
        return proxyFactoryBean.getObject();
    }

    @Override
    public Object postProcessAfterInitialization(Object bean, String beanName) throws BeansException {
        return null;
    }
}

以上就是 Spring Cache 大致实现方法，上面写这么多还没进入介绍 Spring Cache 就是为了让你对 Spring Cache 有一个基本认识，方便来理解 Spring Cache 的实现方式。

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,271评论 5赞 476
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,275评论 2赞 380
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,151评论 0赞 336
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,550评论 1赞 273
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,553评论 5赞 365
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,559评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,924评论 3赞 395
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,580评论 0赞 257
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,826评论 1赞 297
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,578评论 2赞 320
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,661评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,363评论 4赞 318
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,940评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,926评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,156评论 1赞 259
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 42,872评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,391评论 2赞 342