您现在的位置是：首页 > 技术教程 正文

ESP32系列四：搭建http的webserver的服务器

admin 阅读： 2024-03-26
后台-插件-广告管理-内容页头部广告（手机）

最近在使用ESP32搭建web服务器测试，发现esp32搭建这类开发环境还是比较方便的。具体的http协议这里就不再赘述，我们主要说一下如何使用ESP32提供的API来搭建我们的http web。

一、web服务器搭建过程

1、配置web服务器

在ESP-IDF中，Web服务器使用httpd组件实现。我们需要先创建httpd_config_t结构体，指定服务器的端口、最大并发连接数、URI匹配处理器等选项。然后，我们通过调用httpd_start函数来启动Web服务器。（使用默认的配置就可以，包括端口号都已经默认配置好了）

  1. httpd_config_t config = HTTPD_DEFAULT_CONFIG();
  2. httpd_handle_t server = NULL;
  4. // 设置服务器端口为80
  5. config.server_port = 80;
  7. // 创建HTTP服务器句柄
  8. if (httpd_start(&server, &config) != ESP_OK) {
  9. printf("Error starting server!\n");
  10. return;
  11. }

2、 注册 URI处理器
在Web服务器启动后，我们需要为不同的URI注册处理器函数。当Web服务器接收到请求时，会根据请求的URI选择相应的处理器函数进行处理。在ESP-IDF中，我们可以使用httpd_register_uri_handler函数注册URI处理器。该函数的原型如下

  1. esp_err_t httpd_register_uri_handler(httpd_handle_t hd, const httpd_uri_t *uri)

其中，hd参数为HTTP服务器句柄；uri参数为包含URI路径、HTTP方法、处理函数等信息的结构体指针。例如：

  1. static const httpd_uri_t echo = {
  2. .uri = "/",
  3. .method = HTTP_POST,
  4. .handler = echo_post_handler,
  5. .user_ctx = NULL
  6. };
  7. static esp_err_t echo_post_handler(httpd_req_t *req)
  8. {
  9. char buf[100];
  10. // char ssid[10];
  11. // char pswd[10];
  12. int ret, remaining = req->content_len;
  14. while (remaining > 0) {
  15. /* Read the data for the request */
  16. if ((ret = httpd_req_recv(req, buf,
  17. MIN(remaining, sizeof(buf)))) <= 0) {
  18. if (ret == HTTPD_SOCK_ERR_TIMEOUT) {
  19. /* Retry receiving if timeout occurred */
  20. continue;
  21. }
  22. return ESP_FAIL;
  23. }
  25. /* Send back the same data */
  26. httpd_resp_send_chunk(req, buf, ret);
  27. remaining -= ret;
  29. esp_err_t e = httpd_query_key_value(buf,"ssid",wifi_name,sizeof(wifi_name));
  30. if(e == ESP_OK) {
  31. printf("ssid = %s\r\n",wifi_name);
  32. }
  33. else {
  34. printf("error = %d\r\n",e);
  35. }
  37. e = httpd_query_key_value(buf,"password",wifi_password,sizeof(wifi_password));
  38. if(e == ESP_OK) {
  39. printf("pswd = %s\r\n",wifi_password);
  40. }
  41. else {
  42. printf("error = %d\r\n",e);
  43. }
  44. /* Log data received */
  45. ESP_LOGI(TAG, "=========== RECEIVED DATA ==========");
  46. ESP_LOGI(TAG, "%.*s", ret, buf);
  47. ESP_LOGI(TAG, "====================================");
  48. }
  50. // End response
  51. httpd_resp_send_chunk(req, NULL, 0);
  52. if(strcmp(wifi_name ,"\0")!=0 && strcmp(wifi_password,"\0")!=0)
  53. {
  54. xSemaphoreGive(ap_sem);
  55. ESP_LOGI(TAG, "set wifi name and password successfully! goto station mode");
  56. }
  57. return ESP_OK;
  58. }

html的网页如下：这个网页包含了按钮的定义，以及发送json格式的数据。

