君子博学而日参省乎己 则知明而行无过矣

博客园 首页 新随笔 联系 订阅 管理

 最近开发中用到curl库,虽然都是很简单的应用,但对这个库还是产生了兴趣,想学习总结一下。curl库功能非常强大,这里主要针对http应用,尤其是http文件下载做一个总结。当然了,还是主要针对Windows系统来讲。

    本文是第一篇,当然要简单介绍一下curl,然后说一下Windows系统下的编译安装,以及对curl工具的简单应用。

 

    curl是一个基于命令行的应用工具,提供利用URL标准进行文件传输的功能。目前已经支持非常多的流行的互联网协议,如:FTP, FTPS, HTTP, HTTPS, SCP, SFTP, TFTP, TELNET, DICT, LDAP, LDAPS and FILE等。curl支持SSL认证,HTTP POST/PUT,FTP上传,HTTP上传、代理、cookies、用户+密码认证、文件续传、代理管道等一系列强大功能。curl是用C语言写的,但是绑定了很多开发语言。大体上可以把curl分成命令行工具和libcurl库两个部分,命令行工具可以直接输入指令完成相应功能,libcurl则是一个客户端URL传输库,是线程安全且兼容IPv6,可以非常方便地用来做相关开发。

    更多关于curl的信息可以参考官网http://curl.haxx.se/。curl的相关文档非常全,不得不赞一下。其实查阅原文文档是一个很好的习惯,而且还是一件很惬意的事情,对提高英文阅读能力帮助也很大。

    从curl官方网站上可以直接下载到编译好的lib,dll和exe文件,但是自己由源码编译安装curl,也是一件有意思的事情。从网站上下载源码包,解压缩后会看到根文件目录下面有很多文件及文件夹。其中的文件是有关curl项目的介绍、版本变更情况、以及一些有关配置和编译的文件;文件夹中比较重要的有3个:docs、lib和src,docs中包括项目的所有相关文档,lib中为libcurl库的源码,src为curl命令行工具的源码。
    如果你熟悉MSVS开发环境的话,那么编译过程再简单不过了,因为最新的curl源码包中已经自带了vc6的工程文件,只要高于6.0版本的环境都可以直接打开工程进行编译链接,生成二进制文件。整个solution中包含两个project,一个是libcurl库,一个是curl的命令行工具。其中,curl.exe运行是要加载libcurl.dll动态库的。另外,自带的工程设置中没有用到OpenSSL或Zlib这些第三方库,如果需要用到相关扩展功能的话,需要配置引用这些库文件进行编译。
    还有一种方式是通过MSVS命令行的方式进行编译。步骤如下:
    1、首先要清楚自己安装的是msvc哪个版本,目前常见的vc6,vc2003(vc7),vc2005(vc8)和vc2008(vc9),curl源码包中都已经写好了相应的makefile文件,我机器上装的是vc2005;
    2、将vc的安装目录的bin文件目录加到PATH环境变量中,我机器上bin的路径为C:\Program Files\Microsoft Visual Studio 8\VC\bin,这一步主要是为了使我们能够在任何路径下运行bin路径下的工具,如后面要用到的编译工具cl.exe和make工具nmake.exe;
    3、在运行中启动cmd.exe,在其中运行bin目录下的vcvars32.bat这个批处理文件,这个文件中定义了很多vc库文件及相关资源工具的访问变量,指明了响应资源的访问路径,跟环境变量的作用相似,但是只作用于当前命令行窗口;
    4、在cmd中进入到你要编译的curl源码的根文件目录下,输入命令“nmake vc”回车,应该就会看到一长串的编译信息输出。结束后,在lib子目录下会生成release文件夹,里面即为编译后生成的目标文件以及静态链接库文件libcurl.lib,在src子目录下生成curl.exe可执行文件。这一步中需要注意的是根文件目录下的makefile文件中将vc编译工具定义为了vc6,我们应该把其中的“VC=vc6”这句改为自己机器上对应的vc版本。
    另外,“nmake vc”命令也是没有引用任何第三方库来进行编译的,默认编译静态链接的release版本文件。如果要编译其他版本或者引用第三方库来进行编译,则要添加make参数,具体可以参考makefile文件中的配置。
    以上主要介绍的是在Windows平台下用msvc工具编译curl代码,其实curl库几乎可以支持所有常见的操作系统,而且支持的编译工具也很多,如MingW32、Cygwin、Borland C++等。curl的文档中写得都非常清楚,这里就不详细说了。
   
    以上简单介绍了curl库和在Windows平台下用msvc环境编译curl执行文件的步骤,下一篇中将总结一些应用curl库的知识。


 curl的应用方式,一是可以直接通过命令行工具,另一种是利用libcurl库做上层的开发。本篇主要总结一下命令行工具的http相关的应用,尤其是http下载方面的;下一篇再讲基于libcurl库的开发。
   
   
    curl的命令行工具功能非常强大,这些数据交互的功能基本上都是通过URL方式进行的,我们先来看看curl对多个URL的灵活操作,这些规则使我们的批处理需求应用起来非常方便。
   
    1、用{}表示多个URL
    如 http://site.{one,two,three}.com,只要在{}中写上不同的部分,就可以表示3个URL了。
   
    2、用[]表示多个URL
    如 ftp://ftp.numericals.com/file[1-100].txtftp://ftp.numericals.com/file[001-100].txtftp://ftp.letters.com/file[a-z].txt,[]中表示按数字或字母的顺序排列。
    还能表示不连续的排列,如 http://www.numericals.com/file[1-100:10].txthttp://www.letters.com/file[a-z:2].txt,":"后面的数字表示等差排列的阶跃数。
   
    3、结合起来使用
    如 http://any.org/archive[1996-1999]/vol[1-4]/part{a,b,c}.html
   
   
    curl命令行工具的基本语句为:curl [options] [URL...],即 curl [选项] [下载地址]。因此,如果你想下载百度的首页,最简单的方法启动cmd,进入curl安装目录,输入命令:curl http://www.baidu.com,回车,你的输出窗口将立即出现百度首页的html数据。
    对于所有的布尔型option,基本上--option表示支持这个选项,--no-option表示禁用这个选项。下面总结几个比较有用的options。
   
    1、-o/--output <file>
    这个基本上要算最常用的选项了,用于将下载的数据保存到某个文件中。如 curl -o baidu.htmlhttp://www.baidu.com则将百度首页保存到baidu.html文件中了。下载过程中标准输出还会显示下载的统计信息,比如进度、下载字节数、下载速度等。如果指定输出为"-",则下载数据会输出到标准输出。
    如果输出的文件是一个多级目录的话,则要配合--create-dirs选项,--create-dirs将自动创建设置的输出目录。
    如果希望保存到本地的文件名和服务器上的相同,就可以直接用-O选项(大写O),而省去指定本地文件名。
    如果下载多个数据文件,可以使用上面提到的多URL规则。下载文件名也可以批量自定义,就是使用"#"。可以将"#"加到文件名当中,这样实际文件名中的#将被多个URL中的当前字符串代替,如 curlhttp://{site,host}.host[1-5].com -o "#1_#2",#1将被"site"或"host"代替,#2将被1-5之间的数字代替,也就是被当前被处理的URL中的字符串代替。
    另外下载数据的时候,可以加个"-#"选项,用一个进度条来代替文本表示进度。
   
    2、-c/--cookie-jar <file name> 和 -b/--cookie <name=data>
    这是两个操作cookie的选项,很多服务器是需要cookie信息的。用前一个选项可以指定一个文件,将其他文件中的cookie或者从服务器得到的cookie写到文件中;后一个选项则用来向服务器发送cookie信息,可以用"name=data"的形式,也可以直接跟一个保存cookie的文件名。
   
    3、-x/--proxy <proxyhost[:port]>
    该选项为http指定代理及端口,如果不指定端口,默认为1080。如 curl -x 201.36.208.19:3128http://curl.haxx.se/
   
    4、-u/--user <user:password> 和 -U/--proxy-user <user:password>
    登录某些页面或ftp需要先进行认证,输入用户名和密码。curl的这个选项可以直接处理这类操作,用指定的账号和密码进行登录认证。
    后面的选项指定代理的用户名和密码,这样便可以直接用这个代理访问网页了,如  curl -U user:password -x 201.36.208.19:3128 http://curl.haxx.se/
   
    5、-A/--user-agent <agent string>
    该选项可以指定客户端类型,服务器通过该选项判断用户应用的平台及浏览器信息。如 curl -A "Mozilla/4.0 (compatible; MSIE 6.0; Windows NT 5.0)" http://www.clientinfo.com
