显示目录

Qt 使用 curl

Qt 已经提供了 QNetworkAccessManager 用于 Http 访问,Qt 访问网络的 HttpClient 对其进行了简单封装,如下就可以进行 GET 请求:

1
2
3
HttpClient("http://localhost:8080/device").get([](const QString &response) {
qDebug() << response;
});

但是,在非 Qt 项目中就不能使用 QNetworkAccessManager 了,还有就是因为 curl 成熟、强大、跨平台,可能有些项目更希望使用 curl,所以在此以 Windows MinGW 的 Qt 项目为例,介绍 curl 的集成使用。

编译 curl

curl 没有提供编译好的库,需要自己编译,可按照下面的步骤进行(curl 相关的目录根据对应的版本好做出修改)

  • Windows 中可使用 VS2013 编译 curl,所以当然是要先安装 VS2013

  • https://curl.haxx.se/download.html 下载 curl 源码,选择最新版吧,解压得到的压缩包保存到 C:/curl-7.56.0

  • Win + CMD 打开命令行

  • "C:\Program Files (x86)\Microsoft Visual Studio 12.0\VC\bin\vcvars32.bat" 设置 VS 的环境变量,只会当前 CMD 生效

  • cd C:\curl-7.56.0\winbuild

  • nmake /f Makefile.vc mode=dll VC=12 进行编译动态编译,也可以阅读 BUILD.WINDOWS.txt 查看更详细的信息

  • 编译后的库文件保存到 C:\curl-7.56.0\builds\libcurl-vc12-x86-release-dll-ipv6-sspi-winssl,复制此目录到 C 盘根目录,重命名为 libcurl,目录结构如下:

    1
    2
    3
    4
    5
    6
    7
    8
    9
    10
    11
    12
    13
    14
    15
    16
    17
    18
    C:/
    └── libcurl
    ├── bin
    │   ├── curl.exe
    │   └── libcurl.dll
    ├── include
    │   └── curl
    │   ├── curl.h
    │   ├── curlver.h
    │   ├── easy.h
    │   ├── mprintf.h
    │   ├── multi.h
    │   ├── stdcheaders.h
    │   ├── system.h
    │   └── typecheck-gcc.h
    └── lib
    ├── libcurl.exp
    └── libcurl.lib

使用 curl

Qt Creator 中创建一个 Qt 项目,pro 文件里加上 curl 的库信息

1
2
INCLUDEPATH += C:/libcurl/include
LIBS += C:/libcurl/bin/libcurl.dll

这里不需要动态库的索引 .lib 文件,也不需要把 .lib 转换成 .a,直接使用 .dll 就可以了,MinGW 的编译器能够识别,和 VS 的编译器有些不一样。

接下来就可以使用 curl 发送 Http 请求了

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
#include <QDebug>
#include <cstring>
#include <curl/curl.h>

// curl 读取到的数据保存到 std::string
size_t curlSaveResponseToStdString(void *contents, size_t size, size_t nmemb, std::string *s) {
size_t newLength = size * nmemb;
size_t oldLength = s->size();
s->resize(oldLength + newLength);
std::copy((char*)contents, (char*)contents+newLength, s->begin()+oldLength);

return size * nmemb;
}

int main(int argc, char *argv[]) {
// 初始化 curl
CURL *curl = curl_easy_init();

if (curl) {
std::string response;
curl_easy_setopt(curl, CURLOPT_URL, "http://www.qtdebug.com/html/data.json"); // 设置要访问的网址
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlSaveResponseToStdString); // 告诉 curl 保存响应到 string 中
curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response); // 请求的响应保存到变量 response 中
curl_easy_setopt(curl, CURLOPT_VERBOSE, 0L); // 0 不输出请求的详细信息,1 输出
CURLcode code = curl_easy_perform(curl);

if (code == CURLE_OK) {
// std::cout << response << std::endl; // 中文乱码,因为 std::string 对中文的支持不好
// qDebug() << QString::fromUtf8(response.data()); // response.data() 返回的是 UTF-8 的字节数据
qDebug() << QString::fromStdString(response); // 使用 qDebug() 输出,UTF-8 的中文不会乱码
}
} else {
qDebug() << "Error";
}

// 释放 curl 资源
curl_easy_cleanup(curl);

return 0;
}

编译正常,运行时程序异常结束,这是因为程序找不到 libcurl.dll,把 libcurl.dll 复制到编译出来的 exe 目录,再次运行程序,看到控制台输出

“{\”name\”: \”Alice\”}\n”

哈哈,curl 终于集成到我们的项目里了,至于 curl 的更多使用,请执行搜索相关教程即可,在这里就不赘述了,可以看看 C++ 用libcurl库进行http通讯网络编程,这篇文章不错 。

上面演示了 GET 请求,POST 请求只需要设置 CURLOPT_POST 为 1 即可:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
if (curl) {
std::string response;
curl_easy_setopt(curl, CURLOPT_URL, "http://192.168.10.52:8080/rest");
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlSaveResponseToStdString);
curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);

curl_easy_setopt(curl,CURLOPT_POST, 1); // POST 请求
curl_easy_setopt(curl,CURLOPT_POSTFIELDS, "name=赵子龙&department=Dev"); // POST 参数: GET 请求中的中文要进行 URL 编码,否则提示错误