最后送json数据的时候，要用JSON.stringify方法格式化data，否则esp32解析json会报错，此处一定要注意！！！
整体html界面非常简单，没有基础的也很容易读懂，里面写了一个js函数，该函数是在点击按钮的时候触发，功能主要是读取文本框输入的数据，将数据封装为json格式，然后post发送数据，xhttp.open(“POST”, “/wifi_data”, true);中的url “/wifi_data”和esp32服务端中的定义要一致，否则是无法成功的。

  1. html>
  2. <head>
  3. <meta charset="utf-8">
  4. <title>Web server systemtitle>
  5. head>
  6. <table class="fixed" border="5">
  7. <col width="1000px" /><col width="500px" />
  8. <tr><td>
  9. <h2 style=" text-align:center;"> **** Web Server ***h2>
  12. <h3>wifi 密码配置h3>
  13. <div>
  14. <label for="name">wifi名称label>
  15. <input type="text" id="wifi" name="car_name" placeholder="ssid">
  16. <br>
  17. <label for="type">密码label>
  18. <input type="text" id="code" name="car_type" placeholder="password">
  19. <br>
  20. <button id ="send_WIFI" type="button" onclick="send_wifi()">提交button>
  21. div>
  22. td><td>
  23. <table border="10">
  24. <tr>
  25. <td>
  26. <label for="newfile">Upload a filelabel>
  27. td>
  28. <td colspan="2">
  29. <input id="newfile" type="file" onchange="setpath()" style="width:100%;">
  30. td>
  31. tr>
  32. <tr>
  33. <td>
  34. <label for="filepath">Set path on serverlabel>
  35. td>
  36. <td>
  37. <input id="filepath" type="text" style="width:100%;">
  38. td>
  39. <td>
  40. <button id="upload" type="button" onclick="upload()">Uploadbutton>
  41. td>
  42. tr>
  43. table>
  44. td>tr>
  45. table>
  46. <script>
  47. function setpath() {
  48. var default_path = document.getElementById("newfile").files[0].name;
  49. document.getElementById("filepath").value = default_path;
  50. }
  51. function upload() {
  52. var filePath = document.getElementById("filepath").value;
  53. var upload_path = "/upload/" + filePath;
  54. var fileInput = document.getElementById("newfile").files;
  56. /* Max size of an individual file. Make sure this
  57. * value is same as that set in file_server.c */
  58. var MAX_FILE_SIZE = 200*1024;
  59. var MAX_FILE_SIZE_STR = "200KB";
  61. if (fileInput.length == 0) {
  62. alert("No file selected!");
  63. } else if (filePath.length == 0) {
  64. alert("File path on server is not set!");
  65. } else if (filePath.indexOf(' ') >= 0) {
  66. alert("File path on server cannot have spaces!");
  67. } else if (filePath[filePath.length-1] == '/') {
  68. alert("File name not specified after path!");
  69. } else if (fileInput[0].size > 200*1024) {
  70. alert("File size must be less than 200KB!");
  71. } else {
  72. document.getElementById("newfile").disabled = true;
  73. document.getElementById("filepath").disabled = true;
  74. document.getElementById("upload").disabled = true;
  76. var file = fileInput[0];
  77. var xhttp = new XMLHttpRequest();
  78. xhttp.onreadystatechange = function() {
  79. if (xhttp.readyState == 4) {
  80. if (xhttp.status == 200) {
  81. document.open();
  82. document.write(xhttp.responseText);
  83. document.close();
  84. } else if (xhttp.status == 0) {
  85. alert("Server closed the connection abruptly!");
  86. location.reload()
  87. } else {
  88. alert(xhttp.status + " Error!\n" + xhttp.responseText);
  89. location.reload()
  90. }
  91. }
  92. };
  93. xhttp.open("POST", upload_path, true);
  94. xhttp.send(file);
  95. }
  96. }
  98. function send_wifi() {
  99. var input_ssid = document.getElementById("wifi").value;
  100. var input_code = document.getElementById("code").value;
  101. var xhttp = new XMLHttpRequest();
  102. xhttp.open("POST", "/wifi_data", true);
  103. xhttp.onreadystatechange = function() {
  104. if (xhttp.readyState == 4) {
  105. if (xhttp.status == 200) {
  106. console.log(xhttp.responseText);
  107. } else if (xhttp.status == 0) {
  108. alert("Server closed the connection abruptly!");
  109. location.reload()
  110. } else {
  111. alert(xhttp.status + " Error!\n" + xhttp.responseText);
  112. location.reload()
  113. }
  114. }
  115. };
  116. var data = {
  117. "wifi_name":input_ssid,
  118. "wifi_code":input_code
  119. }
  120. xhttp.send(JSON.stringify(data));
  121. }
  123. script>

  1. static esp_err_t html_default_get_handler(httpd_req_t *req)
  2. {
  3. // /* Send HTML file header */
  4. // httpd_resp_sendstr_chunk(req, "");
  6. /* Get handle to embedded file upload script */
  7. extern const unsigned char upload_script_start[] asm("_binary_upload_script_html_start");
  8. extern const unsigned char upload_script_end[] asm("_binary_upload_script_html_end");
  9. const size_t upload_script_size = (upload_script_end - upload_script_start);
  11. /* Add file upload form and script which on execution sends a POST request to /upload */
  12. httpd_resp_send_chunk(req, (const char *)upload_script_start, upload_script_size);
  14. /* Send remaining chunk of HTML file to complete it */
  15. httpd_resp_sendstr_chunk(req, "");
  17. /* Send empty chunk to signal HTTP response completion */
  18. httpd_resp_sendstr_chunk(req, NULL);
  19. return ESP_OK;
  20. }
  22. httpd_uri_t html_default = {
  23. .uri = "/", // Match all URIs of type /path/to/file
  24. .method = HTTP_GET,
  25. .handler = html_default_get_handler,
  26. .user_ctx = "html" // Pass server data as context
  27. };
  29. httpd_register_uri_handler(server, &html_default);

这里要特别注意：

1）、.uri = "/",这个表示当你打开网页的IP地址后第一个要显示的页面，也就是要放到根目录下（"/"也就是根目录）。

2）、ESP32可以直接将html的网页编译进来不需要转为数组，但在CMakeList.txt文件中需要EMBED_FILES upload_script.html这样的形式引入网页文件。这个html编译出出来的文本文件怎么使用呢。wifi.html编译出来一般名称是默认的_binary_名称_类型_start。这个指针代编译出来文件的起始地址。_binary_名称_类型_end，代表结束地址。wifi.html的引用方式如下。通过以下的方式就可以获得html这个大数组。

  1. extern const unsigned char upload_script_start[] asm("_binary_upload_script_html_start");
  2. extern const unsigned char upload_script_end[] asm("_binary_upload_script_html_end");
  3. const size_t upload_script_size = (upload_script_end - upload_script_start);
  5. /* Add file upload form and script which on execution sends a POST request to /upload */
  6. httpd_resp_send_chunk(req, (const char *)upload_script_start, upload_script_size);

3、实现URI处理函数

在注册URI处理器后，我们需要实现对应的处理器函数。URI处理器函数的原型为：

  1. typedef esp_err_t (*httpd_uri_func_t)(httpd_req_t *req);

如上面示例中的：

static esp_err_t html_default_get_handler(httpd_req_t *req)

4、处理HTTP请求
在URI处理器函数中，我们可以通过HTTP请求信息结构体指针httpd_req_t获取HTTP请求的各种参数和数据。以下是一些常用的HTTP请求处理函数：

httpd_req_get_hdr_value_str：获取HTTP请求头中指定字段的值（字符串格式）
httpd_req_get_url_query_str：获取HTTP请求URL中的查询参数（字符串格式）
httpd_query_key_value：解析HTTP请求URL中的查询参数，获取指定参数名的值（字符串格式）
httpd_req_recv：从HTTP请求接收数据
httpd_req_send：发送HTTP响应数据
httpd_resp_set_type：设置HTTP响应内容的MIME类型
httpd_resp_send_chunk：分块发送HTTP响应数据。
例如，以下是一个URI处理器函数的示例，用于处理/echo路径的POST请求：

  1. static esp_err_t echo_post_handler(httpd_req_t *req)
  2. {
  3. char buf[1024];
  4. int ret, remaining = req->content_len;
  6. // 从HTTP请求中接收数据
  7. while (remaining > 0) {
  8. ret = httpd_req_recv(req, buf, MIN(remaining, sizeof(buf)));
  9. if (ret <= 0) {
  10. if (ret == HTTPD_SOCK_ERR_TIMEOUT) {
  11. // 处理超时
  12. httpd_resp_send_408(req);
  13. }
  14. return ESP_FAIL;
  15. }
  17. // 处理接收到的数据
  18. // ...
  20. remaining -= ret;
  21. }
  23. // 发送HTTP响应
  24. httpd_resp_set_type(req, HTTPD_TYPE_TEXT);
  25. httpd_resp_send(req, "Received data: ", -1);
  26. httpd_resp_send_chunk(req, buf, req->content_len);
  27. httpd_resp_send_chunk(req, NULL, 0);
  29. return ESP_OK;
  30. }

5、 发送响应
在URI处理函数中，可以使用httpd_resp_send()函数将响应发送回客户端。该函数需要传入一个httpd_req_t结构体作为参数，该结构体表示HTTP请求和响应。

例如，在上面的hello_get_handler处理函数中，可以使用httpd_resp_send()函数将“Hello, World!”字符串作为响应发送回客户端：

  1. static esp_err_t hello_get_handler(httpd_req_t *req)
  2. {
  3. const char* resp_str = "Hello, World!";
  4. httpd_resp_send(req, resp_str, strlen(resp_str));
  5. return ESP_OK;
  6. }

