【python】Python中小巧的异步web框架Sanic快速上手实战

在这里插入图片描述

✨✨ 欢迎大家来到景天科技苑✨✨

🎈🎈 养成好习惯，先赞后看哦~🎈🎈

🏆 作者简介：景天科技苑
🏆《头衔》：大厂架构师，华为云开发者社区专家博主，阿里云开发者社区专家博主，CSDN全栈领域优质创作者，掘金优秀博主，51CTO博客专家等。
🏆《博客》：Python全栈，PyQt5和Tkinter桌面开发，小程序开发，人工智能，js逆向，App逆向，网络系统安全，数据分析，Django，fastapi，flask等框架，云原生K8S，linux，shell脚本等实操经验，网站搭建，数据库等分享。

所属的专栏：python综合应用，基础语法到高阶实战教学
景天的主页：景天科技苑

在这里插入图片描述

文章目录

Sanic框架
- 安装Sanic
- 创建Sanic应用程序
- - 第一步：导入Sanic模块
  - 第二步：创建Sanic应用实例
  - 第三步：定义路由和处理函数
  - 第四步：启动Sanic应用程序
- 路由和请求处理
- - 基本路由
  - - 示例：处理GET和POST请求
  - 路由参数
  - - 路径参数（Path Parameters）
    - 请求参数（Query Parameters）
  - 请求对象
  - - 示例：访问请求信息
  - 响应对象
  - - 示例：使用HTTPResponse

Sanic框架

Sanic是一个基于Python 3.5+的异步Web框架，它充分利用了Python的异步IO特性（asyncio），从而在处理大量并发请求时表现出色。相比于传统的同步Web框架（如Flask），Sanic能够显著提高应用程序的响应速度和吞吐量。本文将通过实际案例，详细介绍如何在Python中使用Sanic框架来构建Web应用程序。

安装Sanic

在开始之前，首先需要安装Sanic。建议使用Python的虚拟环境来管理项目依赖，以避免不同项目间的依赖冲突。以下是如何创建虚拟环境并安装Sanic的步骤：

创建虚拟环境：
```
python3 -m venv sanic_env
```
激活虚拟环境（以Unix-like系统为例）：
```
source sanic_env/bin/activate
```
在Windows系统中，使用以下命令激活虚拟环境：
```
sanic_env\Scripts\activate
```

安装Sanic 和 Sanic_cors：

pip install sanic
pip install sanic_cors

创建Sanic应用程序

第一步：导入Sanic模块

首先，需要导入Sanic模块。创建一个新的Python文件，例如app.py，并导入Sanic。

from sanic import Sanic

第二步：创建Sanic应用实例

接着，创建一个Sanic应用实例。这个实例将作为Web应用程序的主体。

app = Sanic(__name__)

注意，创建Sanic应用实例的时候，里面的参数只能是字母数字下划线_，中划线-组成，不能有空格，否则报错。
在这里插入图片描述

第三步：定义路由和处理函数

在Sanic中，路由用于定义URL与处理函数之间的映射关系。使用@app.route()装饰器来定义路由，并通过异步函数来处理请求。

from sanic.response import text

@app.route('/')
async def index(request):
    return text('Hello, Sanic!')

在上述代码中，@app.route('/')装饰器定义了一个处理根路径(/)的路由，index函数是处理该路由的异步函数。使用text函数返回纯文本响应。

第四步：启动Sanic应用程序

最后，通过调用app.run()方法启动Sanic应用程序。可以指定监听的主机地址和端口号。

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=8000)

至此，一个简单的Sanic Web应用程序就创建完成了。运行app.py文件，然后在浏览器中访问http://localhost:8000，将看到页面上显示“Hello, Sanic!”。
在这里插入图片描述

路由和请求处理

基本路由

Sanic支持通过@app.route()装饰器定义基本路由。路由可以处理不同类型的HTTP请求（如GET、POST等），并且可以通过在装饰器中指定methods参数来明确处理哪些HTTP方法，如果支持多种请求方式，用列表或者元祖方式传参。

示例：处理GET和POST请求

from sanic import Sanic
from sanic.response import text, json

