拿什么拯救你的性能(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

最后编辑于 ：
©著作权归作者所有,转载或内容合作请联系作者
  • 人面猴
    序言：七十年代末，一起剥皮案震惊了整个滨河市，随后出现的几起案子，更是在滨河造成了极大的恐慌，老刑警刘岩，带你破解...
    沈念sama阅读 203,937评论 6赞 478
  • 死咒
    序言：滨河连续发生了三起死亡事件，死亡现场离奇诡异，居然都是意外死亡，警方通过查阅死者的电脑和手机，发现死者居然都...
    沈念sama阅读 85,503评论 2赞 381
  • 救了他两次的神仙让他今天三更去死
    文/潘晓璐 我一进店门，熙熙楼的掌柜王于贵愁眉苦脸地迎上来，“玉大人，你说我怎么就摊上这事。” “怎么了？”我有些...
    开封第一讲书人阅读 150,712评论 0赞 337
  • 道士缉凶录：失踪的卖姜人
    文/不坏的土叔 我叫张陵，是天一观的道长。 经常有香客问我，道长，这世上最难降的妖魔是什么？ 我笑而不...
    开封第一讲书人阅读 54,668评论 1赞 276
  • 港岛之恋（遗憾婚礼）
    正文 为了忘掉前任，我火速办了婚礼，结果婚礼上，老公的妹妹穿的比我还像新娘。我一直安慰自己，他们只是感情好，可当我...
    茶点故事阅读 63,677评论 5赞 366
  • 恶毒庶女顶嫁案：这布局不是一般人想出来的
    文/花漫 我一把揭开白布。 她就那样静静地躺着，像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上，一...
    开封第一讲书人阅读 48,601评论 1赞 281
  • 城市分裂传说
    那天，我揣着相机与录音，去河边找鬼。 笑死，一个胖子当着我的面吹牛，可吹牛的内容都是我干的。 我是一名探鬼主播，决...
    沈念sama阅读 37,975评论 3赞 396
  • 双鸳鸯连环套：你想象不到人心有多黑
    文/苍兰香墨 我猛地睁开眼，长吁一口气：“原来是场噩梦啊……” “哼！你这毒妇竟也来了？” 一声冷哼从身侧响起，我...
    开封第一讲书人阅读 36,637评论 0赞 258
  • 万荣杀人案实录
    序言：老挝万荣一对情侣失踪，失踪者是张志新（化名）和其女友刘颖，没想到半个月后，有当地人在树林里发现了一具尸体，经...
    沈念sama阅读 40,881评论 1赞 298
  • 护林员之死
    正文 独居荒郊野岭守林人离奇死亡，尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 35,621评论 2赞 321
  • 白月光启示录
    正文 我和宋清朗相恋三年，在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 37,710评论 1赞 329
  • 活死人
    序言：一个原本活蹦乱跳的男人离奇死亡，死状恐怖，灵堂内的尸体忽然破棺而出，到底是诈尸还是另有隐情，我是刑警宁泽，带...
    沈念sama阅读 33,387评论 4赞 319
  • 日本核电站爆炸内幕
    正文 年R本政府宣布，位于F岛的核电站，受9级特大地震影响，放射性物质发生泄漏。R本人自食恶果不足惜，却给世界环境...
    茶点故事阅读 38,971评论 3赞 307
  • 男人毒药：我在死后第九天来索命
    文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹，春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 29,947评论 0赞 19
  • 一桩弑父案，背后竟有这般阴谋
    文/苍兰香墨 我抬头看了看天上的太阳。三九已至，却和暖如春，着一层夹袄步出监牢的瞬间，已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 31,189评论 1赞 260
  • 情欲美人皮
    我被黑心中介骗来泰国打工， 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留，地道东北人。 一个月前我还...
    沈念sama阅读 44,805评论 2赞 349
  • 代替公主和亲
    正文 我出身青楼，却偏偏与公主长得像，于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子，可洞房花烛夜当晚...
    茶点故事阅读 42,449评论 2赞 342