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

更新时间：2017年04月21日 11:15:50 作者：yuanzicheng

本篇文章主要介绍了Java自定义注解实现Redis自动缓存的方法，具有一定的参考价值，感兴趣的小伙伴们可以参考一下。

在实际开发中，可能经常会有这样的需要：从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

基于RxPaparazzo实现图片裁剪、图片旋转、比例放大缩小功能
这篇文章主要为大家详细介绍了基于RxPaparazzo实现图片裁剪、图片旋转、比例放大缩小功能，具有一定的参考价值，感兴趣的小伙伴们可以参考一下
2017-05-05
Java编程实现统计数组中各元素出现次数的方法
这篇文章主要介绍了Java编程实现统计数组中各元素出现次数的方法,涉及java针对数组的遍历、比较、运算等相关操作技巧,需要的朋友可以参考下
2017-07-07
Java校验是否为连续的区间问题
这篇文章主要介绍了Java校验是否为连续的区间问题,具有很好的参考价值,希望对大家有所帮助,如有错误或未考虑完全的地方,望不吝赐教
2023-12-12
springboot详解实现车险理赔信息管理系统代码
本系统基于Springboot开发实现了一个为用户车险进行理赔信息管理的一个信息化管理系统，核心的业务主要是用户申请保险理赔，管理员审核进入理赔程序，事故调查员对事故进行调查和现场勘察，这其中共涉及到三类用户，购买保险的客户，事故调查员和系统管理员
2022-06-06
教你几个 Java 编程中使用技巧
枯燥的编程中总得有些乐趣，今天我们不谈论那些高深的技能，教你几个在编程中的奇技淫巧，说不定在某些时候还能炫耀一番呢，今天小编教你几个 Java 编程中使用技巧，感兴趣的朋友参考下吧
2022-12-12
简单了解Java synchronized关键字同步
这篇文章主要介绍了简单了解Java synchronized关键字同步,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2019-09-09
SpringBoot通过ip获取归属地的几种方式分享
在日常我们逛网站的时候会发现我们登录后会出现归属地信息,例如：我在广州登录会显示广东广州,有些更加精确的会显示到区县,那么我们来看看有哪些方式来获取归属地信息,今天我们来聊一聊
2023-09-09
调用java.lang.Runtime.exec的正确姿势分享
这篇文章主要介绍了调用java.lang.Runtime.exec的正确姿势，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-11-11
C++字符串的处理详解
这篇文章主要介绍了C++ string字符串类，文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值，需要的朋友们下面随着小编来一起学习学习吧
2021-08-08
SpringBoot集成Quartz实现持久化定时接口调用任务
Quartz是功能强大的开源作业调度库，几乎可以集成到任何 Java 应用程序中，从最小的独立应用程序到最大的电子商务系统，本文将通过代码示例给大家介绍SpringBoot集成Quartz实现持久化定时接口调用任务,需要的朋友可以参考下
2023-07-07

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

相关文章

最新评论

大家感兴趣的内容

最近更新的内容

常用在线小工具