requests.post方法中data與json參數區別

 

  Requests參數

1. 先能夠看一下requests的源碼:html

1
2
3
4
5
6
7
8
9
10
11
12
13
def post(url, data=None, json=None, **kwargs):
     r "" "Sends a POST request.
 
     :param url: URL  for  the  new  : class :`Request`  object .
     :param data: (optional) Dictionary, list of tuples, bytes, or file-like
         object  to send  in  the body of the : class :`Request`.
     :param json: (optional) json data to send  in  the body of the : class :`Request`.
     :param \*\*kwargs: Optional arguments that ``request`` takes.
     : return : : class :`Response <Response>`  object
     :rtype: requests.Response
     "" "
 
     return  request( 'post' , url, data=data, json=json, **kwargs)

 

說明:python

  從源碼中註釋看,告訴咱們post請求報文中既能夠傳data,也能夠傳json。而且data與json,既能夠是str類型,也能夠是dict類型。web

 

2. json與data參數規則:django

1、JSONjson

1.使用json參數,無論報文是str類型,仍是dict類型,若是不指定headers中content-type的類型,默認是:application/json。服務器

2、DATAapp

1.使用data參數,報文是dict類型,若是不指定headers中content-type的類型,默認application/x-www-form-urlencoded,至關於普通form表單提交的形式,會將表單內的數據轉換成鍵值對,此時數據能夠從request.POST裏面獲取,而request.body的內容則爲a=1&b=2的這種鍵值對形式。post

注意:即便指定content-type=application/json,request.body的值也是相似於a=1&b=2,因此並不能用json.loads(request.body.decode())獲得想要的值。url

2. 使用data參數,報文是str類型,若是不指定headers中content-type的類型,默認application/json。
 

綜上所述,兩種參數的使用狀況:spa

用data參數提交數據時,request.body的內容則爲a=1&b=2的這種形式,用json參數提交數據時,request.body的內容則爲'{"a": 1, "b": 2}'的這種形式

 

  實例解析

  知道了上面所講的理論,須要經過實例來驗證一下。

以我django項目開發的web接口爲例:

url.py文件

1
2
3
4
5
6
7
8
9
10
from  django.contrib import admin
from  django.urls import path,include
from  django_web.views import views
from  django.conf.urls import url
 
urlpatterns = [
     path( 'admin/' , admin.site.urls),
 
     #首頁
     path( 'index/' ,views.test_dj), #登錄頁面

view.py文件

1
2
3
4
5
6
7
8
9
def test_dj(request):
     print(request.body,111)
     print(request.headers)
  
"" "
     當post請求的請求體以data爲參數,發送過來的數據格式爲:b 'username=test&password=123'
     當post請求的請求體以json爲參數,發送過來的數據格式爲:b '{"username": "test", "password": "123"}'
"" "
return  render(request,  'index.html' )

  

exp1:

test.py

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import requests
 
headers = { 'content-type' : 'application/json' }
 
data = {
     "username" "test" ,
 
     "password" "123"
}
 
print(type(data)) #dict
r1 = requests.post(url= "http://127.0.0.1:8000/index/" ,data=data)
 
 
print(r1.text)

 

返回的報文:

1
2
b 'username=test&password=123'  111
{ 'Content-Length' '26' 'Content-Type' 'application/x-www-form-urlencoded' 'Host' '127.0.0.1:8000' 'User-Agent' 'python-requests/2.22.0' 'Accept-Encoding' 'gzip, deflate' 'Accept' '*/*' 'Connection' 'keep-alive' }

 

exp1案例:證明了第二條規則:使用data參數,報文是dict類型,不指定content-type,默認是:application/x-www-form-urlencoded,請求數據格式是:key1=value1&key2=value2鍵值對形式。

 

exp2:

test.py

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
import requests
 
headers = { 'content-type' : 'application/json' }
 
data = {
     "username" "test" ,
 
     "password" "123"
}
 
print(type(data)) #dict
r1 = requests.post(url= "http://127.0.0.1:8000/index/" ,json=data)
 
 
print(r1.text)

 

將參數data換成json請求,返回的報文:

1
2
b '{"username": "test", "password": "123"}'  111
{ 'Content-Length' '39' 'Content-Type' 'application/json' 'Host' '127.0.0.1:8000' 'User-Agent' 'python-requests/2.22.0' 'Accept-Encoding' 'gzip, deflate' 'Accept' '*/*' 'Connection' 'keep-alive' }

exp2案例:證明了第一條規則:使用json參數,報文是dict類型,若是不指定headers中content-type的類型,默認是:application/json,請求數據格式是:dict形式。

 

exp3:

test.py

1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
import requests,json
 
headers = { 'content-type' : 'application/json' }
 
data = {
     "username" "test" ,
 
     "password" "123"
}
 
print(type(data)) #dict
 
# 方法1
r1 = requests.post(url= "http://127.0.0.1:8000/index/" ,data=json.dumps(data))
# 方法2
r2 = requests.post(url= "http://127.0.0.1:8000/index/" ,json=json.dumps(data))
 
 
print(r1.text)
print(r2.request)

 

查看返回報文:

1
2
3
4
5
b '{"username": "test", "password": "123"}'  111
{ 'Content-Length' '39' 'Content-Type' 'text/plain' 'Host' '127.0.0.1:8000' 'User-Agent' 'python-requests/2.22.0' 'Accept-Encoding' 'gzip, deflate' 'Accept' '*/*' 'Connection' 'keep-alive' }
b '"{\\"username\\": \\"test\\", \\"password\\": \\"123\\"}"'  111
{ 'Content-Length' '49' 'Content-Type' 'application/json' 'Host' '127.0.0.1:8000' 'User-Agent' 'python-requests/2.22.0' 'Accept-Encoding' 'gzip, deflate' 'Accept' '*/*' 'Connection' 'keep-alive' }
[01/Mar/2020 14:02:11]  "POST /index/ HTTP/1.1"  200 1890

  

exp3案例

證明了第一條規則:使用json參數,報文是str類型,若是不指定headers中content-type的類型,默認是:application/json,請求數據格式是:dict形式。也就是test.py中的方法2.

還證明了第三條規則:使用data參數,報文是str類型,若是不指定headers中content-type的類型,默認application/json。其實方法1和方法2是等價的。報文是json字符串數據,分別以data與json兩種參數形式發送請求,獲得的請求體數據格式是同樣。

 

注意:方法1返回的數據類型是:'Content-Type': 'text/plain',表示無格式,但規則說是默認application/json,是否有衝突? 其實否則,服務器並無強制指定接收數據的格式類型,因此這種狀況下也不會報錯。

 

 

 

  總結

  總而言之,記住這句話:用data參數提交數據時,request.body的內容則爲a=1&b=2的這種形式,用json參數提交數據時,request.body的內容則爲'{"a": 1, "b": 2}'的這種形式。

相關文章
相關標籤/搜索