# redis-cache-expire-spring-boot-starter-parent

**Repository Path**: luhan123/redis-cache-expire-spring-boot-starter-parent

## Basic Information

- **Project Name**: redis-cache-expire-spring-boot-starter-parent
- **Description**: 一个注解@CacheExpire搞定方法级别的过期时间设置，使用redis作为spring cache组件
- **Primary Language**: Java
- **License**: Apache-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 3
- **Forks**: 2
- **Created**: 2021-03-18
- **Last Updated**: 2022-05-12

## Categories & Tags

**Categories**: cache-modules

**Tags**: None

## README

# redis-cache-expire-spring-boot-starter-parent

[English](README.en.md)

#### 介绍
当使用`redis`作为`spring cache`组件时，使用注解`@CacheExpire`支持**自定义过期时间**

1. 支持**方法级别**设置过期时间
2. 支持在类上添加注解，该类下的缓存方法通用过期时间
3. 支持忽略功能

#### 软件架构
在`spring-boot-starter-data-redis`基础上改变了`RedisCacheManager`其`getCache`原始行为
在其基础上添加设置自定义过期时间的功能

#### 使用说明
因为`redis-cache-expire-spring-boot-starter`并没有集成`spring-boot-starter-data-redis`所以需要
手动引入依赖
> 主要是为了方便使用各自的`spring-boot-starter-data-redis`版本

1.  引入`spring-boot-starter-data-redis`依赖
~~~xml
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>
~~~
2.  引入本starter依赖
~~~xml
<dependency>
    <groupId>top.luhancc.redis</groupId>
    <artifactId>redis-cache-expire-spring-boot-starter</artifactId>
</dependency>
~~~
> 还没有放到maven中央仓库

3.  和使用`spring cache`一样 使用`@EnableCaching`开启缓存即可
~~~java
@SpringBootApplication
@EnableCaching
public class RedisCacheExpireApplication {
    public static void main(String[] args) {
        SpringApplication.run(RedisCacheExpireApplication.class, args);
    }
}
~~~
4. **在需要添加缓存过期时间的方法上添加`@CacheExpire`注解**

#### 示例代码
方法级别
~~~java
@Service
public class CacheService {
    @Cacheable(value = "cache-test", key = "targetClass + methodName")
    @CacheExpire(value = 100)
    public String data() {
        System.out.println("没走缓存,直接查询");
        return "hello this data is redis cache";
    }
    @Cacheable(value = "cache-test", key = "targetClass + methodName")
    public String data2() {
        System.out.println("没走缓存,直接查询");
        return "hello this data is redis cache is not expire";
    }
}
~~~
类级别
~~~java
@CacheExpire
@Cacheable(value = "cache-test2", key = "targetClass + methodName")
@Service
public class CacheService2 {
    public String data4() {
        return "this is cache data 2";
    }
    @CacheExpire(value = 10, ignore = true)
    public String data3() {
        return "this is cache data 3";
    }
}
~~~

#### 参与贡献

1.  Fork 本仓库
2.  新建 feature/xxx 分支
3.  提交代码
4.  新建 Pull Request