OpenWrt系列:libcurl的api总结

转载:https://blog.csdn.net/m0_37263637/article/details/79489321

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

本文主要记录的是使用libcurl编写嵌入式平台调用开发平台提供restful API所需的posts get这两个接口。
(180920)后续未验证的code是后续使用遇到的,从可用code截取出来,但并没有在文中sample code编译过,所以未验证只是示意。前面的code是亲自编过了的。

1 安装

1.1 环境

libcurl版本:7.58.0
openssl版本:1.0.2g
安装环境:Linux x64

libcurl和openssl版本很重要,有一个匹配关系。

1.2 安装

./configure --prefix=/home/jw.li/work/face/libcurl/curl --with-ssl=/home/jw.li/code/save/ssl
Make  
Make intall

最后在安装目录下的到lib 和include

2 使用

2.1 一些基础的函数

curl_global_init()               //初始化libcurl
curl = curl_easy_init();    //得到curl的指针  
curl_easy_setopt()           //设置http参数 重要
curl_easy_perform(curl); //执行http请求,阻塞的方式进行下载的
curl_easy_cleanup(curl); //回收curl指针

2.2 curl_easy_setopt()常用的参数

CURLOPT_URL            http访问的url
CURLOPT_WRITEFUNCTION  回调函数原型为:size_t function( void *ptr, size_t size, size_t nmemb, void *stream)
CURLOPT_WRITEDATA      用于表明CURLOPT_WRITEFUNCTION函数中的stream指针的来源
CURLOPT_COOKIE         字符串类型,设置http头中的cookie信息。
CURLOPT_POSTFIELDS     字符串类型,提交http的post操作字符串数据。
CURLOPT_HTTPHEADER     选项自定义请求头信息
CURLOPT_POSTFIELDSIZE  指定post长度


CURLOPT_INFILESIZE: 当你上传一个文件到远程站点,这个选项告诉PHP你上传文件的大小。

CURLOPT_VERBOSE: 如果你想CURL报告每一件意外的事情,设置这个选项为一个非零值。

CURLOPT_HEADER: 如果你想把一个头包含在输出中,设置这个选项为一个非零值。

CURLOPT_NOPROGRESS: 如果你不会PHP为CURL传输显示一个进程条,设置这个选项为一个非零值。

注意:PHP自动设置这个选项为非零值,你应该仅仅为了调试的目的来改变这个选项。

CURLOPT_NOBODY: 如果你不想在输出中包含body部分,设置这个选项为一个非零值。

CURLOPT_FAILONERROR: 如果你想让PHP在发生错误(HTTP代码返回大于等于300)时,不显示,设置这个选项为一人非零值。默认行为是返回一个正常页,忽略代码。

CURLOPT_UPLOAD: 如果你想让PHP为上传做准备,设置这个选项为一个非零值。

CURLOPT_POST: 如果你想PHP去做一个正规的HTTP POST,设置这个选项为一个非零值。这个POST是普通的 application/x-www-from-urlencoded 类型,多数被HTML表单使用。

CURLOPT_FTPLISTONLY: 设置这个选项为非零值,PHP将列出FTP的目录名列表。

CURLOPT_FTPAPPEND: 设置这个选项为一个非零值,PHP将应用远程文件代替覆盖它。

CURLOPT_NETRC: 设置这个选项为一个非零值,PHP将在你的 ~./netrc 文件中查找你要建立连接的远程站点的用户名及密码。

CURLOPT_FOLLOWLOCATION: 设置这个选项为一个非零值(象 ‘Location: ‘)的头,服务器会把它当做HTTP头的一部分发送(注意这是递归的,PHP将发送形如 ‘Location: ‘的头)。

CURLOPT_PUT: 设置这个选项为一个非零值去用HTTP上传一个文件。要上传这个文件必须设置CURLOPT_INFILE和CURLOPT_INFILESIZE选项.

CURLOPT_MUTE: 设置这个选项为一个非零值,PHP对于CURL函数将完全沉默。

CURLOPT_TIMEOUT: 设置一个长整形数,作为最大延续多少秒。

CURLOPT_LOW_SPEED_LIMIT: 设置一个长整形数,控制传送多少字节。

CURLOPT_LOW_SPEED_TIME: 设置一个长整形数,控制多少秒传送CURLOPT_LOW_SPEED_LIMIT规定的字节数。

CURLOPT_RESUME_FROM: 传递一个包含字节偏移地址的长整形参数,(你想转移到的开始表单)。

CURLOPT_SSLVERSION: 传递一个包含SSL版本的长参数。默认PHP将被它自己努力的确定,在更多的安全中你必须手工设置。

CURLOPT_TIMECONDITION: 传递一个长参数,指定怎么处理CURLOPT_TIMEVALUE参数。你可以设置这个参数为TIMECOND_IFMODSINCE 或 TIMECOND_ISUNMODSINCE。这仅用于HTTP。

CURLOPT_TIMEVALUE: 传递一个从1970-1-1开始到现在的秒数。这个时间将被CURLOPT_TIMEVALUE选项作为指定值使用,或被默认TIMECOND_IFMODSINCE使用。

