C++ 用libcurl库进行http通讯网络编程
一、libcurl基本编程框架 二、一些基本的函数 三、curl_easy_setopt函数部分选项介绍 四、curl_easy_perform 函数说明(error 状态码) 五、libcurl使用的http消息头 六、获取http应答头信息 七、多线程问题 八、什么时候libcurl无法正常工作 九、关于密码 十、http验证 十一、代码示例 1.基本的http get/post操作 2 获取html网页 3 网页下载保存实例 4 进度条实例显示文件下载进度 5 断点续传实例
一、libcurl基本编程框架
libcurl是一个跨平台的网络协议库,支持http, https, ftp, gopher, telnet, dict, file, 和ldap 协议。libcurl同样支持https证书授权,http post, http put, ftp 上传, http基本表单上传,代理,cookies,和用户认证。想要知道更多关于libcurl的介绍,可以到官网http://curl.haxx.se/上去了解,在这里不再详述。
win32版的libcurl下载地址:http://curl.freeby.pctools.cl/download/libcurl-7.18.0-win32-ms.zip
在基于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()释放内存
在整过过程中设置curl_easy_setopt()参数是最关键的,几乎所有的libcurl程序都要使用它。
二、一些基本的函数
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完成后调用. 就像字面的意思所说perform就像是个舞台.让我们设置的
option 运作起来.参数:
curl类型的指针.
三、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,指定你希望开始传递的偏移量。
四、curl_easy_perform函数说明(error 状态码)
该函数是完成curl_easy_setopt指定的所有选项,本节重点介绍curl_easy_perform的返回值。返回0意味一切ok,非0代表错误发生。主要错误码说明:
1. curle_ok
任务完成一切都好
2 curle_unsupported_protocol
不支持的协议,由url的头部指定
3 curle_couldnt_connect
不能连接到remote 主机或者代理
4 curle_remote_access_denied
访问被拒绝
5 curle_http_returned_error
http返回错误
6 curle_read_error
读本地文件错误
要获取详细的错误描述字符串,可以通过const char *curl_easy_strerror(curlcode errornum )这个函数取得.
五、libcurl使用的http消息头
当使用libcurl发送http请求时,它会自动添加一些http头。我们可以通过curlopt_httpheader属性手动替换、添加或删除相应 的http消息头。
host
http1.1(大部分http1.0)版本都要求客户端请求提供这个信息头。
pragma
"no-cache"。表示不要缓冲数据。
accept
"*/*"。表示允许接收任何类型的数据。
expect
以post的方式向http服务器提交请求时,libcurl会设置该消息头为"100-continue",它要求服务器在正式处理该请求之前,返回一 个"ok"消息。如果post的数据很小,libcurl可能不会设置该消息头。
自定义选项
当前越来越多的协议都构建在http协议之上(如:soap),这主要归功于http的可靠性,以及被广泛使用的代理支持(可以穿透大部分防火墙)。 这些协议的使用方式与传统http可能有很大的不同。对此,libcurl作了很好的支持。
自定义请求方式(customrequest)
http支持get, head或者post提交请求。可以设置curlopt_customrequest来设置自定义的请求方式,libcurl默认以get方式提交请求:
curl_easy_setopt(easy_handle, curlopt_customrequest, "myownrequest");
修改消息头
http协议提供了消息头,请求消息头用于告诉服务器如何处理请求;响应消息头则告诉如何处理接收到的数据。在libcurl中,你可以*的添加 这些消息头:
struct curl_slist *headers=null; /* init to null is important */ headers = curl_slist_append(headers, "hey-server-hey: how are you?"); headers = curl_slist_append(headers, "x-silly-content: yes"); /* pass our list of custom made headers */ curl_easy_setopt(easyhandle, curlopt_httpheader, headers); curl_easy_perform(easyhandle); /* transfer http */ curl_slist_free_all(headers); /* free the header list */
对于已经存在的消息头,可以重新设置它的值:
headers = curl_slist_append(headers, "accept: agent-007"); headers = curl_slist_append(headers, "host: munged.host.line");
删除消息头
对于一个已经存在的消息头,设置它的内容为空,libcurl在发送请求时就不会同时提交该消息头:
headers = curl_slist_append(headers, "accept:");
六、获取http应答头信息
发出http请求后,服务器会返回应答头信息和应答数据,如果仅仅是打印应答头的所有内容,则直接可以通过curl_easy_setopt(curl, curlopt_headerfunction, 打印函数)的方式来完成,这里需要获取的是应答头中特定的信息,比如应答码、cookies列表等,则需要通过下面这个函数:
curlcode curl_easy_getinfo(curl *curl, curlinfo info, ... );
info参数就是我们需要获取的内容,下面是一些参数值:
1.curlinfo_response_code
获取应答码
2.curlinfo_header_size
头大小
3.curlinfo_cookielist
cookies列表
除了获取应答信息外,这个函数还能获取curl的一些内部信息,如请求时间、连接时间等等。
更多的参数可以参考api文档。
七、多线程问题
首先一个基本原则就是:绝对不应该在线程之间共享同一个libcurl handle(curl *对象),不管是easy handle还是multi handle(本文只介绍easy_handle)。一个线程每次只能使用一个handle。
libcurl是线程安全的,但有两点例外:信号(signals)和ssl/tls handler。 信号用于超时失效名字解析(timing out name resolves)。libcurl依赖其他的库来支持ssl/stl,所以用多线程的方式访问https或ftps的url时,应该满足这些库对多线程 操作的一些要求。详细可以参考:
openssl:http://www.openssl.org/docs/crypto/threads.html
gnutls:http://www.gnu.org/software/gnutls/manual/html_node/multi_002dthreaded-applications.html
nss: 宣称是多线程安全的。
八、什么时候libcurl无法正常工作
传输失败总是有原因的。你可能错误的设置了一些libcurl的属性或者没有正确的理解某些属性的含义,或者是远程主机返回一些无法被正确解析的内容。
这里有一个黄金法则来处理这些问题:将curlopt_verbose属性设置为1,libcurl会输出通信过程中的一些细节。如果使用的是http协 议,请求头/响应头也会被输出。将curlopt_header设为1,这些头信息将出现在消息的内容中。
当然不可否认的是,libcurl还存在bug。
如果你对相关的协议了解越多,在使用libcurl时,就越不容易犯错。
九、关于密码
客户端向服务器发送请求时,许多协议都要求提供用户名与密码。libcurl提供了多种方式来设置它们。
一些协议支持在url中直接指定用户名和密码,类似于: protocol://user:password@example.com/path/。libcurl能正确的识别这种url中的用户名与密码并执行 相应的操作。如果你提供的用户名和密码中有特殊字符,首先应该对其进行url编码。
也可以通过curlopt_userpwd属性来设置用户名与密码。参数是格式如 “user:password ”的字符串:
curl_easy_setopt(easy_handle, curlopt_userpwd, "user_name:password");
有时候在访问代理服务器的时候,可能时时要求提供用户名和密码进行用户身份验证。这种情况下,libcurl提供了另 一个属性curlopt_proxyuserpwd:
curl_easy_setopt(easy_handle, curlopt_proxyuserpwd, "user_name:password");
在unix平台下,访问ftp的用户名和密码可能会被保存在$home/.netrc文件中。libcurl支持直接从这个文件中获取用户名与密码:
curl_easy_setopt(easy_handle, curlopt_netrc, 1l);
在使用ssl时,可能需要提供一个私钥用于数据安全传输,通过curlopt_keypasswd来设置私钥:
curl_easy_setopt(easy_handle, curlopt_keypasswd, "keypassword");
十、http验证
在使用http协议时,客户端有很多种方式向服务器提供验证信息。默认的 http验证方法是"basic”,它将用户名与密码以明文的方式、经base64编码后保存在http请求头中,发往服务器。当然这不太安全。
当前版本的libcurl支持的验证方法有:basic, digest, ntlm, negotiate, gss-negotiate and spnego。(译者感叹:搞web这么多年,尽然不知道这些http的验证方式,实在惭愧。)可以通过curlopt_httpauth属性来设置具体 的验证方式:
curl_easy_setopt(easy_handle, curlopt_httpauth, curlauth_digest);
向代理服务器发送验证信息时,可以通过curlopt_proxyauth设置验证方式:
curl_easy_setopt(easy_handle, curlopt_proxyauth, curlauth_ntlm);
也可以同时设置多种验证方式(通过按位与), 使用‘curlauth_any‘将允许libcurl可以选择任何它所支持的验证方式。通过curlopt_httpauth或 curlopt_proxyauth属性设置的多种验证方式,libcurl会在运行时选择一种它认为是最好的方式与服务器通信:
curl_easy_setopt(easy_handle, curlopt_httpauth, curlauth_digest|curlauth_basic);
// curl_easy_setopt(easy_handle, curlopt_httpauth, curlauth_any);
十一、代码示例
下载的libcurl中自带了很多示例代码,在docs\examples目录下,建议下载该库后好好一下这些代码。
libcurl的api文档在docs\libcurl\index.html中。
1.基本的http get/post操作
#include #include bool geturl(char *filename) { curl *curl; curlcode res; file *fp; if ((fp = fopen(filename, "w")) == null) // 返回结果用文件存储 return false; struct curl_slist *headers = null; headers = curl_slist_append(headers, "accept: agent-007"); curl = curl_easy_init(); // 初始化 if (curl) { //curl_easy_setopt(curl, curlopt_proxy, "10.99.60.201:8080");// 代理 curl_easy_setopt(curl, curlopt_httpheader, headers);// 改协议头 curl_easy_setopt(curl, curlopt_url,"http://www.baidu.com"); curl_easy_setopt(curl, curlopt_writedata, fp); //将返回的http头输出到fp指向的文件 curl_easy_setopt(curl, curlopt_headerdata, fp); //将返回的html主体数据输出到fp指向的文件 res = curl_easy_perform(curl); // 执行 if (res != 0) { curl_slist_free_all(headers); curl_easy_cleanup(curl); } fclose(fp); return true; } } bool posturl(char *filename) { curl *curl; curlcode res; file *fp; if ((fp = fopen(filename, "w")) == null) return false; curl = curl_easy_init(); if (curl) { curl_easy_setopt(curl, curlopt_cookiefile, "/tmp/cookie.txt"); // 指定cookie文件 curl_easy_setopt(curl, curlopt_postfields, "&logintype=uid&u=xieyan&psw=xxx86"); // 指定post内容 //curl_easy_setopt(curl, curlopt_proxy, "10.99.60.201:8080"); curl_easy_setopt(curl, curlopt_url, " http://mail.sina.com.cn/cgi-bin/login.cgi "); // 指定url curl_easy_setopt(curl, curlopt_writedata, fp); res = curl_easy_perform(curl); curl_easy_cleanup(curl); } fclose(fp); return true; } int main(void) { geturl("/tmp/get.html"); posturl("/tmp/post.html"); }
编译gcc get_post.c -o get_post–lcurl
./ get_post
2获取html网页
#include #include #include int main(int argc, char *argv[]) { curl *curl; //定义curl类型的指针 curlcode res; //定义curlcode类型的变量,保存返回状态码 if(argc!=2) { printf("usage : file ;\n"); exit(1); } curl = curl_easy_init(); //初始化一个curl类型的指针 if(curl!=null) { //设置curl选项. 其中curlopt_url是让用户指 定url. argv[1]中存放的命令行传进来的网址 curl_easy_setopt(curl, curlopt_url, argv[1]); //调用curl_easy_perform 执行我们的设置.并进行相关的操作. 在这 里只在屏幕上显示出来. res = curl_easy_perform(curl); //清除curl操作. curl_easy_cleanup(curl); } return 0; }
编译gcc get_http.c -o get_http–lcurl
./ get_http
3网页下载保存实例
// 采用curlopt_writefunction 实现网页下载保存功能 #include ; #include ; #include ; #include ; #include ; #include ; file *fp; //定义file类型指针 //这个函数是为了符合curlopt_writefunction而构造的 //完成数据保存功能 size_t write_data(void *ptr, size_t size, size_t nmemb, void *stream) { int written = fwrite(ptr, size, nmemb, (file *)fp); return written; } int main(int argc, char *argv[]) { curl *curl; curl_global_init(curl_global_all); curl=curl_easy_init(); curl_easy_setopt(curl, curlopt_url, argv[1]); if((fp=fopen(argv[2],"w"))==null) { curl_easy_cleanup(curl); exit(1); } ////curlopt_writefunction 将后继的动作交给write_data函数处理 curl_easy_setopt(curl, curlopt_writefunction, write_data); curl_easy_perform(curl); curl_easy_cleanup(curl); exit(0); }编译gccsave_http.c-o save_http –lcurl
./ save_http
/tmp/baidu
4进度条实例显示文件下载进度
// 采用curlopt_noprogress, curlopt_progressfunction curlopt_progressdata 实现文件传输进度提示功能 //函数采用了gtk库,故编译时需指定gtk库 //函数启动专门的线程用于显示gtk 进度条bar #include #include #include #include /* new for v7 */ #include /* new for v7 */ gtkwidget *bar; ////这个函数是为了符合curlopt_writefunction而构造的 //完成数据保存功能 size_t my_write_func(void *ptr, size_t size, size_t nmemb, file *stream) { return fwrite(ptr, size, nmemb, stream); } //这个函数是为了符合curlopt_readfunction而构造的 //数据上传时使用 size_t my_read_func(void *ptr, size_t size, size_t nmemb, file *stream) { return fread(ptr, size, nmemb, stream); } //这个函数是为了符合curlopt_progressfunction而构造的 //显示文件传输进度,t代表文件大小,d代表传 输已经完成部分 int my_progress_func(gtkwidget *bar, double t, /* dltotal */ double d, /* dlnow */ double ultotal, double ulnow) { /* printf("%d / %d (%g %%)\n", d, t, d*100.0/t);*/ gdk_threads_enter(); gtk_progress_set_value(gtk_progress(bar), d*100.0/t); gdk_threads_leave(); return 0; } void *my_thread(void *ptr) { curl *curl; curlcode res; file *outfile; gchar *url = ptr; curl = curl_easy_init(); if(curl) { outfile = fopen("test.curl", "w"); curl_easy_setopt(curl, curlopt_url, url); curl_easy_setopt(curl, curlopt_writedata, outfile); curl_easy_setopt(curl, curlopt_writefunction, my_write_func); curl_easy_setopt(curl, curlopt_readfunction, my_read_func); curl_easy_setopt(curl, curlopt_noprogress, 0l); curl_easy_setopt(curl, curlopt_progressfunction, my_progress_func); curl_easy_setopt(curl, curlopt_progressdata, bar); res = curl_easy_perform(curl); fclose(outfile); /* always cleanup */ curl_easy_cleanup(curl); } return null; } int main(int argc, char **argv) { gtkwidget *window, *frame, *frame2; gtkadjustment *adj; /* must initialize libcurl before any threads are started */ curl_global_init(curl_global_all); /* init thread */ g_thread_init(null); gtk_init(&argc, &argv); window = gtk_window_new(gtk_window_toplevel); frame = gtk_frame_new(null); gtk_frame_set_shadow_type(gtk_frame(frame), gtk_shadow_out); gtk_container_add(gtk_container(window), frame); frame2 = gtk_frame_new(null); gtk_frame_set_shadow_type(gtk_frame(frame2), gtk_shadow_in); gtk_container_add(gtk_container(frame), frame2); gtk_container_set_border_width(gtk_container(frame2), 5); adj = (gtkadjustment*)gtk_adjustment_new(0, 0, 100, 0, 0, 0); bar = gtk_progress_bar_new_with_adjustment(adj); gtk_container_add(gtk_container(frame2), bar); gtk_widget_show_all(window); if (!g_thread_create(&my_thread, argv[1], false, null) != 0) g_warning("can't create the thread"); gdk_threads_enter(); gtk_main(); gdk_threads_leave(); return 0; }编译export pkg_config_path=/usr/lib/pkgconfig/
gcc progress.c –o progress ` pkg-config --libs –cflags gtk+-2..0` -lcurl –lgthread-2.0
./ progress" target="_blank">http://software.sky-union.cn/index.asp
5断点续传实例
//采用curlopt_resume_from_large 实现文件断点续传功能 #include #include #include #include //这个函数为curlopt_headerfunction参数构造 /* 从http头部获取文件size*/ size_t getcontentlengthfunc(void *ptr, size_t size, size_t nmemb, void *stream) { int r; long len = 0; /* _snscanf() is win32 specific */ // r = _snscanf(ptr, size * nmemb, "content-length: %ld\n", &len); r = sscanf(ptr, "content-length: %ld\n", &len); if (r) /* microsoft: we don't read the specs */ *((long *) stream) = len; return size * nmemb; } /* 保存下载文件 */ size_t wirtefunc(void *ptr, size_t size, size_t nmemb, void *stream) { return fwrite(ptr, size, nmemb, stream); } /*读取上传文件 */ size_t readfunc(void *ptr, size_t size, size_t nmemb, void *stream) { file *f = stream; size_t n; if (ferror(f)) return curl_readfunc_abort; n = fread(ptr, size, nmemb, f) * size; return n; } // 下载 或者上传文件函数 int download(curl *curlhandle, const char * remotepath, const char * localpath, long timeout, long tries) { file *f; curl_off_t local_file_len = -1 ; long filesize =0 ; curlcode r = curle_got_nothing; int c; struct stat file_info; int use_resume = 0; /* 得到本地文件大小 */ //if(access(localpath,f_ok) ==0) if(stat(localpath, &file_info) == 0) { local_file_len = file_info.st_size; use_resume = 1; } //采用追加方式打开文件,便于实现文件断点续传工作 f = fopen(localpath, "ab+"); if (f == null) { perror(null); return 0; } //curl_easy_setopt(curlhandle, curlopt_upload, 1l); curl_easy_setopt(curlhandle, curlopt_url, remotepath); curl_easy_setopt(curlhandle, curlopt_connecttimeout, timeout); // 设置连接超时,单位秒 //设置http 头部处理函数 curl_easy_setopt(curlhandle, curlopt_headerfunction, getcontentlengthfunc); curl_easy_setopt(curlhandle, curlopt_headerdata, &filesize); // 设置文件续传的位置给libcurl curl_easy_setopt(curlhandle, curlopt_resume_from_large, use_resume?local_file_len:0); curl_easy_setopt(curlhandle, curlopt_writedata, f); curl_easy_setopt(curlhandle, curlopt_writefunction, wirtefunc); //curl_easy_setopt(curlhandle, curlopt_readfunction, readfunc); //curl_easy_setopt(curlhandle, curlopt_readdata, f); curl_easy_setopt(curlhandle, curlopt_noprogress, 1l); curl_easy_setopt(curlhandle, curlopt_verbose, 1l); r = curl_easy_perform(curlhandle); fclose(f); if (r == curle_ok) return 1; else { fprintf(stderr, "%s\n", curl_easy_strerror(r)); return 0; } } int main(int c, char **argv) { curl *curlhandle = null; curl_global_init(curl_global_all); curlhandle = curl_easy_init(); //download(curlhandle, "ftp://user:pass@host/path/file", "c:\\file", 0, 3); download(curlhandle , "http://software.sky-union.cn/index.asp","/work/index.asp",1,3); curl_easy_cleanup(curlhandle); curl_global_cleanup(); return 0; }编译gccresume.c-o resume –lcurl
./ resume
上一篇: 如何实现ajax延时发送在空闲之后去发送ajax请求
下一篇: 大数据时代 看奥巴马的总统连任之路