使用flask如何獲取post請求引數

2022-08-06 14:00:59

前言

今天我們繼續來說一下，使用flask web application, 如何獲取post 請求引數的。

概述

對於post請求有幾種方式。 Content-Type 實體頭部用於指示資源的MIME型別 media type 。

content-type是http請求頭的欄位。作為請求頭時（post或者put），使用者端告訴伺服器實際傳送的資料型別。

對於不同的content-type 傳送的資料不太一樣，對於伺服器端，需要如何獲取資料，以及正確解析的方法也是不一樣的。

下面列出常用的幾種 Content-Type

application/json
application/x-www-form-urlencoded
multipart/form-data
text/plain
text/xml
text/html

1. application/json

Content-Type 以這種方式的api ,目前來說還是比較多的，現在主流前後端互動的api,使用application/json 這種方式傳輸資料非常常見。主要得意於json 的發展，以及前後端完善的庫支援，使得這種方式比較常見。

這裡以login 登入介面為例

http 請求報文格式如下：

POST /login HTTP/1.1
Host: 127.0.0.1:5000
Content-Type: application/json
Content-Length: 59

{
    "username":"frank",
    "password":"jsdofjdsofjsdo"
}

使用curl

curl --location --request POST 'http://127.0.0.1:5000/login' 
--header 'Content-Type: application/json' 
--data-raw '{
    "username":"frank",
    "password":"jsdofjdsofjsdo"
}'

postman 請求

flask如何獲取請求體呢

對於這種請求方式，flask 如何獲取請求的body 的內容呢？

# main.py
from flask import Flask
from flask import request
from flask import jsonify
# pip install pysimple-log
from simplelog import logger

app = Flask(__name__)

@app.route('/login', methods=[ 'POST'])
def login():
    if request.method == 'POST':
        # 這樣獲取就可以了 
        json_data = request.json
        logger.info(f"json_data:{json_data}")
        return jsonify(json_data)

if __name__ == '__main__':
    app.run(host='0.0.0.0', port=5000, debug=True)

我們直接可以通過， flask 提供的request物件獲取引數。 request.json 通過這個屬性就可以獲取到 request body 的內容了。是不是很方便呢。

2. application/x-www-form-urlencoded

這種方式是瀏覽器原生form表單預設的提交方式

http 請求報文格式

POST /login HTTP/1.1
Host: 127.0.0.1:5000
Content-Type: application/x-www-form-urlencoded
Content-Length: 38

username=frank&password=jsdofjdsofjsdo

使用curl 請求

curl --location --request POST 'http://127.0.0.1:5000/login' 
--header 'Content-Type: application/x-www-form-urlencoded' 
--data-urlencode 'username=frank' 
--data-urlencode 'password=jsdofjdsofjsdo'

flask如何獲取請求體呢

對於這中content-type 我們可以使用 request.form 返回一個不可變的字典型別。然後就可以獲取 request body 啦。

# 省略 ...
@app.route('/login', methods=[ 'POST'])
def login():
    if request.method == 'POST':
        json_data = request.form
        logger.info(f"json_data:{json_data}")
        return jsonify(json_data)

3. multipart/form-data

這又是一個常見的 POST 資料提交的方式。我們使用表單上傳檔案時，必須讓 form 表單的enctype 等於 multipart/form-data。直接來看一個請求範例：

這裡我只是演示一下，對應 http報文

http 請求報文

POST /login HTTP/1.1
Host: 127.0.0.1:5000
Content-Type: multipart/form-data; boundary=----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Length: 239

----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="username"

frank
----WebKitFormBoundary7MA4YWxkTrZu0gW
Content-Disposition: form-data; name="password"

111111sfsfsafsafas==
----WebKitFormBoundary7MA4YWxkTrZu0gW

使用curl 請求

curl --location --request POST 'http://127.0.0.1:5000/login' 
--form 'username="frank"' 
--form 'password="111111sfsfsafsafas=="'

postman 請求

flask如何獲取請求體呢

對於這種方式還是可以通過 request.from 來獲取引數

# ... 省略
@app.route('/login', methods=[ 'POST'])
def login():
    if request.method == 'POST':
        json_data = request.form
        logger.info(f"json_data:{json_data}")
        return jsonify(json_data)

4. text/plain

用純文字傳送資料

http 請求報文如下

POST /login HTTP/1.1
Host: 127.0.0.1:5000
Content-Type: text/plain
Content-Length: 59

{
    "username":"frank",
    "password":"jsdofjdsofjsdo"
}

使用curl 請求

curl --location --request POST 'http://127.0.0.1:5000/login' 
--header 'Content-Type: text/plain' 
--data-raw '{
    "username":"frank",
    "password":"jsdofjdsofjsdo"
}'

postman 請求

flask如何獲取請求體呢

flask 如何正常接收資料呢？原生的請求資料會放在 request.data 裡面，型別是bytes，需要轉成字串，然後通過json 模組轉成字典。

import json
from flask import Flask
from flask import request
from flask import jsonify
# pip install pysimple-log
from simplelog import logger

app = Flask(__name__)

@app.route('/login', methods=['POST'])
def login():
    if request.method == 'POST':
        # bytes 型別
        raw_data = request.data
        logger.info(f'raw_data:{raw_data}')
        json_data = json.loads(raw_data.decode())
        logger.info(f"json_data:{json_data}，type:{type(json_data)}")
        return jsonify(json_data)

結果如下：