ESP32 IDF开发 应用篇⑱ esp_http_client实例分析

最新推荐文章于 2024-06-11 09:14:20 发布
最新推荐文章于 2024-06-11 09:14:20 发布
阅读量735 收藏 3
点赞数 9
分类专栏： ESP32 IDF小白到大师实战 文章标签： http xcode 网络协议
版权声明：本文为博主原创文章，遵循 CC 4.0 BY-SA 版权协议，转载请附上原文出处链接和本声明。
本文链接：https://blog.csdn.net/lu330274924/article/details/134390470
版权

ESP32 IDF开发 应用篇⑱ esp_http_client实例分析


别迷路-导航栏
快速导航找到你想要的（文章目录）
此篇文章如果对你有用，请点赞收藏，您的支持就是博主坚持的动力。

1、博主写这篇技术文章的目的：

（1）、esp_http_client api的使用方法；

2、概述

在上一篇已经介绍了http的基本概念，这章主要介绍esp_http_client.c文件中封装好的api函数的使用。

3、esp_http_client相关API的介绍

这里介绍大部分esp_http_client库的使用更详细的请参考：更多API 参考esp-idf\components\esp_http_client\include\esp_http_client.h

（1）、esp_http_client的初始化
先来看看初始化API

/**
  * @brief 启动HTTP会话
  *此函数必须是第一个要调用的函数,它返回一个esp_http_client_handle_t，您必须将其用作接口中其他函数的输入。
  *操作完成后，此调用必须对esp_http_client_cleanup进行相应的调用。
  * @param [in] config配置，请参见`http_client_config_t`
  * @return
  *-`esp_http_client_handle_t`
  *-如果有任何错误，则为NULL
  */
esp_http_client_handle_t esp_http_client_init(const esp_http_client_config_t *config);

再来解说初始化的内容有哪些
为结构体esp_http_client_config_t的参数分配内存，初始化数据

