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

Posted on by

前言

今天 我們繼續來說一下， 使用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)

結果如下：

可以看出可以正常解析數據瞭，並且以json 的形式返回瞭。

總結

本文主要說明瞭使用flask 框架，如果獲取常見的post請求body 數據，今天的分享就到這裡瞭。

到此這篇關於使用flask如何獲取post請求參數的文章就介紹到這瞭,更多相關flask獲取post請求參數內容請搜索WalkonNet以前的文章或繼續瀏覽下面的相關文章希望大傢以後多多支持WalkonNet！

參考文檔

accessing-request-data

POST 方法的content-type類型

content-type mdn

推薦閱讀：