app = Sanic('Example_App')

@app.route('/get', methods=['GET'])
async def handle_get(request):
    return text('GET request')

@app.route('/post', methods=['POST'])
async def handle_post(request):
    return json({"message": "POST request", "data": request.json})

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=8000)

get请求
在这里插入图片描述

post请求
在这里插入图片描述

路由参数

在Sanic中，你可以很容易地定义带有参数的路由。这些参数可以是URL的一部分，并且可以通过请求对象（request）访问。Sanic提供了两种主要的带参数路由类型：路径参数（Path Parameters）和请求参数（Query Parameters）。

路径参数（Path Parameters）

路径参数是URL路径的一部分，被尖括号（< >）包围。在路由处理函数中，你可以通过位置参数或关键字参数（如果指定了参数名）来访问这些参数。

from sanic import Sanic
from sanic import response

app = Sanic("My-App")

# 使用位置参数
@app.route("/user/<user_id>")
async def handle_user_id(request, user_id):
    return response.json({"user_id": user_id})

# 使用关键字参数（推荐做法，因为它更清晰）
@app.route("/user/<user_id:int>")
async def handle_user_id_with_type(request, user_id: int):
    # 这里你可以假定user_id是一个整数，因为我们在路由中指定了它
    return response.json({"user_id": user_id})

# 你可以指定参数的类型，Sanic会尝试将参数转换为指定的类型
# 如果没有指定类型，Sanic将参数视为字符串

if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000)

获取路径参数
在这里插入图片描述

请求参数（Query Parameters）

请求参数是附加在URL的?之后的部分，并以key=value的形式出现，多个参数之间用&分隔。这些参数不是路由定义的一部分，而是在请求时由客户端提供的。你可以在路由处理函数中通过请求对象（request）的args属性访问它们。

from sanic import Sanic
from sanic import response

app = Sanic("My-App")

@app.route("/search")
async def handle_search(request):
    # 访问请求参数
    search_query = request.args.get('query', '')
    return response.json({"query": search_query})

if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000)

在这里插入图片描述

在这个例子中，/search路由不直接包含任何路径参数，但是它可以处理像/search?query=something这样的请求，其中query是一个请求参数。通过request.args.get('query', '')，我们尝试获取名为query的请求参数的值，如果它不存在，则返回空字符串作为默认值。

Sanic的路由系统非常灵活，允许你轻松地定义和使用带参数的路由，无论是路径参数还是请求参数。

请求对象

在Sanic中，每个请求都封装在一个Request对象中，该对象提供了许多有用的方法和属性，以便你能够访问请求的各种信息，如URL参数、查询字符串、请求头、请求体等。

示例：访问请求信息

from sanic import Sanic, request
from sanic.response import json

app = Sanic('Request Example')

@app.route('/info')
async def handle_info(request):
    # 访问URL参数
    url_param = request.args.get('param', 'Not Found')
    
    # 访问查询字符串
    query_string = request.query_string
    
    # 访问请求头
    user_agent = request.headers.get('User-Agent', 'Unknown')
    
    # 访问请求体（假设是JSON）
    try:
        request_body = request.json
    except Exception:
        request_body = "Invalid JSON"
    
    return json({
        "url_param": url_param,
        "query_string": query_string,
        "user_agent": user_agent,
        "request_body": request_body
    })

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=8000)

在这个例子中，我们创建了一个/info路由，它演示了如何访问URL参数、查询字符串、请求头和请求体。注意，当尝试访问请求体作为JSON时，如果请求体不是有效的JSON，则会捕获异常并返回一个默认值。

响应对象

Sanic的响应对象（通常是通过函数返回值隐式创建的）提供了多种方法来构建HTTP响应。除了之前提到的text和json之外，还有HTTPResponse、file、stream等多种响应类型。

示例：使用HTTPResponse

from sanic import Sanic, HTTPResponse

app = Sanic('HTTPResponse-Example')

@app.route('/custom')
async def handle_custom(request):
    return HTTPResponse("Custom Response", 200, headers={"Custom-Header": "jingtian"})

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=8000)