Python Tornado URL 查询参数

在本文中，我们将介绍如何在 Python Tornado 中处理 URL 的查询参数。查询参数是 URL 中的一部分，用于向服务器传递额外的信息。通过解析和处理查询参数，我们可以根据用户的需求对数据进行过滤、排序或其他操作。

1. Tornado 中的查询参数

在 Tornado 中，我们可以通过 RequestHandler 类的 get_query_arguments 方法来获取查询参数。这个方法返回一个字典，其中键是查询参数的名称，值是一个列表，包含该参数所有的取值。

下面是一个示例：

import tornado.web

class MainHandler(tornado.web.RequestHandler):
    def get(self):
        # 获取名为 "name" 的查询参数
        names = self.get_query_arguments("name")
        self.write("Names: {}".format(names))

假设我们有以下的 URL：http://example.com/?name=Alice&name=Bob。当我们访问这个 URL 时，get_query_arguments("name") 将返回一个列表 ["Alice", "Bob"]。在这个例子中，查询参数 "name" 的取值为多个，并且可以重复出现。

如果我们想获取单个值而不是列表，可以使用 get_query_argument 方法，如下例所示：

import tornado.web

class MainHandler(tornado.web.RequestHandler):
    def get(self):
        # 获取名为 "name" 的查询参数的第一个值
        name = self.get_query_argument("name")
        self.write("Name: {}".format(name))

在上述例子中，get_query_argument("name") 将返回值 "Alice"，即查询参数 "name" 的第一个取值。

2. 处理查询参数的常见需求

2.1 过滤数据

我们经常需要根据查询参数来过滤数据。例如，假设我们有一个用户列表，并且想根据用户的角色来进行过滤。我们可以使用以下代码：

import tornado.web

class UserHandler(tornado.web.RequestHandler):
    def get(self):
        role = self.get_query_argument("role", default=None)
        if role:
            # 根据角色过滤用户数据
            filtered_users = [user for user in users if user["role"] == role]
            self.write("Filtered Users: {}".format(filtered_users))
        else:
            self.write("Users: {}".format(users))

这样，如果我们访问 http://example.com/users?role=admin，将只返回角色为 “admin” 的用户数据，否则将返回所有用户数据。

2.2 排序数据

另一个常见的需求是根据查询参数对数据进行排序。例如，假设我们有一个商品列表，并且想根据价格对商品进行排序。我们可以使用以下代码：

import tornado.web

class ProductHandler(tornado.web.RequestHandler):
    def get(self):
        sort_by = self.get_query_argument("sort_by", default=None)
        if sort_by:
            # 根据价格排序商品数据
            sorted_products = sorted(products, key=lambda p: p["price"])
            self.write("Sorted Products: {}".format(sorted_products))
        else:
            self.write("Products: {}".format(products))

这样，如果我们访问 http://example.com/products?sort_by=price，将按照价格升序返回商品数据，否则将返回原始数据。

3. URL 编码与解码

有时候，查询参数中包含特殊字符或中文等需要进行 URL 编码的内容。Tornado 提供了 tornado.escape 模块，可以方便地进行 URL 编码和解码操作。

下面是一个示例：

import tornado.escape

username = "张三"
encoded_username = tornado.escape.url_escape(username)
print(encoded_username)  # 输出：%E5%BC%A0%E4%B8%89

decoded_username = tornado.escape.url_unescape(encoded_username)
print(decoded_username)  # 输出：张三

在上述例子中，url_escape 方法对字符串进行 URL 编码，url_unescape 方法对编码后的字符串进行解码。

总结

本文介绍了在 Python Tornado 中处理 URL 的查询参数的方法。通过 get_query_arguments 和 get_query_argument 方法，我们可以方便地获取查询参数的值。我们还学习了如何根据查询参数进行数据过滤和排序，并且了解了 URL 编码和解码的方法。希望本文对你在 Python Tornado 开发中处理查询参数有所帮助。