栏目分类:
子分类:
返回
名师互学网用户登录
快速导航关闭
当前搜索
当前分类
子分类
实用工具
热门搜索
名师互学网 > IT > 软件开发 > 后端开发 > Java

MyBatis整合Redis实现二级缓存的示例代码

Java 更新时间: 发布时间: IT归档 最新发布 模块sitemap 名妆网 法律咨询 聚返吧 英语巴士网 伯小乐 网商动力

MyBatis整合Redis实现二级缓存的示例代码

MyBatis框架提供了二级缓存接口,我们只需要实现它再开启配置就可以使用了。

特别注意,我们要解决缓存穿透、缓存穿透和缓存雪崩的问题,同时也要保证缓存性能。

具体实现说明,直接看代码注释吧!

1、开启配置

SpringBoot配置

mybatis:
 configuration:
  cache-enabled: true

2、Redis配置以及服务接口

RedisConfig.java

package com.leven.mybatis.api.config;

import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration;
import org.springframework.data.redis.connection.RedisConnectionFactory;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.data.redis.serializer.Jackson2JsonRedisSerializer;
import org.springframework.data.redis.serializer.StringRedisSerializer;


@Configuration
public class RedisConfig {

  
  @Bean
  public RedisTemplate redisTemplate(RedisConnectionFactory redisConnectionFactory) {
    RedisTemplate template = new RedisTemplate<>();
    template.setConnectionFactory(redisConnectionFactory);
    // 使用Jackson2JsonRedisSerializer来序列化和反序列化redis的value值
    Jackson2JsonRedisSerializer jackson2JsonRedisSerializer = new Jackson2JsonRedisSerializer<>(Object.class);
    StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
    ObjectMapper mapper = new ObjectMapper();
    mapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
    mapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
    jackson2JsonRedisSerializer.setObjectMapper(mapper);
    template.setKeySerializer(stringRedisSerializer);
    template.setValueSerializer(jackson2JsonRedisSerializer);
    template.setHashKeySerializer(stringRedisSerializer);
    template.setHashValueSerializer(jackson2JsonRedisSerializer);
    template.afterPropertiesSet();
    return template;
  }
}



RedisService.java

package com.leven.mybatis.core.service;

import java.util.*;
import java.util.concurrent.TimeUnit;


public interface RedisService {
// =============================common============================
  
  void expire(String key, long time);

  
  void expireAt(String key, Date expireAt);

  
  Long getExpire(String key);

  
  Boolean hasKey(String key);

  
  void delete(String... key);

  
  void delete(Collection keys);

  // ============================String=============================

  
  Object get(String key);

  
  void set(String key, Object value);

  
  void set(String key, Object value, long time);

  
  void set(String key, Object value, long time, TimeUnit timeUnit);

  
  Long incr(String key, long value);

  
  Long decr(String key, long value);

  // ================================Map=================================
  
  Object hashGet(String key, String item);

  
  Map hashEntries(String key);

  
  void hashSet(String key, Map map);

  
  void hashSet(String key, Map map, long time);

  
  void hashSet(String key, String item, Object value);

  
  void hashSet(String key, String item, Object value, long time);

  
  void hashDelete(String key, Object... item);

  
  void hashDelete(String key, Collection items);

  
  Boolean hashHasKey(String key, String item);

  
  Double hashIncr(String key, String item, double value);

  
  Double hashDecr(String key, String item, double value);

  // ============================set=============================
  
  Set setGet(String key);

  
  Boolean setIsMember(String key, Object value);

  
  Long setAdd(String key, Object... values);

  
  Long setAdd(String key, Collection values);

  
  Long setAdd(String key, long time, Object... values);

  
  Long setSize(String key);

  
  Long setRemove(String key, Object... values);

  // ===============================list=================================
  
  List listRange(String key, long start, long end);

  
  Long listSize(String key);

  
  Object listIndex(String key, long index);

  
  void listRightPush(String key, Object value);

  
  void listRightPush(String key, Object value, long time);

  
  void listRightPushAll(String key, List value);

  
  void listRightPushAll(String key, List value, long time);

  
  void listSet(String key, long index, Object value);

  
  Long listRemove(String key, long count, Object value);
}



RedisServiceImpl.java

package com.leven.mybatis.core.service.impl;

