SpringBoot与缓存

一、JSR107

Java Caching定义了5个核心接口，分别是CachingProvider, CacheManager, Cache, Entry 和 Expiry。

1. CachingProvider定义了创建、配置、获取、管理和控制多个CacheManager。一个应用可以在运行期访问多个CachingProvider。
2. CacheManager定义了创建、配置、获取、管理和控制多个唯一命名的Cache，这些Cache存在于CacheManager的上下文中。一个CacheManager仅被一个CachingProvider所拥有。
3. Cache是一个类似Map的数据结构并临时存储以Key为索引的值。一个Cache仅被一个CacheManager所拥有。
4. Entry是一个存储在Cache中的key-value对。
5. Expiry 每一个存储在Cache中的条目有一个定义的有效期。一旦超过这个时间，条目为过期的状态。一旦过期，条目将不可访问、更新和删除。缓存有效期可以通过ExpiryPolicy设置。
   

二、Spring缓存抽象

Spring从3.1开始定义了org.springframework.cache.Cache
和org.springframework.cache.CacheManager接口来统一不同的缓存技术；
并支持使用JCache（JSR-107）注解简化我们开发；

• Cache接口为缓存的组件规范定义，包含缓存的各种操作集合；

• Cache接口下Spring提供了各种xxxCache的实现；如RedisCache，EhCacheCache , ConcurrentMapCache等；

• 每次调用需要缓存功能的方法时，Spring会检查检查指定参数的指定的目标方法是否已经被调用过；如果有就直接从缓存中获取方法调用后的结果，如果没有就调用方法并缓存结果后返回给用户。下次调用直接从缓存中获取。

• 使用Spring缓存抽象时我们需要关注以下两点；

  1. 确定方法需要被缓存以及他们的缓存策略
  2. 从缓存中读取之前缓存存储的数据
     

三、几个重要概念&缓存注解

Cache	缓存接口，定义缓存操作。实现有：RedisCache、EhCacheCache、ConcurrentMapCache等
CacheManager	缓存管理器，管理各种缓存（Cache）组件
@Cacheable	主要针对方法配置，能够根据方法的请求参数对其结果进行缓存（查询）
@CacheEvict	清空缓存(删除)
@CachePut	保证方法被调用，又希望结果被缓存。（更新）
@EnableCaching	开启基于注解的缓存
keyGenerator	缓存数据时key生成策略
serialize	缓存数据时value序列化策略

Cache SpEL available metadata

四、缓存使用

1. 引入spring-boot-starter-cache模块

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-cacheartifactId>
dependency>

2. @EnableCaching开启缓存

package com.matthew.cache;

import org.mybatis.spring.annotation.MapperScan;
import org.springframework.boot.SpringApplication;
import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.cache.annotation.EnableCaching;

/**
* @Description ：
 * TODO 搭建基本环境
 * TODO 1. 导入数据库文件，创建出department和employee表
 * TODO 2. 创建javaBean封装数据
 * TODO 3. 整合MyBatis操作数据库
 * TODO     1.配置数据源信息
 * TODO     2.使用注解版的MyBatis
 * TODO         1）、@MapperScan指定需要扫描的mapper接口所在的包
 * TODO 二、快速体验缓存
 *          步骤
 *              1. 开启基于注解的缓存
 *              2. 标注缓存注解即可
 *                  @Cacheable
 *                  @CacheEvict
 *                  @CachePut
 *      默认使用的是ConcurrentMapCacheManager==ConcurrentMapCache；将数据保存在ConcurrentMapCache中，
 *      开发中使用缓存中间件；redis、memcached、ehcache；
 *      三、整合redis作为缓存
 *      Redis是一个开源（BSD许可）的，内存中的数据结构存储系统，它可以作数据库、缓存和消息中间件
 *      1. 安装redis，使用docker
 *      2. 引入redis的stater
 *      3. 配置redis
 *      4. 测试缓存
 *          原理：CacheManager==Cache 缓存组件来实际给缓存中存取数据
 *          1）、引入redis的starter、容器中保存的时RedisCacheManager；
 *          2）、RedisCacheManager帮我们创建RedisCache来作为缓存组件；RedisCache通过操作redis缓存数据的。
 *          3）、默认保存数据k-v都是Objects，利用序列化保存；如何保存为json
 *              1.引入了redis的starter，cacheManager变为RedisCacheManager
 *              2.默认创建的RedisCacheManager操作redis的时候使用的是RedisTemplate
 *              3.RedisTemplate是默认使用的jdk的序列化机制
 *          4）、自定义CacheManager
* @Date   2019/6/12 18:55
*/
@MapperScan("com.matthew.cache.mapper")
@EnableCaching
@SpringBootApplication
public class Springboot01CacheApplication {

