pythonrequests模块post参数data和json的区别

Posted 2022-02-05 sysu_lluozh

requests.post主要参数是data与json，接下来看看这两者使用的主要区别

一、源码

看一下requests.post的源码：

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)

从源码中注释可以得知，post请求报文中既可以传data，也可以传json。并且data与json既可以是str类型，也可以是dict类型

二、参数规则

看看json与data的参数规则

2.1 json参数

• 使用json参数，报文是dict类型
  如果不指定content-type时，默认为application/json
• 使用json参数，报文是str类型
  如果不指定content-type时，默认为application/json

2.2 data参数

• 使用data参数，报文是dict类型
  如果不指定headers中content-type的类型，默认application/x-www-form-urlencoded
  相当于普通form表单提交的形式，将表单内的数据转换成键值对，此时数据可以从request.post里面获取，而request.body的内容则为a=1&b=2的这种键值对形式

  注意：
  即使指定content-type=application/json，request.body的值也是类似于a=1&b=2，所以并不能用json.loads(request.body.decode())得到想要的值

• 使用data参数，报文是str类型
  如果不指定headers中content-type的类型，默认application/json

综上所述，两种参数的使用情况：

1. 用data参数提交数据时，request.body的内容则为a=1&b=2的这种形式
2. 用json参数提交数据时，request.body的内容则为’“a”: 1, “b”: 2'的这种形式

三、实例解析

以django项目开发的web接口为例
url.py文件

from django.contrib import admin
from django.urls import path
import view

urlpatterns = [
    path('admin/', admin.site.urls),
    # 首页
    path('index/',view.test_dj),  # 登陆页面
]

view.py文件

from django.shortcuts import render

def test_dj(request):
    print(request.body)
    print(request.headers)
    """
    当post请求的请求体以data为参数，发送过来的数据格式为：b'username=test&password=123'
    当post请求的请求体以json为参数，发送过来的数据格式为：b'"username": "test", "password": "123"'
    """
    return render(request, 'index.html')

完整代码查看demo项目

3.1 示例1

test.py

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)

返回的报文：

b'username=test&password=123'


	'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'

即说明：使用data参数，报文是dict类型，不指定content-type，默认是：application/x-www-form-urlencoded，请求数据格式是：key1=value1&key2=value2键值对形式

3.2 示例2

test.py

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请求，返回的报文：

b'"username": "test", "password": "123"'


	'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'

即说明：使用json参数，报文是dict类型，如果不指定headers中content-type的类型，默认是：application/json，请求数据格式是：dict形式

3.3 示例3

test.py

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)

查看返回报文：

b'"username": "test", "password": "123"'

	'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\\\\""'

	'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'

即说明：使用json参数，报文是str类型，如果不指定headers中content-type的类型，默认是：application/json，请求数据格式是：dict形式

同时说明：使用data参数，报文是str类型，如果不指定headers中content-type的类型，默认application/json
报文是json字符串数据，分别以data与json两种参数形式发送请求，得到的请求体数据格式是一样

总结如下：

• 用data参数提交数据时，request.body的内容则为a=1&b=2的这种形式
• 用json参数提交数据时，request.body的内容则为’“a”: 1, “b”: 2'的这种形式