DCache 分布式存储系统｜K-K-Row 缓存模块的创建与使用

作者 | Eaton

导语 | 随着微服务与云的发展，分布式架构的需求变得越来越普遍，传统的 SQL 结构化存储方案已经跟不上脚步，于是 NoSQL 出现了。DCache 作为基于 TARS 的分布式 NoSQL 缓存系统，完美支持 TARS 服务。前一篇文章中，我们介绍了怎么创建并使用 KV 模块，本文将继续介绍如何创建和使用 DCache 中的 K-K-Row 缓存模块。

系列文章

DCache 分布式存储系统｜DCache 部署与应用创建

DCache 分布式存储系统｜Key-Value 缓存模块的创建与使用

DCache 分布式存储系统｜K-K-Row 缓存模块的创建与使用

K-K-Row 模块简介

k-k-row，与 key-value 相似，但这里 value 不是字符串，而是相当于一张表，能够存储结构化数据。k-k-row 即 key key row，指通过两个 key，即主索引/主键（Main Key）和联合索引（Union Key），能够唯一确定一条记录 row，如下

不难看出，k-k-row 的存储结构和 SQL 数据库很像，主键相当于表名，映射到 Value。既不需要重复存储数据，也不会带来序列化和并发修改控制的问题，很好的解决了问题。

与 KV 模块相似，我们只需完成以下步骤即可在服务中使用 k-k-row 缓存服务

创建 K-K-Row 缓存模块
获取 DCache 接口文件
创建缓存服务代理
调用缓存模块服务

本文将继续基于 TestDemo 介绍如何创建 K-K-Row 缓存模块，以及怎么在 TARS 服务中调用该服务来缓存数据。

本文使用的示例可以在 GitHub 仓库 DCacheDemo 中查看。

创建 K-K-Row 缓存模块

在文章 Key-Value 缓存模块的创建与使用中，我们已经介绍过如何创建 Key-Value 缓存模块，各类型缓存模块创建流程是相似的，这部分不再赘述，仅介绍不同的部分。

这里我们将缓存模块服务命名为 TestDemoKKRow，cache 类型 选择 k-k-row(MKVCache)，如下

K-K-Row 为多键值类型，配置字段时可以新增多个联合索引或数据字段，点击 添加，如下

确认好已配置信息后，点击 安装发布 即可完成发布。

到这里，我们就可以在其它服务中使用该缓存模块来缓存 K-K-Row 数据了。

获取 DCache 接口文件

DCache 是基于 TARS 开发的，因此使用上和 TARS 服务一样，也是通过 .tars 接口文件来调用对应缓存服务的接口。

我们复制 DCache/src/TarsComm 下的 CacheShare.tars, ProxyShare.tars 和 DCache/src/Proxy 下的 Proxy.tars 到自己项目目录下即可。

本文 Demo 获取 DCache 接口文件后的项目文件结构如下

DCacheDemo
├── CacheShare.tars
├── ProxyShare.tars
├── Proxy.tars
├── config.conf
├── main.cpp
└── makefile

创建缓存服务代理

前一篇文章我们提到过，创建一个应用后会自动创建一个路由服务和代理服务，并通过 TestDemo 介绍了如何创建缓存服务代理来调用服务。

我们继续使用 TestDemo，新增一个模块名 ModuleTestDemoKKRow，值为我们前面创建的模块名 TestDemoKKRow，用于之后通过代理调用该模块，如下。

// main.cpp
#include 
#include 
#include "servant/Communicator.h"
#include "servant/ServantProxy.h"
#include "Proxy.h"

using namespace std;
using namespace tars;

// TestDemo 代理服务对象名
static string DCacheTestDemoObj = "DCache.TestDemoProxyServer.ProxyObj";

// 缓存模块名
static string ModuleTestDemoKV    = "TestDemoKV";
static string ModuleTestDemoKKRow = "TestDemoKKRow";

int main(int argc, char *argv[])
{
    CommunicatorPtr comm = new Communicator();
    try
    {
        TC_Config conf;
        // 解析配置文件
        conf.parseFile("config.conf");
        // 加载配置
        comm->setProperty(conf);
        // 生成代理
        auto prx = comm->stringToProxy(DCacheTestDemoObj);

        // TODO: 调用 DCache 缓存服务
    }
    catch (exception &e)
    {
        cerr << "error: " << e.what() << endl;
    }
    catch (...)
    {
        cerr << "Unknown Error" << endl;
    }
}