    public static void main(String[] args) {
        SpringApplication.run(Springboot01CacheApplication.class, args);
    }

}

3. 使用缓存注解

package com.matthew.cache.service;

import com.matthew.cache.bean.Employee;
import com.matthew.cache.mapper.EmployeeMapper;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Qualifier;
import org.springframework.cache.annotation.*;
import org.springframework.stereotype.Service;

/**
 * @Description TODO 缓存举例@Cacheable、@CachePut、@CacheEvict、@Caching、@CacheConfig
 * @Author Matthew
 * @Date 2019/6/12 19:37
 * @Version 1.0
 */
@CacheConfig(cacheNames = "emp")//抽取缓存的公共配置
@Service
public class EmployeeService {
    @Autowired(required = false)//bean为null时防止报错
    EmployeeMapper employeeMapper;

    /**
    * @Description ：将方法的运行结果进行缓存，以后再要相同的数据，直接从缓存中获取，不用调用方法。
     * CacheManager管理多个Cache组件的，对缓存的zhenzhengCRUD操作在Cache组件中，每一个缓存组件有自己唯一一个名字；
     *
     * 原理：
     *  1. 自动配置类：CacheAutoConfiguration
     *  2.
     *  org.springframework.boot.autoconfigure.cache.GenericCacheConfiguration
     *  org.springframework.boot.autoconfigure.cache.JCacheCacheConfiguration
     *  org.springframework.boot.autoconfigure.cache.EhCacheCacheConfiguration
     *  org.springframework.boot.autoconfigure.cache.HazelcastCacheConfiguration
     *  org.springframework.boot.autoconfigure.cache.InfinispanCacheConfiguration
     *  org.springframework.boot.autoconfigure.cache.CouchbaseCacheConfiguration
     *  org.springframework.boot.autoconfigure.cache.RedisCacheConfiguration
     *  org.springframework.boot.autoconfigure.cache.CaffeineCacheConfiguration
     *  org.springframework.boot.autoconfigure.cache.SimpleCacheConfiguration
     *  org.springframework.boot.autoconfigure.cache.NoOpCacheConfiguration
     *  3. 哪个配置类默认生效  SimpleCacheConfiguration
     *  4. 给容器中注册了一个CacheManager，ConcurrentMapCacheManager
     *  5. 可以获取和创建ConcurrentMapCache类型的缓存组件；他的作用将数据保存在ConcurrentMap中；
     *
     *  运行的流程：
     * @Cacheable：
     *  1. 方法运行之前，先去查询Cache（缓存组件），按照cacheNames指定的名字获取；
     *      （CacheManager先获取相应的缓存），第一次获取如果没有Cache组件会自动创建，
     *  2. 去Cache中查找缓存的内容，使用一个key，默认就是方法的参数；
     *      key是按照某一种策略生成的；默认是使用keyGenerator生成的，默认使用SimpleKeyGenerator生产key
     *          SimpleKeyGenerator生产key的默认策略：
     *              如果没有参数；key = new SimpleKey();
     *              如果有一个参数：key = 参数的值
     *              如果有多个参数：key = new SimpleKey(params);
     *  3. 没有查到缓存就调用目标方法
     *  4. 将目标方法返回的结果，放进缓存中
     *
     *  @Cacheable标注的方法执行之前先来检查缓存中有没有这个数据，默认按照参数的值作为key去查询缓存，
     *  如果没有就运行方法将结果放入缓存，以后再来调用就可以直接使用缓存中的数据。
     *
     *  核心：
     *      1. 使用CacheManager【ConcurrentMapCacheManager】按照名字得到Cache组件【ConcurrentMapCache】
     *      2. key使用keyGenerator生成的，默认是SimpleKeyGenerator
     *
     * 几个属性：
     *      cacheName/value：指定缓存的名字；将方法的返回结果放在哪个缓存中，是数组的方式，可以指定多个缓存；
     *      key：缓存数据使用的key；可以用它来指定。默认是使用方法参数的值 1-方法的返回值
     *          编写SpEL: #id：参数id的值  #a0 #p0 #root.args[0]
     *          getEmp[2]: key = "#root.methodName + '[' + #id + ']'"
     *      keyGenerator：key的生成器，可以自己指定key的生成器的组件id
     *          key/keyGenerator：二选一使用
     *      cacheManager：指定缓存管理器；或者cacheResolver指定获取解析器
     *      condition：指定符合条件的情况下才缓存；
     *      方法参数的名字. 可以直接 #参数名 ，也可以使用 #p0或#a0 的形式，0代表参数的索引；
     *              ,condition = "#id>0"
     *              condition = "#a0>1";第一个参数的值>1的时候才进行缓存
     *      unless：否定缓存；当unless指定的条件为true，方法的返回值就不会被缓存，可以获取到结果进行判断
     *              ,unless = "#result==null"
     *      sync：是否适用异步模式
    * @Date   2019/6/12 19:59
    * @Param id
    */
    @Cacheable(cacheNames = "emp"/* ,key = "#id", keyGenerator = "myKeyGenerator", condition = "#p0>1",unless = "#a0==2"*/)
    public Employee getEmp(Integer id) {
        System.out.println("查询"+id+"号员工");
        Employee empById = employeeMapper.getEmpById(id);
        return empById;
    }

