# sou-cache

**Repository Path**: wxtech/sou-cache

## Basic Information

- **Project Name**: sou-cache
- **Description**: 一个基于Spring实现的的缓存插件，使用简单，能快速提高系统响应能力。
- **Primary Language**: Java
- **License**: GPL-2.0
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 0
- **Forks**: 1
- **Created**: 2023-05-31
- **Last Updated**: 2023-05-31

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

# sou-cache

#### 介绍
sou-cache是基于Spring开发的缓存插件，能动态刷新缓存，快速上手轻松提高系统访问量。
 
#### 软件架构



#### 安装教程

1.    
    引入hutool工具

             <dependency>
                <groupId>cn.hutool</groupId>
                <artifactId>hutool-all</artifactId>
                <version>5.7.3</version>
                <optional>true</optional>
            </dependency>


2.  下载sou-cache-1.0-SNAPSHOT.jar引入项目


#### 使用说明

1.  配置application.properties

| 参数名称                                 | 说明                                                         | 默认值   |
|--------------------------------------|------------------------------------------------------------|-------|
| sou.cache.remote.timeout.add.seconds | 远程缓存最大有效期 =缓存时间+配置时间，单位秒。如：缓存过期时间10秒，则redis的保存时间为60+10=70秒 。| 60    |
| sou.cache.open                       | 是否开启缓存                                                     | false |
| sou.cache.remote                     | 是否开启远程缓存  ,需要容器有redisTemplate的bean                                                 | false |
| spring.application.name              | redis缓存根目录                                                | |


2.  注解配置说明

| 参数名称                                 | 说明                                                         | 默认值   |
|--------------------------------------|------------------------------------------------------------|-------|
| sce | 	缓存秒数 | 0 |
| key                      | 缓存的key                                                    | null|
| refresh | 默认刷新缓存的比例，0-100 过期缓存刷新几率。如：10拿到过期缓存的请求其中10%将会强制去刷新当前缓存key的数据，0代表不允许返回过期缓存| 10|                                              
| nodes | 远程缓存分散存储节点，避免redis集群的情况下热点缓存压垮redis节点,建议 = redis集群节点数| 1|  

3.  使用注解
@SouCache
如下图，使用key保存当前接口，缓存时间10秒

![输入图片说明](imgimage.png)

4.  自己定义刷新策略
实现GlobalRefreshCacheStrategy 的refreshPermission接口
如：

   /**
     * 缓存刷新的策略，
     * @param key
     * @return true 可以去刷新缓存，false 不可以刷新缓存
     */
![输入图片说明](image.png)
#### 流程图
![输入图片说明](%E6%B5%81%E7%A8%8B%E5%9B%BESouCache.drawio%20(1).png)
#### 参与贡献

1.  hongzihao