CURLcode code = curl_easy_perform(curl);

if (code == CURLE_OK) {
qDebug() << QString::fromUtf8(response.data());
}
}

参考案例

最后,附上一个小程序,包含了 GET 和 POST 的请求,作为参考:

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
#include <QDebug>
#include <string>
#include <iostream>
#include <curl/curl.h>

std::string get(const char* url, CURLcode *code = NULL, std::list<const char *> headers = std::list<const char *>());
std::string post(const char* url, const char* data = NULL, bool jsonBody = false, CURLcode *code = NULL, std::list<const char *> headers = std::list<const char *>());

int main(int argc, char *argv[]) {
CURLcode code;
std::string r1 = get("http://qtdebug.com/html/data.json");
qDebug() << QString::fromUtf8(r1.data());

qDebug() << "------------------------------------------------";

std::string r2 = post("http://eplatform.edu-edu.com.cn/live/api/auth/login", "{ \"username\": \"u1\", \"password\": \"abcd\"}", true);
qDebug() << QString::fromUtf8(r2.data());

qDebug() << "------------------------------------------------";

std::string r3 = get("http://eplatform.edu-edu.com.cn/live/api/channels/mine", &code, {"Authorization: JWT eyJhbGciOiJIUzI1NiIsInR5cCI6IkpXVCJ9.eyJpZCI6IjU4NjM1Y2Y4NGY0N2M4MGYyNGI1NDQ5NyIsImlhdCI6MTUwOTA3NjY5MCwiZXhwIjoxNTA5MTYzMDkwfQ.6nLBnhjTYJgwjwFf_Lf0LreKryrQ6ITdT-PcGAPhKB8"});
qDebug() << QString::fromUtf8(r3.data());

return 0;
}

// curl 读取到的数据保存到 std::string
size_t curlSaveResponseToStdString(void *contents, size_t size, size_t nmemb, std::string *s) {
size_t newLength = size * nmemb;
size_t oldLength = s->size();
s->resize(oldLength + newLength);
std::copy((char*)contents, (char*)contents+newLength, s->begin()+oldLength);

return size * nmemb;
}

/**
* @brief 执行 HTTP GET 请求
* @param url 请求的 URL
* @param code 请求返回的状态码的指针
* @param headers 请求头
* @return 请求执行成功时返回响应的字符串,失败则返回空字符串,请求是否执行成功可以通过 code 进行判断
*/
std::string get(const char* url, CURLcode *code, std::list<const char *> headers) {
std::string response;

// 初始化 curl
CURL *curl = curl_easy_init();

if (curl) {
struct curl_slist *tempHeaders = NULL;

std::list<const char *>::const_iterator iter;
for (iter = headers.cbegin(); iter != headers.cend(); ++iter) {
tempHeaders = curl_slist_append(tempHeaders, *iter);
}

curl_easy_setopt(curl, CURLOPT_HTTPHEADER, tempHeaders);
curl_easy_setopt(curl, CURLOPT_URL, url);
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlSaveResponseToStdString);
curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
curl_easy_setopt(curl, CURLOPT_VERBOSE, 0);

CURLcode temp = curl_easy_perform(curl);

if (code != NULL) {
*code = temp;
}

curl_slist_free_all(tempHeaders); /* free the header list */
} else {
if (code != NULL) {
*code = CURLE_FAILED_INIT;
}
}

// 释放 curl 资源
curl_easy_cleanup(curl);

return response;
}

/**
* @brief 执行 HTTP POST 请求
* @param url 请求的 URL
* @param data 请求的参数
* @param jsonBody 如果为 true,则请求的参数是 JSON 格式,否则为 Form 表单的格式 key1=value1&key2=value2&...
* @param code 请求返回的状态码的指针
* @param headers 请求头
* @return 请求执行成功时返回响应的字符串,失败则返回空字符串,请求是否执行成功可以通过 code 进行判断
*/
std::string post(const char* url, const char* data, bool jsonBody, CURLcode *code, std::list<const char *> headers) {
std::string response;

// 初始化 curl
CURL *curl = curl_easy_init();

if (curl) {
// Headers
struct curl_slist *tempHeaders = NULL;

std::list<const char *>::const_iterator iter;
for (iter = headers.cbegin(); iter != headers.cend(); ++iter) {
tempHeaders = curl_slist_append(tempHeaders, *iter);
}

if (jsonBody) {
tempHeaders = curl_slist_append(tempHeaders, "Accept: application/json; charset=utf-8");
tempHeaders = curl_slist_append(tempHeaders, "Content-Type: application/json");
}

curl_easy_setopt(curl, CURLOPT_HTTPHEADER, tempHeaders);
curl_easy_setopt(curl, CURLOPT_URL, url);
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, curlSaveResponseToStdString);
curl_easy_setopt(curl, CURLOPT_WRITEDATA, &response);
curl_easy_setopt(curl,CURLOPT_POST, 1); // POST 请求
curl_easy_setopt(curl,CURLOPT_POSTFIELDS, data); // POST 参数

CURLcode temp = curl_easy_perform(curl);

if (code != NULL) {
*code = temp;
}

curl_slist_free_all(tempHeaders); /* free the header list */
} else {
if (code != NULL) {
*code = CURLE_FAILED_INIT;
}
}

// 释放 curl 资源
curl_easy_cleanup(curl);

return response;
}