【LibCurl】C++使用libcurl实现HTTP POST和GET、PUT

libcurl简介

libcurl是一个跨平台的网络协议库，支持http, https, ftp, gopher, telnet, dict, file, 和ldap 协议。libcurl同样支持HTTPS证书授权，HTTP POST, HTTP PUT, FTP 上传, HTTP基本表单上传，代理，cookies,和用户认证

libcurl的官网： http://curl.haxx.se/

库下载地址： https://github.com/curl/curl/releases/tag/curl-7_71_1

libcurl的简单使用

初始化libcurl：

curl_global_init()

函数得到 easy interface型指针：

curl_easy_init()

设置传输选项：

curl_easy_setopt()

设置的传输选项，实现回调函数以完成用户特定任务：

curl_easy_setopt()

函数完成传输任务：

curl_easy_perform()

释放内存：

curl_easy_cleanup()

curl_global_init

CURLcode curl_global_init(long flags);函数只能用一次。(其实在调用curl_global_cleanup 函数后仍然可再用)

如果这个函数在curl_easy_init函数调用时还没调用，它讲由libcurl库自动调用，

所以多线程下最好主动调用该函数以防止在线程中curl_easy_init时多次调用。

注意：虽然libcurl是线程安全的，但curl_global_init是不能保证线程安全的，

所以不要在每个线程中都调用curl_global_init，应该将该函数的调用放在主线程中。

写入此函数避免出现上述风险：

• 参数：flags

  CURL_GLOBAL_ALL //初始化所有的可能的调用。
  CURL_GLOBAL_SSL //初始化支持 安全套接字层。
  CURL_GLOBAL_WIN32 //初始化win32套接字库。
  CURL_GLOBAL_NOTHING //没有额外的初始化。

封装：C++使用libcurl实现HTTP POST和GET

在C++中使用libcurl实现HTTP POST和GET的源码如下：

#include <curl/curl.h>
#include <string>

class HttpConnection {
public:
    HttpConnection() {
        curl_global_init(CURL_GLOBAL_ALL);
        curl_ = curl_easy_init();
    }

    ~HttpConnection() {
        curl_easy_cleanup(curl_);
    }

    bool Post(const std::string& url, const std::string& data, std::string& response) {
        if (!curl_) {
            return false;
        }

        // set params
		// set curl header
		struct curl_slist* header_list = NULL;
		// der_list = curl_slist_append(header_list, "User-Agent: Mozilla/5.0 (Windows NT 10.0; WOW64; Trident/7.0; rv:11.0) like Gecko");
		header_list = curl_slist_append(header_list, "Content-Type:application/json; charset = UTF-8");
		curl_easy_setopt(curl_, CURLOPT_HTTPHEADER, header_list);    

        curl_easy_setopt(curl_, CURLOPT_URL, url.c_str());
        curl_easy_setopt(curl_, CURLOPT_POST, 1L);
        curl_easy_setopt(curl_, CURLOPT_POSTFIELDS, data.c_str());
        curl_easy_setopt(curl_, CURLOPT_WRITEFUNCTION, &WriteCallback);
        curl_easy_setopt(curl_, CURLOPT_WRITEDATA, &response);

        CURLcode res = curl_easy_perform(curl_);
        return (res == CURLE_OK);
    }

    bool Get(const std::string& url, std::string& response) {
        if (!curl_) {
            return false;
        }

        curl_easy_setopt(curl_, CURLOPT_URL, url.c_str());
		curl_easy_setopt(curl_, CURLOPT_POST, 0L);
        curl_easy_setopt(curl_, CURLOPT_WRITEFUNCTION, &WriteCallback);
        curl_easy_setopt(curl_, CURLOPT_WRITEDATA, &response);

        CURLcode res = curl_easy_perform(curl_);
        return (res == CURLE_OK);
    }

private:
    CURL* curl_ = nullptr;

    static size_t WriteCallback(void* contents, size_t size, size_t nmemb, void* userp) {
        size_t realsize = size * nmemb;
        std::string* str = static_cast<std::string*>(userp);
        str->append(static_cast<char*>(contents), realsize);
        return realsize;
    }
};

这个类中包含了两个公共方法Post和Get，用于实现HTTP的POST和GET请求。

它们接受一个URL参数和可选的请求数据，以及一个用于存储响应的字符串引用。

在使用这个类之前，需要先创建一个实例，并调用Post或Get方法。

如果请求成功，方法会返回true，并将服务器响应存储在传递的response字符串中。

否则，它将返回false，response将保持为空字符串。

