# spring-boot-cache

**Repository Path**: caychen/spring-boot-cache

## Basic Information

- **Project Name**: spring-boot-cache
- **Description**: No description available
- **Primary Language**: Java
- **License**: Not specified
- **Default Branch**: master
- **Homepage**: None
- **GVP Project**: No

## Statistics

- **Stars**: 1
- **Forks**: 0
- **Created**: 2018-04-04
- **Last Updated**: 2020-12-19

## Categories & Tags

**Categories**: Uncategorized

**Tags**: None

## README

## 1、引入Cache依赖
```xml
<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-cache</artifactId>
</dependency>
```

## 2、添加@EnableCaching注解开启缓存功能

## 3、数据访问接口中，添加缓存配置注解
```java
@CacheConfig(cacheNames = "person")
// 如果在@Cacheable中添加cacheNames或者value属性，则可以省略该注解；
// 如果在@Cacheable中未添加cacheNames或者value属性，则必须在@CacheConfig中指定cacheNames或者value属性
public interface IPersonRepository extends JpaRepository<Person, Integer>, JpaSpecificationExecutor<Person>{

    @Cacheable(key = "#p0")//#p0表示函数的第一个参数
    Person findPersonByName(String name);
}
```

## 4、Cache注解详解
* **@CacheConfig**：主要用于配置该类中会用到的一些共用的缓存配置。在本例中@CacheConfig(cacheNames = "users")：
    配置了该数据访问对象中返回的内容将存储于名为users的缓存对象中，我们也可以不使用该注解，直接通过@Cacheable自己配置缓存集的名字来定义。

* **@Cacheable**：配置了findByName函数的返回值将被加入缓存。同时在查询时，会先从缓存中获取，若不存在才再发起对数据库的访问。该注解主要有下面几个参数：
    * **value、cacheNames**：两个等同的参数（cacheNames为Spring 4新增，作为value的别名），用于指定缓存存储的集合名。
    由于Spring 4中新增了@CacheConfig，因此在Spring 3中原本必须有的value属性，也成为非必需项了；

    * **key**：缓存对象存储在Map集合中的key值，非必需，缺省按照函数的所有参数组合作为key值，若自己配置需使用SpEL表达式，
    比如：@Cacheable(key = "#p0")：使用函数第一个参数作为缓存的key值，更多关于SpEL表达式的详细内容可参考官方文档；

    * **condition**：缓存对象的条件，非必需，也需使用SpEL表达式，只有满足表达式条件的内容才会被缓存，
    比如：@Cacheable(key = "#p0", condition = "#p0.length() < 3")，表示只有当第一个参数的长度小于3的时候才会被缓存，若做此配置上面的AAA用户就不会被缓存；

    * **unless**：另外一个缓存条件参数，非必需，需使用SpEL表达式。它不同于condition参数的地方在于它的判断时机，该条件是在函数被调用之后才做判断的，所以它可以通过对result进行判断。

    * **keyGenerator**：用于指定key生成器，非必需。若需要指定一个自定义的key生成器，我们需要去实现org.springframework.cache.interceptor.KeyGenerator接口，并使用该参数来指定。
        需要注意的是：该参数与key是互斥的；

    * **cacheManager**：用于指定使用哪个缓存管理器，非必需。只有当有多个时才需要使用；

    * **cacheResolver**：用于指定使用那个缓存解析器，非必需。需通过org.springframework.cache.interceptor.CacheResolver接口来实现自己的缓存解析器，并用该参数指定。

* **@CachePut**：配置于函数上，能够根据参数定义条件来进行缓存，它与@Cacheable不同的是，它每次都会真实调用函数，所以主要用于数据新增和修改操作上。它的参数与@Cacheable类似，具体功能可参考上面对@Cacheable参数的解析

* **@CacheEvict**：配置于函数上，通常用在删除方法上，用来从缓存中移除相应数据。除了同@Cacheable一样的参数之外，它还有下面两个参数：
    * **allEntries**：非必需，默认为false。当为true时，会移除所有数据
    * **beforeInvocation**：非必需，默认为false，会在调用方法之后移除数据。当为true时，会在调用方法之前移除数据。
    
    
## 5、使用Ehcache缓存
### 5.1、添加Ehcache依赖
```xml
<dependency>
    <groupId>net.sf.ehcache</groupId>
    <artifactId>ehcache</artifactId>
</dependency>
```
### 5.2、加入ehcache.xml配置文件
在src/main/resources目录下创建：**ehcache.xml**，加入配置信息

### 5.3、全局配置文件中添加配置信息（可以不写）
```properties
#ehcache配置文件路径
spring.cache.ehcache.config=
#cache类型
spring.cache.type=
```

<br/>  

------ 
#### 插入一波广告，欢迎关注
|**#**|**#**|
|:--|:--:|
|**作者:**|**Cay**|
|**QQ:**|<a target="_blank" href="http://wpa.qq.com/msgrd?v=3&uin=412425870&site=qq&menu=yes"><img border="0" src="http://wpa.qq.com/pa?p=2:412425870:41" alt="点击这里给我发消息" title="412425870"/></a>|
|**邮箱:**|**412425870@qq.com**|
|**微信公众号：Cay课堂**|**![](https://github.com/caychen/readme/raw/master/img/%E5%BE%AE%E4%BF%A1%E5%85%AC%E4%BC%97%E5%8F%B7.jpg)**|
|**csdn博客：**|**[http://blog.csdn.net/caychen](http://blog.csdn.net/caychen "我的csdn博客")**|
|**码云：**|**[https://gitee.com/caychen/](https://gitee.com/caychen/ "我的码云")**|
|**github：**|**[https://github.com/caychen](https://gitee.com/caychen/ "我的github")**|
|**点击群号或者扫描二维码即可加入QQ群:[328243383(1群)](https://jq.qq.com/?_wv=1027&k=54r3suD)**|**![](https://github.com/caychen/readme/raw/master/img/1%E7%BE%A4.png)**|
|**点击群号或者扫描二维码即可加入QQ群:[180479701(2群)](https://jq.qq.com/?_wv=1027&k=521g7zY)**|**![](https://github.com/caychen/readme/raw/master/img/2%E7%BE%A4.png)**|