Qt Grpc

最近又回归了金融行业，做 PC 客户端软件

服务端用 go 写的，用了 grpc，自然客户端也要共用 proto 文件

正巧，Qt 6.8 正式纳入了 qt grpc 模块，让我们搭建环境，Thinking in Qt！

Q_ENUM_NS

Qt GRPC 模块一般和 Qt Protobuf 模块一起使用

它不是开箱可用的，必须先安装 protoc，可选安装 openssl

众所周知，Qt6 使用 CMake 构建工程，默认不支持 qmake 导入该模块

Qt 提供了 Protobuf 插件，通过引入 ProtobufTools 模块


xxxxxxxxxx
1
1
find_package(Qt6 COMPONENTS ProtobufTools REQUIRED)

Qt 提供了 GRPC 插件，通过引入 GrpcTools 模块


xxxxxxxxxx
1
1
find_package(Qt6 COMPONENTS GrpcTools REQUIRED)

因为默认的 protoc 生成的都是 C++ 的类型，比如 std::string、std::vector

通过 Qt 的插件：qtprotobufgen 和 qtgrpcgen，生成的 .h 和 .cpp 就是 QString、QList 类型

生成的枚举类型自带 Q_ENUM_NS，可以直接 qDebug，也可以通过 QMetaEnum 转成 QString


xxxxxxxxxx
19
1
#include <QMetaEnum>
2
#include <QDebug>
3

4
namespace MyNamespace {
5
Q_NAMESPACE
6
enum class MyEnum : int32_t {
7
    ValueA = 0,
8
    ValueB = 1,
9
    ValueC = 2,
10
};
11
Q_ENUM_NS(MyEnum)
12
}
13

14
MyNamespace::MyEnum myValue = MyNamespace::MyEnum::ValueA;
15
QMetaEnum metaEnum = QMetaEnum::fromType<MyNamespace::MyEnum>();
16
QString str = metaEnum.valueToKey(int(myValue));
17

18
qDebug() << myValue; // 输出 MyNamespace::MyEnum::ValueA
19
qDebug() << str;     // 输出 "ValueA"

vcpkg

Qt 推荐使用 vcpkg 安装 gRPC、Protobuf 和 OpenSSL 模块

这里说下 Qt Creator 配置 vcpkg

打开终端，依次输入命令，安装 protobuf、grpc 和 openssl


xxxxxxxxxx
6
1
cd C:\
2
git clone https://github.com/microsoft/vcpkg.git
3
bootstrap-vcpkg.bat
4
vcpkg.exe install protobuf
5
vcpkg.exe install grpc
6
vcpkg.exe install openssl

打开 Qt Creator，点击【帮助】——【关于插件...】

新建项目后（Build system 选 cmake），点击【文件】——【New File...】

编辑 vcpkg.json

CMakeLists.txt

官网的太简单，这里给一份复杂点的参考，方便大家复制粘贴


xxxxxxxxxx
35
1
├─image
2
│  └─image.qrc
3
│  └─my_client.ico
4
│
5
├─pem
6
│  └─pem.qrc
7
│  └─ca-cert.pem
8
│  └─ca-key.pem
9
│  └─client-cert.pem
10
│  └─client-key.pem
11
│  └─client-req.pem
12
│
13
├─proto
14
│  ├─common
15
│  │  ├─const.proto
16
│  │  └─param.proto
17
│  │
18
│  ├─md
19
│  │  └─md.proto
20
│  │
21
│  ├─trader
22
│  │  └─trader.proto
23
│  │
24
│  └─tt
25
│     └─tt_server.proto
26
│
27
├─main.cpp
28
│
29
├─mainwindow.cpp
30
│
31
├─mainwindow.h
32
│
33
├─vcpkg.json
34
│
35
└─CMakeLists.txt


xxxxxxxxxx
104
1
cmake_minimum_required(VERSION 3.16)
2

3
project(my_client VERSION 0.1 LANGUAGES CXX)
4

5
set(CMAKE_AUTOUIC ON)
6
set(CMAKE_AUTOMOC ON)
7
set(CMAKE_AUTORCC ON)
8

9
set(CMAKE_CXX_STANDARD 17)
10
set(CMAKE_CXX_STANDARD_REQUIRED ON)
11

12
find_package(OpenSSL REQUIRED)
13

