ESP32 MicroPython教程:在Picoweb app上获取查询参数

dfrobot

简介

本文esp32 教程，主要介绍如何获取发送给Picoweb app的HTTP请求的查询参数。我们将使用上篇帖子:中开发的解析器获取MicroPython字典格式的参数值。

请注意，为使代码尽可能简单，我们假设客户端总是发送正确格式的请求参数，并不对此进行任何验证。当然，在实际应用中，必须考虑所有的错误情况，在使用之前应该检查参数是否有效以及格式是否正确等等。

测试使用的是一个集成sp - wroom -32模块的开发板：FireBeetle ESP32。代码开发是在MicroPython IDE uPyCraft上完成的。

代码

首先需要导入picoweb和network模块，它们分别是创建HTTP服务器app和将ESP32连接到WiFi网络所需要的。

[mw_shl_code=applescript,true]

import picoweb
import network[/mw_shl_code]

然后，我们将声明一个查询字符串解析函数，用于获取MicroPython字典格式的查询字符串参数。该函数相关代码已在上篇帖子：ESP32 MicroPython教程：开发一个简单的URL查询字符串解析器 中详细解释，此处不再赘述。

请注意，为简单起见，本例将直接使用解析函数代码，但是最好的做法是将这些代码封装到一个单独的模块里并在此处导入使用，以实现最清晰的代码结构。

[mw_shl_code=applescript,true]

def qs_parse(qs):
  parameters = {}
  ampersandSplit = qs.split("&")
  for element in ampersandSplit:
    equalSplit = element.split("=")
    parameters[equalSplit[0]] = equalSplit[1]
  return parameters[/mw_shl_code]

接下来，使用上一篇教程中的通用代码将ESP32连接到WiFi网络。同样地，这些代码也可以封装到一个模块中，以确保主代码更加简洁。

[mw_shl_code=applescript,true]ssid = "yourNetworkName"
password =  "YourNetworkPass"
station = network.WLAN(network.STA_IF)
station.active(True)
station.connect(ssid, password)
while station.isconnected() == False:
  pass
ip = station.ifconfig()[/mw_shl_code]

然后，创建我们的app实例并指定负责对请求进行处理的路由（route）。我们将对路由“/query“进行监听。

[mw_shl_code=applescript,true]app = picoweb.WebApp("myApp")
@app.route("/query")
def query(req, resp):
   ##route handling code
[/mw_shl_code]

路由处理函数的第一个输入参数是一个HTTPRequest类的对象，我们在声明参数时将其命名为req。那么为了获取该路由所执行请求的查询字符串，我们只需获取这个对象的qs属性即可。

但是，从这个属性中只能得到未经解析的完整查询字符串，因此需要使用先前声明的解析函数，从而以更有用的格式获取参数及数值。函数的输出是一个字典变量，字典的键就是URL查询参数名，而数值就是相应的URL查询参数值。

[mw_shl_code=applescript,true]queryString = req.qs
parameters = qs_parse(queryString)[/mw_shl_code]

我们将假设接收两个查询参数，一个叫做param1，另一个是param2。这样，我们就能根据字典的键从URL查询字符串中得到相应的数值。

为使代码尽可能简短，我们假设客户端正确地发送了这些参数，因此我们不会进行任何验证（比如确认键是否存在于字典中）。

当然， 在实际的应用中，我们理应采取这种防护措施。您可以参考这篇文章：ESP32 / ESP8266 MicroPython教程：如何使用字典 如何获取MicroPython字典中所有可用键的说明，以便对其进行验证。

为了确认一切正常，我们将只把查询字符串中的参数值发送回客户端。如上所述，我们可以从字典中轻松得到这些值。

[mw_shl_code=applescript,true]yield from picoweb.start_response(resp)
yield from resp.awrite("Parameter 1 value: " + parameters["param1"] + "\n")
yield from resp.awrite("Parameter 2 value: " + parameters["param2"])[/mw_shl_code]

最后，调用app实例的run方法，将其绑定到连接WiFi网络时所分配的IP。最终的源代码（包括该调用）如下所示。

[mw_shl_code=applescript,true]import picoweb
import network
#### Parsing function
def qs_parse(qs):
  parameters = {}
  ampersandSplit = qs.split("&")
  for element in ampersandSplit:
    equalSplit = element.split("=")
    parameters[equalSplit[0]] = equalSplit[1]
  return parameters
#### WiFi Connection
ssid = "yourNetworkName"
password =  "YourNetworkPass"
station = network.WLAN(network.STA_IF)
station.active(True)
station.connect(ssid, password)
while station.isconnected() == False:
  pass
ip = station.ifconfig()
#### Picoweb app
app = picoweb.WebApp("myApp")
@app.route("/query")
def query(req, resp):
    queryString = req.qs
    parameters = qs_parse(queryString)
    yield from picoweb.start_response(resp)
    yield from resp.awrite("Parameter 1 value: " + parameters["param1"] + "\n")
    yield from resp.awrite("Parameter 2 value: " + parameters["param2"])
app.run(debug=True, host =ip[0])[/mw_shl_code]

测试代码

只需将代码上传到ESP32并运行，即可对其进行测试。代码执行完成后，我们的Picoweb app根节点将会打印到控制台上。请将该URL复制粘贴到浏览器中，并为其补齐路由和查询参数。

在图1所示的示例中，我将param1设为数值10，param2设为字符串“abc”。在URL浏览器地址栏中回车后，您就会得到类似的输出，其中显示了所返回的正确参数值。

图1 - 指定路由的请求输出（显示所发送的查询参数值）。

注：本文作者是Nuno Santos，他是一位和蔼可亲的电子和计算机工程师，住在葡萄牙里斯本 (Lisbon)。

他写了很多有关ESP32、ESP8266的有用的教程和项目。

查看更多ESP32/ESP8266教程和项目，请点击 ： ESP32教程汇总贴

英文版教程 ： ESP32 tutorial