wxiaoqi / ace-cache

基于spring boot上的注解缓存，自带轻量级缓存管理页面。@Cache比spring cache更轻量的缓存，支持单个缓存设置过期时间，可以根据前缀移除缓存。采用fastjson序列化与反序列化，以json串存于缓存之中。ace-cache可以快速用于日常的spring boot应用之中。

ace-cache

基于spring boot上的注解缓存，自带轻量级缓存管理页面。
@Cache比spring cache更轻量的缓存，支持单个缓存设置过期时间，可以根据前缀移除缓存。
采用fastjson序列化与反序列化，以json串存于缓存之中。
ace-cache可以快速用于日常的spring boot应用之中。

使用手册

Maven依赖

<dependency>
    <groupId>com.github.wxiaoqi</groupId>
    <artifactId>ace-cache</artifactId>
    <version>1.0.0</version>
</dependency>

缓存配置

1、配置redis数据源，application.yml文件

# 1.0.0版本推荐使用spring redis配置
spring:
  redis:
    database: 0
    host: localhost
    timeout: 2000
    sysName: ace #默认key前缀
    enable: true #是否启用ace-cache
    userkey: #用户会话的标志，存放于cookie或request header 
    lettuce:
      pool:
        max-active: 300
        min-idle: 100
        max-wait: 1000

# 不建议使用配置，此配置在0.0.2以下版本使用
redis:
    pool:
         maxActive: 300
         maxIdle: 100
         maxWait: 1000
    host: 127.0.0.1
    port: 6379
    password:
    timeout: 2000
    # 服务或应用名
    sysName: ace
    enable: true
    database: 0

缓存开启

2、开启AOP扫描

@EnableAceCache

缓存使用

3、在Service上进行@Cache注解或@CacheClear注解

注解说明

配置缓存：@Cache

注解参数	类型	说明
key	字符串	缓存表达式，动态运算出key
expires	整形	缓存时长，单位：分钟
desc	描述	缓存说明
scope	枚举	缓存作用范围，会话级还是应用级
parser	Class<? extends ICacheResultParser>	缓存返回结果自定义处理类
generator	Class<? extends IKeyGenerator>	缓存键值自定义生成类
result	Class[]	缓存返回结果自定义类型，默认取第一位

清除缓存：@CacheClear

注解参数	类型	说明
pre	字符串	清除某些前缀key缓存
key	字符串	清除某个key缓存
keys	字符串数组	清除某些前缀key缓存
generator	Class<? extends IKeyGenerator>	缓存键值自定义生成类

全局分布式锁：@CacheGlobalLock

注解参数	类型	说明
key	字符串	分布式做key表达式
retry	整形	重试加锁间隔时间，单位ms
waitLock	布尔型	是否一直等待全局锁？ 默认为否，获取不到锁则不执行程序。
generator	Class<? extends IKeyGenerator>	缓存键值自定义生成类

默认key动态表达式说明

表达式举例	说明	举例
@Cache(key="user:{1}") public User getUserByAccount(String account)	{1}表示获取第一个参数值 {2}表示获取第二个参数值 ……依此类推	若：account = ace，则：key = user:ace
@CacheClear(pre="user{1.account}") User saveOrUpdate(User user)	{1}表示获取第一个参数值 {1.xx}表示获取第一个参数中的xxx属性	若：account=ace，则：key = user:ace

轻量管理端

访问地址：http://localhost:8080/cache
管理端批量或前缀清除ace-cache注册的缓存，同时也可以快速预览缓存的数据内容，也可以对缓存的失效时间进行延长。

Demo

1、在src/main/test中展开的相关示例代码

CacheTest是核心启动类

service包是缓存调用例子，包含自定义表达式和结果解析、注解的使用

2017年5月22日

初次与大家见面，请多多指教！

2017年5月23日 兼容spring mvc模式

配置文文件

application.properties

redis.pool.maxActive = 300
redis.pool.maxIdle = 100
redis.pool.maxWait = 1000
redis.host = 127.0.0.1
redis.port = 6379
redis.password = 
redis.timeout = 2000
redis.database = 0
redis.sysName = ace
redis.enable = true

applicationContext.xml

<!-- beans 头部-->
xmlns:aop="http://www.springframework.org/schema/aop"
xmlns:context="http://www.springframework.org/schema/context"
xsi:schemaLocation="
	http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.1.xsd
	http://www.springframework.org/schema/context  
	http://www.springframework.org/schema/context/spring-context-3.0.xsd"	
<!-- 开启AOP配置 -->	
<aop:aspectj-autoproxy></aop:aspectj-autoproxy>
<context:component-scan base-package="com.ace.cache"/>
<context:annotation-config/> 

maven依赖

<properties>
    <!-- spring -->
    <spring.version>4.1.3.RELEASE</spring.version>
<properties>
<dependencies>
    <dependency>
    	<groupId>org.springframework</groupId>
    	<artifactId>spring-core</artifactId>
    	<version>${spring.version}</version>
    </dependency>
    <dependency>
    	<groupId>org.springframework</groupId>
    	<artifactId>spring-beans</artifactId>
    	<version>${spring.version}</version>
    </dependency>
    <dependency>
    	<groupId>org.springframework</groupId>
    	<artifactId>spring-context</artifactId>
    	<version>${spring.version}</version>
    </dependency>
    <dependency>
    	<groupId>org.springframework</groupId>
    	<artifactId>spring-context-support</artifactId>
    	<version>${spring.version}</version>
    </dependency>
    <dependency>
    	<groupId>org.springframework</groupId>
    	<artifactId>spring-aspects</artifactId>
    	<version>${spring.version}</version>
    </dependency>
    <dependency>
    	<groupId>org.springframework</groupId>
    	<artifactId>spring-webmvc</artifactId>
    	<version>${spring.version}</version>
    </dependency>
    <dependency>
    	<groupId>org.aspectj</groupId>
    	<artifactId>aspectjrt</artifactId>
    	<version>${aspectj.version}</version>
    </dependency>
