Skip to main content
体验最新特性 了解更多
IceCMS文档
Version: 中文

Redis缓存集成指南

概述​

本文档说明如何为文章、资源、首页等接口添加Redis缓存支持。

一、准备工作​

1.1 确保已创建缓存工具类​

确认以下文件已创建:

  • ✅ RedisConfig.java - Redis配置类
  • ✅ CacheUtil.java - 缓存工具类

1.2 配置Redis (可选)​

编辑 application.yml:

spring:
  redis:
    enabled: true    # 启用Redis
    host: localhost
    port: 6379

不启用Redis也能运行,只是不会使用缓存。

二、在Controller中添加缓存支持​

2.1 注入CacheUtil​

在Controller类中添加:

@Autowired
private CacheUtil cacheUtil;

2.2 缓存策略说明​

接口缓存时间缓存Key说明
轮播图1小时mini:carousel不常变化
重要文章30分钟mini:important:articles更新频率中等
文章详情5分钟article:detail:{id}访问频繁
资源详情5分钟resource:detail:{id}访问频繁
热榜第一页10分钟mini:hotlist:page1只缓存第一页
文章列表第一页5分钟mini:articles:page1:limit{n}只缓存第一页
资源列表第一页5分钟mini:resources:page1:limit{n}只缓存第一页
圈子分类1小时mini:square:classlist不常变化
搜索结果不缓存-实时性要求高

三、具体实现示例​

3.1 轮播图接口 - 简单缓存​

原代码:​

@GetMapping("/getCarousel")
public List<Map<String, Object>> getCarousel() {
    QueryWrapper<MiniCarousel> wrapper = new QueryWrapper<>();
    wrapper.eq("status", 1);
    wrapper.orderByAsc("sort");

    List<MiniCarousel> miniCarousels = miniCarouselMapper.selectList(wrapper);
    List<Map<String, Object>> resultList = new ArrayList<>();

    for (MiniCarousel miniCarousel : miniCarousels) {
        Map<String, Object> myMap = new HashMap<>();
        myMap.put("id", miniCarousel.getId());
        myMap.put("title", miniCarousel.getTitle());
        myMap.put("url", miniCarousel.getImg());
        resultList.add(myMap);
    }

    return resultList;
}

添加缓存后:​

@GetMapping("/getCarousel")
public List<Map<String, Object>> getCarousel() {
    String cacheKey = "mini:carousel";

    return cacheUtil.getOrLoad(cacheKey, () -> {
        QueryWrapper<MiniCarousel> wrapper = new QueryWrapper<>();
        wrapper.eq("status", 1);
        wrapper.orderByAsc("sort");

        List<MiniCarousel> miniCarousels = miniCarouselMapper.selectList(wrapper);
        List<Map<String, Object>> resultList = new ArrayList<>();

        for (MiniCarousel miniCarousel : miniCarousels) {
            Map<String, Object> myMap = new HashMap<>();
            myMap.put("id", miniCarousel.getId());
            myMap.put("title", miniCarousel.getTitle());
            myMap.put("url", miniCarousel.getImg());
            resultList.add(myMap);
        }

        return resultList;
    }, 3600); // 缓存1小时
}

改动说明:

  1. 定义缓存Key
  2. 使用 cacheUtil.getOrLoad() 包装原逻辑
  3. 设置缓存时间(秒)

3.2 文章详情 - 带异步更新浏览量​

添加缓存后:​

@GetMapping("/getArticleById/{id}")
public ArticleVO getArticleById(@PathVariable("id") Integer id) {
    String cacheKey = "article:detail:" + id;

    ArticleVO articleVO = cacheUtil.getOrLoad(cacheKey, () -> {
        Article article = articleService.getById(id);
        if (article == null) {
            return null;
        }
        // 原来的处理逻辑
        return articleVO;
    }, 300); // 缓存5分钟

    // 异步更新浏览量(不影响响应速度)
    if (articleVO != null) {
        new Thread(() -> {
            try {
                Article article = articleService.getById(id);
                if (article != null) {
                    article.setHits(article.getHits() + 1);
                    articleService.updateById(article);
                    cacheUtil.delete(cacheKey);
                }
            } catch (Exception e) {
                // 异常不影响主流程
            }
        }).start();
    }

    return articleVO;
}

改动说明:

  1. 使用缓存返回文章详情
  2. 浏览量更新改为异步(提升响应速度)
  3. 更新后清除缓存

3.3 热榜接口 - 只缓存第一页​