14
find_package(Qt6 REQUIRED COMPONENTS
15
    Core
16
    Grpc
17
    GrpcTools
18
    Gui
19
    Protobuf
20
    ProtobufQtCoreTypes
21
    ProtobufQtGuiTypes
22
    ProtobufTools
23
    ProtobufWellKnownTypes
24
    Widgets
25
)
26

27
set(SOURCES
28
    main.cpp
29
    mainwindow.h
30
    mainwindow.cpp
31
    mainwindow.ui
32
    
33
)
34

35
qt_add_executable(my_client WIN32
36
    ${SOURCES}
37
    image/image.qrc
38
    pem/pem.qrc
39
)
40

41
target_compile_options(my_client PRIVATE /utf-8)
42

43
qt_add_protobuf(my_client
44
    PROTO_FILES proto/common/const.proto
45
    PROTO_INCLUDES ${CMAKE_CURRENT_SOURCE_DIR}
46
    OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/proto/common
47
)
48

49
qt_add_protobuf(my_client
50
    PROTO_FILES proto/common/param.proto
51
    PROTO_INCLUDES ${CMAKE_CURRENT_SOURCE_DIR}
52
    OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/proto/common
53
)
54

55
qt_add_protobuf(my_client
56
    PROTO_FILES proto/md/md.proto
57
    PROTO_INCLUDES ${CMAKE_CURRENT_SOURCE_DIR}
58
    OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/proto/md
59
)
60

61
qt_add_protobuf(my_client
62
    PROTO_FILES proto/trader/trader.proto
63
    PROTO_INCLUDES ${CMAKE_CURRENT_SOURCE_DIR}
64
    OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/proto/trader
65
)
66

67
qt_add_protobuf(my_client
68
    PROTO_FILES proto/tt/tt_server.proto
69
    PROTO_INCLUDES ${CMAKE_CURRENT_SOURCE_DIR}
70
    OUTPUT_DIRECTORY ${CMAKE_CURRENT_BINARY_DIR}/proto/tt
71
)
72

73
qt_add_grpc(my_client
74
    CLIENT
75
    PROTO_FILES
76
        ${CMAKE_CURRENT_SOURCE_DIR}/proto/md/md.proto
77
        ${CMAKE_CURRENT_SOURCE_DIR}/proto/tt/tt_server.proto
78
    PROTO_INCLUDES
79
        ${CMAKE_CURRENT_SOURCE_DIR}
80
        ${CMAKE_CURRENT_SOURCE_DIR}/proto/md
81
        ${CMAKE_CURRENT_SOURCE_DIR}/proto/tt
82
)
83

