SpringBoot詳解整合Redis緩存方法

Posted on 2022-07-15 by WalkonNet

1、Spring Boot支持的緩存組件

在Spring Boot中，數據的緩存管理存儲依賴於Spring框架中cache相關的org.springframework.cache.Cache和org.springframework.cache.CacheManager緩存管理器接口。

如果程序中沒有定義類型為CacheManager的Bean組件或者是名為cacheResolver的CacheResolver緩存解析器，Spring Boot將嘗試選擇並啟用以下緩存組件（按照指定的順序）：

（1）Generic

（2）JCache (JSR-107) (EhCache 3、Hazelcast、Infinispan等)

（3）EhCache 2.x

（4）Hazelcast

（5）Infinispan

（6）Couchbase

（7）Redis

（8）Caffeine

（9）Simple

上面按照Spring Boot緩存組件的加載順序，列舉瞭支持的9種緩存組件，在項目中添加某個緩存管理組件（例如Redis）後，Spring Boot項目會選擇並啟用對應的緩存管理器。如果項目中同時添加瞭多個緩存組件，且沒有指定緩存管理器或者緩存解析器（CacheManager或者cacheResolver），那麼Spring Boot會按照上述順序在添加的多個緩存中優先啟用指定的緩存組件進行緩存管理。

剛剛講解的Spring Boot默認緩存管理中，沒有添加任何緩存管理組件能實現緩存管理。這是因為開啟緩存管理後，Spring Boot會按照上述列表順序查找有效的緩存組件進行緩存管理，如果沒有任何緩存組件，會默認使用最後一個Simple緩存組件進行管理。Simple緩存組件是Spring Boot默認的緩存管理組件，它默認使用內存中的ConcurrentMap進行緩存存儲，所以在沒有添加任何第三方緩存組件的情況下，可以實現內存中的緩存管理，但是我們不推薦使用這種緩存管理方式

2、基於註解的Redis緩存實現

在Spring Boot默認緩存管理的基礎上引入Redis緩存組件，使用基於註解的方式講解Spring Boot整合Redis緩存的具體實現

（1）添加Spring Data Redis依賴啟動器。在pom.xml文件中添加Spring Data Redis依賴啟動器

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-data-redis</artifactId>
</dependency>

當我們添加進redis相關的啟動器之後, SpringBoot會使用RedisCacheConfigratioin 當做生效的自動配置類進行緩存相關的自動裝配,容器中使用的緩存管理器是RedisCacheManager , 這個緩存管理器創建的Cache為 RedisCache , 進而操控redis進行數據的緩存

（2）Redis服務連接配置

# Redis服務地址
spring.redis.host=127.0.0.1
# Redis服務器連接端口
spring.redis.port=6379
# Redis服務器連接密碼（默認為空）
spring.redis.password=

（3）對CommentService類中的方法進行修改使用@Cacheable、@CachePut、@CacheEvict三個註解定制緩存管理，分別進行緩存存儲、緩存更新和緩存刪除的演示

package com.lagou.service;
import com.lagou.pojo.Comment;
import com.lagou.repository.CommentRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.stereotype.Service;
import java.util.Optional;
@Service
public class CommentService {
    @Autowired
    private CommentRepository commentRepository;
    /**
     * @Cacheable: 將該方法查詢結果comment存放在SpringBoot默認緩存中
     * cacheNames: 起一個緩存的命名空間，對應緩存的唯一標識
     * value：緩存結果   key：默認隻有一個參數的情況下，key值默認就是方法參數值; 如果沒有參數或者多個參數的情況：會使用SimpleKeyGenerate來為生成key
     */
    @Cacheable(cacheNames = "comment", unless = "#result==null")
    public Comment findCommentById(Integer id) {
        Optional<Comment> byId = commentRepository.findById(id);
        if (byId.isPresent()) {
            Comment comment = byId.get();
            return comment;
        }
        return null;
    }
    // 更新方法
    @CachePut(cacheNames = "comment", key = "#result.id")
    public Comment updateComment(Comment comment) {
        commentRepository.updateComment(comment.getAuthor(), comment.getId());
        return comment;
    }
    // 刪除方法
    @CacheEvict(cacheNames = "comment")
    public void deleteComment(Integer id) {
        commentRepository.deleteById(id);
    }
}