    /**
     * @Description ：TODO @CachePut:既调用方法，又更新缓存数据；同步更新缓存
     * TODO 修改了数据库的某个数据，同时更新缓存；
     *      运行时机：
     *          1. 先调用目标方法
     *          2. 将目标方法的结果缓存起来
     *      测试步骤：
     *          1. 查询1号员工,查到的结果会放在缓存中
     *          2. 以后查询还是之前的结果
     *          3. 更新1号员工；【lastName=zhangsan，gender=0】
     *              将方法的返回值也放进缓存了 ；
     *              key：传入的employee对象   值：返回的employee对象；
     *          4. 查询1号员工？
     *              应该是更新后的员工；
     *                  key = "#employee.id":使用传入的参数的员工id；
     *                  key = "#result.id":使用返回后的id
     *                      @Cacheable的key是不能用#result.id,因为它是在方法执行之前缓存，方法没执行当然不会有返回值。
     *              为什么是没更新前的？【1号员工没有在缓存中更新,所以按照之前的key查还是会查出更新前的结果，因此我们应该按照更新后的key值进行查找】
     * @Date 2019/6/14 19:30
     */
    @CachePut(/*value = "emp",*/ key = "#employee.id")
    public Employee updateEmp(Employee employee) {
        System.out.println("updateEmp: " + employee);
        employeeMapper.updateEmp(employee);
        return employee;
    }

    /**
     * @Description ：
     * TODO @CacheEvict:缓存清除
     *      key:指定要清除的数据
     *      allEntries = true
     *      beforeInvocation = false ；缓存的清除是否在方法之前执行
     *      默认代表是在方法之后执行;如果出现按异常缓存就不会清除
     * @Date 2019/6/14 20:03
     */
    @CacheEvict(/*value = "emp",*/key = "#id")
    public void deleteEmp(Integer id) {
        System.out.println("deleteEmp:" + id);
        //employeeMapper.deleteEmpById(id);
    }
    //  @Caching定义复杂的缓存规则
    @Caching(
            cacheable = {
                    @Cacheable(/*value = "emp",*/key = "#lastName")
            },
            put = {//加了put之后肯定调用方法
                    @CachePut(/*value = "emp",*/key = "#result.id"),
                    @CachePut(/*value = "emp",*/key = "#result.email")
            }
    )
    public Employee getEmpLastName(String lastName) {
        System.out.println("查询"+lastName+"号员工");
        return employeeMapper.getEmpByLastName(lastName);
    }
}

package com.matthew.cache.config;

import org.springframework.cache.annotation.Cacheable;
import org.springframework.cache.interceptor.KeyGenerator;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;


import java.lang.reflect.Method;
import java.util.Arrays;


/**
 * @Description TODO
 * @Author Matthew
 * @Date 2019/6/13 20:51
 * @Version 1.0
 */
@Configuration
public class MyCacheConfig  {

    @Bean(name = "myKeyGenerator")
    public KeyGenerator keyGenerator(){
        return new KeyGenerator(){
            @Override
            public Object generate(Object o, Method method, Object... objects) {
                return method.getName() + "[" + Arrays.asList(objects).toString() + "]";
            }
        };
    }
}

4. 切换为其他缓存

五、整合redis实现缓存

1. 引入spring-boot-starter-data-redis

<dependency>
    <groupId>org.springframework.bootgroupId>
    <artifactId>spring-boot-starter-data-redisartifactId>
dependency>

2. application.yml配置redis连接地址
   你们可以查看自己的主机地址，

spring.redis.host=192.168.43.105

3. 使用RestTemplate操作redis
   1. redisTemplate.opsForValue();//操作字符串
   2. redisTemplate.opsForHash();//操作hash
   3. redisTemplate.opsForList();//操作list
   4. redisTemplate.opsForSet();//操作set
   5. redisTemplate.opsForZSet();//操作有序set

