Curl常用函數介紹


一、LibCurl基本編程框架

在基於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. 調用 curl_global_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 CURL *curl_easy_init( );
描述:
  curl_easy_init用來初始化一個CURL的指針(有些像返回FILE類型的指針一樣). 相應的在調用結束時要用curl_easy_cleanup函數清理.
  一般curl_easy_init意味着一個會話的開始. 它會返回一個easy_handle(CURL*對象), 一般都用在easy系列的函數中.
4 void curl_easy_cleanup(CURL *handle);
描述:
  這個調用用來結束一個會話.與curl_easy_init配合着用. 
參數:
  CURL類型的指針.
5 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手冊.
6 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協議提供了消息頭,請求消息頭用於告訴服務器如何處理請求;響應消息頭則告訴瀏覽器如何處理接收到的數據。在libcurl中,你可以自由的添加 這些消息頭:

  struct curl_slist *headers=NULL; /*init to NULL is important*/
  headers = curl_slist_append(headers,"Accept:*/*"); 
  headers = curl_slist_append(headers,"Pragma:no-cache");
  headers = curl_slist_append(headers,"Host:http 1.1");
  curl_easy_setopt(easyhandle,CURLOPT_HTTPHEADER, headers);
  curl_easy_perform(easyhandle);/*transfer http */
  curl_slist_free_all(headers); /*free the header list*/
刪除消息頭
  對於一個已經存在的消息頭,設置它的內容為空,libcurl在發送請求時就不會同時提交該消息頭:
  headers = curl_slist_append(headers, "Accept:");
七、多線程問題
    首先一個基本原則就是:絕對不應該在線程之間共享同一個libcurl handle(CURL *對象),不管是easy handle還是multi handle(本文只介紹easy_handle)。一個線程每次只能使用一個handle。
八、什么時候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);

 

 


免責聲明!

本站轉載的文章為個人學習借鑒使用,本站對版權不負任何法律責任。如果侵犯了您的隱私權益,請聯系本站郵箱yoyou2525@163.com刪除。



 
粵ICP備18138465號   © 2018-2025 CODEPRJ.COM