MyBatis-RedisCache源码分析

Terwer 后端开发 MyBatis评论211字数 3447阅读11分29秒阅读模式
摘要

RedisCache 是 MyBatis 的二级缓存实现类,通过操作 jedis 来实现数据的存储和获取。构造方法中通过 RedisConfigurationBuilder 创建 RedisConfig 对象,并使用该对象创建 Jedis 连接池。

回顾

在前面,我们通过 redis​ 集成了 MyBatis​ 的二级缓存,MyBatis的二级缓存整合redis ,接下来,我们来分析一下 RedisCache​ 的源码。文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

源码分析

RedisCache 主要是通过实现 Cache 接口来做的。数据存储和获取主要是通过操作 jedis 来实现。文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

public final class RedisCache implements Cache {
    private final ReadWriteLock readWriteLock = new DummyReadWriteLock();
    private String id;
    private static JedisPool pool;

    public RedisCache(String id) {
        if (id == null) {
            throw new IllegalArgumentException("Cache instances require an ID");
        } else {
            this.id = id;
            RedisConfig redisConfig = RedisConfigurationBuilder.getInstance().parseConfiguration();
            pool = new JedisPool(redisConfig, redisConfig.getHost(), redisConfig.getPort(), redisConfig.getConnectionTimeout(), redisConfig.getSoTimeout(), redisConfig.getPassword(), redisConfig.getDatabase(), redisConfig.getClientName());
        }
    }
}

RedisCache 在 MyBatis 启动的时候由 MyBatis 的 CacheBuilder​ 构建,构建的方式就是调用 Cache​ 实现类的带 id​ 参数的构造方法文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

// CacheBuilder.java

public Cache build() {
    setDefaultImplementations();
    Cache cache = newBaseCacheInstance(implementation, id);
    setCacheProperties(cache);
}

private Cache newBaseCacheInstance(Class<? extends Cache> cacheClass, String id) {
    Constructor<? extends Cache> cacheConstructor = getBaseCacheConstructor(cacheClass);
    try {
        return cacheConstructor.newInstance(id);
    } catch (Exception e) {
        throw new CacheException("Could not instantiate cache implementation (" + cacheClass + "). Cause: " + e, e);
    }
}

RedisCache​ 的构造方法中,调用了 RedisConfigurationBuilder​ 来常见 RedisConfig​ 对象,并通过 RedisConfig​ 对象来创建 Jedis​ 。文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

RedisConfig​ 继承了 JedisPoolConfig​ ,并定义了一些属性来读取配置。文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

public class RedisConfig extends JedisPoolConfig {
    private String host = "localhost";
    private int port = 6379;
    private int connectionTimeout = 2000;
    private int soTimeout = 2000;
    private String password;
    private int database = 0;
    private String clientName;
}

RedisConfig​ 是由 RedisConfigurationBuilder​​ 构建的,这个类的主要方法是 parseConfiguration文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

public RedisConfig parseConfiguration(ClassLoader classLoader) {
    Properties config = new Properties();
    InputStream input = classLoader.getResourceAsStream(this.redisPropertiesFilename);
    if (input != null) {
        try {
            config.load(input);
        } catch (IOException var12) {
            throw new RuntimeException("An error occurred while reading classpath property '" + this.redisPropertiesFilename + "', see nested exceptions", var12);
        } finally {
            try {
                input.close();
            } catch (IOException var11) {
            }

        }
    }

    RedisConfig jedisConfig = new RedisConfig();
    this.setConfigProperties(config, jedisConfig);
    return jedisConfig;
}

该方法从 Resource​ 读取一个 redis.properties​ 文件,其结构如下:文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

host=localhost
port=6379
password=123456
database=0

读取完成之后将内容设置到 RedisConfig 对象中。文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

接下来,RedisCache 使用 RedisCo 创建 Jedis。在 RedisCache 中,实现了一个简单的模板方法来操作 redis:文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

private Object execute(RedisCallback callback) {
    Jedis jedis = pool.getResource();

    Object var3;
    try {
        var3 = callback.doWithRedis(jedis);
    } finally {
        jedis.close();
    }

    return var3;
}

目标接口为 RedisCallback,该接口定义了一个简单的 doWithRedis 方法用来进行 redis 相关操作:文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

public interface RedisCallback {
    Object doWithRedis(Jedis var1);
}

接下来,我们分析一下 Cache 中的两个重要方法 putObject()和 getObject()文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

public void putObject(final Object key, final Object value) {
    this.execute(new RedisCallback() {
        public Object doWithRedis(Jedis jedis) {
            jedis.hset(RedisCache.this.id.toString().getBytes(), key.toString().getBytes(), SerializeUtil.serialize(value));
            return null;
        }
    });
}
public Object getObject(final Object key) {
    return this.execute(new RedisCallback() {
        public Object doWithRedis(Jedis jedis) {
            return SerializeUtil.unserialize(jedis.hget(RedisCache.this.id.toString().getBytes(), key.toString().getBytes()));
        }
    });
}

可以看出来,MyBatis-RedisCache 采用的是 redis 的 hash​ 结构来存储数据,把 Cache 的 id​ 作为 hash 的 key​(Cache 的 id 在 Mapper 中是 namspace),缓存和读取之前通过 SerializeUtil 进行 序列化 或者 反序列化文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

文章更新历史文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

2024/06/11 同步文章到其他平台 文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

RedisCache 是 MyBatis 的二级缓存实现类,通过操作 jedis 来实现数据的存储和获取。构造方法中通过 RedisConfigurationBuilder 创建 RedisConfig 对象,并使用该对象创建 Jedis 连接池。文章源自浅海拾贝-https://blog.terwergreen.com/mybatisrediscache-source-code-analysis-1tshmo.html

相关文章
  • 扫码加我微信
  • 验证消息请输入:来自你的博客
  • weinxin
  • 我的微信公众号
  • 微信扫一扫与我交流吧
  • weinxin
Terwer
匿名

发表评论

匿名网友 填写信息

:?: :razz: :sad: :evil: :!: :smile: :oops: :grin: :eek: :shock: :???: :cool: :lol: :mad: :twisted: :roll: :wink: :idea: :arrow: :neutral: :cry: :mrgreen: