ESP32基础应用之HTTP 服务器

Posted while(1)

tags:

篇首语:本文由小常识网(cha138.com)小编为大家整理,主要介绍了ESP32基础应用之HTTP 服务器相关的知识,希望对你有一定的参考价值。


参考资料:

  1. esp32 http服务器编程指南

1 HTTP服务器简介

  1. HTTP服务器一般指Web服务器,是指驻留于因特网上某种类型计算机的程序,可以处理浏览器等Web客户端的请求并返回相应响应,也可以放置网站文件,让全世界浏览;可以放置数据文件,让全世界下载。目前最主流的三个Web服务器是Apache、 nginx 、IIS。
  2. Web服务器是指驻留于因特网上某种类型计算机的程序。当Web浏览器(客户端)连到服务器上并请求文件时,服务器将处理该请求并将文件反馈到该浏览器上,附带的信息会告诉浏览器如何查看该文件(即文件类型)。服务器使用HTTP(超文本传输协议)与客户机浏览器进行信息交流,这就是人们常把它们称为HTTP服务器的原因。

参考来源:百度百科 HTTP服务器

2 ApiPost测试工具

使用ApiPost作为测试工具,如图:
在这里插入图片描述
链接:

  1. ApiPost官方地址
  2. ApiPost使用说明

3 HTTP服务器实验

参考例程:Simple HTTPD Server Example

注意:ESP32开发板作为HTTP服务器;ApiPost作为客户端
实验流程大概为:

  1. httpd_start() :创建 HTTP 服务器的实例,根据具体的配置为其分配内存和资源,并返回该服务器实例的句柄。服务器使用了两个套接字,一个用来监听 HTTP 流量(TCP 类型),另一个用来处理控制信号(UDP 类型),它们在服务器的任务循环中轮流使用。通过向 httpd_start() 传递 httpd_config_t 结构体,可以在创建服务器实例时配置任务的优先级和堆栈的大小。TCP 流量被解析为 HTTP 请求,根据请求的 URI 来调用用户注册的处理程序,在处理程序中需要发送回 HTTP 响应数据包。
  2. httpd_register_uri_handler():通过传入 httpd_uri_t 结构体类型的对象来注册 URI 处理程序。该结构体包含如下成员:uri 名字,method 类型(比如 HTTPD_GET/HTTPD_POST/HTTPD_PUT 等等), esp_err_t *handler (httpd_req_t *req) 类型的函数指针,指向用户上下文数据的 user_ctx 指针。
  3. httpd_stop():根据传入的句柄停止服务器,并释放相关联的内存和资源。这是一个阻塞函数,首先给服务器任务发送停止信号,然后等待其终止。期间服务器任务会关闭所有已打开的连接,删除已注册的 URI 处理程序,并将所有会话的上下文数据重置为空。

3.1 ApiPost之GET测试

查看get注册参数以及处理函数代码(详细代码请参考例程)。

static const httpd_uri_t hello = {
    .uri       = "/hello",            //具体路径,如  http://192.168.3.173:80/hello  
    .method    = HTTP_GET,            //方法method 
    .handler   = hello_get_handler,   //处理函数
    /* Let's pass response string in user
     * context to demonstrate it's usage */
    .user_ctx  = "Hello World!i am esp32 2021.06.25"  //给客户端的响应
};
/* An HTTP GET handler */
static esp_err_t hello_get_handler(httpd_req_t *req)
{
    char*  buf;
    size_t buf_len;

    //获取请求头,并打印出来
    /* Get header value string length and allocate memory for length + 1,
     * extra byte for null termination */
    buf_len = httpd_req_get_hdr_value_len(req, "Host") + 1;
    if (buf_len > 1) {
        buf = malloc(buf_len);
        /* Copy null terminated value string into buffer */
        if (httpd_req_get_hdr_value_str(req, "Host", buf, buf_len) == ESP_OK) {
            ESP_LOGI(TAG, "Found header => Host: %s", buf);
        }
        free(buf);
    }
    buf_len = httpd_req_get_hdr_value_len(req, "Accept-Language") + 1;
    if (buf_len > 1) {
        buf = malloc(buf_len);
        if (httpd_req_get_hdr_value_str(req, "Accept-Language", buf, buf_len) == ESP_OK) {
            ESP_LOGI(TAG, "Found header => Accept-Language: %s", buf);
        }
        free(buf);
    }

    buf_len = httpd_req_get_hdr_value_len(req, "User-Agent") + 1;
    if (buf_len > 1) {
        buf = malloc(buf_len);
        if (httpd_req_get_hdr_value_str(req, "User-Agent", buf, buf_len) == ESP_OK) {
            ESP_LOGI(TAG, "Found header => User-Agent: %s", buf);
        }
        free(buf);
    }

    buf_len = httpd_req_get_hdr_value_len(req, "Connection") + 1;
    if (buf_len > 1) {
        buf = malloc(buf_len);
        if (httpd_req_get_hdr_value_str(req, "Connection", buf, buf_len) == ESP_OK) {
            ESP_LOGI(TAG, "Found header => Connection: %s", buf);
        }
        free(buf);
    }
	
    buf_len = httpd_req_get_hdr_value_len(req, "content-type") + 1;
    if (buf_len > 1) {
        buf = malloc(buf_len);
        if (httpd_req_get_hdr_value_str(req, "content-type", buf, buf_len) == ESP_OK) {
            ESP_LOGI(TAG, "Found header => content-type: %s", buf);
        }
        free(buf);
    }

    //获取query并打印出来,再分类
    /* Read URL query string length and allocate memory for length + 1,
     * extra byte for null termination */
    buf_len = httpd_req_get_url_query_len(req) + 1;
    if (buf_len > 1) {
        buf = malloc(buf_len);
        if (httpd_req_get_url_query_str(req, buf, buf_len) == ESP_OK) {
            ESP_LOGI(TAG, "Found URL query => %s", buf);
            char param[32];
            /* Get value of expected key from query string */
            if (httpd_query_key_value(buf, "query1", param, sizeof(param)) == ESP_OK) {
                ESP_LOGI(TAG, "Found URL query parameter => query1=%s", param);
            }
            if (httpd_query_key_value(buf, "query3", param, sizeof(param)) == ESP_OK) {
                ESP_LOGI(TAG, "Found URL query parameter => query3=%s", param);
            }
            if (httpd_query_key_value(buf, "query2", param, sizeof(param)) == ESP_OK) {
                ESP_LOGI(TAG, "Found URL query parameter => query2=%s", param);
            }
        }
        free(buf);
    }

    //设置响应头
    /* Set some custom headers */
    httpd_resp_set_hdr(req, "Custom-Header-11", "Custom-Value-1");
    httpd_resp_set_hdr(req, "Custom-Header-22", "Custom-Value-2");

    /* Send response with custom headers and body set as the
     * string passed in user context*/
    const char* resp_str = (const char*) req->user_ctx;
    httpd_resp_send(req, resp_str, strlen(resp_str));

    /* After sending the HTTP response the old HTTP request
     * headers are lost. Check if HTTP request headers can be read now. */
    if (httpd_req_get_hdr_value_len(req, "Host") == 0) {
        ESP_LOGI(TAG, "Request headers lost");
    }
    return ESP_OK;
}

关于HTTP报文接收请参考:这里

  1. 编译并烧录程序,打开串口,记录IP地址在这里插入图片描述
  2. 打开ApiPost,发送get的uri。在这里插入图片描述
  3. 打开ESP32开发板的串口,得到数据如下 :在这里插入图片描述
  4. 打开ApiPost查看响应数据在这里插入图片描述在这里插入图片描述在这里插入图片描述
    请求头解释如下:
    Accept-Encoding: gzip, deflate, br
    表示浏览器支持的编码是gzip、deflate、br(客户端支持的编码)
    Accept-Language: zh-CN
    浏览器支持的语言分别是简体中文和中文(当前客户端可以支持的语言)
    User-Agent:ApiPOST Runtime +https://www.apipost.cn
    用户代理,客户端是ApiPOST,如果是其他浏览器则显示其他浏览器
    更多请求头解释清参考:HTTP服务器(一)