package com.matthew.cache;

import com.matthew.cache.bean.Employee;
import com.matthew.cache.mapper.EmployeeMapper;
import org.junit.Test;
import org.junit.runner.RunWith;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.test.context.junit4.SpringRunner;

import javax.annotation.Resource;

@RunWith(SpringRunner.class)
@SpringBootTest
public class Springboot01CacheApplicationTests {
    @Resource
    EmployeeMapper employeeMapper;

    @Autowired
    StringRedisTemplate stringRedisTemplate;//操作k-v都是字符串的
    @Autowired
    RedisTemplate redisTemplate;//k-v都是对象的
    @Autowired
    RedisTemplate<Object, Employee> empRedisTemplate;

    /**
    * @Description ：Redis常见的五大数据类型
     * String（字符串）、List（列表）、Set（集合）、Hash（散列）、ZSet（有序集合）
     *  stringRedisTemplate.opsForValue()[String（字符串）]
     *  stringRedisTemplate.opsForList()[List（列表）]
     *  stringRedisTemplate.opsForSet()[Set（集合）]
     *  stringRedisTemplate.opsForHash()[Hash（散列）]
     *  stringRedisTemplate.opsForZSet()[ZSet（有序集合）]
    * @Date   2019/6/16 17:10
    */
    @Test
    public void test01(){
        //给redis中保存数据
        stringRedisTemplate.opsForValue().append("msg", "hello");
        String msg = stringRedisTemplate.opsForValue().get("msg");
        System.out.println(msg);

        stringRedisTemplate.opsForList().leftPush("mylist", "1");
        stringRedisTemplate.opsForList().leftPush("mylist", "、");
        stringRedisTemplate.opsForList().leftPush("mylist", "2");

    }

    @Test
    public void test02() {
        Employee empById = employeeMapper.getEmpById(1);
        //默认如果保存对象，使用jdk序列化机制，序列化后的数据保存到redis中
//        redisTemplate.opsForValue().set("emp-01",empById);
        //1、将数据以json的方式保存
        //（1）自己将对象转为json
        //（2）redisTemplate默认的序列化规则；改变默认的序列化规则；
        empRedisTemplate.opsForValue().set("emp-01",empById);
    }

}

4. 配置缓存、CacheManagerCustomizers

package com.matthew.cache.config;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import com.matthew.cache.bean.Employee;
import org.springframework.boot.context.properties.ConfigurationProperties;
import org.springframework.cache.CacheManager;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.cache.RedisCacheConfiguration;
import org.springframework.data.redis.cache.RedisCacheManager;
import org.springframework.data.redis.cache.RedisCacheWriter;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.*;

import java.net.UnknownHostException;
import java.time.Duration;

/**
 * @Description TODO
 * @Author Matthew
 * @Date 2019/6/16 18:00
 * @Version 1.0
 */
@Configuration
public class MyRedisConfig {
    @Bean
    public RedisTemplate<Object, Employee> empRedisTemplate(RedisConnectionFactory redisConnectionFactory) throws UnknownHostException {
        RedisTemplate<Object, Employee> template = new RedisTemplate();
        template.setConnectionFactory(redisConnectionFactory);
        Jackson2JsonRedisSerializer<Employee> employeeJackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<Employee>(Employee.class);
        template.setDefaultSerializer(employeeJackson2JsonRedisSerializer);
        return template;
    }



    /**
     * 缓存管理器
     */
    @Bean
    public CacheManager cacheManager(RedisConnectionFactory redisConnectionFactory) {
        //初始化一个RedisCacheWriter
        RedisCacheWriter redisCacheWriter = RedisCacheWriter.nonLockingRedisCacheWriter(redisConnectionFactory);
        //设置CacheManager的值序列化方式为json序列化
        RedisSerializer<Object> jsonSerializer = new GenericJackson2JsonRedisSerializer();
        RedisSerializationContext.SerializationPair<Object> pair = RedisSerializationContext.SerializationPair
                .fromSerializer(jsonSerializer);
        RedisCacheConfiguration defaultCacheConfig=RedisCacheConfiguration.defaultCacheConfig()
                .serializeValuesWith(pair);
        //设置默认超过期时间是30秒
        defaultCacheConfig.entryTtl(Duration.ofSeconds(30));
        //初始化RedisCacheManager
        return new RedisCacheManager(redisCacheWriter, defaultCacheConfig);
    }



}

5. 测试使用缓存、切换缓存、 CompositeCacheManager