以上使用@Cacheable、@CachePut、@CacheEvict註解在數據查詢、更新和刪除方法上進行瞭緩存管理。

其中，查詢緩存@Cacheable註解中沒有標記key值，將會使用默認參數值comment_id作為key進行數據保存，在進行緩存更新時必須使用同樣的key；同時在查詢緩存@Cacheable註解中，定義瞭“unless = "#result==null"”表示查詢結果為空不進行緩存

控制層

package com.lagou.controller;
import com.lagou.pojo.Comment;
import com.lagou.service.CommentService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
public class CommentController {
    @Autowired
    private CommentService commentService;
    @RequestMapping( "/findCommentById")
    public Comment findCommentById(Integer id) {
        Comment comment = commentService.findCommentById(id);
        return comment;
    }
    @RequestMapping(value = "/updateComment")
    public Comment updateComment(Comment comment) {
        Comment commentById = commentService.findCommentById(comment.getId());
        commentById.setAuthor(comment.getAuthor());
        return commentService.updateComment(commentById);
    }
    @RequestMapping(value = "/deleteComment")
    public void deleteComment(Integer id) {
        commentService.deleteComment(id);
    }
}

（4）基於註解的Redis查詢緩存測試

可以看出，查詢用戶評論信息Comment時執行瞭相應的SQL語句，但是在進行緩存存儲時出現瞭IllegalArgumentException非法參數異常，提示信息要求對應Comment實體類必須實現序列化（“DefaultSerializer requires a Serializable payload but received an object of type”）。

（5）將緩存對象實現序列化。

（6）再次啟動測試

訪問“http://localhost:8080/findCommentById?id=1”查詢id為1的用戶評論信息，並重復刷新瀏覽器查詢同一條數據信息，查詢結果

查看控制臺打印的SQL查詢語句

還可以打開Redis客戶端可視化管理工具Redis Desktop Manager連接本地啟用的Redis服務，查看具體的數據緩存效果

執行findById()方法查詢出的用戶評論信息Comment正確存儲到瞭Redis緩存庫中名為comment的名稱空間下。其中緩存數據的唯一標識key值是以“名稱空間comment::+參數值（comment::1）”的字符串形式體現的，而value值則是經過JDK默認序列格式化後的HEX格式存儲。這種JDK默認序列格式化後的數據顯然不方便緩存數據的可視化查看和管理，所以在實際開發中，通常會自定義數據的序列化格式

（7）基於註解的Redis緩存更新測試。

先通過瀏覽器訪問“http://localhost:8080/updateComment/1/shitou”更新id為1的評論作者名為shitou；

接著，繼續訪問“http://localhost:8080/findCommentById?id=1”查詢id為1的用戶評論信息

可以看出，執行updateComment()方法更新id為1的數據時執行瞭一條更新SQL語句，後續調用findById()方法查詢id為1的用戶評論信息時沒有執行查詢SQL語句，且瀏覽器正確返回瞭更新後的結果，表明@CachePut緩存更新配置成功

（8）基於註解的Redis緩存刪除測試

通過瀏覽器訪問“http://localhost:8080/deleteComment?id=1”刪除id為1的用戶評論信息；

執行deleteComment()方法刪除id為1的數據後查詢結果為空，之前存儲在Redis數據庫的comment相關數據也被刪除，表明@CacheEvict緩存刪除成功實現

通過上面的案例可以看出，使用基於註解的Redis緩存實現隻需要添加Redis依賴並使用幾個註解可以實現對數據的緩存管理。另外，還可以在Spring Boot全局配置文件中配置Redis有效期，示例代碼如下：

# 對基於註解的Redis緩存數據統一設置有效期為1分鐘，單位毫秒
spring.cache.redis.time-to-live=60000

上述代碼中，在Spring Boot全局配置文件中添加瞭“spring.cache.redis.time-to-live”屬性統一配置Redis數據的有效期（單位為毫秒），但這種方式相對來說不夠靈活