表示告诉服务器,客户端是运行在Windows 2000系统上的IE6.0。

   

    6、-d/--data <data>
    该选项用来以POST方式向http服务器发送特定数据,最常用的就是提交表单。如 curl -d "user=username&password=111" http://www.login.com,表示用账号username和密码111向站点发送登录申请。其中多个数据段可以用"&"进行连接一起发送;如果数据前面加上符号"@",则数据来源为后面指定的文件,如 curl -d password=@D:\pw.txt http://www.login.com

   

    7、-C/--continue-at <offset>
    改选项提供断点续传功能,与-o选项配合使用。如 curl -c -Ohttp://vfile.home.news.cn/music/public/vd05/200905/31/a8/MUfs052009053117155750a8be70.mp3。如果指定offset,则从offset的位置开始续传。如果未指定offset,或者直接用"-C -",则curl会自己分析该从什么位置开始续传。

   

    8、-r/--range <range>
    该选项指定下载字节的范围,常应用于分块下载文件。range的表示方式有多种,如100-500,则指定从100开始的400个字节数据;-500表示最后的500个字节;5000-表示从第5000个字节开始的所有字节;另外还可以同时指定多个字节块,中间用","分开。如
    curl -r 0-1024000 -o new_divide_1.mp3http://vfile.home.news.cn/music/public/vd05/200905/31/a8/MUfs052009053117155750a8be70.mp3 &
    curl -r 1024001-2048000 -o new_divide_2.mp3http://vfile.home.news.cn/music/public/vd05/200905/31/a8/MUfs052009053117155750a8be70.mp3 &
    curl -r 2048001- -o new_divide_3.mp3http://vfile.home.news.cn/music/public/vd05/200905/31/a8/MUfs052009053117155750a8be70.mp3
    这样就会将目标mp3文件分块下载为3个文件,然后可以用dos的copy命令:copy new_divide_1.mp3/b + new_divide_2.mp3/b + new_divide_3.mp3/b new_divide.mp3即可将3个分块文件合并为一个完整的mp3文件。
   
    9、-w/--write-out <format>
    该选项格式化输出一些用户操作的数据信息,用到的格式化输出符除了"\n","\r","\t"这些常见转义符外,还包括"@"和"%"。其中"@filename"表示输出filename文件中的数据,"@-"表示输出用户写入标准输入的数据;"%"标识符后面跟上定义的关键字,则可以输出对应的curl数据,常用的关键字有:
    http_code —— 上次操作返回的响应码;
    time_total —— 上次操作耗时,单位为秒;
    time_connect —— TCP连接远程主机的耗时,单位为秒;
    time_pretransfer —— 文件真正开始传输之前交互耗时,单位为秒,可能主要包括一些命令处理和协议分析的耗时;
    time_starttransfer —— 文件的第一个字节开始传输之前的耗时,单位为秒,包括time_pretransfer和服务器计算结果的时间;
    size_download —— 下载的总字节数;
    size_upload —— 上传的总字节数;
    size_request —— 发送http请求的总字节数;
    speed_download —— curl成功下载的平均下载速度;
    speed_upload —— curl成功上传的平均上传速度;
    举例:curl -o page.html -s -w %{time_connect}:%{time_starttransfer}:%{time_total}http://curl.haxx.se/,其中-s表示安静模式,即略去所有状态信息。
   
    10、--connect-timeout <seconds> 和 -m/--max-time <seconds>
    前者表示允许的连接的最长耗时,单位为秒;后者表示允许的整个操作的最长耗时,单位为秒,这个选项对于控制一个批处理操作的时长非常有用。
   
    11、--limit-rate <speed> 、 -Y/--speed-limit <speed> 和 -y/--speed-time <time>
    --limit-rate <speed>指定最大的数据传输率,单位为bytes/s,也可以用'k'或'K'表示kb/s,'m'或'M'表示mb/s,'g'或'G'表示gb/s,所给的speed为平均传输率,短时间峰值可能会超过此值;
