pyhton Sanic框架的文件上傳功能開發(fā)實戰(zhàn)示例教程

更新時間：2024年08月26日 10:58:52 作者：景天科技苑

Sanic是一個Python 3.5+的異步Web框架,它的設計理念與Flask相似,但采用了更高效的異步I/O處理,在處理文件上傳時,Sanic同樣提供了方便、高效的方法,本教程將結合實際案例,詳細介紹如何在Sanic框架中實現(xiàn)文件上傳的功能,感興趣的朋友跟隨小編一起看看吧

Sanic框架的文件上傳

Sanic是一個Python 3.5+的異步Web框架，它的設計理念與Flask相似，但采用了更高效的異步I/O處理。在處理文件上傳時，Sanic同樣提供了方便、高效的方法。本教程將結合實際案例，詳細介紹如何在Sanic框架中實現(xiàn)文件上傳的功能。

環(huán)境準備

在開始之前，請確保你已經安裝了Python 3.5或更高版本，并安裝了Sanic框架。如果沒有安裝Sanic，可以通過pip命令進行安裝：

pip install sanic

基本概念

在Sanic中，文件上傳通常是通過request.files屬性來實現(xiàn)的。當客戶端以multipart/form-data的方式發(fā)送POST請求時，可以通過request.files.get('filename')來獲取指定的文件對象。

文件上傳示例

1. 創(chuàng)建Sanic應用

首先，我們需要創(chuàng)建一個Sanic應用實例，并定義一個用于文件上傳的路由。
首先創(chuàng)建個文件上傳的目錄

代碼展示：

from sanic import Sanic
from sanic.response import json
app = Sanic("File-Upload-Example")
@app.route("/upload", methods=["POST"])
async def handle_upload(request):
    # 獲取上傳的文件，根據(jù)請求體中file字段獲取上傳的文件
    #先打印file對象
    print("files對象",request.files)
    file = request.files.get('file')
    # print("獲取的文件對象名",file.name)
    print("查看file有哪些方法",dir(file))
    if file:
        # 對文件進行處理，這里簡單地將文件保存到本地
        file_path = './uploads/' + file.name
        with open(file_path, 'wb') as f:
            #上傳的文件在file的body中
            f.write(file.body)
        return json({"message": "File uploaded successfully", "filename": file.name})
    else:
        return json({"error": "No file uploaded"}, status=400)
if __name__ == "__main__":
    app.run(host="0.0.0.0", port=8000)

2. 客戶端上傳文件

為了測試文件上傳功能，我們需要一個客戶端來發(fā)送文件?？梢允褂肞ostman這樣的工具，或者使用Python的requests庫來發(fā)送請求。

使用Postman 打開Postman，創(chuàng)建一個新的POST請求。
在請求URL中輸入http://localhost:8000/upload。
設置Headers中的Content-Type為multipart/form-data。
在Body中選擇form-data，然后點擊Add file選擇你要上傳的文件。
然后在Value處點擊Search Files選擇需要上傳的文件。
發(fā)送請求，并查看響應。

在body處選擇 form-data類型請求，創(chuàng)建個key為file的鍵值對。

點擊Search Files選擇需要上傳的文件

選擇文件

點擊發(fā)送請求

上傳成功

使用Python requests庫

我們現(xiàn)在桌面創(chuàng)建個txt文檔

import requests
url = 'http://localhost:8000/upload'
files = {'file': open(r'C:\Users\dell\Desktop\text.txt', 'rb')}
response = requests.post(url, files=files)
print(response.text)

上傳成功

文件上傳的進階用法

3. 驗證上傳文件的類型

為了防止用戶上傳不安全的文件類型（如可執(zhí)行文件、腳本文件等），你需要在服務器端驗證上傳文件的MIME類型或文件擴展名。

from sanic import HTTPResponse, request, json
@app.route("/upload", methods=["POST"])
async def handle_upload(request):
    file = request.files.get("file")
    if not file:
        return json({"error": "沒有文件被上傳"}, status=400)
    # 檢查文件類型
    allowed_types = {"image/jpeg", "image/png", "application/pdf"}
    if file.type not in allowed_types:
        return json({"error": "不允許的文件類型"}, status=400)
    # 保存文件（這里省略了具體的保存邏輯）
    return json({"message": "文件上傳成功"})

在這個例子中，我們檢查了上傳文件的type屬性，它通常包含了文件的MIME類型。我們定義了一個allowed_types集合，包含了允許上傳的文件類型。如果上傳的文件類型不在這個集合中，我們就返回一個錯誤響應。

4. 安全性考慮

防止目錄遍歷：確保在保存上傳文件時，不要直接使用用戶輸入的文件名或路徑，以防止目錄遍歷攻擊。可以使用哈希函數(shù)或UUID來生成唯一的文件名。
限制上傳目錄的權限：確保上傳目錄的權限設置得當，以防止未授權訪問或執(zhí)行上傳的文件。
使用HTTPS：在生產環(huán)境中，始終使用HTTPS來保護用戶數(shù)據(jù)和文件傳輸?shù)陌踩浴?/li>

5. 進度反饋

對于大文件上傳，用戶可能會希望看到上傳進度。然而，Sanic本身并不直接支持上傳進度的跟蹤。但是，你可以通過前端JavaScript（如使用XMLHttpRequest或Fetch API的upload事件）來跟蹤上傳進度，并通過WebSocket、Server-Sent Events (SSE) 或輪詢等方式將進度信息發(fā)送到服務器，然后服務器可以將這些信息廣播給需要它們的客戶端。