我們使用ESP32_Arduino自帶庫: HTTPClient

一. 請求相關(guān)API函數(shù)

首先,創(chuàng)建一個客戶端對象

1. 初始化HTTP客戶端 http_client.begin()

/**
 * 解析url以獲得所有參數(shù)悬赏，默認(rèn)port是80端口
 * @param url String
 */
bool begin(String url);

/**
 * 解析url以獲得所有參數(shù)馆衔，默認(rèn)port是80端口
 * @param client : 傳入一個網(wǎng)絡(luò)連接客戶端
 * @param url String
 */
bool begin(WiFiClient &client, String url);

/**
 * 設(shè)置host port 以及uri
 * @param host String（192.168.1.12鱼鼓，不需要帶上http://前綴）
 * @param port uint16_t
 * @param uri  String
 */
bool begin(String host, uint16_t port, String uri = "/");

/**
 * 設(shè)置host port 以及uri
 * @param client 傳入一個網(wǎng)絡(luò)連接客戶端
 * @param host String（192.168.1.12，不需要帶上http://前綴）
 * @param port uint16_t
 * @param uri  String
 * @param https bool 是否啟用https
 */
bool begin(WiFiClient &client, String host, uint16_t port, String uri = "/", bool https = false);

/**
 * 設(shè)置host port 以及uri
 * @param host String（192.168.1.12视粮，不需要帶上http://前綴）
 * @param port uint16_t
 * @param uri  String
 * @param CAcert CA證書(https)
 */
bool begin(String host, uint16_t port, String uri, const char* CAcert);
bool begin(String host, uint16_t port, String uri, const char* CAcert, const char* cli_cert, const char* cli_key);

2. 設(shè)置長連接 http_client.setReuse(true);

/**
 * try to reuse the connection to the server
 * keep-alive 請求頭
 * @param reuse bool
 */
void setReuse(bool reuse); // keep-alive

3. setUserAgent —— 封裝標(biāo)準(zhǔn)請求頭User-Agent

/**
 * set User Agent
 * User Agent請求頭：使得服務(wù)器能夠識別客戶使用的操作系統(tǒng)及版本、CPU 類型未辆、瀏覽器及版本睛琳、瀏覽器渲染引擎、瀏覽器語言鬼店、瀏覽器插件等网棍。
 * @param userAgent const char *
 */
void setUserAgent(const String& userAgent);

4. addHeader —— 封裝自定義請求頭

函數(shù)說明：

/**
 * adds Header to the request
 * @param name  自定義請求頭的名字
 * @param value 自定義請求頭的參數(shù)值
 * @param first 是否要把當(dāng)前請求頭放在請求頭的最前面
 * @param replace 是否需要替換之前已經(jīng)存在該請求頭的參數(shù)值，默認(rèn)就是覆蓋舊值
 */
void addHeader(const String& name, const String& value, bool first = false, bool replace = true);

5. GET 請求

函數(shù)說明：

/**
 * 發(fā)送一個get請求
 * @return http 狀態(tài)碼
 */
int GET();

6. POST 請求

函數(shù)說明：

/**
 * 發(fā)送一個post請求
 * @param payload uint8_t * 需要提交的數(shù)據(jù)
 * @param size size_t 提交的數(shù)據(jù)的字節(jié)數(shù)
 * @return http 狀態(tài)碼
 */
int POST(uint8_t * payload, size_t size);
 
/**
 * 發(fā)送一個post請求
 * @param payload String 需要提交的數(shù)據(jù)
 * @return http 狀態(tài)碼
 */
int POST(String payload);

7. PUT 請求

函數(shù)說明：

/**
 * 發(fā)送一個PUT請求（博主也沒有用過PUT）
 * @param payload uint8_t * 需要提交的數(shù)據(jù)
 * @param size size_t 提交的數(shù)據(jù)的字節(jié)數(shù)
 * @return http 狀態(tài)碼
 */
int PUT(uint8_t * payload, size_t size);
/**
 * 發(fā)送一個PUT請求（博主也沒有用過PUT）
 * @param payload String 需要提交的數(shù)據(jù)
 * @return http 狀態(tài)碼
 */
int PUT(String payload);

8. PATCH 請求

函數(shù)說明：

