libcurl快速入门

当使用C++做HTTP客户端时，目前通用的做法就是使用libcurl。其官方网站的地址是http://curl.haxx.se/，该网站主要提供了Curl和libcurl。Curl是命令行工具，用于完成FTP, FTPS, HTTP, HTTPS,
GOPHER, TELNET, DICT, FILE 以及 LDAP的命令的请求及接收回馈。libcurl提供给开发者，用于使用C++跨平台的开发各种网络协议的请求及响应。

在基于LibCurl的程序里，主要采用callback function （回调函数）的形式完成传输任务，用户在启动传输前设置好各类参数和回调函数，当满足条件时libcurl将调用用户的回调函数实现特定功能。下面是利用libcurl完成传输任务的流程：

1、调用curl_global_init()初始化libcurl

2、调用curl_easy_init()函数得到easy interface型指针

3、调用curl_easy_setopt()设置传输选项

4、根据curl_easy_setopt()设置的传输选项，实现回调函数以完成用户特定任务

5、调用curl_easy_perform()函数完成传输任务

6、调用curl_easy_cleanup()释放内存

7、当应用程序不再使用libcurl的时候，调用curl_global_cleanup来释放相关的资源

一些基本的函数：

1、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//没有额外的初始化。

2 、void curl_global_cleanup(void);

描述：在结束libcurl使用的时候，用来对curl_global_init做的工作清理。类似于close的函数。

注意：虽然libcurl是线程安全的，但curl_global_cleanup是不能保证线程安全的，所以不要在每个线程中都调用curl_global_init，应该将该函数的调用放在主线程中。

3、 char *curl_version( );

描述: 打印当前libcurl库的版本。

4 、CURL *curl_easy_init( );

描述:

curl_easy_init用来初始化一个CURL的指针(有些像返回FILE类型的指针一样)。 相应的在调用结束时要用curl_easy_cleanup函数清理。

一般curl_easy_init意味着一个会话的开始。 它会返回一个easy_handle(CURL*对象), 一般都用在easy系列的函数中。

5 、void curl_easy_cleanup(CURL *handle);

描述:

这个调用用来结束一个会话。与curl_easy_init配合着用。

参数:

CURL类型的指针。

6 、CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter);

描述: 这个函数最重要了。几乎所有的curl 程序都要频繁的使用它。它告诉curl库。程序将有如何的行为。 比如要查看一个网页的html代码等。(这个函数有些像ioctl函数)参数:

1 CURL类型的指针

2 各种CURLoption类型的选项。(都在curl。h库里有定义,man 也可以查看到)

3 parameter 这个参数 既可以是个函数的指针,也可以是某个对象的指针,也可以是个long型的变量。它用什么这取决于第二个参数。

CURLoption 这个参数的取值很多。具体的可以查看man手册。

7 、CURLcode curl_easy_perform(CURL *handle);

描述:这个函数在初始化CURL类型的指针 以及curl_easy_setopt完成后调用。 让我们设置的option运作起来。

参数:

CURL类型的指针。

下面这段示例代码，就是应用libcurl的简单例子：

static size_t OnWriteData(void* buffer, size_t size, size_t nmemb, void* lpVoid)
{
std::string* str = dynamic_cast<std::string*>((std::string *)lpVoid);
if( NULL == str || NULL == buffer )
{
return -1;
}

char* pData = (char*)buffer;
str->append(pData, size * nmemb);
return nmemb;
}

int CHttpClient::Get(const std::string & strUrl, std::string & strResponse)
{
CURLcode res;
CURL* curl = curl_easy_init();
if(NULL == curl)
{
return CURLE_FAILED_INIT;
}

curl_easy_setopt(curl, CURLOPT_URL, strUrl.c_str());
curl_easy_setopt(curl, CURLOPT_READFUNCTION, NULL);
curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, OnWriteData);
curl_easy_setopt(curl, CURLOPT_WRITEDATA, (void *)&strResponse);
curl_easy_setopt(curl, CURLOPT_NOSIGNAL, 1);
curl_easy_setopt(curl, CURLOPT_CONNECTTIMEOUT, 3);
curl_easy_setopt(curl, CURLOPT_TIMEOUT, 3);
res = curl_easy_perform(curl);
curl_easy_cleanup(curl);
return res;
}

curl_easy_setopt函数常见选项：

本节主要介绍curl_easy_setopt中跟http相关的参数。该函数是curl中非常重要的函数，curl所有设置都是在该函数中完成的，该函数的设置选项众多，本节的阐述的只是部分常见选项。

1、CURLOPT_URL

设置访问URL

2、CURLOPT_WRITEFUNCTION，CURLOPT_WRITEDATA

回调函数原型为：size_t function( void *ptr, size_t size, size_t nmemb, void *stream); 函数将在libcurl接收到数据后被调用，因此函数多做数据保存的功能，如处理下载文件。CURLOPT_WRITEDATA 用于表明CURLOPT_WRITEFUNCTION函数中的stream指针的来源。

如果你没有通过CURLOPT_WRITEFUNCTION属性给easy handle设置回调函数，libcurl会提供一个默认的回调函数，它只是简单的将接收到的数据打印到标准输出。你也可以通过 CURLOPT_WRITEDATA属性给默认回调函数传递一个已经打开的文件指针，用于将数据输出到文件里。

3、CURLOPT_HEADERFUNCTION，CURLOPT_HEADERDATA

回调函数原型为 size_t function( void *ptr, size_t size,size_t nmemb, void *stream); libcurl一旦接收到http 头部数据后将调用该函数。CURLOPT_WRITEDATA 传递指针给libcurl，该指针表明CURLOPT_HEADERFUNCTION 函数的stream指针的来源。

4、CURLOPT_READFUNCTION，CURLOPT_READDATA

libCurl需要读取数据传递给远程主机时将调用CURLOPT_READFUNCTION指定的函数，函数原型是：size_t function(void *ptr, size_t size, size_t nmemb,void *stream)。 CURLOPT_READDATA 表明CURLOPT_READFUNCTION函数原型中的stream指针来源。

5、CURLOPT_NOPROGRESS，CURLOPT_PROGRESSFUNCTION，CURLOPT_PROGRESSDATA

跟数据传输进度相关的参数。CURLOPT_PROGRESSFUNCTION 指定的函数正常情况下每秒被libcurl调用一次，为了使CURLOPT_PROGRESSFUNCTION被调用，CURLOPT_NOPROGRESS必须被设置为false，CURLOPT_PROGRESSDATA指定的参数将作为CURLOPT_PROGRESSFUNCTION指定函数的第一个参数

6、CURLOPT_TIMEOUT，CURLOPT_CONNECTIONTIMEOUT

CURLOPT_TIMEOUT 由于设置传输时间，CURLOPT_CONNECTIONTIMEOUT 设置连接等待时间

7、CURLOPT_FOLLOWLOCATION

设置重定位URL

8、CURLOPT_RANGE， CURLOPT_RESUME_FROM

断点续传相关设置。CURLOPT_RANGE 指定char *参数传递给libcurl，用于指明http域的RANGE头域，例如：

表示头500个字节：bytes=0-499

表示第二个500字节：bytes=500-999

表示最后500个字节：bytes=-500

表示500字节以后的范围：bytes=500-

第一个和最后一个字节：bytes=0-0,-1

同时指定几个范围：bytes=500-600,601-999

CURLOPT_RESUME_FROM 传递一个long参数给libcurl，指定你希望开始传递的偏移量。