调用 K-K-Row 缓存模块服务

通过 TestDemo 代理服务的代理对象和模块名 TestDemoKKRow，我们就能够调用前面创建的K-K-Row 缓存模块的接口了。

本部分将通过简单示例，介绍 k-k-row 类型缓存模块部分接口的使用。关于其它接口的信息，参见 Proxy 接口指南。

接口调用流程与 TARS 服务接口调用流程一致。如果你还不清楚 TARS 服务的调用方式和流程，可以阅读文章 TARS RPC 通信框架｜提供多种远程调用方式了解 TARS 服务的调用方式。

后面的示例中，会使用到三个工具函数，定义如下

// 构建 UpdateValue
DCache::UpdateValue genUpdateValue(DCache::Op op, const string &value)
{
    DCache::UpdateValue updateValue;
    updateValue.op = op;
    updateValue.value = value;
    return updateValue;
}

// 打印 map 类型数据
void printMapData(const map &data)
{
    map::const_iterator it = data.begin();
    while (it != data.end())
    {
        cout << "|" << it->first << ":" << it->second;
        ++it;
    }
    cout << endl;
}

// 打印 vector 数据
void printVectorMapData(const vector> &data)
{
    for (auto item : data)
    {
        printMapData(item);
    }
}

genUpdateValue 用于构建 DCache::UpdateValue 结构，该结构用于存储插入或更新的数据值，在其它类型模块的接口中，经常会用到。printMapData 和 printVectorMapData 用于方便打印返回的数据。

那么接下来，我们来看看怎么使用 K-K-Row 缓存模块。

K-K-Row 模块读写操作

K-K-Row 即多键值模块，一个主键可以对应多条记录。这里我们仅介绍写接口 insertMKV 和读接口 getMKV，其它接口类似。

插入数据

接口 insertMKV 用于插入键值对数据，定义如下

int insertMKV(const InsertMKVReq &req)

其中结构 InsertMKVReq 及其嵌套结构 InsertKeyValue 的定义如下

struct InsertMKVReq
{
  1 require string moduleName;    // 模块名
  2 require InsertKeyValue data;  // 待写入数据
};

struct InsertKeyValue
{
  1 require string mainKey;  // 主key
  2 require map mpValue;  // 除主key外的其他字段数据
  3 require byte ver = 0;           // 版本号
  4 require bool dirty = true;      // 是否设置为脏数据
  5 require bool replace = false;   // 如果记录已存在且replace为true时则覆盖旧记录
  6 require  int  expireTimeSecond = 0;  // 数据过期时间
};

使用示例如下

void testInsertMKV(const string &mainKey, const map &data, DCache::ProxyPrx prx)
{
    cout << "\t-- " << "insertMKV ";
    // 打印准备插入的数据
    printMapData(data);

    // 构造插入数据
    DCache::InsertKeyValue insertData;
    insertData.mainKey = mainKey;

    map::const_iterator it = data.begin();
    while (it != data.end())
    {
        // 构造 UpdateValue
        insertData.mpValue[it->first] = genUpdateValue(DCache::SET, it->second);
        ++it;
    }

    // 构造请求
    DCache::InsertMKVReq insertReq;
    insertReq.moduleName = ModuleTestDemoKKRow;
    insertReq.data = insertData;

    prx->insertMKV(insertReq);
}

获取数据

接口 getMKV 用于根据主键获取主键对应的键值对，定义如下

int getMKV(const GetMKVReq &req, GetMKVRsp &rsp)

请求消息结构 GetMKVReq 及返回消息结构 GetMKVRsp 的定义如下

struct GetMKVReq
{
  1 require string moduleName;  // 模块名
  2 require string mainKey;     // 主key
  3 require string field;       // 需要查询的字段集，多个字段用','分隔如 "a,b", "*"表示所有
  4 require vector cond;   // 查询条件集合，除主Key外的其他字段，多个条件直间为And关系
  5 require bool retEntryCnt = false; // 是否返回主key下的总记录条数
  6 require string idcSpecified = ""; // idc区域
};

struct GetMKVRsp
{
  1 require vector > data;  //查询结果
};

使用示例如下

void testGetMKV(const string &key, DCache::ProxyPrx prx)
{
    cout << "\t-- " << "getMKV    " << '\n';

    // 构造请求
    DCache::GetMKVReq req;
    req.moduleName = ModuleTestDemoKKRow;
    req.mainKey = key;
    req.field = "*";

    DCache::GetMKVRsp rsp;
    prx->getMKV(req, rsp);

    // 打印返回数据
    printVectorMapData(rsp.data);
}

