spring aop实现注解式缓存

    场景：根据键到缓存中取数据，缓存中没有则从数据库获取，获取后又存进缓存，于是：

   private CacheClient cacheClient;
   ……
   public String bindInfo(String organCode, Long userId) {
        String cacheKey = ……;
        String cacheData = (String) cacheClient.get(cacheKey);
        if (cacheData != null) {
            return cacheData;
        } else {
            ……
            String data = sessionTemplate.selectOne(……, ……);
            if (data != null) {
                cacheClient.set(cacheKey, data);
            }
            return data;
        }
    }

上述代码很常见，写到烦。

懒人懒招：

        1、自定义缓存与清除缓存注解

        2、mvel合成cacheKey

一、缓存注解与aop

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface CacheConfig {
    String template() default "";//缓存键值模板
    String[] expression() default {};//获取缓存键值表达式
    int expires() default -1;//过期时间
}

@Component
@Aspect
public class CacheConfigAspect {
    private static final Logger logger = LoggerFactory.getLogger(CacheConfigAspect.class);
    @Autowired
    private CacheClient cacheClient;
    private static CacheMap<String, Class> returnTypeCache = new LFUCache<String, Class>(1000, 2 * 60 * 1000);
    @Pointcut(value = "@annotation(com.yiwuliu.cache.annotations.CacheConfig) && @annotation(cacheConfig)")
    public void cacheConfigAspect(CacheConfig cacheConfig) {
    }
    @Around(value = "cacheConfigAspect(cacheConfig)")
    public Object needCacheAround(ProceedingJoinPoint joinPoint, CacheConfig cacheConfig) {
        Object data = null;
        try {
            String template = cacheConfig.template();
            String[] expressions = cacheConfig.expression();
            Object[] params = joinPoint.getArgs();
            String cacheKey = AssembleUtil.assembleCacheKey(template, expressions, params);
            Class clazz = returnTypeCache.get(joinPoint.toLongString());
            if (!Strings.isNullOrEmpty(cacheKey) && null != clazz) {
                data = getDataFromCache(clazz, cacheKey);
            }
            if (null == data) {
                data = getDataFromDB(joinPoint, cacheConfig, cacheKey);
            }
        } catch (Throwable e) {
            logger.error("{} failed to get info from cache in result of {}", joinPoint.getSignature().toLongString(),
                         e.toString());
        }
        return data;
    }
}

二、缓存清除注解与aop

@Retention(RetentionPolicy.RUNTIME)
@Target({ElementType.METHOD})
@Documented
public @interface CacheClear {
    String template() default "";//缓存键值模板
    String[] expressions() default {};//获取缓存键值表达式
}

@Component
@Aspect
public class CacheClearAspect {
    private static final Logger logger = LoggerFactory.getLogger(CacheClearAspect.class);
    @Autowired
    private CacheClient cacheClient;
    @Pointcut(value = "@annotation(com.yiwuliu.cache.annotations.CacheClear) && @annotation(cacheClear)")
    public void cacheClearAspect(CacheClear cacheClear) {
    }
    @Around(value = "cacheClearAspect(cacheClear)")
    public Object clearAspect(ProceedingJoinPoint joinPoint, CacheClear cacheClear) {
        Object result = null;
        try {
            String template = cacheClear.template();
            String[] expressions = cacheClear.expressions();
            Object[] params = joinPoint.getArgs();
            result = joinPoint.proceed(params);
            String cacheKey = AssembleUtil.assembleCacheKey(template, expressions, params);
            cacheClient.delete(cacheKey);
            logger.debug("CacheClearsAspect Remove From Cache : {}", cacheKey);
        } catch (Throwable throwable) {
            throwable.printStackTrace();
        }
        return result;
    }
}

三、AssembleUtil合成CacheKey

public final class AssembleUtil {
    private static final String SEPARATOR = ":";
    public static List<String> assembleCacheKeys(String[] templates, String[] expressions,
                                                 Object[] params) throws Exception {
        List<java.lang.String> cacheKeys = Lists.newArrayList();
        expressions = templateValues(expressions, params);
        for (java.lang.String template : templates) {
            cacheKeys.add(MessageFormat.format(template, expressions));
        }
        return cacheKeys;
    }
    public static String assembleCacheKey(String template, String[] expressions, Object[] params) throws Exception {
        return MessageFormat.format(template, templateValues(expressions, params));
    }
    private static String[] templateValues(String[] expressions, Object[] params) {
        for (int i = 0; i < expressions.length; i++) {
            java.lang.String[] split = expressions[i].split(SEPARATOR);
            int argsIndex = Integer.parseInt(split[0]) - 1;
            if (split.length == 1) {
                expressions[i] = java.lang.String.valueOf(params[argsIndex]);
            } else {
                expressions[i] = java.lang.String.valueOf(MVEL.eval(split[1], params[argsIndex]));
            }
        }
        return expressions;
    }
}

四、怎么用？？？

1、spring文件中加入aop:aspect-autoproxy配置，依赖org.aspectj:aspectjweaver、org.aspectj:aspectjrt 

<aop:aspectj-autoproxy expose-proxy="true"/>

2、给需要缓存结果的方法加注解

@CacheConfig(template = "phone:bind:{0}:{1}", expression = {"1", "2"})
public OpenUserModel bindInfo(String organCode, Long userId) {
    Map<String, Object> params = Maps.newHashMap();
    params.put(ParamsKey.ORGAN_CODE, organCode);
    params.put(ParamsKey.USER_ID, userId);
    return sessionTemplate.selectOne("phone.bind.bindInfo", params);
}

3、给需要清除缓存的方法加注解

@CacheClear(template = "phone:bind:{0}:{1}", expressions = {"1:organCode", "1:userId"})
public void bind(OpenUserModel openUserModel) {
    sessionTemplate.insert(……, ……);
}

---

纯粹小白，欢迎路过大神指正！