3、基於API的Redis緩存實現

在Spring Boot整合Redis緩存實現中，除瞭基於註解形式的Redis緩存實現外，還有一種開發中常用的方式——基於API的Redis緩存實現。這種基於API的Redis緩存實現，需要在某種業務需求下通過Redis提供的API調用相關方法實現數據緩存管理；同時，這種方法還可以手動管理緩存的有效期。

下面，通過Redis API的方式講解Spring Boot整合Redis緩存的具體實現

（1）使用Redis API進行業務數據緩存管理。在com.lagou.service包下編寫一個進行業務處理的類ApiCommentService

package com.lagou.service;
import com.lagou.pojo.Comment;
import com.lagou.repository.CommentRepository;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.cache.annotation.CacheEvict;
import org.springframework.cache.annotation.CachePut;
import org.springframework.cache.annotation.Cacheable;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Service;
import java.util.Optional;
import java.util.concurrent.TimeUnit;
@Service
public class ApiCommentService {
    @Autowired
    private CommentRepository commentRepository;
    @Autowired
    private RedisTemplate redisTemplate;
    // 使用API方式進行緩存，先去緩存中查找，緩存中有，直接返回；沒有查詢數據庫
    public Comment findCommentById(Integer id) {
        Object o = redisTemplate.opsForValue().get("comment_" + id);
        if (o != null) {
            return (Comment) o; // 查詢到數據
        } else {
            // 緩存中沒有，從數據庫中查詢
            Optional<Comment> byId = commentRepository.findById(id);
            if (byId.isPresent()) {
                Comment comment = byId.get();
                // 將查詢結果存入到緩存中，同時還可以設置有效期
                redisTemplate.opsForValue().set("comment_" + id, comment, 1, TimeUnit.DAYS); // 過期時間為一天
                return comment;
            }
        }
        return null;
    }
    // 更新方法
    public Comment updateComment(Comment comment) {
        commentRepository.updateComment(comment.getAuthor(), comment.getId());
        // 將更新數據進行緩存更新
        redisTemplate.opsForValue().set("comment_" + comment.getId(), comment, 1, TimeUnit.DAYS);
        return comment;
    }
    // 刪除方法
    public void deleteComment(Integer id) {
        commentRepository.deleteById(id);
        redisTemplate.delete("comment_" + id);
    }
}

（2）編寫Web訪問層Controller文件

package com.lagou.controller;
import com.lagou.pojo.Comment;
import com.lagou.service.ApiCommentService;
import com.lagou.service.CommentService;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
@RestController
@RequestMapping("/api")
public class ApiCommentController {
    @Autowired
    private ApiCommentService commentService;
    @RequestMapping( "/findCommentById")
    public Comment findCommentById(Integer id) {
        Comment comment = commentService.findCommentById(id);
        return comment;
    }
    @RequestMapping(value = "/updateComment")
    public Comment updateComment(Comment comment) {
        Comment commentById = commentService.findCommentById(comment.getId());
        commentById.setAuthor(comment.getAuthor());
        return commentService.updateComment(commentById);
    }
    @RequestMapping(value = "/deleteComment")
    public void deleteComment(Integer id) {
        commentService.deleteComment(id);
    }
}

基於API的Redis緩存實現的相關配置。基於API的Redis緩存實現不需要@EnableCaching註解開啟基於註解的緩存支持，所以這裡可以選擇將添加在項目啟動類上的@EnableCaching進行刪除或者註釋

到此這篇關於SpringBoot詳解整合Redis緩存方法的文章就介紹到這瞭,更多相關SpringBoot Redis緩存內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

SpringBoot詳解整合Redis緩存方法

目錄

1、Spring Boot支持的緩存組件

2、基於註解的Redis緩存實現

3、基於API的Redis緩存實現

推薦閱讀：

發佈留言取消回覆

近期文章

目錄

1、Spring Boot支持的緩存組件

2、基於註解的Redis緩存實現

3、基於API的Redis緩存實現

推薦閱讀：

發佈留言 取消回覆

近期文章

標籤

發佈留言取消回覆