概述
HTTP(HyperText Transfer Protocol)是一款用于傳輸超文本的應用層協議。AliOS Things的網絡協議棧包含了HTTP組件,提供HTTP客戶端標準能力。開發者可以通過組件API,在設備端快速實現通過HTTP GET、POST等方法與服務端進行數據交互。例如,設備端發起HTTP GET請求https://www.aliyun.com/,獲取網頁數據。
該組件支持以下功能:
HTTP GET
HTTP HEAD
HTTP POST
HTTP PUT
版權信息
Apache 2.0 License
目錄結構
.
├── include
│ └── httpclient.h # 對外頭文件
├── internal # 內部頭文件
├── package.yaml # 編譯配置文件
└── src
├── http_aos_wrapper.c # http收發適配層
├── http_client.c # http核心處理層
├── http_formdata.c # http表單數據處理
└── http_method_api.c # http方法接口
依賴組件
osal_aos
mbedtls
常用配置
HTTP的常用配置在文件package.yaml內
CONFIG_HTTP_SECURE :是否開啟HTTPS支持,默認開啟
CONFIG_HTTP_SECURE: 1
CONFIG_HTTP_FILE_OPERATE :是否使用文件操作,默認關閉
CONFIG_HTTP_FILE_OPERATE: 0
HTTP的內部配置在文件internal/http_opts.h內
HTTPCLIENT_AUTHB_SIZE : HTTP認證數據(用戶名、密碼)長度
#ifndef HTTPCLIENT_AUTHB_SIZE
#define HTTPCLIENT_AUTHB_SIZE 128
#endif
HTTPCLIENT_CHUNK_SIZE : http chunk塊數據大小
#ifndef HTTPCLIENT_CHUNK_SIZE
#define HTTPCLIENT_CHUNK_SIZE 1024
#endif
HTTPCLIENT_SEND_BUF_SIZE : HTTP發送緩存大小
#ifndef HTTPCLIENT_SEND_BUF_SIZE
#define HTTPCLIENT_SEND_BUF_SIZE 512
#endif
HTTPCLIENT_MAX_HOST_LEN : URL中host段最大長度
#ifndef HTTPCLIENT_MAX_HOST_LEN
#define HTTPCLIENT_MAX_HOST_LEN 64
#endif
HTTPCLIENT_MAX_URL_LEN : URL最大長度
#ifndef HTTPCLIENT_MAX_URL_LEN
#define HTTPCLIENT_MAX_URL_LEN 512
#endif
HTTPCLIENT_MAX_RECV_WAIT_MS : 接收超時時間
#ifndef HTTPCLIENT_MAX_RECV_WAIT_MS
#define HTTPCLIENT_MAX_RECV_WAIT_MS 5000
#endif
HTTP_PORT : HTTP默認端口
#ifndef HTTP_PORT
#define HTTP_PORT 80
#endif
HTTPS_PORT : HTTPS默認端口
#ifndef HTTPS_PORT
#define HTTPS_PORT 443
#endif
API說明
分配HTTP請求頭部緩存和響應緩存
HTTPC_RESULT httpclient_prepare(httpclient_data_t *client_data, int header_size, int resp_size)
args | description |
client_data | 用戶數據結構體指針 |
header_size | 頭部大小 |
resp_size | 回復大小 |
釋放HTTP請求頭部緩存和響應緩
HTTPC_RESULT httpclient_unprepare(httpclient_data_t *client_data);
args | description |
client_data | 用戶數據結構體指針 |
重置HTTP請求頭部緩存和響應緩存
void httpclient_reset(httpclient_data_t *client_data)
args | description |
client_data | 用戶數據結構體指針 |
向URL發送GET請求,等待回復。
HTTPC_RESULT httpclient_get(httpclient_t *client, char *url, httpclient_data_t *client_data)
args | description |
client | HTTP client上下文,包含配置參數,如服務端口號、服務端證書等 |
url | URL地址 |
client_data | 用戶數據結構體指針 |
向URL發送POST請求,等待回復。
HTTPC_RESULT httpclient_post(httpclient_t *client, char *url, httpclient_data_t *client_data)
args | description |
client | HTTP client上下文,包含配置參數,如服務端口號、服務端證書等 |
url | URL地址 |
client_data | 用戶數據結構體指針 |
向URL發送PUT請求,等待回復。
HTTPC_RESULT httpclient_put(httpclient_t *client, char *url, httpclient_data_t *client_data)
args | description |
client | HTTP client上下文,包含配置參數,如服務端口號、服務端證書等 |
url | URL地址 |
client_data | 用戶數據結構體指針 |
向URL發送DELETE請求,等待回復。
HTTPC_RESULT httpclient_delete(httpclient_t *client, char *url, httpclient_data_t *client_data)
args | description |
client | HTTP client上下文,包含配置參數,如服務端口號、服務端證書等 |
url | URL地址 |
client_data | 用戶數據結構體指針 |
建立連接
HTTPC_RESULT httpclient_conn(httpclient_t *client, const char *url)
args | description |
client | HTTP client上下文,包含配置參數,如服務端口號、服務端證書等 |
url | URL地址 |
發送請求
HTTPC_RESULT httpclient_send(httpclient_t *client, const char *url, int method, httpclient_data_t *client_data)
args | description |
client | HTTP client上下文,包含配置參數,如服務端口號、服務端證書等 |
url | URL地址 |
method | 請求方法,具體值參考枚舉HTTP_REQUEST_TYPE |
client_data | 用戶數據結構體指針 |
接收響應
HTTPC_RESULT httpclient_recv(httpclient_t *client, httpclient_data_t *client_data)
args | description |
client | HTTP client上下文,包含配置參數,如服務端口號、服務端證書等 |
client_data | 用戶數據結構體指針 |
關閉連接
void httpclient_clse(httpclient_t *client)
args | description |
client | HTTP client上下文,包含配置參數,如服務端口號、服務端證書等 |
設置請求自定義頭部
void httpclient_set_custom_header(httpclient_t *client, char *header)
args | description |
client | HTTP client上下文,包含配置參數,如服務端口號、服務端證書等 |
header | 自定義header |
獲取響應碼
int httpclient_get_response_code(httpclient_t *client)
args | description |
client | HTTP client上下文,包含配置參數,如服務端口號、服務端證書等 |
獲取響應頭部字段值
int httpclient_get_response_header_value(char *header_buf, char *name, int *val_pos, int *val_len)
args | description |
header_buf | 響應頭部緩存 |
name | 字段名 |
val_pos | 字段起始位置 |
val_len | 字段長度 |
添加文本表單數據
int httpclient_formdata_addtext(httpclient_data_t* client_data, char* content_disposition, char* content_type, char* name, char* data, int data_len);
args | description |
client_data | 用戶字段指針 |
content_disposition | 待添加的內容地址 |
content_type | 內容類型 |
name | 名稱的地址 |
data | 表單數據地址 |
data_len | 表單數據長度 |
添加文件表單數據
int httpclient_formdata_addfile(httpclient_data_t* client_data, char* content_disposition, char* name, char* content_type, char* file_path);
args | description |
client_data | 用戶字段指針 |
content_disposition | 待添加的內容地址 |
name | 名稱的地址 |
content_type | 內容類型 |
file_path | 文件路徑 |
使用示例
組件使用示例相關的代碼下載、編譯和固件燒錄均依賴AliOS Things配套的開發工具,所以首先需要參考《AliOS Things集成開發環境使用說明之搭建開發環境》,下載安裝。 待開發環境搭建完成后,可以按照以下步驟進行示例的測試。
步驟1 創建或打開工程
打開已有工程
如果用于測試的案例工程已存在,可參考《AliOS Things集成開發環境使用說明之打開工程》打開已有工程。
創建新的工程
組件的示例代碼可以通過編譯鏈接到AliOS Things的任意案例(solution)來運行,這里選擇helloworld_demo案例。helloworld_demo案例相關的源代碼下載可參考《AliOS Things集成開發環境使用說明之創建工程》。
步驟2 添加組件
案例下載完成后,需要在helloworld_demo組件的package.yaml中添加對組件的依賴:
depends:
- netmgr: dev_aos # helloworld_demo中引入netmgr組件,用于WiFi聯網
- http: dev_aos # helloworld_demo中引入http組件
步驟3 下載組件
在已安裝了的開發環境工具欄中,選擇Terminal -> New Terminal啟動終端,并且默認工作路徑為當前工程的workspace,此時在終端命令行中輸入:
aos install http
上述命令執行成功后,組件源碼則被下載到了./components/http路徑中。
步驟4 添加示例
在HTTP組件的package.yaml中添加example示例代碼:
source_file:
- "src/*.c"
- "example/http_example.c" # add http_example.c
步驟5 編譯固件
在示例代碼已經添加至組件的配置文件,并且helloworld_demo已添加了對該組件的依賴后,就可以編譯helloworld_demo案例來生成固件了,具體編譯方法可參考《AliOS Things集成開發環境使用說明之編譯固件》。
步驟6 燒錄固件
helloworld_demo案例的固件生成后,可參考《AliOS Things集成開發環境使用說明之燒錄固件》來燒錄固件。
步驟7 打開串口
固件燒錄完成后,可以通過串口查看示例的運行結果,打開串口的具體方法可參考《AliOS Things集成開發環境使用說明之查看日志》。
當串口終端打開成功后,可在串口中輸入help來查看已添加的測試命令。
步驟8 HTTP測試示例
CLI命令行輸入初始化netmgr命令:
netmgr_example
CLI命令行輸入聯網命令:
netmgr -t wifi -c ssid password
然后,CLI命令行輸入:
http_example
關鍵日志
CLI日志:
http comp test success!