转载

拿什么拯救你的性能(1) - Spring Boot 中使用cache

一、什么是缓存 Cache

Cache 一词最早来自于CPU设计
当CPU要读取一个数据时,首先从CPU缓存中查找,找到就立即读取并送给CPU处理;没有找到,就从速率相对较慢的内存中读取并送给CPU处理,同时把这个数据所在的数据块调入缓存中,可以使得以后对整块数据的读取都从缓存中进行,不必再调用内存。正是这样的读取机制使CPU读取缓存的命中率非常高(大多数CPU可达90%左右),也就是说CPU下一次要读取的数据90%都在CPU缓存中,只有大约10%需要从内存读取。这大大节省了CPU直接读取内存的时间,也使CPU读取数据时基本无需等待。总的来说,CPU读取数据的顺序是先缓存后内存。
再到后来,出先了硬盘缓存,然后到应用缓存,浏览器缓存,Web缓存,等等!
缓存为王!!

Spring Cache

Spring Cache是Spring针对Spring应用,给出的一整套应用缓存解决方案。
Spring Cache本身并不提供缓存实现,而是通过统一的接口和代码规范,配置、注解等使你可以在Spring应用中使用各种Cache,而不用太关心Cache的细节。通过Spring Cache ,你可以方便的使用
各种缓存实现,包括ConcurrentMap,Ehcache 2.x,JCache,Redis等。

Spring中Cache的定义

Sping 中关于缓存的定义,包括在接口 org.springframework.cache.Cache 中,
它主要提供了如下方法

// 根据指定key获取值
<T> T get(Object key, Class<T> type)
// 将指定的值,根据相应的key,保存到缓存中
void put(Object key, Object value);
// 根据键,回收指定的值
void evict(Object key)

从定义中不难看着,Cache 事实上就是一个key-value的结构,我们通过个指定的key来操作相应的value

Cache Manager

Cache是key-value的集合,但我们在项目中,可能会存在各种业务主题的不同的Cache,比如用户的cache,部门的Cache等,这些cache在逻辑上是分开的。为了区分这些Cache,提供了org.springframework.cache.CacheManager用来管理各种Cache.该接口只包含两个方法

// 根据名字获取对应主题的缓存
Cache getCache(String name);
// 获取所有主题的缓存
Collection<String> getCacheNames();

在该接口中,不允许对Cache进行增加、删除操作,这些操作应该在各种CacheManager实现的内部完成,而不应该公开出来。

基于注解的缓存

对数据的缓存操作,理论上和业务本身的相关性不大,我们应当把对Cache的读写操作从主要代码逻辑中分离出来。Spring分离的方式就是基于注解的(当然像JSR-107等也是基于注解的)。
Spring 提供了一系列的注解,包括@Cacheable,@CachePut,@CacheEvict等一系列注解来简化我们对缓存的操做,这些注解都位于org.springframework.cache.annotation包下。

二、例子

一个简单的Spring Boot使用Spring Cache的例子

我们一步一步,来构建一个基于Spring Boot Cache的例子

新建一个Spring Boot 项目,引入如下依赖

<dependencies>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-cache</artifactId>
    </dependency>
    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-web</artifactId>
    </dependency>

    <dependency>
        <groupId>org.springframework.boot</groupId>
        <artifactId>spring-boot-starter-test</artifactId>
        <scope>test</scope>
    </dependency>
</dependencies>

其中,spring-boot-starter-cache是cache关键依赖。

修改Application类,加入启用缓存的注解@EnableCaching

@SpringBootApplication
@EnableCaching
public class CacheSimpleApplication {
    public static void main(String[] args) {
        SpringApplication.run(CacheSimpleApplication.class, args);
    }
}

@EnableCache注解启动了Spring的缓存机制,它会使应用检测所有缓存相关的注解并开始工作,同时还会创建一个CacheManager的bean,可以被我们的应用注入使用。

新建一个RestController类

@RestController
@RequestMapping("/")
public class CacheController {

    @Autowired
    private CacheTestService cacheTestService;

    /**
     * 根据ID获取信息
     * 
     * @param id
     * @return
     */
    @GetMapping("{id}")
    public String test(@PathVariable("id") String id) {
        return cacheTestService.get(id);
    }

    /**
     * 删除某个ID的信息
     * 
     * @param id
     * @return
     */
    @DeleteMapping("{id}")
    public String delete(@PathVariable("id") String id) {
        return cacheTestService.delete(id);
    }

    /**
     * 保存某个ID的信息
     * 
     * @param id
     * @return
     */
    @PostMapping
    public String save(@RequestParam("id") String id, @RequestParam("value") String value) {
        return cacheTestService.save(id, value);
    }

    /**
     * 跟新某个ID的信息
     * 
     * @param id
     * @return
     */
    @PutMapping("{id}")
    public String update(@PathVariable("id") String id, @RequestParam("value") String value) {
        return cacheTestService.update(id, value);
    }
}

