Java自定义注解实现Redis自动缓存的方法

发布时间 - 2026-01-11 00:45:47    点击率:

在实际开发中,可能经常会有这样的需要:从MySQL中查询一条数据(比如用户信息),此时需要将用户信息保存至Redis。

刚开始我们可能会在查询的业务逻辑之后再写一段Redis相关操作的代码,时间长了后发现这部分代码实际上仅仅做了Redis的写入动作,跟业务逻辑没有实质的联系,那么有没有什么方法能让我们省略这些重复劳动呢?

首先想到用AOP,在查询到某些数据这一切入点(Pointcut)完成我们的切面相关处理(也就是写入Redis)。那么,如何知道什么地方需要进行缓存呢,也就是什么地方需要用到AOP呢?参考数据库事务的实现用到了@Transactional,那我们也可以自定义一个注解@RedisCache,将此注解用在需要的方法上,方法的返回结果作为需要保存的信息,方法的查询参数(比如用户的id)可以用来作为key。

上面的分析考虑下来貌似可行,那么接下来就动手实践吧!

详细步骤

1.创建一个自定义注解@RedisCache

package redis;

import java.lang.annotation.*;

/**
 * 自定义注解,结合AOP实现Redis自动缓存
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.METHOD)
@Inherited
@Documented
public @interface RedisCache {
}

2.创建缓存写入的辅助类:RedisHelper.java,其中包含一个范型方法用于接收不同类的实例对象,以保证我们的方法能够通用。这里比较简单,直接把对象转成json,在Redis中用string保存。而且不管什么情况统统写入,实际还可以完善下具体逻辑,比如判断缓存是否已存在,缓存信息是否最新等等。

package redis;

import com.alibaba.fastjson.JSONObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.StringRedisTemplate;
import org.springframework.stereotype.Component;

@Component
public class RedisHelper {

  @Autowired
  private StringRedisTemplate stringRedisTemplate;

  public <T> void saveCache(String key,T t){
    String json = JSONObject.toJSONString(t);
    stringRedisTemplate.opsForValue().set(key,json);
  }

}

3.创建RedisCacheAspect.java,利用AOP框架AspectJ完成切面处理(用万金油环绕通知吧,按需要有取舍地使用具体某些类型的通知吧),我们这里用到了返回通知,也就是方法调用成功得到返回结果后进行切面处理动作

package redis;

import org.aspectj.lang.ProceedingJoinPoint;
import org.aspectj.lang.annotation.Around;
import org.aspectj.lang.annotation.Aspect;
import org.aspectj.lang.annotation.Pointcut;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Component;

@Aspect
@Component
public class RedisCacheAspect {

  @Autowired
  private RedisHelper redisHelper;

  @Pointcut("@annotation(redis.RedisCache)")
  public void setJoinPoint(){}

  //环绕通知:可以获取返回值
  @Around(value = "setJoinPoint()")
  public Object aroundMethod(ProceedingJoinPoint proceedingJoinPoint){
    Object result = null;
    try {
      //前置通知

      result = proceedingJoinPoint.proceed();

      //返回通知

      //缓存至Redis
      Object[] args = proceedingJoinPoint.getArgs();
      //key策略:需要缓存的对象的全类名-id,如:entity.User-1
      redisHelper.saveCache(result.getClass().getName()+"-"+args[0],result);

    } catch (Throwable e) {
      //异常通知

    }
    //后置通知

    return result;
  }

}

4.接下来是具体业务相关的代码

UserController.java

package controller;

import com.alibaba.fastjson.JSONObject;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.PathVariable;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.ResponseBody;
import service.UserService;

@SuppressWarnings("unused")
@Controller
public class UserController {

  @Autowired
  private UserService userService;

  @RequestMapping(value = "/user/{id}", method = RequestMethod.GET,produces = "application/json;charset=utf-8")
  @ResponseBody
  public String test(@PathVariable Long id){
    return JSONObject.toJSONString(userService.get(id));
  }
}

UserService.java,其中get方法上使用了自定义注解@RedisCache

package service;

import dao.UserDao;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.stereotype.Service;
import redis.RedisCache;

import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

@Service
public class UserService<User> implements BaseService<User> {

  @Autowired
  private UserDao userDao;

  public Map add(User user) {
    return null;
  }

  public Map update(User user) {
    return null;
  }

  @RedisCache
  public User get(Long id) {
    return (User) userDao.get(id);
  }

  public List<User> query(User user) {
    List<User> list = new ArrayList<User>();
    list = userDao.query(user);
    return list;
  }

  public Map delete(User user) {
    return null;
  }
}

5.测试

浏览器直接访问http://localhost:8080/user/1,得到返回结果

http://localhost:8080/user/1

连接Redis查看结果

127.0.0.1:6381> keys entity*
1) "entity.User-1"
127.0.0.1:6381> get entity.User-1
"{\"id\":1,\"mobile\":\"110\",\"name\":\"\xe7\x94\xa8\xe6\x88\xb71\",\"password\":\"123456\",\"username\":\"0001\"}"
127.0.0.1:6381>

好了,到此我们已经看到开头的想法验证成功了,只需要在查询的方法上加上注解@RedisCache,就自动地悄无声息地写入Redis了,是不是很方便!

以上就是本文的全部内容,希望对大家的学习有所帮助,也希望大家多多支持。


# java实现redis缓存  # 自定义注解  # java  # 实现  # 缓存  # 如何基于LoadingCache实现Java本地缓存  # Java缓存Map设置过期时间实现解析  # 如何在 Java 中实现一个 redis 缓存服务  # Java中LocalCache本地缓存实现代码  # Java LocalCache 本地缓存的实现实例  # Java本地缓存的实现代码  # Java实现一个简单的缓存方法  # java shiro实现退出登陆清空缓存  # Java 实现缓存的三种方式及问题汇总  # 自定义  # 什么地方  # 这一  # 会有  # 好了  # 还可以  # 要有  # 只需  # 会在  # 要在  # 这部  # 能让  # 刚开始  # 要将  # 将此  # 悄无声息  # 到此  # 用在  # 长了  # 很方便 


相关栏目: 【 网站优化151355 】 【 网络推广146373 】 【 网络技术251813 】 【 AI营销90571


相关推荐: Swift开发中switch语句值绑定模式  如何在IIS中新建站点并配置端口与IP地址?  海南网站制作公司有哪些,海口网是哪家的?  iOS中将个别页面强制横屏其他页面竖屏  标题:Vue + Vuex + JWT 身份认证的正确实践与常见误区解析  javascript中的try catch异常捕获机制用法分析  Laravel如何使用模型观察者?(Observer代码示例)  Midjourney怎样加参数调细节_Midjourney参数调整技巧【指南】  Java遍历集合的三种方式  如何为不同团队 ID 动态生成多个非值班状态按钮  QQ浏览器网页版登录入口 个人中心在线进入  Laravel如何连接多个数据库_Laravel多数据库连接配置与切换教程  北京网站制作费用多少,建立一个公司网站的费用.有哪些部分,分别要多少钱?  laravel服务容器和依赖注入怎么理解_laravel服务容器与依赖注入解析  javascript读取文本节点方法小结  教你用AI润色文章,让你的文字表达更专业  教学论文网站制作软件有哪些,写论文用什么软件 ?  Win11摄像头无法使用怎么办_Win11相机隐私权限开启教程【详解】  悟空识字如何进行跟读录音_悟空识字开启麦克风权限与录音  美食网站链接制作教程视频,哪个教做美食的网站比较专业点?  香港服务器网站生成指南:免费资源整合与高速稳定配置方案  如何在云指建站中生成FTP站点?  Laravel Pest测试框架怎么用_从PHPUnit转向Pest的Laravel测试教程  Windows10如何删除恢复分区_Win10 Diskpart命令强制删除分区  如何在阿里云香港服务器快速搭建网站?  高端建站如何打造兼具美学与转化的品牌官网?  网页制作模板网站推荐,网页设计海报之类的素材哪里好?  Android中AutoCompleteTextView自动提示  Laravel如何处理CORS跨域问题_Laravel项目CORS配置与解决方案  如何用PHP快速搭建CMS系统?  中国移动官方网站首页入口 中国移动官网网页登录  油猴 教程,油猴搜脚本为什么会网页无法显示?  Laravel如何实现多表关联模型定义_Laravel多对多关系及中间表数据存取【方法】  Laravel集合Collection怎么用_Laravel集合常用函数详解  Laravel中的Facade(门面)到底是什么原理  Laravel如何使用Scope本地作用域_Laravel模型常用查询逻辑封装技巧【手册】  Laravel如何处理文件上传_Laravel Storage门面实现文件存储与管理  Edge浏览器怎么启用睡眠标签页_节省电脑内存占用优化技巧  Swift中swift中的switch 语句  Laravel怎么实现一对多关联查询_Laravel Eloquent模型关系定义与预加载【实战】  Android仿QQ列表左滑删除操作  Android实现代码画虚线边框背景效果  如何在七牛云存储上搭建网站并设置自定义域名?  Laravel观察者模式如何使用_Laravel Model Observer配置  javascript事件捕获机制【深入分析IE和DOM中的事件模型】  Laravel怎么进行数据库事务处理_Laravel DB Facade事务操作确保数据一致性  用v-html解决Vue.js渲染中html标签不被解析的问题  网站图片在线制作软件,怎么在图片上做链接?  如何在服务器上三步完成建站并提升流量?  公司网站制作价格怎么算,公司办个官网需要多少钱?