-Y/--speed-limit <speed>指定最小传输率,单位为bytes/s,如果小于speed值,则传输中止,如此时-y选项没有被设置,默认time为30;-y/--speed-time <time>指定-Y选项的有效时间段,如果-Y选项没有被设置,默认为1。

 

    12、--max-filesize <bytes>
    该选项指定所要下载的文件的最大长度,如果超过bytes值,则下载并不开始,curl返回退出码63。
   
    13、--retry <num> 、 --retry-delay <seconds> 和 --retry-max-time <seconds>
    当传输过程中出现错误,如超时、FTP 5xx返回码或者HTTP 5xx返回码,curl会进行按照设置进行重试,这几个选项都与重试有关。--retry <num>设置重试次数,--retry-delay <seconds>设置两次重试的间隔时间,--retry-max-time <seconds>设置两次重试间隔的最长时间。默认情况下,curl不进行重试;如果重试,第一次间隔1秒,之后每次都间隔上一次的2倍时间,直到间隔时间达到10分钟,之后的重试都将采用10分钟间隔。如果这3个选项的值被重新设置,则执行设置值。
   
    14、-T/--upload-file <file>
    该选项是上传命令,如向http服务器上传一个文件:curl -T D:\new_divide.mp3http://www.uploadserver.com/path/;向一个ftp服务器上传文件:curl -T D:\new_divide.mp3 -u user:password ftp://upload_site:port/path/

 


    curl定义了一组"EXIT CODES",用来标识在出现错误时的相关信息,目前范围从1-83,具体信息可以查阅curl库自带的文档。这些退出码对于我们分析错误及原因有很大帮助。
   
   
    以上简单介绍了一下利用curl命令行工具进行一些简单的http和ftp应用,大家可以试着多用一下,会慢慢发现curl的强大功能,有很多独特的功能用起来非常简单方便。


