当前位置：首页 > article >正文

tornado获取请求参数

article 2025/1/31 10:50:28

在Tornado框架中，获取请求参数（包括查询字符串参数、表单数据、JSON数据等）可以通过RequestHandler类提供的方法来完成。以下是一些常用的方法来获取不同类型的请求参数：

1. 获取查询字符串参数

查询字符串参数是附加在URL后面的键值对，用于传递信息。例如，在URL http://example.com/page?key1=value1&key2=value2 中，key1 和 key2 是参数名，value1 和 value2 是对应的参数值。

在Tornado中，可以通过以下几种方式获取查询字符串参数：

使用get_query_argument(name, default=None, strip=True)：
- name：要获取的查询参数名。
- default：如果查询参数不存在，则返回的默认值（可选）。
- strip：是否去除参数值两边的空白字符（默认为True）。
示例代码：
```
class MyHandler(tornado.web.RequestHandler):
    def get(self):
        value1 = self.get_query_argument("key1", default="默认值")
        self.write(f"key1的值是: {value1}")
```

使用get_query_arguments(name, strip=True)：

与get_query_argument类似，但返回的是一个列表，因为URL中同一个参数名可以出现多次。

示例代码：

class MyHandler(tornado.web.RequestHandler):
    def get(self):
        values = self.get_query_arguments("key1", strip=True)
        self.write(f"key1的所有值是: {values}")

使用self.request.arguments：

这是一个字典，包含了URL中所有的查询参数。键是参数名，值是包含所有对应值的列表。

示例代码：

class MyHandler(tornado.web.RequestHandler):
    def get(self):
        all_args = self.request.arguments
        self.write(f"所有查询参数是: {all_args}")

2. 获取表单数据

表单数据通常通过POST请求发送。在Tornado中，可以通过以下几种方式获取表单数据：

使用get_body_argument(name, default=None, strip=True)：

类似于get_query_argument，但用于从POST请求的请求体中获取表单字段的值。

示例代码：

class MyFormHandler(tornado.web.RequestHandler):
    def post(self):
        value = self.get_body_argument("fieldname", default="默认值")
        self.write(f"表单字段的值是: {value}")

使用get_arguments(name, strip=True)：
- 注意，虽然get_arguments方法也存在于RequestHandler中，但它主要用于获取查询字符串参数，并且在处理表单数据时，如果表单的enctype为application/x-www-form-urlencoded（默认值），则可以使用get_body_arguments来替代（尽管get_arguments在某些情况下也可能工作，但这不是其设计初衷）。
使用get_body_arguments(name, strip=True)：
- 类似于get_query_arguments，但用于从POST请求的请求体中获取表单字段的值，并返回一个列表。
处理文件上传：
- 如果表单包含文件上传字段，并且enctype被设置为multipart/form-data，则应该使用self.request.files来获取文件数据。

3. 获取JSON数据

如果客户端以Content-Type: application/json发送POST请求，并在请求体中包含了JSON数据，则可以通过以下方式获取这些数据：

直接访问self.request.json：

Tornado会自动将JSON请求体解析为Python字典，并存储在self.request.json中。

示例代码：

class MyJsonHandler(tornado.web.RequestHandler):
    def post(self):
        data = self.request.json
        value = data.get("fieldname", "默认值")
        self.write(f"JSON字段的值是: {value}")