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，得到返回结果

连接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了，是不是很方便！

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