这篇讲一下基于libcurl库的开发(Windows平台,MSVC2005开发环境)。
    libcurl是一个简单易用的基于URL传输的客户端开发库,支持多种平台以及三十多种开发语言绑定。libcurl是线程安全的,兼容IPv6,功能强大且运行效率高,很多知名公司如Google、Adobe的产品都应用过libcurl。
    在05环境中做libcurl开发,需要将静态库文件加到编译链接环境中,并且要dll动态运行库支持。
   
   
    libcurl提供了一组C语言API函数直接调用。首先需要提到的两个函数就是curl_global_init()和curl_global_cleanup()。libcurl要用到一系列的全局常量,curl_global_init()函数就是初始化这些变量,并分配一些全局资源;curl_global_cleanup()则负责释放这些资源。因此一般情况下,在调用libcurl函数之前,先用curl_global_init(CURL_GLOBAL_ALL)做初始化,在调用完毕后,用curl_global_cleanup()
退出。需要注意的是,这些全局变量和资源并不是线程安全的,因此,在多线程应用的环境中,最好不要多次调用curl_global_init()和curl_global_cleanup(),调用其他函数并不会改变这些全局变量和资源。
    libcurl支持3种不同的接口调用方式,分别是"easy"、"multi"和"share"模式。libcurl-easy是一组同步接口,函数都是curl_easy_*形式,这种模式调用curl_easy_perform()函数进行URL数据传输,直到传输完成函数才返回;libcurl-multi是一组异步接口,函数都是curl_multi_*形式,调用curl_multi_perform()函数进行传输,但是每次调用只传一片数据,我们可以用select()函数控制多个下载任务进行同步下载,来实现在一个线程中同时下载多个文件;libcurl-share允许在多线程中操作共享数据。下面以libcurl-easy为例讲一下libcurl的函数。
   
    1、CURL *curl_easy_init()
    此函数需要最先被调用,返回CRUL easy句柄;后续其他函数调用都要用到这个句柄。如果没有调用curl_global_init(),该函数自动调用,但是考虑到线程安全的问题,最好自己调用curl_global_init()。

 

    2、CURLcode curl_easy_setopt(CURL *handle, CURLoption option, parameter)
    所有参数和选项设置都是通过这个函数完成的,它告诉libcurl怎样去进行传输。参数handle即为curl_easy_init()返回的句柄,后面根据option的类型,设置相应的parameter值,该函数每次调用只能设置一个选项。具体的option讲解在这两篇博文中有较全面的介绍:
    http://blog.163.com/wangsen_315/blog/static/9461414200882384555217/
    http://blog.sina.com.cn/s/blog_4f9fc6e10100einf.html
    这里只总结一下与下载有关的常用选项设置。
   
    CURLOPT_URL
    字符串类型,该选项设置要处理的URL地址,该选项是进行curl_easy_perform之前唯一必须要设置的选项。
   
    CURLOPT_COOKIE
    字符串类型,设置http头中的cookie信息。
   
    CURLOPT_COOKIEFILE
    字符串类型,同CURLOPT_COOKIE,不过cookie信息从文件中读取。
   
    CURLOPT_FOLLOWLOCATION
    布尔值类型,该参数设置为非零值表示follow服务器返回的重定向信息。
   
    CURLOPT_POSTFIELDS
    字符串类型,提交http的post操作字符串数据。
   
    CURLOPT_TIMEOUT
    long数值类型,设置函数执行的最长时间,时间单位为s。
   
    CURLOPT_CONNECTTIMEOUT
    long数值类型,设置连接服务器最长时间,时间单位为s;当置为0时表示无限长。
   
    CURLOPT_MAX_RECV_SPEED_LARGE
    curl_off_t类型数据,指定下载过程中最大速度,单位bytes/s。
   
    CURLOPT_HEADERFUNCTION
    函数指针类型,该选项设置一个处理接收到的header数据的回调函数,函数原型为:
    size_t function( void *ptr, size_t size, size_t nmemb, void *stream);
    其中,ptr指向接收到的header头数据,数据大小为size*nmemb,stream指向调用CURLOPT_WRITEHEADER选项设置的参数。该回调函数应返回实际处理的数据量大小,或者出错返回-1。

   

    CURLOPT_WRITEFUNCTION
    函数指针类型,该选项设置一个处理接收到的下载数据的回调函数,函数原型为:
    size_t function( void *ptr, size_t size, size_t nmemb, void *stream);
    其中,ptr指向接收到的数据,数据大小为size*nmemb,stream指向调用CURLOPT_WRITEDATA选项设置的参数。
    如果函数指针置为NULL,则会调用默认的函数,将数据写入到由CURLOPT_WRITEDATA指定的FILE*中。
   
    CURLOPT_HTTPHEADER
    curl_slist结构体类型,该选项自定义请求头信息。
   
    CURLOPT_NOPROGRESS
    布尔值类型,设置该值为非零值关闭PHP为CRUL传输显示的进度条。
   
    3、void curl_easy_reset(CURL *handle )
    重新初始化CURL句柄的选项设置。
   
    4、CURLcode curl_easy_getinfo(CURL *curl, CURLINFO info, ... )
    查询CRUL会话的内部信息,具体说明请参考curl自带文档。
   
    5、void curl_easy_cleanup(CURL * handle )
    该函数与curl_easy_init函数成对出现,handle即为调用curl_easy_init返回的句柄。该函数在CURL会话结束退出时调用,之后handle无效。
   
    libcurl库开发就简单总结这些,只是一个很粗略的介绍,具体的细节请参考curl自带的文档手册。本文没有给出示例代码,因为curl的源码包中已经自带了很多例子,大家可以仔细研究一下。
    curl这个系列就总结到这里,希望对大家了解curl库有帮助,其中有错误的地方,请大家指出,谢谢!

 

 

posted on 2012-11-24 16:16  刺猬的温驯  阅读(388)  评论(0编辑  收藏  举报