what

github地址是基于qt、hiredis下面的redis的c++客户端连接程序，官方标注支持

Supported Qt versions: 5.6-5.9
我使用的环境是qt5.9.2

where&when

C++连接redis的地方使用

why

程序基于qt，简单易上手;

how

step1
简单测试，使用的是windows下面的redis服务器，印象中应该是微软维护的redis，直接启动redis-server.exe即可，当然最简单的是使用chocolatey来安装啦
step2
打开qredis-cli.pro工程，编译即可。
step3
简单使用

        /**设置需要连接的redis的配置项*/
        config = new RedisClient::ConnectionConfig (ip);
        config->setPort(port.toInt());

        /**新建连接*/
        connection = new RedisClient::Connection(*config);


        /**连接信号槽 日志信号以及错误数据信号*/
        QObject::connect(connection, &RedisClient::Connection::log, [&](QString msg) {
            QString info = tr("Connection:") + msg;
            qDebug() << info;
            ui->textEdit_info->append(info);
        });

        QObject::connect(connection, &RedisClient::Connection::error, [&](QString msg) {
            QString info = tr("Connection error:") + msg;
            qDebug() << info;
            ui->textEdit_info->append(info);
        });


    try {
        //发起连接的建立
        connection->connect();
    } catch (const RedisClient::Connection::Exception& e) {
        qDebug() << QString("Cannot run command:") + e.what();
    }

    //同步设置数据
    QString cmd = QString("SET");
    QString key = "test";
    QString value = "111";
    QVariant setResult = connection->commandSync(cmd, key, value).value();
    qDebug() <<  RedisClient::Response::valueToHumanReadString(setResult);
   
    //异步设置数据，设置回调函数，**回调函数执行的时候已经与回调对象所在的线程是一个线程了**
    QList<QByteArray> rawCmd;
    rawCmd.append("GET");
    rawCmd.append("test");
    connection->command(rawCmd, this, [this](RedisClient::Response r, QString error) {
            if (error.isEmpty()) {
                qDebug() << ("异步获取数据" + RedisClient::Response::valueToHumanReadString(r.value()));
            } else {
                qDebug() << ("异步获取数据错误");
            }
        });

    //同步读取数据
    QString key = "test";
    auto result = connection->commandSync("GET", key);
    QVariant val = result.value();
    qDebug() << RedisClient::Response::valueToHumanReadString(val);

detail

hiredis源码相关

项目文件pri引用中，原始只引用了四个文件，sds.h/sds.c以及read.h/read.c，如下

# Core deps 
# Read API from hiredis
INCLUDEPATH += $$PWD/
DEPENDPATH += $$PWD/hiredis
HEADERS += $$PWD/hiredis/read.h \
                      $$PWD/hiredis/sds.h \
                     $$PWD/hiredis/packed.h \
                     $$PWD/hiredis/endpacked.h
SOURCES += $$PWD/hiredis/read.c \
                     $$PWD/hiredis/sds.c

问题一、字节码对齐问题

packed.h以及unpacked.h是我自己引进来处理msvc以及gcc下面字节码对其的头文件，内容很简单，就是在msvc下面使用

pack(push,1)
pack(pop)

在gcc下面使用

__attribute__ ((__packed__))

文件内容
packed.h

#ifndef PACKED_H
#define PACKED_H

#ifdef _MSC_VER
#define PACKED
#pragma pack(push,1)
#elif defined(__GNUC__)
#define PACKED __attribute__ ((__packed__))
#endif

#endif // PACKED_H

endpacked.h文件内容

#ifndef ENDPACKED_H
#define ENDPACKED_H

#ifdef _MSC_VER
#pragma pack(pop)
#undef PACKED
#elif defined(__GNUC__)
#define PACKED __attribute__ ((__packed__))
#endif

#endif // ENDPACKED_H

所以sds.h就被修改成了

#include "packed.h"
//其他struct的声明
struct sdshdr5 {
    unsigned char flags; /* 3 lsb of type, and 5 msb of string length */
    char buf[];
} PACKED;
struct sdshdr8{
    uint8_t len; /* used */
    uint8_t alloc; /* excluding the header and null terminator */
    unsigned char flags; /* 3 lsb of type, 5 unused bits */
    char buf[];
} PACKED;
//其他struct的声明
#include "endpacked.h"

问题二、sds.h/sds.c

是不是很眼熟的定义，与redis源码里面的sds基本一致，全称是simple dynamic string，详细了解可以参看大作《redis设计与实现》（貌似后面sds也进行了扩展）。
简单说，就是封装了char的动态字符串，与基础c字符串比较,引用子《redis设计与实现》一书。

微信截图_20190312113850.png

问题三、read.h/read.c

初看貌似是在解析redis协议相关东西。具体如何使用需要查看qredisclient代码了。

qredisclient

数据处理时序图

Title:数据处理时序图
Connection->ConnectionConfig: 检查配置是否正确
Connection->AbstractTransporter:检查传输是否已经连接
Connection->AbstractTransporter:初始化传输，关联信号
AbstractTransporter->TransportThread:移到新的线程
TransportThread-->AbstractTransporter:线程启动完毕执行初始化
AbstractTransporter->AbstractTransporter:m_loopTimer时控处理，\n每秒processCommandQueue\n最终调用runCommand
AbstractTransporter->QSslSocket:socket初始化
AbstractTransporter->Redis:连接redis服务器,使用SignalWaiter
Redis-->AbstractTransporter:连接成功，connect信号
AbstractTransporter-->Connection:auth()登录验证
Connection->AbstractTransporter: 封装命令[同步(CommandExecutor)/异步]，\n放入队列\n同步命令设置回调函数,阻塞线程           
AbstractTransporter->QSslSocket:取出头数据m_commands\n封装成RunningCommand
QSslSocket->Redis:发送数据
Redis-->QSslSocket:数据返回
QSslSocket-->AbstractTransporter:readyRead接收数据
AbstractTransporter->AbstractTransporter:ResponseParser接收数据，\n解析应答数据包,\n同步命令则调用回调函数，\n返回数据
AbstractTransporter-->Connection:同步命令返回CommandExecutor回调

简书不识别时序图，使用马克飞象生成

数据处理时序图

流程比较清晰，除了同步命令回调那边有一点绕。
几个注意点：

传输线程Thread启动完毕之后，执行AbstractTransporter的init方法，初始化socket，连接redis

socket连接成功发送connectted信号，Connection中开始auth\ping\all info获取redis服务器的状态

执行同步命令的时候，Command的回调是在CommandExecutor中设置的；后续再收到应答调用sendResponse的时候调用回调

CommandExecutor以及SignalWaiter是封装的用于等待数据执行，设置超时的封装的类

使用hiredis的地方是在接收到数据报文的时候,解析数据项获取应答报文。

  /**读取socket数据项*/
  if (!m_parser.feedBuffer(readFromSocket())) {
      return;
  }

  /**读取一个完整应答报文*/
  resp = m_parser.getNextResponse();

暂时就这样啦。

2019-03-12 qredisclient