@GetMapping("/getHotList")
public Map<String, Object> getHotList(
        @RequestParam(value = "page", defaultValue = "1") int page,
        @RequestParam(value = "limit", defaultValue = "20") int limit) {

    // 只缓存第一页
    if (page == 1) {
        String cacheKey = "mini:hotlist:page1";

        return cacheUtil.getOrLoad(cacheKey, () -> {
            return buildHotList(page, limit);
        }, 600); // 缓存10分钟
    }

    // 其他页不缓存,直接查询
    return buildHotList(page, limit);
}

// 提取查询逻辑为单独方法
private Map<String, Object> buildHotList(int page, int limit) {
    Map<String, Object> result = new HashMap<>();
    // 原来的查询逻辑
    return result;
}

改动说明:

  1. 只缓存第一页(访问最频繁)
  2. 其他页直接查询
  3. 提取查询逻辑为独立方法

四、缓存更新策略​

4.1 创建/更新/删除后清除缓存​

示例: 发布文章后清除列表缓存​

@PostMapping("/createArticle")
public Result createArticle(@RequestBody Article article) {
    // 创建文章
    articleService.save(article);

    // 清除相关缓存
    cacheUtil.delete(
        "mini:articles:page1:limit10",
        "mini:articles:page1:limit20",
        "mini:important:articles",
        "mini:hotlist:page1"
    );

    return Result.succ("发布成功");
}

示例: 更新文章后清除详情缓存​

@PostMapping("/updateArticle")
public Result updateArticle(@RequestBody Article article) {
    // 更新文章
    articleService.updateById(article);

    // 清除该文章的详情缓存
    cacheUtil.delete("article:detail:" + article.getId());

    // 清除列表缓存
    cacheUtil.delete(
        "mini:articles:page1:limit10",
        "mini:hotlist:page1"
    );

    return Result.succ("更新成功");
}

五、完整集成步骤​

步骤1: 备份原Controller​

cp MiniProgrammeController.java MiniProgrammeController.java.bak

步骤2: 添加CacheUtil注入​

@RestController
@RequestMapping("/Mini")
public class MiniProgrammeController {

    @Autowired
    private CacheUtil cacheUtil;

    // ... 其他代码 ...
}

步骤3: 修改需要缓存的接口​

推荐顺序:

  1. ✅ getCarousel - 轮播图
  2. ✅ getImportantArticles - 重要文章
  3. ✅ getSquareClasslist - 圈子分类
  4. ✅ getArticleById - 文章详情
  5. ✅ getResourceById - 资源详情
  6. ✅ getHotList - 热榜
  7. ✅ getAllArticles - 文章列表
  8. ✅ getAllResources - 资源列表

步骤4: 测试​

测试缓存是否生效:​

# 第一次访问 - 慢(查数据库)
curl http://localhost:8181/Mini/getCarousel

# 第二次访问 - 快(走缓存)
curl http://localhost:8181/Mini/getCarousel

六、缓存Key命名规范​

模块:功能:参数

示例:
mini:carousel                          # 轮播图
mini:important:articles                # 重要文章
mini:hotlist:page1                     # 热榜第一页
mini:articles:page1:limit10            # 文章列表第一页(每页10条)
mini:resources:page1:limit20           # 资源列表第一页(每页20条)
mini:square:classlist                  # 圈子分类列表
article:detail:123                     # 文章123的详情
resource:detail:456                    # 资源456的详情

七、性能提升预期​

启用Redis前:​

轮播图: 50-100ms
文章详情: 50-100ms
热榜: 100-200ms
文章列表: 100-200ms

启用Redis后(缓存命中):​

轮播图: 5-10ms      ↑ 提升90%
文章详情: 5-10ms    ↑ 提升90%
热榜: 10-20ms       ↑ 提升90%
文章列表: 10-20ms   ↑ 提升90%

数据库压力:​

QPS降低: 60-80%
连接数降低: 50-70%

八、常见问题​

Q1: 缓存更新不及时怎么办?​

方案1: 缩短缓存时间

cacheUtil.getOrLoad(key, supplier, 60); // 改为1分钟

方案2: 主动清除缓存

articleService.updateById(article);
cacheUtil.delete("article:detail:" + article.getId());

Q2: Redis宕机会影响服务吗?​

不会! CacheUtil会自动降级:

Redis可用 -> 使用缓存
Redis故障 -> 自动降级到直接查询数据库

功能完全正常,只是响应稍慢。

Previous
Redis可选配置指南
Next
Redis集成完成总结
Was this helpful?