import com.leven.commons.model.exception.SPIException;
import com.leven.mybatis.model.constant.Constant;
import com.leven.mybatis.core.service.RedisService;
import com.leven.mybatis.model.constant.ExceptionCode;
import lombok.extern.slf4j.Slf4j;
import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.data.redis.core.RedisTemplate;
import org.springframework.stereotype.Service;

import java.util.*;
import java.util.concurrent.TimeUnit;


@Slf4j
@Service
public class RedisServiceImpl implements RedisService {

  
  private static final String PREFIX = Constant.APPLICATION;

  @Autowired
  private RedisTemplate redisTemplate;

  // =============================common============================
  
  @Override
  public void expire(String key, long time) {
    redisTemplate.expire(getKey(key), time, TimeUnit.SECONDS);
  }

  
  @Override
  public void expireAt(String key, Date expireAt) {
    redisTemplate.expireAt(getKey(key), expireAt);
  }

  
  @Override
  public Long getExpire(String key) {
    return redisTemplate.getExpire(getKey(key), TimeUnit.SECONDS);
  }

  
  @Override
  public Boolean hasKey(String key) {
    return redisTemplate.hasKey(getKey(key));
  }

  
  @Override
  public void delete(String... keys) {
    if (keys != null && keys.length > 0) {
      if (keys.length == 1) {
 redisTemplate.delete(getKey(keys[0]));
      } else {
 List keyList = new ArrayList<>(keys.length);
 for (String key : keys) {
   keyList.add(getKey(key));
 }
 redisTemplate.delete(keyList);
      }
    }
  }

  
  @Override
  public void delete(Collection keys) {
    if (keys != null && !keys.isEmpty()) {
      List keyList = new ArrayList<>(keys.size());
      for (String key : keys) {
 keyList.add(getKey(key));
      }
      redisTemplate.delete(keyList);
    }
  }

  // ============================String=============================
  
  @Override
  public Object get(String key) {
    return key == null ? null : redisTemplate.opsForValue().get(getKey(key));
  }

  
  @Override
  public void set(String key, Object value) {
    redisTemplate.opsForValue().set(getKey(key), value);
  }

  
  @Override
  public void set(String key, Object value, long time) {
    set(key, value, time, TimeUnit.SECONDS);
  }

  
  @Override
  public void set(String key, Object value, long time, TimeUnit timeUnit) {
    if (time > 0) {
      redisTemplate.opsForValue().set(getKey(key), value, time, timeUnit);
    } else {
      set(getKey(key), value);
    }
  }

  
  @Override
  public Long incr(String key, long value) {
    if (value < 1) {
      throw new SPIException(ExceptionCode.RUNTIME_UNITE_EXP,"递增因子必须大于0");
    }
    return redisTemplate.opsForValue().increment(getKey(key), value);
  }

  
  @Override
  public Long decr(String key, long value) {
    if (value < 1) {
      throw new SPIException(ExceptionCode.RUNTIME_UNITE_EXP,"递减因子必须大于0");
    }
    return redisTemplate.opsForValue().decrement(getKey(key), value);
  }

  // ================================Map=================================
  
  @Override
  public Object hashGet(String key, String item) {
    return redisTemplate.opsForHash().get(getKey(key), item);
  }

  
  @Override
  public Map hashEntries(String key) {
    return redisTemplate.opsForHash().entries(getKey(key));
  }

  
  @Override
  public void hashSet(String key, Map map) {
    redisTemplate.opsForHash().putAll(getKey(key), map);
  }

  
  @Override
  public void hashSet(String key, Map map, long time) {
    String k = getKey(key);
    redisTemplate.opsForHash().putAll(k, map);
    if (time > 0) {
      expire(k, time);
    }
  }

  
  @Override
  public void hashSet(String key, String item, Object value) {
    redisTemplate.opsForHash().putIfAbsent(getKey(key), item, value);
  }

  
  @Override
  public void hashSet(String key, String item, Object value, long time) {
    String k = getKey(key);
    redisTemplate.opsForHash().putIfAbsent(k, item, value);
    if (time > 0) {
      expire(k, time);
    }
  }

  
  @Override
  public void hashDelete(String key, Object... item) {
    redisTemplate.opsForHash().delete(getKey(key), item);
  }

  
  @Override
  public void hashDelete(String key, Collection items) {
    redisTemplate.opsForHash().delete(getKey(key), items.toArray());
  }

  
  @Override
  public Boolean hashHasKey(String key, String item) {
    return redisTemplate.opsForHash().hasKey(getKey(key), item);
  }

  
  @Override
  public Double hashIncr(String key, String item, double value) {
    if (value < 1) {
      throw new SPIException(ExceptionCode.RUNTIME_UNITE_EXP,"递增因子必须大于0");
    }
    return redisTemplate.opsForHash().increment(getKey(key), item, value);
  }

  
  @Override
  public Double hashDecr(String key, String item, double value) {
    if (value < 1) {
      throw new SPIException(ExceptionCode.RUNTIME_UNITE_EXP,"递减因子必须大于0");
    }
    return redisTemplate.opsForHash().increment(getKey(key), item, -value);
  }