运行示例

我们来实际运行一下上面的使用示例。完整的使用示例可以在 GitHub 仓库 DCacheDemo 中获取。

我们通过 testKKRow 测试上节提到的模块读写接口，我们向同一主键插入两条记录，UID 分别为 test1, test2，如下

void testKKRow(DCache::ProxyPrx prx)
{
    cout << START << " testKKRow" << endl;

    string mainKey = "Key";
    map data;
    data["UID"] = "test1";
    data["VALUE"] = "hello";
    testInsertMKV(mainKey, data, prx);

    data["UID"] = "test2";
    data["VALUE"] = "hey";
    testInsertMKV(mainKey, data, prx);

    testGetMKV(mainKey, prx);

    cout << END << " testKKRow" << endl;
}

接着，在 main 函数中执行

int main(int argc, char *argv[])
{
    ...

        auto prx = comm->stringToProxy(DCacheTestDemoObj);

        // 调用 DCache 缓存服务
        testKKRow(prx);
    ...
}

编译构建并运行示例，结果如下

可以看到，getMKV 返回了两条记录。以上就是DCache缓存模块的具体使用流程。到此，我们成功调用了 DCache 的 K-K-Row 缓存服务。

K-K-Row 缓存模块服务接口

除了设置键值接口 insertMKV 和读取键值接口 getMKV，DCache 中还提供了丰富的 K-K-Row 操作接口，包括批量插入(insertMKVBatch), 删除(delMKV), 更新(updateMKV) 等，如下

// 按主key查询，支持'and'条件匹配
int getMKV(GetMKVReq req, out GetMKVRsp rsp);
// 按主key批量数据查询，给定多个主key，用统一的条件进行匹配查询
int getMKVBatch(MKVBatchReq req, out MKVBatchRsp rsp);
// 按主键批量查询
int getMUKBatch(MUKBatchReq req, out MUKBatchRsp rsp);
// 按主key批量查询，针对每个主key支持'and'，'or'复杂条件匹配
int getMKVBatchEx(MKVBatchExReq req, out MKVBatchExRsp rsp);
// 获取主key下的记录数，返回值为正数时，为主key下记录数
int getMainKeyCount(MainKeyReq req);
// 获取cache中所有的主key，不包含落地db的key
int getAllMainKey(GetAllKeysReq req, out GetAllKeysRsp rsp);
// 插入一条记录到Cache
int insertMKV(InsertMKVReq req);
// 插入批量数据到Cache
int insertMKVBatch(InsertMKVBatchReq req, out MKVBatchWriteRsp rsp);
// 批量更新接口。只支持指定联合key的更新
int updateMKVBatch(UpdateMKVBatchReq req, out MKVBatchWriteRsp rsp);
// 更新Cache记录，更新接口不能更新联合key字段。
int updateMKV(UpdateMKVReq req);
// 原子更新接口。适用于对数据做自增自减操作，多线程操作能保证数据原子更新。
int updateMKVAtom(UpdateMKVAtomReq req);
// 删除 Cache记录
int eraseMKV(MainKeyReq req);
// 删除Cache和Db记录
int delMKV(DelMKVReq req);
// 批量删除, rsp.rspData中存储了每个删除请求的结果
int delMKVBatch(DelMKVBatchReq req, out MKVBatchWriteRsp rsp);

接口的使用方式与前面介绍的 insertMKV 和 getMKV 是类似的，关于接口的具体入参和出参结构可以参考 Proxy 接口指南。

总结

本文通过使用示例，介绍了 DCache 中 K-K-Row 缓存模块的创建和使用方式，满足开发者对结构化缓存数据的需求。

TARS 可以在考虑到易用性和高性能的同时快速构建系统并自动生成代码，帮助开发人员和企业以微服务的方式快速构建自己稳定可靠的分布式应用，从而令开发人员只关注业务逻辑，提高运营效率。多语言、敏捷研发、高可用和高效运营的特性使 TARS 成为企业级产品。

TARS微服务助您数字化转型，欢迎访问：

TARS官网：https://TarsCloud.org

TARS源码：https://github.com/TarsCloud

Linux基金会官方微服务免费课程：https://www.edx.org/course/bu...

获取《TARS官方培训电子书》：https://wj.qq.com/s2/7849909/...

或扫码获取：