该类调用某个Service来实现实际的增删改查操作。

Service 实现

接下来,我们要实现我们的Service

@Service
public class SimpleCacheTestServiceImpl implements CacheTestService {
    private static final Logger logger = LoggerFactory.getLogger(SimpleCacheTestServiceImpl.class);

    private final Map<String, String> enties = new HashMap<>();

    public SimpleCacheTestServiceImpl() {
        enties.put("1", "this no 1");
    }

    @Autowired
    private CacheManager cacheManager;

    @Override
    @Cacheable(cacheNames = "test")
    public String get(String id) {
        // 记录数据产生的时间,用于测试对比
        long time = new Date().getTime();
        // 打印使用到的cacheManager
        logger.info("The cacheManager is" + cacheManager);
        // 当数据不是从cache里面获取时,打印日志
        logger.info("Get value by id=" + id + ", The time is " + time);
        return "Get value by id=" + id + ",the value is" + enties.get(id);
    }

    @Override
    public String delete(String id) {
        return enties.remove(id);
    }

    @Override
    public String save(String id, String value) {        
        logger.info("save value " + value + " with key " + id);
        enties.put(id, value);
        return value;
    }

    @Override
    public String update(String id, String value) {
        return enties.put(id, value);
    }
}
  • 缓存
    首先在get方法上加上@Cacheable注解,运行代码测试。
    我们使用postman做测试,测试地址为http://localhost:8080/1,浏览器响应Get value by id=1,the value isthis no 1,服务器控制台打印两行日志
    Get value by id=1,the value isthis no 1
    Get value by id=1, The time is 1516004770216
    但我们再次刷新浏览器地址时,浏览器正常返回,但控制台已经不再打印了,原因是第二次调用时,Spring 已经不再执行方法,而是直接获取缓存的值。Spring Cache将函数的返回值以函数参数为key,缓存在了名为test的缓存中
    这里我们使用了@Cacheable注解,注解中的cacheNames指定了这里读取的是哪个Cache。这里会在cacheName="test"的cache中去查找key是id的缓存对象。
  • 删除缓存中的数据
    在上面的程序中,如果我们通过delete请求删除指定值,发送delete请求到http://localhost:8080/1,这个时候,值已经从map中删除了,但我们get 请求到http://localhost:8080/1的时候,仍然可以拿到值,这是因为我们在删除数据的时候,没有删除缓存中的数据,而在前面的get方法中,方法的运行结果仍然被保存着,Spring不会去重新读取,而是直接读取缓存。这个时候,我们在方法前面加上注解
@Override
@CacheEvict(cacheNames = "test")
public String delete(String id) {
    return enties.remove(id);
}

先后测试,首先调用get请求,会正确显示返回值为Get value by id=1,the value is 1
然后调用delete请求。将数据从cache和map中删除,再次调用get请求,这时返回Get value by id=1,the value is null,代表该值确实从缓存中删除了。
这里我们使用了@CacheEvict注解,cacheNames指定了删除哪个cache中的数据,默认会使用方法的参数作为删除的key

  • 更新缓存
    当程序到这里时,如果我们运行post请求,请求体为 id=1&value=new1,这时控制台打印save value new value1 with key 1,代码会将值保存到map中,但我们运行get请求时,会发现返回值仍然是之前的状态。这是我们可以使用
@Override
@CachePut(cacheNames = "test", key = "#id")
public String save(String id, String value) {
    logger.info("save value " + value + " with key " + id);
    return enties.put(id, value);
}

重新执行代码,我们先发送delete请求,从map和和cache中删除数据。然后再发送post请求,写入数据到map中。最后再发送get请求,会发现现在可以正确的取到值了,控制台也没有打印从map中获取数据的日志。
这里用到了@CachePut注解,这个注解的作用是将方法的返回值按照给定的key,写入到cacheNames指定的cache中去
同样,我们需要再put方法上加上@CachePut注解,让修改也能刷新缓存中的数据。
到这里,一个简单的包含增删改查的缓存应用就完成了。

三、划重点

几个注解

  • @EnableCaching 启用缓存配置
  • @Cacheable 指定某个方法的返回值是可以缓存的。在注解属性中指定缓存规则。
  • @Cacheput 将方法的返回值缓存到指定的key中
  • @CacheEvict 删除指定的缓存数据
    注意
    @Cacheable和@Cacheput都会将方法的执行结果按指定的key放到缓存中,@Cacheable在执行时,会先检测缓存中是否有数据存在,如果有,直接从缓存中读取。如果没有,执行方法,将返回值放入缓存,而@Cacheput会先执行方法,然后再将执行结果写入缓存。使用@Cacheput的方法一定会执行

完整的示例代码在 https://github.com/ldwqh0/cache-test



作者:虾游于海
链接:https://www.jianshu.com/p/fc076b6c2a13
來源:简书
著作权归作者所有。商业转载请联系作者获得授权,非商业转载请注明出处。
正文到此结束
Loading...