Mybatis-Redis 2次キャッシュ分散実装

11726 ワード

Mybatis 2次キャッシュのデフォルトorg.apache.ibatis.cache.impl.PerpetualCacheが実装する(メモリベースのMapcache)では、プロジェクトの分散配置では、マルチインスタンス間の分散キャッシュの一貫性が保証されないため、分散配置に適応するように変更する必要があります.
MybatisはEhcache 2級キャッシュ構成をサポートし、デフォルトは単一インスタンスの配置に適用され、分散配置もサポートできる(配置が複雑で、メンテナンスが困難で、RMI(手動、自動-マルチキャスト)、JGroups、EhCache Serverなどの配置方式をサポートする).
Ehcache分散配置については、次の項目を参照してください.
https://blog.csdn.net/tang06211015/article/details/52281551
http://blog.sina.com.cn/s/blog_6151984a0101816j.html
 
Ehcache&Redis比較:
(1)Ehcache(分散キャッシュ)は直接jvm仮想マシンでキャッシュされ、速度が速く、効率が高い.しかし,キャッシュ共有が面倒でクラスタ分散アプリケーションが不便である.
(2)Redis(集中型キャッシュ)はsocketを介してキャッシュサービスにアクセスし,ecacheよりも効率が低く,データベースよりもずっと速く,クラスタや分散型キャッシュの処理が便利で成熟したスキームがある.
そのため、Redisを使用して分散キャッシュをサポートすることを考慮し、Mybatisはmybatis-redisプラグインを公式に提供しています(http://www.mybatis.org/redis-cache/)、公式プラグインは個別に構成する必要があります/redis.PropertiesはJedisConfigPoolを維持しているが、個別の構成がプロジェクトの既存のRedis構成と重複し、ローカル構成を多重化できないことを考慮して、公式orgを参照することにした.mybatis.caches.redis.RedisCacheは自分のMybatisRedisCacheを書き直します.
MybatisRedisCacheは以下のように実現される.
import com.fasterxml.jackson.annotation.JsonAutoDetect;
import com.fasterxml.jackson.annotation.PropertyAccessor;
import com.fasterxml.jackson.databind.ObjectMapper;
import org.apache.ibatis.cache.Cache;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.data.redis.core.RedisTemplate;

import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;

/**
 * Mybatis - redis    
 *
 * @author luohq
 * @date 2019/3/15
 */
public final class MybatisRedisCache implements Cache {
    /**
     *      
     */
    private static final Logger logger = LogManager.getLogger(MybatisRedisCache.class);

    /**
     *    
     */
    private final ReadWriteLock readWriteLock = new ReentrantReadWriteLock();
    /**
     * ID
     */
    private String id;

    /**
     *   redisTemplate
     */
    private static RedisTemplate redisTemplate;

    /**
     * Jackson-databind      (  )
     */
    private static ObjectMapper objectMapper;

    /**
     *        
     */
    static {
        objectMapper = new ObjectMapper();
        //         
        objectMapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        /**
         *        (  objectMapper.readValue(hashVal, Object.class)                  
         *   :             (  ))
         */
        objectMapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
    }

    public MybatisRedisCache() {
    }

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


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

    @Override
    public int getSize() {
        try {
            Long size = redisTemplate.opsForHash().size(this.id.toString());
            logger.info("MybatisRedisCache.getSize: {}->{}", id, size);
            return size.intValue();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return 0;
    }

    @Override
    public void putObject(final Object key, final Object value) {
        try {
            String hashVal = objectMapper.writeValueAsString(value);
            logger.info("MybatisRedisCache.putObject: {}->{}->{}", id, key, hashVal);
            redisTemplate.opsForHash().put(this.id.toString(), key.toString(), hashVal);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @Override
    public Object getObject(final Object key) {
        try {
            String hashVal = (String) redisTemplate.opsForHash().get(this.id.toString(), key.toString());
            logger.info("MybatisRedisCache.getObject: {}->{}->{}", id, key, hashVal);
            if (null == hashVal) {
                return null;
            }
            return objectMapper.readValue(hashVal, Object.class);
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }

    @Override
    public Object removeObject(final Object key) {
        try {
            redisTemplate.opsForHash().delete(this.id.toString(), key.toString());
            logger.info("MybatisRedisCache.removeObject: {}->{}->{}", id, key);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

    @Override
    public void clear() {
        try {
            redisTemplate.delete(this.id.toString());
            logger.info("MybatisRedisCache.clear: {}", id);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

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

    @Override
    public String toString() {
        return "MybatisRedisCache {" + this.id + "}";
    }

    /**
     *   redisTemplate
     *
     * @param redisTemplate
     */
    public void setRedisTemplate(RedisTemplate redisTemplate) {
        MybatisRedisCache.redisTemplate = redisTemplate;
    }
}


MybatisRedisCacheの改良版:
改善点は次のとおりです.
(1)シーケンス化器をredisTemplateに直接配置し、redisTemplateがシーケンス化を担当する.
コードは次のとおりです.
import com.xxx.util.JsonUtils;
import org.apache.ibatis.cache.Cache;
import org.apache.logging.log4j.LogManager;
import org.apache.logging.log4j.Logger;
import org.springframework.data.redis.core.RedisTemplate;

import java.util.concurrent.locks.ReadWriteLock;
import java.util.concurrent.locks.ReentrantReadWriteLock;

/**
 * Mybatis - redis    
 *
 * @author luohq
 * @date 2019/3/15
 */
public final class MybatisRedisCache implements Cache {
    /**
     *      
     */
    private static final Logger logger = LogManager.getLogger(MybatisRedisCache.class);

    /**
     *    
     */
    private final ReadWriteLock readWriteLock = new ReentrantReadWriteLock();
    /**
     * ID
     */
    private String id;

    /**
     *   redisTemplate
     */
    private static RedisTemplate redisTemplate;

    public MybatisRedisCache() {
    }

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


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

    @Override
    public int getSize() {
        try {
            Long size = redisTemplate.opsForHash().size(this.id.toString());
            logger.debug("MybatisRedisCache.getSize: {}->{}", id, size);
            return size.intValue();
        } catch (Exception e) {
            e.printStackTrace();
        }
        return 0;
    }

    @Override
    public void putObject(final Object key, final Object value) {
        try {
            logger.debug("MybatisRedisCache.putObject: {}->{}->{}", id, key, JsonUtils.toJson(value));
            redisTemplate.opsForHash().put(this.id.toString(), key.toString(), value);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

    @Override
    public Object getObject(final Object key) {
        try {
            Object hashVal = redisTemplate.opsForHash().get(this.id.toString(), key.toString());
            logger.debug("MybatisRedisCache.getObject: {}->{}->{}", id, key, JsonUtils.toJson(hashVal));
            return hashVal;
        } catch (Exception e) {
            e.printStackTrace();
            return null;
        }
    }

    @Override
    public Object removeObject(final Object key) {
        try {
            redisTemplate.opsForHash().delete(this.id.toString(), key.toString());
            logger.debug("MybatisRedisCache.removeObject: {}->{}->{}", id, key);
        } catch (Exception e) {
            e.printStackTrace();
        }
        return null;
    }

    @Override
    public void clear() {
        try {
            redisTemplate.delete(this.id.toString());
            logger.debug("MybatisRedisCache.clear: {}", id);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

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

    @Override
    public String toString() {
        return "MybatisRedisCache {" + this.id + "}";
    }

    /**
     *   redisTemplate
     *
     * @param redisTemplate
     */
    public void setRedisTemplate(RedisTemplate redisTemplate) {
        MybatisRedisCache.redisTemplate = redisTemplate;
    }
}

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;

/**
 * Redis  
 *
 * @author luohq
 * @date: 2019/03/13
 */

@Configuration
public class RedisConfig {

    /**
     *   RedisTemplate
     *
     * @param factory
     * @return
     */
    @Bean
    public RedisTemplate redisTemplate(RedisConnectionFactory factory, Jackson2JsonRedisSerializer redisJsonSerializer) {
        RedisTemplate template = new RedisTemplate<>();
        //redis    
        template.setConnectionFactory(factory);
        StringRedisSerializer stringRedisSerializer = new StringRedisSerializer();
        //redis.key    
        template.setKeySerializer(stringRedisSerializer);
        //redis.value    
        template.setValueSerializer(redisJsonSerializer);
        //redis.hash.key    
        template.setHashKeySerializer(stringRedisSerializer);
        //redis.hash.value    
        template.setHashValueSerializer(redisJsonSerializer);
        //         
        template.afterPropertiesSet();
        //    redis    
        template.setEnableTransactionSupport(true);
        return template;
    }

    /**
     *   redis Json    
     *
     * @return
     */
    @Bean
    public Jackson2JsonRedisSerializer redisJsonSerializer() {
        //  Jackson2JsonRedisSerializer         redis value (    JDK      )
        Jackson2JsonRedisSerializer serializer = new Jackson2JsonRedisSerializer(Object.class);
        ObjectMapper mapper = new ObjectMapper();
        mapper.setVisibility(PropertyAccessor.ALL, JsonAutoDetect.Visibility.ANY);
        mapper.enableDefaultTyping(ObjectMapper.DefaultTyping.NON_FINAL);
        serializer.setObjectMapper(mapper);
        return serializer;
    }

}

使用方法:
(1)Mybatis 2次キャッシュ設定をオンにする
方式1:mybatis-config.xml

    
        
        
    
   ...

方式2:Springboot-アプリケーション.properties
#              。
mybatis.configuration.cache-enabled=true

(2)mapper.xml 2次キャッシュの使用



   
   
   ......