  // ============================set=============================
  
  @Override
  public Set setGet(String key) {
    return redisTemplate.opsForSet().members(getKey(key));
  }

  
  @Override
  public Boolean setIsMember(String key, Object value) {
    return redisTemplate.opsForSet().isMember(getKey(key), value);
  }

  
  @Override
  public Long setAdd(String key, Object... values) {
    return redisTemplate.opsForSet().add(getKey(key), values);
  }

  
  @Override
  public Long setAdd(String key, Collection values) {
    return redisTemplate.opsForSet().add(getKey(key), values.toArray());
  }

  
  @Override
  public Long setAdd(String key, long time, Object... values) {
    String k = getKey(key);
    Long count = redisTemplate.opsForSet().add(k, values);
    if (time > 0){
      expire(k, time);
    }
    return count;
  }

  
  @Override
  public Long setSize(String key) {
    return redisTemplate.opsForSet().size(getKey(key));
  }

  
  @Override
  public Long setRemove(String key, Object... values) {
    return redisTemplate.opsForSet().remove(getKey(key), values);
  }

  // ===============================list=================================
  
  @Override
  public List listRange(String key, long start, long end) {
    return redisTemplate.opsForList().range(getKey(key), start, end);
  }

  
  @Override
  public Long listSize(String key) {
    return redisTemplate.opsForList().size(getKey(key));
  }

  
  @Override
  public Object listIndex(String key, long index) {
    return redisTemplate.opsForList().index(getKey(key), index);
  }

  
  @Override
  public void listRightPush(String key, Object value) {
    redisTemplate.opsForList().rightPush(getKey(key), value);
  }

  
  @Override
  public void listRightPush(String key, Object value, long time) {
    String k = getKey(key);
    redisTemplate.opsForList().rightPush(k, value);
    if (time > 0){
      expire(k, time);
    }
  }

  
  @Override
  public void listRightPushAll(String key, List value) {
    redisTemplate.opsForList().rightPushAll(getKey(key), value);
  }

  
  @Override
  public void listRightPushAll(String key, List value, long time) {
    String k = getKey(key);
    redisTemplate.opsForList().rightPushAll(k, value);
    if (time > 0) {
      expire(k, time);
    }
  }

  
  @Override
  public void listSet(String key, long index, Object value) {
    redisTemplate.opsForList().set(getKey(key), index, value);
  }

  
  @Override
  public Long listRemove(String key, long count, Object value) {
    return redisTemplate.opsForList().remove(getKey(key), count, value);
  }

  private String getKey(String key) {
    return PREFIX + ":" + key;
  }
}

3、实现MyBatis的Cache接口

MybatisRedisCache.java

package com.leven.mybatis.core.cache;

import com.leven.commons.core.util.ApplicationContextUtils;
import com.leven.commons.model.exception.SPIException;
import com.leven.mybatis.core.service.RedisService;
import com.leven.mybatis.model.constant.ExceptionCode;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.lang3.RandomUtils;
import org.apache.ibatis.cache.Cache;

import java.security.MessageDigest;
import java.util.HashSet;
import java.util.Map;
import java.util.Set;
import java.util.concurrent.TimeUnit;
import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;


@Slf4j
public class MybatisRedisCache implements Cache {

  
  private static final String CHARSET = "utf-8";
  
  private static final String ALGORITHM = "SHA-256";
  
  private static final String CACHE_NAME = "MyBatis:";
  
  private final ReadWriteLock readWriteLock = new ReentrantReadWriteLock();
  
  private final String id;
  
  private static volatile RedisService redisService;
  
  private volatile MessageDigest messageDigest;

  /////////////////////// 解决缓存雪崩,具体范围根据业务需要设置合理值 //////////////////////////
  
  private static final int MIN_EXPIRE_MINUTES = 60;
  
  private static final int MAX_EXPIRE_MINUTES = 120;

  
  public MybatisRedisCache(String id) {
    if (id == null) {
      throw new IllegalArgumentException("Cache instances require an ID");
    }
    this.id = id;
  }

  
  @Override
  public String getId() {
    return id;
  }

  
  @Override
  public void putObject(Object key, Object value) {
    try {
      String strKey = getKey(key);
      // 有效期为1~2小时之间随机,防止雪崩
      int expireMinutes = RandomUtils.nextInt(MIN_EXPIRE_MINUTES, MAX_EXPIRE_MINUTES);
      getRedisService().set(strKey, value, expireMinutes, TimeUnit.MINUTES);
      log.debug("Put cache to redis, id={}", id);
    } catch (Exception e) {
      log.error("Redis put failed, id=" + id, e);
    }
  }

  
  @Override
  public Object getObject(Object key) {
    try {
      String strKey = getKey(key);
      log.debug("Get cache from redis, id={}", id);
      return getRedisService().get(strKey);
    } catch (Exception e) {
      log.error("Redis get failed, fail over to db", e);
      return null;
    }
  }

  
  @Override
  public Object removeObject(Object key) {
    try {
      String strKey = getKey(key);
      getRedisService().delete(strKey);
      log.debug("Remove cache from redis, id={}", id);
    } catch (Exception e) {
      log.error("Redis remove failed", e);
    }
    return null;
  }

  
  @Override
  public void clear() {
    try {
      log.debug("clear cache, id={}", id);
      String hsKey = CACHE_NAME + id;
      // 获取CacheNamespace所有缓存key
      Map idMap = getRedisService().hashEntries(hsKey);
      if (!idMap.isEmpty()) {
 Set keySet = idMap.keySet();
 Set keys = new HashSet<>(keySet.size());
 keySet.forEach(item -> keys.add(item.toString()));
 // 清空CacheNamespace所有缓存
 getRedisService().delete(keys);
 // 清空CacheNamespace
 getRedisService().delete(hsKey);
      }
    } catch (Exception e) {
      log.error("clear cache failed", e);
    }
  }

  
  @Override
  public int getSize() {
    return 0;
  }

  
  @Override
  public ReadWriteLock getReadWriteLock() {
    return readWriteLock;
  }

  
  private String getKey(Object cacheKey) {
    String cacheKeyStr = cacheKey.toString();
    log.debug("count hash key, cache key origin string:{}", cacheKeyStr);
    String strKey = byte2hex(getSHADigest(cacheKeyStr));
    log.debug("hash key:{}", strKey);
    String key = CACHE_NAME + strKey;
    // 在redis额外维护CacheNamespace创建的key,clear的时候只清理当前CacheNamespace的数据
    getRedisService().hashSet(CACHE_NAME + id, key, "1");
    return key;
  }

  
  private byte[] getSHADigest(String data) {
    try {
      if (messageDigest == null) {
 synchronized (MessageDigest.class) {
   if (messageDigest == null) {
     messageDigest = MessageDigest.getInstance(ALGORITHM);
   }
 }
      }
      return messageDigest.digest(data.getBytes(CHARSET));
    } catch (Exception e) {
      log.error("SHA-256 digest error: ", e);
      throw new SPIException(ExceptionCode.RUNTIME_UNITE_EXP,"SHA-256 digest error, id=" + id + ".");
    }
  }

  
  private String byte2hex(byte[] bytes) {
    StringBuilder sign = new StringBuilder();
    for (byte aByte : bytes) {
      String hex = Integer.toHexString(aByte & 0xFF);
      if (hex.length() == 1) {
 sign.append("0");
      }
      sign.append(hex.toUpperCase());
    }
    return sign.toString();
  }

  
  private RedisService getRedisService() {
    if (redisService == null) {
      synchronized (RedisService.class) {
 if (redisService == null) {
   redisService = ApplicationContextUtils.getBeanByClass(RedisService.class);
 }
      }
    }
    return redisService;
  }
}

到此这篇关于MyBatis整合Redis实现二级缓存的示例代码的文章就介绍到这了,更多相关MyBatis整合Redis二级缓存内容请搜索考高分网以前的文章或继续浏览下面的相关文章希望大家以后多多支持考高分网!

转载请注明:文章转载自 www.mshxw.com
我们一直用心在做
关于我们 文章归档 网站地图 联系我们

版权所有 (c)2021-2022 MSHXW.COM

ICP备案号:晋ICP备2021003244-6号