</dependencies>

使用方式

使用方式与spring boot的方式一样，在方法上直接注解即可。

ace-cache's Issues

你的源码可以把log4j改成slf4j么？

我项目是logback，不想说再引入一个log4j

@CacheGlobalLock 并发锁问题

在并发状态下 可以同时进入

启动后，访问localhost:8080/cache

怎么无法跳到index.html页面呢~ 😓

希望支持web管理端账号密码配置

希望支持web管理端账号密码配置，进入web管理端时，输入账号密码验证

返回值类型为String时能缓存但无法读取缓存

返回值类型为String时能缓存但无法读取缓存，现象是Redis有缓存的内容，但是每次还会走进缓存的方法中，返回值类型换成JSONObject后可以读取到了

1.0版本没上maven吗? 找不到

1.0版本没上maven吗? 找不到

database设置没有生效的问题

按照使用说明在项目里配置redis参数

#redis-cache 相关
redis:
    pool:
         maxActive: 300
         maxIdle: 100
         maxWait: 1000
    host: 127.0.0.1
    port: 6379
    password:
    timeout: 2000
    # 服务或应用名
    sysName: ace
    enable: true
    database: 0

问题：将 database: 0 改为 database: 1，或者 database: 2，均不生效，使用的还是 database: 0？
分析：定位到问题点为 RedisConfig.java 类

@Bean(name = "pool")
public JedisPool constructJedisPool() {
    String ip = this.host;
    int port = Integer.parseInt(this.port);
    String password = this.password;
    int timeout = Integer.parseInt(this.timeout);
    int database = Integer.parseInt(this.database);
    if (null == pool) {
        if (StringUtils.isBlank(password)) {
            pool = new JedisPool(constructJedisPoolConfig(), ip, port, timeout);
        } else {
            pool = new JedisPool(constructJedisPoolConfig(), ip, port, timeout, password, database);
        }
    }
    return pool;
}

当password为空时，

pool = new JedisPool(constructJedisPoolConfig(), ip, port, timeout);

此时 database 的参数未使用。

查看 JedisPool 构造函数发现：

public JedisPool(GenericObjectPoolConfig poolConfig, String host, int port, int timeout) {
    this(poolConfig, host, port, timeout, (String)null, 0, (String)null);
}

public JedisPool(GenericObjectPoolConfig poolConfig, String host, int port, int timeout, String password, int database, String clientName) {
    this(poolConfig, host, port, timeout, timeout, password, database, clientName, false, (SSLSocketFactory)null, (SSLParameters)null, (HostnameVerifier)null);
}

使用的database为0。

解决：建议将

pool = new JedisPool(constructJedisPoolConfig(), ip, port, timeout);

修改为

pool = new JedisPool(constructJedisPoolConfig(), ip, port, timeout, (String)null, database);

调整后的函数为：

@Bean(name = "pool")
public JedisPool constructJedisPool() {
    String ip = this.host;
    int port = Integer.parseInt(this.port);
    String password = this.password;
    int timeout = Integer.parseInt(this.timeout);
    int database = Integer.parseInt(this.database);
    if (null == pool) {
        if (StringUtils.isBlank(password)) {
            pool = new JedisPool(constructJedisPoolConfig(), ip, port, timeout, (String)null, database);
        } else {
            pool = new JedisPool(constructJedisPoolConfig(), ip, port, timeout, password, database);
        }
    }
    return pool;
}

添加redis配置信息（非127.0.0.1）后，启动项目后获取的还是本机的redis服务

添加redis配置信息（非127.0.0.1）后，启动项目后获取的还是本机的redis服务

因为是aop的，跨类是可以的，如果跨类，用自己 的方法是不能触发aop的

有解决办法吗？

当传入的参数为Object类型的时候可以优化一下

DefaultKeyGenerator类中
if (parameterTypes[index].isAssignableFrom(List.class))
可以优化为
if (!(parameterTypes[index] instanceof Object) && parameterTypes[index].isAssignableFrom(List.class))

发现一个bug。返回类型是string时，会解析出错。

跟踪了代码。当缓存的value是string是由于fastjson的转义解析json会出错，造成缓存失效。

问个问题

这个cache 是否处理 缓存击穿

这个库挺好的，就是maven搜不到，安装不了，可惜了

这个库挺好的，就是maven搜不到，安装不了，可惜了，希望作者上maven

目前发现一个问题，关于返回值是Object或父类问题

我的项目创建了几个ResponseResultVo，Base包含了一些基本的错误信息，错误码，数据等，新建一个PageResponseResultVo继承了它包含了分页信息，这个时候使用BaseResponseResultVo作为方法返回值生成缓存没问题，但是缓存生效后无法转为PageResponseResultVo，分页信息丢失，原因就是json转换时不能使用方法原来的返回值作为对象转换而是使用了方法标注的返回值转换。希望能改善下这个问题，包括支持范型等问题。

你好，请问使用@cache（key），那么value值是多少