/**
 * 發(fā)送一個PATCH請求（博主也沒有用過PATCH）
 * @param payload uint8_t * 需要提交的數(shù)據(jù)
 * @param size size_t 提交的數(shù)據(jù)的字節(jié)數(shù)
 * @return http 狀態(tài)碼
 */
int PATCH(uint8_t * payload, size_t size);
/**
 * 發(fā)送一個PATCH請求（博主也沒有用過PATCH）
 * @param payload String 需要提交的數(shù)據(jù)
 * @return http 狀態(tài)碼
 */
int PATCH(String payload);

9. sendRequest 發(fā)送請求

GET妇智、POST滥玷、PUT氏身、PATCH最終都會調(diào)用sendRequest方法。
函數(shù)說明：

/**
 * GET惑畴、POST蛋欣、PUT、PATCH最終都會調(diào)用sendRequest方法
 * sendRequest
 * @param type const char * 請求類型    "GET", "POST", ....
 * @param payload String  請求攜帶的數(shù)據(jù)  data for the message body
 * @return
 */
int sendRequest(const char * type, String payload);
/**
 * sendRequest
 * @param type const char * 請求類型 "GET", "POST", ....
 * @param payload uint8_t * 請求攜帶的數(shù)據(jù)  data for the message body if null not send
 * @param size size_t  請求攜帶的數(shù)據(jù)字節(jié)數(shù) size for the message body if 0 not send
 * @return -1 if no info or > 0 when Content-Length is set by server
 */
int sendRequest(const char * type, uint8_t * payload = NULL, size_t size = 0);
/**
 * sendRequest
 * @param type const char *  請求類型 "GET", "POST", ....
 * @param stream Stream *  請求攜帶的數(shù)據(jù)流 data stream for the message body
 * @param size size_t   數(shù)據(jù)流大小 size for the message body if 0 not Content-Length is send
 * @return -1 if no info or > 0 when Content-Length is set by server
 */
int sendRequest(const char * type, Stream * stream, size_t size = 0);

10. setTimeout —— 設(shè)置請求超時

函數(shù)說明:

/**
 * 請求超時時間配置 ms為單位
 * @param timeout unsigned int  默認(rèn)500ms
 */
void setTimeout(uint16_t timeout);

11. useHTTP10 —— http協(xié)議版本

函數(shù)說明:

/**
 * http協(xié)議版本
 * @param usehttp10 true表示用http1.0如贷，默認(rèn)是false陷虎，用http1.1
 */
void useHTTP10(bool usehttp10 = true);

12. end —— 結(jié)束請求

函數(shù)說明:

/**
 * 結(jié)束請求
 * called after the payload is handled
 */
void end(void);

二. 響應(yīng)相關(guān)API

1. collectHeaders —— 設(shè)置需要收集的響應(yīng)頭

函數(shù)說明:

/**
 * 設(shè)置需要收集的響應(yīng)頭（1-n個）
 * @param headerKeys[] const char *   響應(yīng)頭的名字
 * @param headerKeysCount const size_t 響應(yīng)頭的個數(shù)
 * 注意點(diǎn)：headerKeys數(shù)組元素個數(shù)需要大于等于 headerKeysCount
 */
void collectHeaders(const char* headerKeys[], const size_t headerKeysCount);

RequestArgument定義如下：

struct RequestArgument {
    String key;//鍵值對里面的key
    String value;//鍵值對里面的value
};

注意點(diǎn)：

這個方法收集的headerKeys會在響應(yīng)數(shù)據(jù)處理函數(shù)中應(yīng)用到；

2. header(name) —— 獲取具體響應(yīng)頭參數(shù)值

函數(shù)說明:

/**
 * 獲取響應(yīng)頭參數(shù)值
 * @param name   const char *   響應(yīng)頭的名字
 * @return value of headerkey（name）
 */
String header(const char* name);

如果沒有調(diào)用collectHeaders(),那就會默認(rèn)返回空字符串杠袱；

3. header(index) —— 獲取第index個響應(yīng)頭參數(shù)值

函數(shù)說明:

/**
 * 獲取第i個響應(yīng)頭參數(shù)值
 * @param i   size_t   響應(yīng)頭索引值
 * @return value of header index
 */
String header(size_t i);

如果沒有調(diào)用collectHeaders(),那就會默認(rèn)返回空字符串尚猿；

4. headerName(index) —— 獲取第i個響應(yīng)頭名字

函數(shù)說明:

/**
 * 獲取第i個響應(yīng)頭名字
 * @param i   size_t   響應(yīng)頭索引值
 * @return name of header index
 */
String headerName(size_t i);

如果沒有調(diào)用collectHeaders(),那就會默認(rèn)返回空字符串；

5. headers() —— 獲取收集響應(yīng)頭個數(shù)

函數(shù)說明:

/**
 * 獲取收集響應(yīng)頭個數(shù)
 * @return count int
 */
int headers();                     // get header count

6. hasHeader(name) —— 判斷是否存在某一個響應(yīng)頭

函數(shù)說明:

/**
 * 判斷是否存在某一個響應(yīng)頭
 * @param name   const char*   響應(yīng)頭名字
 * @return bool
 */
bool hasHeader(const char* name);  // check if header exists

7. handleHeaderResponse —— 處理響應(yīng)頭數(shù)據(jù)

函數(shù)說明:

/**
 * 讀取從服務(wù)器返回的響應(yīng)頭數(shù)據(jù)
 * @return int http狀態(tài)碼
 */
int handleHeaderResponse()

8. getString —— 獲取響應(yīng)數(shù)據(jù)

函數(shù)說明:

/**
 * 把響應(yīng)數(shù)據(jù)轉(zhuǎn)成字符串 (可能需要很大內(nèi)存空間)
 * @return String 響應(yīng)數(shù)據(jù)轉(zhuǎn)成字符串
 */
String getString(void);

9. getStream —— 獲取響應(yīng)數(shù)據(jù)的流

函數(shù)說明:

/**
 * 獲取響應(yīng)數(shù)據(jù)的流
 * @return WiFiClient& tcp響應(yīng)數(shù)據(jù)的流
 */
WiFiClient& getStream(void);

10. getStreamPtr —— 獲取響應(yīng)數(shù)據(jù)的流

函數(shù)說明:

/**
 * 獲取響應(yīng)數(shù)據(jù)的流
 * @return WiFiClient& tcp響應(yīng)數(shù)據(jù)的流
 */
WiFiClient* getStreamPtr(void);

11. writeToStream —— 獲取響應(yīng)數(shù)據(jù)的流楣富，并寫到其他流對象

在講解該函數(shù)之前凿掂，博主先給讀者簡單介紹一下分塊編碼（Transfer-Encoding: chunked）：

Transfer-Encoding，是一個 HTTP 頭部字段（響應(yīng)頭域）纹蝴，字面意思是「傳輸編碼」缠劝。最新的 HTTP 規(guī)范里，只定義了一種編碼傳輸：分塊編碼(chunked)骗灶。
分塊傳輸編碼（Chunked transfer encoding）是超文本傳輸協(xié)議（HTTP）中的一種數(shù)據(jù)傳輸機(jī)制惨恭，允許HTTP由網(wǎng)頁服務(wù)器發(fā)送給客戶端的數(shù)據(jù)可以分成多個部分。分塊傳輸編碼只在HTTP協(xié)議1.1版本（HTTP/1.1）中提供耙旦。
數(shù)據(jù)分解成一系列數(shù)據(jù)塊脱羡，并以一個或多個塊發(fā)送，這樣服務(wù)器可以發(fā)送數(shù)據(jù)而不需要預(yù)先知道發(fā)送內(nèi)容的總大小免都。
具體方法

在頭部加入 Transfer-Encoding: chunked 之后锉罐，就代表這個報文采用了分塊編碼。這時绕娘，報文中的實(shí)體需要改為用一系列分塊來傳輸脓规。
每個分塊包含十六進(jìn)制的長度值和數(shù)據(jù)，長度值獨(dú)占一行险领，長度不包括它結(jié)尾的 CRLF(\r\n)侨舆，也不包括分塊數(shù)據(jù)結(jié)尾的 CRLF。
最后一個分塊長度值必須為 0绢陌，對應(yīng)的分塊數(shù)據(jù)沒有內(nèi)容挨下，表示實(shí)體結(jié)束。

/**
 * 把響應(yīng)數(shù)據(jù)的流寫到其他流對象
 * @param Stream* 其他流對象
 * @return int 寫成功的字節(jié)數(shù)
 */
int writeToStream(Stream* stream);

12. getSize —— 獲取響應(yīng)數(shù)據(jù)的字節(jié)數(shù)

函數(shù)說明:

/**
 * 獲取響應(yīng)數(shù)據(jù)字節(jié)數(shù)
 * @return int 響應(yīng)數(shù)據(jù)字節(jié)數(shù)
 */
int getSize(void);

13. errorToString —— 獲取請求失敗響應(yīng)信息

函數(shù)說明:

/**
 * 根據(jù)錯誤碼error返回具體錯誤信息
 * @param error 錯誤碼
 * @return String 錯誤碼對應(yīng)的錯誤信息
 */
static String errorToString(int error);

#include <Arduino.h>
#include "WiFi.h"
#include "HTTPClient.h"

const char *ssid = "anny";                      //wifi名
const char *password = "20141208";              //wifi密碼
const char *host = "https://api.seniverse.com"; //心知天氣APIhost
const char *apiKey = "SZihSaRrzq6LclO30";       //API key 私鑰
const char *city = "taian";                     //查詢的城市
//示例: https://api.seniverse.com/v3/weather/now.json?key=your_private_key&location=beijing&language=zh-Hans&unit=c

WiFiClient wifi_Client;
HTTPClient http_client;
String req;
String rsp;

class cityWeather
{
public:
  char cityName[16];
  char weather[32];
  char temp[16];
  char update[32];
};

//Wifi連接
void setupWifi()
{
  delay(10);
  Serial.println("connecting WIFI");
  WiFi.begin(ssid, password);
  while (!WiFi.isConnected())
  {
    Serial.print(".");
    delay(500);
  }
  Serial.println("OK");
  Serial.println("Wifi connected");
}

void setUpHttpClient()
{
  req = (String)host + "/v3/weather/now.json?key=";
  req += apiKey;
  req += "&location=";
  req += city;
  req += "&language=zh-Hans&unit=c";
  Serial.println(req);
  if (http_client.begin(req))
  {
    Serial.println("HTTPclient setUp done!");
  }
}

void setup()
{
  Serial.begin(115200);
  delay(3000);
  setupWifi();
  setUpHttpClient();
}

void loop()
{
  int http_code = http_client.GET();
  Serial.println(http_code);
  if (http_code > 0)
  {
    Serial.printf("HTTP get code: %d\n", http_code);
    if (http_code == HTTP_CODE_OK)
    {
      rsp = http_client.getString();
      Serial.println(rsp);
    }
    else
    {
      Serial.printf("fail to get cityWeather,code:%d\n", http_code);
    }
  }
  delay(5000);
}

玩轉(zhuǎn) ESP32 + Arduino (十四) HTTPClient庫訪問網(wǎng)絡(luò)資源

玩轉(zhuǎn) ESP32 + Arduino (十四) HTTPClient庫訪問網(wǎng)絡(luò)資源

一. 請求相關(guān)API函數(shù)

1. 初始化HTTP客戶端 http_client.begin()

2. 設(shè)置長連接 http_client.setReuse(true);

3. setUserAgent —— 封裝標(biāo)準(zhǔn)請求頭User-Agent

4. addHeader —— 封裝自定義請求頭

5. GET 請求

6. POST 請求

7. PUT 請求

8. PATCH 請求

9. sendRequest 發(fā)送請求

10. setTimeout —— 設(shè)置請求超時

11. useHTTP10 —— http協(xié)議版本

12. end —— 結(jié)束請求

二. 響應(yīng)相關(guān)API

1. collectHeaders —— 設(shè)置需要收集的響應(yīng)頭

2. header(name) —— 獲取具體響應(yīng)頭參數(shù)值

3. header(index) —— 獲取第index個響應(yīng)頭參數(shù)值

4. headerName(index) —— 獲取第i個響應(yīng)頭名字

5. headers() —— 獲取收集響應(yīng)頭個數(shù)

6. hasHeader(name) —— 判斷是否存在某一個響應(yīng)頭

7. handleHeaderResponse —— 處理響應(yīng)頭數(shù)據(jù)

8. getString —— 獲取響應(yīng)數(shù)據(jù)

9. getStream —— 獲取響應(yīng)數(shù)據(jù)的流

10. getStreamPtr —— 獲取響應(yīng)數(shù)據(jù)的流

11. writeToStream —— 獲取響應(yīng)數(shù)據(jù)的流楣富，并寫到其他流對象

12. getSize —— 獲取響應(yīng)數(shù)據(jù)的字節(jié)數(shù)

13. errorToString —— 獲取請求失敗響應(yīng)信息