Spring Cache 介紹

Spring Cache 是 Spring 提供的的緩存解決方案，它並非是一個具體的緩存實現，而是和 JSR107 類似的一套緩存規範，基於註解並與 Spring 的無縫集成。本文主要介紹其基本概念及簡單使用。

1、簡介

1.1、Spring Cache 概述

Spring Cache 是 Spring 提供的一種緩存抽象機制，用於簡化應用中的緩存操作。它通過將方法的返回值緩存起來，當下次調用同一方法時，如果傳入的參數與之前的調用相同，就可以直接從緩存中獲取結果，而不需要再執行方法體中的代碼，提高了系統的性能和響應速度。

Spring Cache 的特點：
聲明式緩存：通過在方法上添加註解，如 @Cacheable、@CachePut、@CacheEvict 等來聲明緩存的行為，無需手動編寫緩存代碼。
多種緩存支持：Spring Cache 提供了對多種緩存框架的支持，包括 Redis、Ehcache、Guava Cache、Caffeine 等，可以根據需要選擇合適的緩存實現。
緩存策略配置：可以通過配置文件或者編程方式來配置緩存的策略，包括緩存的過期時間、緩存的淘汰策略等。
註解靈活應用：通過在方法上添加不同的註解，可以實現緩存的讀取、更新和清除等操作，根據業務需求進行靈活配置。
緩存切麵自動代理：Spring Cache 通過 AOP 技術，利用代理模式在方法執行前後攔截，自動處理緩存相關的操作，對業務代碼無侵入。

1.2、Spring Cache 註解

這些註解通過聲明式的方式來管理緩存，通過在方法上添加相應的註解，可以方便地實現緩存的讀取、更新和清除等操作。同時，Spring Cache 還支持使用 SpEL 表達式來動態地指定緩存的 Key 和條件等。開發者可以根據具體的業務需求選擇合適的註解來配置緩存行為。

2、Spring Cache 使用

Spring Boot 中使用 Spring Cache 大概有以下步驟。

2.1、引入相關依賴

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

2.2、啟用緩存

在啟動類上添加 @EnableCaching 註解。

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

2.3、引入並配置具體的緩存實現

2.3.1、Caffeine 作為緩存實現

A、引入依賴

<dependency>
    <groupId>com.github.ben-manes.caffeine</groupId>
    <artifactId>caffeine</artifactId>
</dependency>

B、配置緩存(application.yml)

spring:
  cache:
    type: caffeine
    caffeine:
      spec: maximumSize=1000,expireAfterWrite=3s

spec 的配置屬性可參考 com.github.benmanes.caffeine.cache.CaffeineSpec 類。

2.3.2、JCache 作為緩存實現

JCache 也是緩存規範，這裡使用 Ehcache3 作為其緩存實現。

A、引入依賴

<dependency>
    <groupId>javax.cache</groupId>
    <artifactId>cache-api</artifactId>
</dependency>
<dependency>
    <groupId>org.ehcache</groupId>
    <artifactId>ehcache</artifactId>
</dependency>

B、配置緩存(application.yml)

spring:
  cache:
    type: jcache
    jcache:
      config: classpath:ehcache3.xml

C、ehcache3 配置(ehcache3.xml)

<?xml version="1.0" encoding="UTF-8"?>
<config xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
        xmlns:jsr107="http://www.ehcache.org/v3/jsr107"
        xmlns="http://www.ehcache.org/v3"
        xsi:schemaLocation="http://www.ehcache.org/v3
        http://www.ehcache.org/schema/ehcache-core-3.10.xsd
        http://www.ehcache.org/v3/jsr107
        http://www.ehcache.org/schema/ehcache-107-ext-3.10.xsd">

    <persistence directory="D:\temp"/>

    <cache alias="myCache">
        <key-type>java.lang.Integer</key-type>
        <value-type>java.lang.String</value-type>
        <expiry>
            <tti unit="minutes">5</tti>
        </expiry>
        <resources>
            <heap unit="MB">10</heap>
            <offheap unit="MB">50</offheap>
            <disk persistent="true" unit="MB">500</disk>
        </resources>
    </cache>
</config>

2.4、緩存使用

根據需要在方法上添加相應註解即可。

package com.abc.general.service.impl;

import com.abc.general.service.ICacheService;
import lombok.extern.slf4j.Slf4j;
import org.springframework.cache.annotation.*;
import org.springframework.stereotype.Service;

@Slf4j
@Service
public class CacheServiceImpl implements ICacheService {
    @Cacheable(cacheNames = "myCache", key = "#id")
    @Override
    public String queryById(int id) {
        log.info("queryById,id={}", id);
        return "value" + id;
    }

    @CachePut(cacheNames = "myCache", key = "#id")
    @Override
    public String updateById(int id, String newValue) {
        log.info("updateById,id={},newValue={}", id, newValue);
        return newValue;
    }

    @CacheEvict(cacheNames = "myCache", key = "#id")
    @Override
    public void deleteById(int id) {
        log.info("deleteById,id={}", id);
    }
}