基于注解的方法缓存

在web项目中, 查询数据库非常耗时耗资源, 所以, 对于同一方法相同参数的请求, 应该保存到缓存中, 而不是每次都去查数据库, 方法的返回值可以保存到Mongodb或redis中

具体实现:

@MethodCache注解

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
public @interface MethodCache {

/**
 * 指定缓存的过期时间, 默认60秒
 *
 * @return int
 */
int expireSeconds() default 60;

/**
 * 缓存的key, 如果不指定, 默认按照方法的签名作为key
 *
 * @return String
 */
String key() default "";

/**
 * 缓存防击穿的标志, 默认是开启防击穿功能
 *
 * @return boolean
 */
boolean limitQuery() default true;

/**
 * 防击穿的时限
 *
 * @return int
 */
int limitQuerySeconds() default 5;

/**
 * 是否保存空的结果
 *
 * @return boolean
 */
boolean saveEmptyResult() default true;

}
MethodCacheAspect切面

该切面的核心思想就是用方法的签名+实参对象的哈希值作为key, 先从缓存中取, 取不到再调用具体方法去查询, 查询结果后保存到缓存中, 其中可以设置一次只能有一个线程去查, 还可以设置重试次数, 还可以设置是否保存空结果

@Aspect
@Order(value = 2)
@Component
public class MethodCacheAspect {

@Resource
private JedisPool jedisPool;

@Resource
private DisLockUtil disLockUtil;

private static final Logger LOGGER = LoggerFactory.getLogger(MethodCacheAspect.class);

private static final String EMPTY_RESULT = "NULL";

/**
 * 切面具体的操作
 *
 * @param proceedingJoinPoint 切面
 * @param methodCache         注解
 * @return Object
 * @throws Throwable 抛出异常
 */
@Around("@annotation(methodCache)")
public Object execute(ProceedingJoinPoint proceedingJoinPoint, MethodCache methodCache) throws Throwable {
    MethodSignature methodSignature = (MethodSignature) proceedingJoinPoint.getSignature();
    Method method = methodSignature.getMethod();

    // 方法参数解析
    int size = proceedingJoinPoint.getArgs().length;
    // 解析请求参数
    List<Object> list = parseRequestParam(proceedingJoinPoint, size);
    // 根据方法获取相应的key
    String key = methodCache.key();
    if (StringUtils.isBlank(key)) {
        key = getSignature(method);
    }
    key += HashAlgorithms.mixHash(JSON.toJSONString(list));
    Object deserialize = tryGetFromCache(key);
    if (deserialize != null) {
        // 防止缓存击穿, 查询不到数据时也会设置空结果的标记, 避免直接把压力落到DB上
        if (EMPTY_RESULT.equals(deserialize)) {
            return null;
        }
        return deserialize;
    }
    Object proceed;
    String mutexKey = "mutex_" + key;
    if (methodCache.limitQuery()) {
        boolean lock = disLockUtil.lock(mutexKey, methodCache.limitQuerySeconds());
        // 如果第一次设置分布式锁失败, 最多允许重试三次
        int count = 1;
        while (!lock && count < 3) {
            lock = disLockUtil.lock(mutexKey, methodCache.limitQuerySeconds());
            count++;
            TimeUnit.SECONDS.sleep(1);
        }
        if (lock) {
            // 允许查询
            proceed = executeConcreteMethod(proceedingJoinPoint, mutexKey);
            Object cacheResult = proceed;
            // 缓存中不存在, 需要执行方法查询
            if (cacheResult == null) {
                cacheResult = EMPTY_RESULT;
            }
            try (Jedis jedis = jedisPool.getResource()) {
                jedis.setnx(key.getBytes(), KryoUtil.writeToByteArray(cacheResult));
                jedis.expire(key, methodCache.expireSeconds());
            }
        } else {
            LOGGER.warn("设置防击穿锁失败, key为:{}", mutexKey);
            throw new CustomException(ErrorCodeEnum.DUPLICATE_REQUEST.getMessage());
        }
    } else {
        // 允许查询
        proceed = executeConcreteMethod(proceedingJoinPoint, mutexKey);
    }
    return proceed;
}

/**
 * 执行具体的方法
 *
 * @param proceedingJoinPoint 切面
 * @return Object
 * @throws Throwable 异常
 */
private Object executeConcreteMethod(ProceedingJoinPoint proceedingJoinPoint, String mutexKey) throws Throwable {
    Object proceed;
    try {
        proceed = proceedingJoinPoint.proceed();
    } finally {
        disLockUtil.unlock(mutexKey, false);
    }
    return proceed;
}

/**
 * 尝试从缓存中获取
 *
 * @param key key
 * @return Object
 */
private Object tryGetFromCache(String key) {
    byte[] resultBytes;
    try (Jedis jedis = jedisPool.getResource()) {
        if (!jedis.exists(key)) {
            return null;
        }
        resultBytes = jedis.get(key.getBytes());
    }
    if (resultBytes != null) {
        LOGGER.info("key:{}获取到缓存", key);
        return KryoUtil.readFromByteArray(resultBytes);
    }
    return null;
}

/**
 * 解析请求参数
 *
 * @param proceedingJoinPoint 切面
 * @param size 参数个数
 * @return List<Object>
 */
private List<Object> parseRequestParam(ProceedingJoinPoint proceedingJoinPoint, int size) {
    Object[] args = proceedingJoinPoint.getArgs();
    List<Object> argList = new ArrayList<>();
    for (int i = 0; i < size; i++) {
        if (args[i] instanceof HttpServletRequest) {
            HttpServletRequest request = (HttpServletRequest) args[i];
            argList.add(request.getParameterMap());
        } else if (args[i] instanceof HttpServletResponse || args[i] instanceof HttpSession
                || args[i] instanceof HttpCookie) {
            continue;
        } else {
            argList.add(args[i]);
        }
    }
    return argList;
}

/**
 * 生成方法签名
 *
 * @param method 方法
 * @return String
 */
private String getSignature(Method method) {
    StringBuilder sb = new StringBuilder();
    String methodName = method.getName();
    if (StringUtils.isNotBlank(methodName)) {
        sb.append(method).append("#");
    }
    return sb.toString();
}

}

©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 155,704评论 4 358
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 66,084评论 1 286
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 105,560评论 0 237
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 43,360评论 0 201
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 51,686评论 3 285
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 40,150评论 1 204
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 31,528评论 2 306
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 30,256评论 0 193
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 33,878评论 1 235
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 30,215评论 2 239
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 31,757评论 1 255
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 28,121评论 2 249
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 32,659评论 3 228
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 25,932评论 0 8
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 26,638评论 0 191
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 35,159评论 2 263
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 35,112评论 2 258

推荐阅读更多精彩内容