下列选项的值将被作为字符串:

CURLOPT_URL: 这是你想用PHP取回的URL地址。你也可以在用curl_init()函数初始化时设置这个选项。

CURLOPT_USERPWD: 传递一个形如[username]:[password]风格的字符串,作用PHP去连接。

CURLOPT_PROXYUSERPWD: 传递一个形如[username]:[password] 格式的字符串去连接HTTP代理。

CURLOPT_RANGE: 传递一个你想指定的范围。它应该是’X-Y’格式,X或Y是被除外的。HTTP传送同样支持几个间隔,用逗句来分隔(X-Y,N-M)。

CURLOPT_POSTFIELDS: 传递一个作为HTTP “POST”操作的所有数据的字符串。

CURLOPT_REFERER: 在HTTP请求中包含一个’referer’头的字符串。

CURLOPT_USERAGENT: 在HTTP请求中包含一个’user-agent’头的字符串。

CURLOPT_FTPPORT: 传递一个包含被ftp ‘POST’指令使用的IP地址。这个POST指令告诉远程服务器去连接我们指定的IP地址。 这个字符串可以是一个IP地址,一个主机名,一个网络界面名(在UNIX下),或是‘-’(使用系统默认IP地址)。

CURLOPT_COOKIE: 传递一个包含HTTP cookie的头连接。

CURLOPT_SSLCERT: 传递一个包含PEM格式证书的字符串。

CURLOPT_SSLCERTPASSWD: 传递一个包含使用CURLOPT_SSLCERT证书必需的密码。

CURLOPT_COOKIEFILE: 传递一个包含cookie数据的文件的名字的字符串。这个cookie文件可以是Netscape格式,或是堆存在文件中的HTTP风格的头。

CURLOPT_CUSTOMREQUEST: 当进行HTTP请求时,传递一个字符被GET或HEAD使用。为进行DELETE或其它操作是有益的,更Pass a string to be used instead of GET or HEAD when doing an HTTP request. This is useful for doing or another, more obscure, HTTP request.

注意: 在确认你的服务器支持命令先不要去这样做。

下列的选项要求一个文件描述(通过使用fopen()函数获得):

CURLOPT_FILE: 这个文件将是你放置传送的输出文件,默认是STDOUT.

CURLOPT_INFILE: 这个文件是你传送过来的输入文件。

CURLOPT_WRITEHEADER: 这个文件写有你输出的头部分。

CURLOPT_STDERR: 这个文件写有错误而不是stderr。

2.3 编程模型

curl = curl_easy_init(); 初始化
 curl_easy_setopt(curl, CURLOPT_POSTFIELDS, body.c_str());     设置相应http参数
 curl_easy_setopt(curl, CURLOPT_WRITEDATA, (void *)response); 设置响应内容写入buffer
 ret = curl_easy_perform(curl);                          //执行请求 得到结果
 long response_code = 0;
 curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &response_code);//获取http 状态码

3 代码

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

using namespace std;

//回调函数  得到响应内容
int write_data(char* buffer, size_t size, size_t nmemb, void* userp){
    std::string * str = dynamic_cast<std::string *>((std::string *)userp);
    str->append((char *)buffer, size * nmemb);
    return nmemb;
}

int posts(string url, string &body,  string* response);
int get(string url, string* response);



int main(int argc, char** argv){
	std::map<std::string, std::string> data;
	std::string body;

	std::string response;
    int status_code = get("http://www.baidu.com", &response);
	if (status_code != CURLcode::CURLE_OK) {
			return -1;
	}
	cout << response << endl;
	cout << "*********************************"  << endl;

    status_code = posts("https://www.zhihu.com", body, &response);
	if (status_code != CURLcode::CURLE_OK) {
			return -1;
	}
	cout << response << endl;

	return 0;
}

int get(string url, string* response)
{
    CURL *curl;
    CURLcode ret;
    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "Accept: Agent-007");
    curl = curl_easy_init();    // 初始化
    
    if (curl)
    {
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);        //改协议头
        curl_easy_setopt(curl, CURLOPT_URL, (char *)url.c_str());   // 指定url
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_data);
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, (void *)response);
        int status_code = curl_easy_perform(curl);   // 执行


         ret = curl_easy_perform(curl);                          //执行请求
        if(ret == 0){
            curl_slist_free_all(headers);
            curl_easy_cleanup(curl);    
            return status_code;
        }
        else{
            return ret;
        }
    }
    else{
        return -1;
    }
}
//POST 处理x-www-form-urlencoded格式数据 如下
//{id: 'SEA2HHHH',
//  time: '2018-12-27T21:43:41.604Z',
//  image: 'haha' }
//则    curl_easy_setopt(curl, CURLOPT_POSTFIELDS, body.c_str());           //指定post内容中
//body内容为:
//id=SEA2HHHH&image='haha&time=2019-01-02+14:22:41