3.2 ApiPost之POST测试


static const httpd_uri_t echo = {
    .uri       = "/echo",            //具体路径,如  http://192.168.3.173:80/echo
    .method    = HTTP_POST,          //方法method 
    .handler   = echo_post_handler,  //处理函数
    .user_ctx  = NULL
};

/* An HTTP POST handler */
static esp_err_t echo_post_handler(httpd_req_t *req)
{
    char buf[100];
    int ret, remaining = req->content_len;

    while (remaining > 0) {
        /* Read the data for the request */
        if ((ret = httpd_req_recv(req, buf,
                        MIN(remaining, sizeof(buf)))) <= 0) {
            if (ret == HTTPD_SOCK_ERR_TIMEOUT) {
                /* Retry receiving if timeout occurred */
                continue;
            }
            return ESP_FAIL;
        }

        /* Send back the same data */
        httpd_resp_send_chunk(req, buf, ret);  
        remaining -= ret;

        /* Log data received */
        ESP_LOGI(TAG, "=========== RECEIVED DATA ==========");
        ESP_LOGI(TAG, "%.*s", ret, buf);
        ESP_LOGI(TAG, "====================================");
    }

    // End response
    httpd_resp_send_chunk(req, NULL, 0);
    return ESP_OK;
}

  1. 打开ApiPost,发送POST的uri。在这里插入图片描述
  2. 打开ESP32开发板的串口,得到数据如下 :在这里插入图片描述

3.3 ApiPost值PUT测试

/* An HTTP PUT handler. This demonstrates realtime
 * registration and deregistration of URI handlers
 */
static esp_err_t ctrl_put_handler(httpd_req_t *req)
{
    char buf;
    int ret;

    if ((ret = httpd_req_recv(req, &buf, 1)) <= 0) {
        if (ret == HTTPD_SOCK_ERR_TIMEOUT) {
            httpd_resp_send_408(req);
        }
        return ESP_FAIL;
    }

    if (buf == '0') {
        /* URI handlers can be unregistered using the uri string */
        ESP_LOGI(TAG, "Unregistering /hello and /echo URIs");
        httpd_unregister_uri(req->handle, "/hello");
        httpd_unregister_uri(req->handle, "/echo");
        /* Register the custom error handler */
        httpd_register_err_handler(req->handle, HTTPD_404_NOT_FOUND, http_404_error_handler);
    }
    else {
        ESP_LOGI(TAG, "Registering /hello and /echo URIs");
        httpd_register_uri_handler(req->handle, &hello);
        httpd_register_uri_handler(req->handle, &echo);
        /* Unregister custom error handler */
        httpd_register_err_handler(req->handle, HTTPD_404_NOT_FOUND, NULL);
    }

    /* Respond with empty body */
    httpd_resp_send(req, NULL, 0);
    return ESP_OK;
}

static const httpd_uri_t ctrl = {
    .uri       = "/ctrl",
    .method    = HTTP_PUT,
    .handler   = ctrl_put_handler,
    .user_ctx  = NULL
};
  1. 打开ApiPost,发送PUT的uri,且Body部分写0在这里插入图片描述
  2. 打开ESP32开发板的串口,得到数据如下 :在这里插入图片描述
  3. 打开ApiPost,发送PUT的uri,且Body部分写除0其他数据在这里插入图片描述
  4. 打开ESP32开发板的串口,得到数据如下 :在这里插入图片描述

以上是关于ESP32基础应用之HTTP 服务器的主要内容,如果未能解决你的问题,请参考以下文章

ESP32基础应用之httpt获取网络天气并使用cJSON解析数据

ESP32基础应用之使用mqtt连接阿里云物联网平台

ESP32基础应用之websocket

ESP32入门基础之空中升级(OTA)

ESP32入门基础之空中升级(OTA)

ESP32基础应用之LVGL基础