二、主要使用API的说明
1. httpd_register_uri_handler
用于将HTTP请求的URI路由到处理程序。这个函数接收两个参数：httpd_handle_t类型的HTTP服务器句柄和httpd_uri_t类型的URI配置。

2. httpd_handle_t
httpd_handle_t是HTTP服务器的一个句柄，它是通过httpd_start函数创建的。而httpd_uri_t则定义了HTTP请求的URI信息，包括URI路径、HTTP请求方法和处理函数等。

3. httpd_query_key_value获取变量值
httpd_query_key_value 用于从查询字符串中获取指定键的值。查询字符串是指URL中?后面的部分，包含多个键值对，每个键值对之间使用&分隔。例如，对于以下URL：
http://192.168.1.1/path/to/handler?key1=value1&key2=value2
获取其中的：
esp_err_t httpd_query_key_value(const char *query, const char *key, char *buf, size_t buf_len);

这是一个使用示例

  1. char query_str[] = "key1=value1&key2=value2";
  2. char key[] = "key1";
  3. char value[16];
  5. if (httpd_query_key_value(query_str, key, value, sizeof(value)) == ESP_OK) {
  6. printf("value=%s\n", value);
  7. } else {
  8. printf("key not found\n");
  9. }

4. 获取get参数示例

下面定义的 handler 演示了如何从请求参数里解析 字符串param1和整型变量param2：

  1. esp_err_t index_handler(httpd_req_t *req)
  2. {
  3. char* query_str = NULL;
  4. char param1_value[10] = {0};
  5. int param2_value=0;
  7. query_str = strstr(req->uri, "?");
  8. if(query_str!=NULL){
  9. query_str ++;
  10. httpd_query_key_value(query_str, "param1", param1_value, sizeof(param1_value));
  11. char param2_str[10] = {0};
  12. httpd_query_key_value(query_str, "param2", param2_str, sizeof(param2_str));
  13. param2_value = atoi(param2_str);
  14. }
  16. char resp_str[50] = {0};
  17. snprintf(resp_str, sizeof(resp_str), "param1=%s, param2=%d", param1_value, param2_value);
  18. httpd_resp_send(req, resp_str, strlen(resp_str));
  19. return ESP_OK;
  20. }

5. 获取post参数示例

下面的示例代码中根据httpd_req_t的content_len来分配一个缓冲区，并解析请求中的POST参数：

  2. esp_err_t post_demo_handler(httpd_req_t *req)
  3. {
  4. char post_string[64];
  5. int post_int=0;
  7. if (req->content_len > 0)
  8. {
  9. // 从请求体中读取POST参数
  10. char *buf = malloc(req->content_len + 1);
  11. int ret = httpd_req_recv(req, buf, req->content_len);
  12. if (ret <= 0)
  13. {
  14. // 接收数据出错
  15. free(buf);
  16. return ESP_FAIL;
  17. }
  18. buf[req->content_len] = '\0';
  20. // 解析POST参数
  21. char *param_str;
  22. param_str = strtok(buf, "&");
  23. while (param_str != NULL)
  24. {
  25. char *value_str = strchr(param_str, '=');
  26. if (value_str != NULL)
  27. {
  28. *value_str++ = '\0';
  29. if (strcmp(param_str, "post_string") == 0)
  30. {
  31. strncpy(post_string, value_str, sizeof(post_string));
  32. }
  33. else if (strcmp(param_str, "post_int") == 0)
  34. {
  35. post_int = atoi(value_str);
  36. }
  37. }
  38. param_str = strtok(NULL, "&");
  39. }
  41. free(buf);
  42. }
  44. // 将结果打印输出
  45. printf("post_string=%s, post_int=%d\n", post_string, post_int);
  47. // 返回成功
  48. httpd_resp_send(req, NULL, 0);
  49. return ESP_OK;
  50. }
  53. httpd_uri_t post_uri = {
  54. .uri = "/post",
  55. .method = HTTP_POST,
  56. .handler = post_demo_handler,
  57. .user_ctx = NULL
  58. };

标签:
声明

1.本站遵循行业规范，任何转载的稿件都会明确标注作者和来源；2.本站的原创文章，请转载时务必注明文章作者和来源，不尊重原创的行为我们将追究责任；3.作者投稿可能会经我们编辑修改或补充。

在线投稿：投稿 站长QQ：1888636

后台-插件-广告管理-内容页尾部广告（手机）
相关文章
关注我们

扫一扫关注我们，了解最新精彩内容

搜索
排行榜
最近发表
标签列表