int posts(string url, string &body,  string* response)
{
    CURL *curl;
    CURLcode ret;
    curl = curl_easy_init();
    long response_code = 0;
    if (curl)
    {
         curl_easy_setopt(curl, CURLOPT_POSTFIELDS, body.c_str());           //指定post内容
        curl_easy_setopt(curl, CURLOPT_POSTFIELDSIZE, body.size());         //指定post长度
        curl_easy_setopt(curl, CURLOPT_HEADER, 0);                          //设置协议头
        // curl_easy_setopt(curl, CURLOPT_SSL_VERIFYPEER, 0L);
        curl_easy_setopt(curl, CURLOPT_SSL_VERIFYHOST, 0L);             
        curl_easy_setopt(curl, CURLOPT_URL, (char *)url.c_str());           //指定url
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_data);          //绑定相应
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, (void *)response);        //绑定响应内容的地址
        ret = curl_easy_perform(curl);                          //执行请求
        if(ret == 0){
            curl_easy_cleanup(curl);   
            curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &response_code);//获取http 状态码 
            return 0;  
        }
        else{
			curl_easy_getinfo(curl, CURLINFO_RESPONSE_CODE, &response_code);//获取http 状态码
            return ret;
        }
    }
	else{
        return -1;
	}
}



//***************put for c(180727) 下列code未验证***************//
//put 函数用于上传数据
size_t read_data(char* buffer, size_t size, size_t nitems, void* instream){
    size_t sizes = fread(buffer, size, nitems, (FILE *)instream); 
    return nitems;
}
//put 文件, 即 raw bin 类型数据在node中接受需要使用 res.on('data')方式,在json编码数据可以使用req.body
int put(char* url, FILE* fd,  int fsize, char* response)//put 地址,put 文件句柄, 文件大小, 接受响应存储位置
{
    CURL *curl;
    CURLcode ret;
    curl = curl_easy_init();
    struct curl_slist *headers = NULL;
    headers = curl_slist_append(headers, "expect: "); //将值置为空,可以屏蔽该头
    //headers = curl_slist_append(headers, "content-length: ");//put 不能省略这个头content-length
    headers = curl_slist_append(headers, "test: put");//设置put http header头
    // printf("\n%s %d\n", body, fsize);
    if (curl)
    { 
        curl_easy_setopt(curl,CURLOPT_URL, url);//配置url
        curl_easy_setopt(curl,CURLOPT_UPLOAD, 1);//设置为上传模式 PUT
        curl_easy_setopt(curl, CURLOPT_HTTPHEADER, headers);//改协议头
        curl_easy_setopt(curl, CURLOPT_READFUNCTION, &read_data);//配置上传内容函数处理
        curl_easy_setopt(curl, CURLOPT_READDATA, fd);//向处理函数传递 文件指针
        curl_easy_setopt(curl, CURLOPT_INFILE, fd); //定位作为上传的输入文件 
        curl_easy_setopt(curl, CURLOPT_INFILESIZE, fsize);//上传文件字节数
        curl_easy_setopt(curl, CURLOPT_WRITEFUNCTION, write_data);//用于接受响应回调函数
        curl_easy_setopt(curl, CURLOPT_WRITEDATA, (void *)response);//传递接受响应内容的存储地址
        ret = curl_easy_perform(curl);                          //执行请求
        if(ret == 0){
            curl_easy_cleanup(curl);    
            return 0;  
        }
        else{
            return ret;
        }
    }
	else{
        return -1;
	}
}

//***************post(180920) 下列code未验证 普通post ****************//
int post(string url, string &body,  string* response)
{
    CURL *curl;
    curl = curl_easy_init();

    if (curl)
    {
        curl_easy_setopt(curl, CURLOPT_POSTFIELDS, (char *)body.c_str());    // 指定post内容
        curl_easy_setopt(curl, CURLOPT_URL, (char *)url.c_str());   // 指定url
        curl_easy_perform(curl);
        curl_easy_cleanup(curl);
    }
	else{
		// cout << "error" << endl;
	}

    return 0;
}

//***************(180920) 下列code未验证 post body请求参数构造****************//
void makeUrlencodedForm(map<string, string> const & params, string * content)
{
	content->clear();
	map<string, string>::const_iterator it;
	for(it=params.begin(); it!=params.end(); it++)
	{
		char * key = curl_escape(it->first.c_str(), (int) it->first.size());
		char * value = curl_escape(it->second.c_str(),(int) it->second.size());
		*content += key;
		*content += '=';
		*content += value;
		*content += '&';
		curl_free(key);
		curl_free(value);
	}
}
//***************post中 boy参数得到sample****************//
    //string body;
  	// map<string, string> data;
    // data["file"] = "file bin";
    // data["group_id"] = "deviceinfo";
	// makeUrlencodedForm(data, &body);
//************************************************************//

编译:

g++ -I../libcurl/include  -std=c++11  ./test_main.cpp   -L../libcurl/lib -lcurl -lssl -lcrypto  -O2 -ldl  -o sample_X86_64
发布了45 篇原创文章 · 获赞 48 · 访问量 11万+

猜你喜欢

转载自blog.csdn.net/qq_24550925/article/details/88415459