扩展，LibCurl 实现 Put 操作

#include <cstdio>
#include <cstdlib>
#include <fcntl.h>
#include <sys/stat.h>
#include <unistd.h>
#include <curl/curl.h>
#include <curl/types.h>
#include <curl/easy.h>

#include <stdarg.h>
#include <string.h>
#include <errno.h>
#include <check_error.h>

FILE *fp; //定义FILE类型指针

//重写把数据读入上传数据流函数
size_t read_file(void* buff, size_t size, size_t nmemb, void* userp)
{
    size_t sizes = fread(buff, size, nmemb, (FILE *)userp);
    return sizes;
}
  
int main(int argc,char **argv)
{
    CURLcode res; //easy_handle定义的一些错误码
    const char url[2096];
    //初始化libcurl

     if(argc!=3)
    {
        printf("please input url and filename");
        exit(-1);
    }
     res = curl_global_init(CURL_GLOBAL_ALL);
    if (res != CURLE_OK)
    {
        printf("init libcurl failed.\n" );
       return -1;
    }


    //获取要上传的文件指针
    FILE* r_file = fopen(argv[2], "rb");
    if (0 == r_file)
    {
       printf( "the file %s isnot exit\n",argv[2]);
      return -1;
    }

    CURL* easy_handle;

    easy_handle = curl_easy_init();
    if (0 == easy_handle)
    {
       printf( "get a easy_handle handle fail!");
       fclose(r_file);
       curl_global_cleanup();
       curl_easy_cleanup(easy_handle);
       return -1;
    }

    // 获取文件大小
    fseek(r_file, 0, 2);
    int file_size = ftell(r_file);
    rewind(r_file);

    curl_easy_setopt(easy_handle, CURLOPT_URL, argv[1]); //获取URL地址
    curl_easy_setopt(easy_handle, CURLOPT_UPLOAD, 1); //告诉easy_handle是做上传操作
    curl_easy_setopt(easy_handle, CURLOPT_READFUNCTION, &read_file); //调用重写的读文件流函数
    curl_easy_setopt(easy_handle, CURLOPT_READDATA, r_file); //往read_file()函数中传入用户自定义的数据类型
    curl_easy_setopt(easy_handle, CURLOPT_INFILE, r_file); //定位作为上传的输入文件
    curl_easy_setopt(easy_handle, CURLOPT_VERBOSE, 1); //打印出具体http协议字段
    //curl_easy_setopt(easy_handle, CURLOPT_HEADER, 1);
    curl_easy_setopt(easy_handle, CURLOPT_INFILESIZE, file_size); //上传的字节数

    //执行设置好的操作
    res = curl_easy_perform(easy_handle);

    //获取HTTP错误码
    int HTTP_flag = 0;
    curl_easy_getinfo(easy_handle, CURLINFO_RESPONSE_CODE , &HTTP_flag);

    //一般清理动作
    fclose(r_file);
    curl_global_cleanup();
    curl_easy_cleanup(easy_handle);

    printf("url :%s localfile: %s\n",argv[1],argv[2]);
    printf("HTTP_flag is %d\n",HTTP_flag);

    // printf( "操作本地文件: file_name url:\n");
    //检测HTTP错误码和执行操作结果
    if (CURLE_OK != res)
    {
       printf("failure\n");
       return -1;
    }
    else
    {
      printf("success\n");
      return 0;
    }
 }

在 StackOverFlow 中有一则关于 Put 操作的问题：https://stackoverflow.com/questions/7569826/send-string-in-put-request-with-libcurl

其中的回答有说：Dont use curl_easy_setopt(curl, CURLOPT_PUT, 1L);

比较好的写法是如此：

curl = curl_easy_init();

if (curl) {
    headers = curl_slist_append(headers, client_id_header);
    headers = curl_slist_append(headers, "Content-Type: application/json");

    curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers); 
    curl_easy_setopt(curl, CURLOPT_URL, request_url);  
    curl_easy_setopt(curl, CURLOPT_CUSTOMREQUEST, "PUT"); /* !!! */

    curl_easy_setopt(curl, CURLOPT_POSTFIELDS, json_struct); /* data goes here */

    res = curl_easy_perform(curl);

    curl_slist_free_all(headers);
    curl_easy_cleanup(curl);
}

比较好奇 why 这样，结果查询 LibCurl 官方的资料说：CURLOPT_PUT 已经被弃用了(简单明了，所以正确的使用姿势应该保证是 CURLOPT_UPLOAD Option)