esp_http_client_handle_t esp_http_client_init(const esp_http_client_config_t *config)
{

    _success = (
                   (client                         = calloc(1, sizeof(esp_http_client_t)))           &&
                   (client->parser                 = calloc(1, sizeof(struct http_parser)))          &&
                   (client->parser_settings        = calloc(1, sizeof(struct http_parser_settings))) &&
                   (client->auth_data              = calloc(1, sizeof(esp_http_auth_data_t)))        &&
                   (client->request                = calloc(1, sizeof(esp_http_data_t)))             &&
                   (client->request->headers       = http_header_init())                             &&
                   (client->request->buffer        = calloc(1, sizeof(esp_http_buffer_t)))           &&
                   (client->response               = calloc(1, sizeof(esp_http_data_t)))             &&
                   (client->response->headers      = http_header_init())                             &&
                   (client->response->buffer       = calloc(1, sizeof(esp_http_buffer_t)))
               );
			。。。。。
    _success = (
                   (client->transport_list = esp_transport_list_init()) &&
                   (tcp = esp_transport_tcp_init()) &&
                   (esp_transport_set_default_port(tcp, DEFAULT_HTTP_PORT) == ESP_OK) &&
                   (esp_transport_list_add(client->transport_list, tcp, "http") == ESP_OK)
}

在esp_transport_tcp_init中注册了tcp的回调函数

tcp_connect, tcp_read, tcp_write, tcp_close, tcp_poll_read, tcp_poll_write, tcp_destroy
esp_transport_handle_t esp_transport_tcp_init(void)
{
esp_transport_set_func(t, tcp_connect, tcp_read, tcp_write, tcp_close, tcp_poll_read, tcp_poll_write, tcp_destroy);
}

（2）、设置url连接API

/**
  * @brief 为客户端设置URL，执行此行为时，URL中的选项将替换旧的
  *
  * @param [in]客户端esp_http_client句柄
  * @param [in] url URL
  *
  * @return
  *-ESP_OK
  *-ESP_FAIL
  */
esp_err_t esp_http_client_set_url(esp_http_client_handle_t client, const char *url);

解析esp_http_client_set_url主要是对对client->connection_info结构体的操作，将url分解到connection_info各个参数中
结构体connection_info_t

typedef struct {
    char                         *url;
    char                         *scheme;
    char                         *host;
    int                          port;
    char                         *username;
    char                         *password;
    char                         *path;
    char                         *query;
    char                         *cert_pem;
    esp_http_client_method_t     method;
    esp_http_client_auth_type_t  auth_type;
    esp_http_client_transport_t  transport_type;
    int                          max_store_header_size;
} connection_info_t;

（3）、设置请求方法

/**
  * @brief设置http请求方法
  *
  * @param [in]客户端esp_http_client句柄
  * @param [in]方法方法
  *
  * @return
  *-ESP_OK
  *-ESP_ERR_INVALID_ARG
  */
esp_err_t esp_http_client_set_method(esp_http_client_handle_t client, esp_http_client_method_t method);
请求方法：
/**
 * @brief HTTP method
 */
typedef enum {
    HTTP_METHOD_GET = 0,    /*!< HTTP GET Method */
    HTTP_METHOD_POST,       /*!< HTTP POST Method */
    HTTP_METHOD_PUT,        /*!< HTTP PUT Method */
    HTTP_METHOD_PATCH,      /*!< HTTP PATCH Method */
    HTTP_METHOD_DELETE,     /*!< HTTP DELETE Method */
    HTTP_METHOD_HEAD,       /*!< HTTP HEAD Method */
    HTTP_METHOD_NOTIFY,     /*!< HTTP NOTIFY Method */
    HTTP_METHOD_SUBSCRIBE,  /*!< HTTP SUBSCRIBE Method */
    HTTP_METHOD_UNSUBSCRIBE,/*!< HTTP UNSUBSCRIBE Method */
    HTTP_METHOD_OPTIONS,    /*!< HTTP OPTIONS Method */
    HTTP_METHOD_MAX,
} esp_http_client_method_t;

（4）、设置post数据

/**
  * @brief设置发布数据，必须在`esp_http_client_perform`之前调用此函数。
  *注意：传递给此函数的data参数是一个指针，该函数不会复制数据
  *
  * @param [in]客户端esp_http_client句柄
  * @param [in]数据发布数据指针
  * @param [in] len帖子长度
  *
  * @return
  *-ESP_OK
  *-ESP_FAIL
  */
esp_err_t esp_http_client_set_post_field(esp_http_client_handle_t client, const char *data, int len);

（5）、esp_http_perform获得请求，完成TCP发送和接收

/*
 esp_http_client_perform以阻塞或非阻塞方式执行整个请求。
默认情况下，API以阻塞方式执行请求，并在完成后返回，
*/
esp_err_t esp_http_client_perform(esp_http_client_handle_t client);
/**
  * @brief 此函数将打开连接，写入所有标头字符串并返回
  *
  * @param [in]客户端esp_http_client句柄
  * @param [in] write_len HTTP内容长度需要写入服务器
  *
  * @return
  *-ESP_OK
  *-ESP_FAIL
  */
esp_err_t esp_http_client_open(esp_http_client_handle_t client, int write_len);
/**
  * @brief 该函数需要在esp_http_client_open之后调用，它将从http流中读取，处理所有接收头
  *
  * @param [in]客户端esp_http_client句柄
  *
  * @return
  *-（0）如果流不包含内容长度标头或分块编码（由`esp_http_client_is_chunked`响应检查）
  *-（-1：ESP_FAIL）如果有任何错误
  */
int esp_http_client_fetch_headers(esp_http_client_handle_t client);

4、软件设计

（1）、在连接好wifi之后首先就是填充结构体，结构体的内容如下：

/**
 * @brief HTTP configuration
 */
typedef struct {
    const char                  *url;      /*!< HTTP URL，URL上的信息最重要，它将覆盖下面的其他字段*/
    const char                  *host;      /*!< 域名或IP作为字符串 */
    int                         port;        /*!< 用于连接的端口，默认取决于esp_http_client_transport_t（80或443）*/
    const char                  *username;   /*!< 用于Http身份验证 */
    const char                  *password;   /*!< 用于Http身份验证 */
    esp_http_client_auth_type_t auth_type;   /*!< Http身份验证类型，请参见`esp_http_client_auth_type_t` */
    const char                  *path;       /*!< HTTP路径（如果未设置），默认为`/`*/
    const char                  *query;      /*!< HTTP 查询 */
    const char                  *cert_pem;   /*!< SSL服务器认证，PEM格式为字符串（如果客户端要求验证服务器） */
    const char                  *client_cert_pem; /*!< SSL客户端认证，PEM格式为字符串（如果服务器要求验证客户端） */
    const char                  *client_key_pem;  /*!< SSL客户端密钥，PEM格式为字符串（如果服务器要求验证客户端） */
    esp_http_client_method_t    method;       /*!< HTTP方法 */
    int                         timeout_ms;   /*!< 网络超时（以毫秒为单位） */
    bool                        disable_auto_redirect; /*!< 禁用HTTP自动重定向 */
    int                         max_redirection_count;/*!< 最大重定向数，如果为零，则使用默认值*/
    http_event_handle_cb        event_handler; /*!< HTTP事件处理 */
    esp_http_client_transport_t transport_type; /*!< HTTP传输类型，请参见`esp_http_client_transport_t` */
    int                         buffer_size;    /*!< HTTP接收缓冲区大小 */
    int                         buffer_size_tx; /*!< HTTP传输缓冲区大小 */
    void                        *user_data;    /*!< HTTP user_data上下文 */
    bool                        is_async;      /*!< 设置异步模式，目前仅支持HTTPS*/
    bool                        use_global_ca_store;/*!< Use a global ca_store for all the connections in which this bool is set. */
    bool                        skip_cert_common_name_check;/*!< 跳过对服务器证书CN字段的任何验证 */
} esp_http_client_config_t;

给结构体赋值，并且注册回调函数检测状态

esp_http_client_config_t config = {
.url = “http://httpbin.org/get”,
.event_handler = _http_event_handler,
};

初始化结构体，注册tcp读写连接函数

esp_http_client_handle_t client = esp_http_client_init(&config);

esp_http_client默认就是GET方法，其他方法如下

/**
 * @brief HTTP method
 */
typedef enum {
    HTTP_METHOD_GET = 0,    /*!< HTTP GET Method */
    HTTP_METHOD_POST,       /*!< HTTP POST Method */
    HTTP_METHOD_PUT,        /*!< HTTP PUT Method */
    HTTP_METHOD_PATCH,      /*!< HTTP PATCH Method */
    HTTP_METHOD_DELETE,     /*!< HTTP DELETE Method */
    HTTP_METHOD_HEAD,       /*!< HTTP HEAD Method */
    HTTP_METHOD_NOTIFY,     /*!< HTTP NOTIFY Method */
    HTTP_METHOD_SUBSCRIBE,  /*!< HTTP SUBSCRIBE Method */
    HTTP_METHOD_UNSUBSCRIBE,/*!< HTTP UNSUBSCRIBE Method */
    HTTP_METHOD_OPTIONS,    /*!< HTTP OPTIONS Method */
    HTTP_METHOD_MAX,
} esp_http_client_method_t;

GET获取数据使用esp_http_client_perform函数
在使用其他方法或重新设置url使用函数：

esp_http_client_set_url(client, "http://httpbin.org/post");
esp_http_client_set_method(client, HTTP_METHOD_POST);

5、实例

static void vTaskHttpGet(void *pvParameters)
{
    //等待连接成功，或已经连接有断开连接，此函数会一直阻塞，只有有连接
   xEventGroupWaitBits(xCreatedEventGroup_WifiConnect,// 事件标志组句柄 
        WIFI_CONNECTED_BIT, // 等待bit0和bit1被设置 
        pdFALSE,             //TRUE退出时bit0和bit1被清除，pdFALSE退出时bit0和bit1不清除
        pdTRUE,             //设置为pdTRUE表示等待bit1和bit0都被设置,pdFALSE表示等待bit1或bit0其中一个被设置
        portMAX_DELAY);      //等待延迟时间，一直等待 
    http_url_test();
    http_hostname_path_test();

    ESP_LOGI(TAG, "Finish http Test");
    vTaskDelete(NULL);
}

在任务vTaskHttpGet中测试

static void http_url_test(void)
{
    esp_http_client_config_t config = {
        .url = "http://httpbin.org/get",
        .event_handler = _http_event_handler,
    };
    //esp_http_client_config_t的参数分配内存，初始化数据,注册tcp的读写连接回调函数
    esp_http_client_handle_t client = esp_http_client_init(&config);

    // GET，默认方法
    //发送接收数据
    esp_err_t err = esp_http_client_perform(client);
    if (err == ESP_OK) {
        ESP_LOGI(TAG, "HTTP GET Status = %d, content_length = %d",
                esp_http_client_get_status_code(client),
                esp_http_client_get_content_length(client));
    } else {
        ESP_LOGE(TAG, "HTTP GET request failed: %s", esp_err_to_name(err));
    }

    // POST
    const char *post_data = "field1=value1&field2=value2";
    esp_http_client_set_url(client, "http://httpbin.org/post");
    esp_http_client_set_method(client, HTTP_METHOD_POST);
    esp_http_client_set_post_field(client, post_data, strlen(post_data));
    err = esp_http_client_perform(client);
    if (err == ESP_OK) {
        ESP_LOGI(TAG, "HTTP POST Status = %d, content_length = %d",
                esp_http_client_get_status_code(client),
                esp_http_client_get_content_length(client));
    } else {
        ESP_LOGE(TAG, "HTTP POST request failed: %s", esp_err_to_name(err));
    }

    //PUT
    esp_http_client_set_url(client, "http://httpbin.org/put");
    esp_http_client_set_method(client, HTTP_METHOD_PUT);
    err = esp_http_client_perform(client);
    if (err == ESP_OK) {
        ESP_LOGI(TAG, "HTTP PUT Status = %d, content_length = %d",
                esp_http_client_get_status_code(client),
                esp_http_client_get_content_length(client));
    } else {
        ESP_LOGE(TAG, "HTTP PUT request failed: %s", esp_err_to_name(err));
    }

    //PATCH
    esp_http_client_set_url(client, "http://httpbin.org/patch");
    esp_http_client_set_method(client, HTTP_METHOD_PATCH);
    esp_http_client_set_post_field(client, NULL, 0);
    err = esp_http_client_perform(client);
    if (err == ESP_OK) {
        ESP_LOGI(TAG, "HTTP PATCH Status = %d, content_length = %d",
                esp_http_client_get_status_code(client),
                esp_http_client_get_content_length(client));
    } else {
        ESP_LOGE(TAG, "HTTP PATCH request failed: %s", esp_err_to_name(err));
    }

    //DELETE
    esp_http_client_set_url(client, "http://httpbin.org/delete");
    esp_http_client_set_method(client, HTTP_METHOD_DELETE);
    err = esp_http_client_perform(client);
    if (err == ESP_OK) {
        ESP_LOGI(TAG, "HTTP DELETE Status = %d, content_length = %d",
                esp_http_client_get_status_code(client),
                esp_http_client_get_content_length(client));
    } else {
        ESP_LOGE(TAG, "HTTP DELETE request failed: %s", esp_err_to_name(err));
    }

    //HEAD
    esp_http_client_set_url(client, "http://httpbin.org/get");
    esp_http_client_set_method(client, HTTP_METHOD_HEAD);
    err = esp_http_client_perform(client);
    if (err == ESP_OK) {
        ESP_LOGI(TAG, "HTTP HEAD Status = %d, content_length = %d",
                esp_http_client_get_status_code(client),
                esp_http_client_get_content_length(client));
    } else {
        ESP_LOGE(TAG, "HTTP HEAD request failed: %s", esp_err_to_name(err));
    }
    //释放内存
    esp_http_client_cleanup(client);

}

6、调试结果

在这里插入图片描述

所有文章源代码：https://download.csdn.net/download/lu330274924/88518092

物联网程序猿
关注
专栏目录
ESP32-C3入门教程 网络篇⑤——基于esp_http_client实现HTTP的POST/GET/PUT/DELETE请求服务器的第一种方法
小康师兄
10-23 1249
ESP32-C3入门教程 网络篇⑤——基于esp_http_client实现HTTP的POST/GET/PUT/DELETE请求服务器的第一种方法
【史上最全面ESP32教程】http通信
m0_62599305的博客
07-10 1983
随着物联网（IoT）的快速发展，ESP32作为一款高性能、低功耗的Wi-Fi和蓝牙双模芯片，受到了广泛的关注和应用。在物联网设备中，HTTP协议是实现设备与服务器之间通信的常用协议。本文将介绍HTTP协议的基本概念及其常见应用场景。关闭HTTPClient对象，释放资源。无。无返回值。// 处理响应http.end();// 关闭HTTP连接检查HTTPClient对象是否已连接到服务器。无。返回true表示连接成功，返回false表示未连接或连接已断开。// 执行请求操作。
ESP32 Arduino (十) HTTPClient库
DOF526570的博客
02-08 4420
很多时候我们需要ESP32去访问外网的服务器获取一些网络资源，HTTP服务器是最常见的服务器，在这个时候就需要ESP32作为HTTPClient使用，HttpClient是Apache中的一个开源的项目。它实现了HTTP标准中Client端的所有功能，使用它能够很容易地进行HTTP信息的传输。 HttpClient 是 Apache Jakarta Common 下的子项目，用来提供高效的、最新的、功能丰富的支持 HTTP 协议的客户端编程工具包，并且它支持 HTTP 协议最新的版本和建议。
ESP32基础应用之http client实验
while（1）
04-29 4244
必填
ESP32 HTTP Client接口使用
12-21 8758
前言 记录下ESP32自带的HTTP接口的使用， ESP HTTP模块提供了丰富的API支持HTTP/HTTPS的请求，模块位于esp-idf\components\esp_http_client中，其中Kconfig可修改默认使能HTTPS和身份验证，在menuconfig也可以进行配置 如有异议，请指正 HTTP简介 HTTP协议是Hyper Text Transfer Protocol超文本传输协议的缩写，基于TCP传输层协议进行通信，采用客户端-服务器模型（C/S架构），属于应用层协议 HTTP数
ESPIDF开发ESP32学习笔记【HTTP客户端实现】
qq_40500005的博客
01-24 5959
TCP协议栈 ESP使用lwIP作为嵌入式的TCP/IP协议栈支持 lwIP是一套在MCU层级上用C实现的IP协议栈，可以运行在裸机/RTOS/嵌入式Linux，乐鑫为ESP32提供了相关移植包 相关内容可以参考lwIP库函数，在LWIP和ESP-NETIF组件中得到支持 esp_err_t esp_netif_init(void); esp_err_t esp_netif_deinit(void); esp_netif_t *esp_netif_new(const esp_netif_config_t *
ESP32 的esp_http_client详解
热门推荐
面朝大海春暖花开
07-25 1万+
说明：我使用的是esp-idf-V3.1.3 ，官方给我们封装好了 HTTP，使用起来还是很方便 一、wifi连接 在main函数里面主要是做了wifi连接的初始化和HTTP任务的创建，如下是main的全部内容 void app_main() { esp_err_t ret = nvs_flash_init(); if (ret == ESP_ERR_NVS_NO_FR...
ESP32 IDF开发-ESP32 MQTT_TCP例程
07-23
在本教程中，我们将深入探讨ESP32如何使用IDF进行MQTT和TCP/IP的集成，以及如何构建一个简单的MQTT客户端应用。 首先，ESP-IDF是Espressif Systems为ESP32微控制器提供的开源开发框架。它包含了构建、编译和调试ESP...
ESP-IDF OTA机制详解（1）
phmatthaus的专栏
06-11 202
ESP-IDF OTA机制详解（1）
ESP32-C3模组在跑HTTP官方例程时遇到的问题（1）
phmatthaus的专栏
05-31 1057
ESP32-C3模组在跑HTTP官方例程时遇到的问题（1）
ESP32-IDF开发实例-网络编程-WebSocket服务器
视觉与物联智能
07-16 1143
WebSocket服务器 ESP32是一系列高度集成的、专为移动设备、可穿戴电子产品设计的物联网模块，其集成了天线开关、RF balun、功率放大器、低接收噪声放大器，滤波器、电源管理模块等，可以独立运行应用，也可以通过SPI/SDIO或I2C/UART接口为其他设备提供WiFi和蓝牙功能。
ESP32 HTTP 获取城市温度DEMO
05-07
ESP32先连接上WIFI，然后通过HTTP 访问服务器数据，通过CJSON解析数据，获取城市温度。
esp8266模块的http_client参考SDK历程
06-01
这是关于esp8266的SDK固件，esp8266作为Client，发送http连接服务器
乐鑫Esp32学习 esp32上实现本地 TCP 客户端和服务端角色，可断线重连原路返回数据。
06-27
乐鑫Esp32学习之旅⑨ esp32上实现本地 TCP 客户端和服务端角色，可断线重连原路返回数据。 CSDN博客 https://blog.csdn.net/xh870189248/article/details/80817529
ESP32，HTTP升级，简单DEMO
06-13
在ESP32下，通过HTTP本地升级。这是一个简单的DEMO。高手就不要下载了。
乐鑫Esp32学习之旅⑧ esp32上实现本地 UDP 客户端和服务端角色，在局域网内实现通讯。
06-20
乐鑫Esp32学习esp32上实现本地 UDP 客户端和服务端角色，在局域网内实现通讯。博文：https://blog.csdn.net/xh870189248/article/details/80737111
ESP32-IDF开发实例-网络编程-WebSocket 客户端
视觉与物联智能
07-11 1055
WebSocket 客户端 ESP32是一系列高度集成的、专为移动设备、可穿戴电子产品设计的物联网模块，其集成了天线开关、RF balun、功率放大器、低接收噪声放大器，滤波器、电源管理模块等，可以独立运行应用，也可以通过SPI/SDIO或I2C/UART接口为其他设备提供WiFi和蓝牙功能。 本次实例将使用ESP32-IDF的websocket客户端实现数据请求。 1、硬件准备 NodeMCU ESP32-S V3.0开发板一块 带有WiFi功能的路由器 2、软件准备 vscode ESP-IDF
ESP32学习记录 HTTP Client
xierbazi1的博客
08-25 4033
ESP32 HTTP实验 记录下学习ESP32-HTTP 的过程 1、esp_http_client的demo demo中HTTP配置的参数结构体 esp_http_client_config_t typedef struct { const char *url; //url请求接口必须配置 /*!< HTTP URL, the information on the URL is most important, it ove
ESP32学习笔记（13）——HTTP客户端
Leung的博客
05-08 4678
一、HTTP简介 HTTP（Hyper Text Transfer Protocol） 超文本传输协议，是一种建立在 TCP 上的无状态连接，整个基本的工作流程是客户端发送一个 HTTP 请求，说明客户端想要访问的资源和请求的动作，服务端收到请求之后，服务端开始处理请求，并根据请求做出相应的动作访问服务器资源，最后通过发送 HTTP 响应把结果返回给客户端。其中一个请求的开始到一个响应的结束称为事务，当一个事务结束后还会在服务端添加一条日志条目。 1.1 HTTP请求 HTTP 请求是客户端往服务端发送请
esp32 idf http
最新发布
08-23
ESP32 IDF (Espressif IoT Development Framework) 是由Espressif Systems公司开发的一套针对其ESP32系列芯片的开源软件开发框架。它主要用于构建物联网应用，包括HTTP协议的支持。在IDF中，你可以利用库函数如`esp_http_client`来进行HTTP通信： 1. **发起HTTP请求**：可以创建一个`esp_http_client_handle_t`类型的结构体实例，然后通过`esp_http_start()`发送GET、POST等请求。 ```c esp_http_client_config_t config = { .url = "http://example.com/api", }; esp_http_client_handle_t client; esp_err_t err = esp_http_client_init(&client, &config); if (err == ESP_OK) { err = esp_http_perform(client); } ``` 2. **处理响应**：HTTP请求完成后，可以使用`esp_http_get_data()`读取服务器返回的数据，并解析响应内容。 3. **错误处理**：需要检查`esp_http_status`枚举值以捕获网络请求过程中的错误。
评论 3
添加红包

请填写红包祝福语或标题

个

红包个数最小为10个

元

红包金额最低5元

当前余额3.43元 前往充值 >
需支付：10.00元
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包

打赏作者

物联网程序猿

你的鼓励将是我创作的最大动力

¥1 ¥2 ¥4 ¥6 ¥10 ¥20
扫码支付：¥1
获取中
扫码支付

您的余额不足，请更换扫码支付或充值

打赏作者

实付元
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明：

1.余额是钱包充值的虚拟货币，按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载，可以购买VIP、付费专栏及课程。

余额充值