84
target_include_directories(my_client
85
    PRIVATE
86
        ${CMAKE_CURRENT_SOURCE_DIR}
87
        ${CMAKE_BINARY_DIR
88
        proto/common
89
        proto/trader
90
        proto/md
91
        proto/tt
92
)
93

94
target_link_libraries(my_client PRIVATE
95
    OpenSSL::SSL
96
    OpenSSL::Crypto
97
    Qt6::Core
98
    Qt6::Grpc
99
    Qt6::Gui
100
    Qt6::Protobuf
101
    Qt6::ProtobufWellKnownTypes
102
    Qt6::Widgets
103
)
104

这样，会在 build/Desktop_Qt_6_8_3_MSVC2022_64bit-RelWithDebInfo/proto 文件夹生成各种 _qtprotoreg.cpp、*.qpb.cpp 和 *.qpb.h

TLS


x
1
QFile certFile(":/pem/client-cert.pem");
2
certFile.open(QIODevice::ReadOnly);
3
QSslCertificate serverCert(&certFile);
4
certFile.close();
5
QFile keyFile(":/pem/client-key.pem");
6
keyFile.open(QIODevice::ReadOnly);
7
QSslKey serverKey(&keyFile, QSsl::Rsa, QSsl::Pem);
8
keyFile.close();
9
QFile caCertFile(":/pem/ca-cert.pem");
10
caCertFile.open(QIODevice::ReadOnly);
11
QSslCertificate caCert(&caCertFile);
12
caCertFile.close();
13
QSslConfiguration sslConfig;
14
sslConfig.setLocalCertificate(serverCert);
15
sslConfig.setPrivateKey(serverKey);
16
sslConfig.addCaCertificate(caCert);
17
sslConfig.setPeerVerifyMode(QSslSocket::VerifyPeer);
18
sslConfig.setProtocol(QSsl::TlsV1_2);
19
sslConfig.setAllowedNextProtocols({{"h2"}});
20
QGrpcChannelOptions channelOptions;
21
channelOptions.setSslConfiguration(sslConfig);
22
auto tt_server_channel = std::make_shared<QGrpcHttp2Channel>(QUrl("https://127.0.0.1:7777"), channelOptions);
23
tt_server_client->attachChannel(tt_server_channel);

这里要特别提一下这句


xxxxxxxxxx
1
1
sslConfig.setAllowedNextProtocols({{"h2"}});

一开始一直连不上服务器

非常感谢下面这个链接，帮了我大忙

https://github.com/jgaa/next-app/blob/74705d3612a90c7f9f638c2b4bc68951123f9f7c/src/NextAppUi/ServerComm.cpp#L203

另外


x
1
sslConfig.setPeerVerifyMode(QSslSocket::VerifyPeer);

也可以改成


xxxxxxxxxx
1
1
sslConfig.setPeerVerifyMode(QSslSocket::VerifyNone);

这样就不用验证 key 了


x
1
sslConfig.setProtocol(QSsl::TlsV1_3); 
2

3
//也可以根据情况改成
4

5
sslConfig.setProtocol(QSsl::TlsV1_2);

GRPC

qt grpc 主要有 unary calls 和 bidirectional streams （以及 server streams 和 client streams）

通过 QGrpcCallReply 和 QGrpcBidiStream 来使用，这里简单分享下用法


xxxxxxxxxx
16
1
qint64 requestTime = QDateTime::currentMSecsSinceEpoch();
2
ping::pong::Ping request;
3
request.setTime(requestTime);
4

5
auto reply = cl.PingPong(request,{});
6
QObject::connect(reply.get(), &QGrpcCallReply::finished, reply.get(),
7
                 [requestTime, replyPtr = reply.get()]() {
8
                     if (const auto response = replyPtr->read<ping::pong::Pong>())
9
                        qDebug() << "Ping-Pong time difference" << response->time() - requestTime;
10
                    qDebug() << "Failed deserialization";
11
                 });
12

13
QObject::connect(reply.get(), &QGrpcCallReply::errorOccurred, stream.get()
14
                 [](const QGrpcStatus &status) {
15
                     qDebug() << "Error occurred: " << status.code() << status.message();
16
                 });


xxxxxxxxxx
17
1
QObject::connect(stream.get(), &QGrpcBidiStream::messageReceived, stream.get(),
2
                 [streamPtr = stream.get(), &timer, &maxPingPongTime, &requestTime]{
3
                     if (const auto response = streamPtr->read<ping::pong::Pong>())
4
                        maxPingPongTime = std::max(maxPingPongTime, response->time() - requestTime);
5
                 });
6

7
QObject::connect(stream.get(), &QGrpcBidiStream::finished, stream.get(),
8
                 [streamPtr = stream.get(), &timer, &maxPingPongTime]{
9
                     qDebug() << "Maximum Ping-Pong time: " << maxPingPongTime;
10
                     timer.stop();
11
                 });
12

13
QObject::connect(stream.get(), &QGrpcBidiStream::errorOccurred, stream.get(),
14
                 [&timer](const QGrpcStatus &status){
15
                     qDebug() << "Error occurred: " << status.code() << status.message();
16
                     timer.stop();
17
                 });

可以登录 Qt 官方的 git，查看最新的 demo https://code.qt.io/cgit/qt/qtgrpc.git/tree/examples/grpc

Copilot

之前我一直用网页打开 chatgpt.com，写 prompt 复制粘贴代码

Qt Creator 15.0.0 已经集成了 Copilot 插件，改变了我的编程习惯

首先是安装 node.js

https://nodejs.org/en

然后安装 Neovim

https://neovim.io

最后 clone 以下仓库，参考下图配置 node.exe 及 language-server.js


xxxxxxxxxx
1
1
git clone https://github.com/github/copilot.vim.git

现在我编写代码都常开代理，善用 tab 了

分享下我的快捷键设置

End

最后的最后，再次感谢 vcpkg 和 copilot！

0FE79CD3