python接口测试之如何对request二次封装

前言

python的request库让单个接口请求变得简单，但是对于整个项目的所有接口请求，进行二次封装更能减少代码冗余，提高代码效率。

如何判断当前的网络层是否需要封装？

大部分测试人员的编程经验不如开发人员，尤其是代码初学者，对封装的重要性感悟不深，不清楚哪些代码需要做二次封装。
判断是否需要二次封装，可以先从以下几点判断（用网络层代码举例）：

1. 问问自己，写单个接口请求会感觉到麻烦吗？比如处理请求参数繁琐、定位错误原因困难、响应数据需要多次序列化才拿到想要的字段
2. 检查是否存在除了发起请求的代码，每次请求都需要写相同的代码。
3. 其它同事想调用你写好的封装方法吗？

用通俗的话说，好的网络层封装代码，是可以做到简单的调用就完成了接口请求。

以下是我第一次写网络请求的部分代码，每次拿到请求响应数据reponse,都要再转换一下才能变成字典型数据。并且报错的具体原因没有打印，实际是接口报404错误。

response = baseRequest.postRequest(url, prdid, phoneid, eight_user_type)
res_dict = json.loads(response.text)#每次请求都需要写的代码

网络层封装思路讲解

网上关于request二次封装的文章很多，由于每家公司接口的响应体和请求体结构不一样，找到完全适用于公司接口封装的代码有些难度，只能复制粘贴有用的代码，所以掌握封装的思路很有必要。
一、查看公司接口的请求体结构，找出所有接口的共同点
例如以下接口请求结构：

{
"list": [
{
"index": "",
"word": ""
},
{
"index": "",
"word": ""
}
],
"number": 0,
"baseHead": {
"type": "A",
"city": 11111111111,
"phoneid": "1212123",
"platform": "android",
"productid": 15500,
"timestamp": 0
},
}

假设整个项目的接口具有以下特征

1. baseHead对象以及对象里面的字段是所有接口都有的，是基本请求体。
2. baseHead基本请求体里，只有type、phoneid、productid是常用字段并且会影响业务，其它字段都是非必传参数并且不会用于校验任何业务
3. 接口如果需要上传其它参数，则会写在 baseHead的外层。

根据以上特征，写出基本请求体、headers

# 基本的请求体
def getRequestParam(type, phoneid, productid):
    upload_data = {
        "baseHead": {
            "type": "A",
            "city": 11111111111,
            "phoneid": "1212123",
            "platform": "android",
            "productid": 15500,
            "timestamp": 0
        }
    }
    return upload_data


def getHeaders():
    headers = {
        'content-type': 'application/json',

    }
    return headers

写好基本请求体，还要考虑可能需要上传基本请求字段以外的，一个或多个参数，字段的值可能是基本类型，也可能是数组，封装的方法要兼容不同类型。这里封装的请求方法用**kwargs代表要传的参数。

def postRequest(request_url,type, phoneid, productid,**kwargs):
    reskwargs = {}
    url = request_url
    # 获取上传的请求体
    upload_data = getRequestParam(type, phoneid, productid)
    ## 循环字典，加入请求体
    for k, v in kwargs.items():
        upload_data[k] = v
    headers = getHeaders()
    # 请求接口
    response = requests.post(url=url, json=upload_data, headers=headers)

二、当接口请求错误时，需要快速定位到具体原因，所以还需要处理请求异常的情况

 try:
        response = requests.post(url=url, json=upload_data, headers=headers)
        if response.status_code == 200:
            #服务器请求成功，在这里处理相关逻辑
           
        elif 200 < response.status_code < 600:
           #服务器请求失败，在这里处理相关逻辑
    except requests.exceptions.Timeout as e:
        Logger.error(f'Error occurred while scraping {url}, Msg: {e}', exc_info=True)
    except requests.exceptions.TooManyRedirects as e:
        Logger.error(f'Error occurred while scraping {url}, Msg: {e}', exc_info=True)
    except requests.exceptions.RequestException as e:
        Logger.error(f'Error occurred while scraping {url}, Msg: {e}', exc_info=True)

以上是根据HTTP响应码来判断是否请求成功。一般情况下，公司接口也会再做校验，比如上传的参数不对，缺少参数时，会返回错误信息和code,相关逻辑在response.status_code == 200时做相对应处理就好了。

三.分析响应体结构，请求方法返回字典型数据
假设接口响应体结构如下

{
    "stateCode":0
     "datas":{}
     "msg"：""
     
}

返回的数据需要包含这三个字段的值,比如请求成功的时候返回字典数据。

def postRequest(request_url,type, phoneid, productid,**kwargs):
    reskwargs = {}
    url = request_url
    # 获取上传的请求体
    upload_data = getRequestParam(type, phoneid, productid)
    ## 循环字典，加入请求体
    for k, v in kwargs.items():
        upload_data[k] = v
    headers = getHeaders()
    # 请求接口
    try:
        response = requests.post(url=url, json=upload_data, headers=headers)
        if response.status_code == 200:
            #服务器请求成功，在这里处理相关逻辑
            res_dict = json.loads(response.text)  # 使用loads()将json字符串的res转换成方便python处理的dict
            code = res_dict['stateCode']
            data = res_dict['datas']
            message = res_dict['msg']
            reskwargs['stateCode'] = code
            reskwargs['datas'] = data
            reskwargs['msg'] = message
            return reskwargs
        elif 200 < response.status_code < 600:
           #服务器请求失败，在这里处理相关逻辑
    except requests.exceptions.Timeout as e:
        Logger.error(f'Error occurred while scraping {url}, Msg: {e}', exc_info=True)
    except requests.exceptions.TooManyRedirects as e:
        Logger.error(f'Error occurred while scraping {url}, Msg: {e}', exc_info=True)
    except requests.exceptions.RequestException as e:
        Logger.error(f'Error occurred while scraping {url}, Msg: {e}', exc_info=True)

四、请求举例
上文已经将请求方法写好，直接调用就可以,time为额外需要传入的字段

request_url ="http:XXX"+1
type = 0
phoneid ="test"
productid = "123"
time = "1234"
reskwargs = baseRequest.postRequest(request_url,type, phoneid, productid,time = time)
print(reskwargs['stateCode'])
print(reskwargs['msg'])
print(reskwargs['datas'])

如果请求出错，可以快速定位到原因，这是请求出错的打印，可以看到是404。（将url用XXX表示）

[2022-03-18 11:38:09] [INFO] Redirect_URL: XXX
[2022-03-18 11:38:09] [ERROR] Get invalid status code:404--body:{"timestamp":1647574689464,"status":404,"error":"Not Found","path":"XXX}--url:XXX
Traceback (most recent call last):
  File "C:/Users/heqiaoyan/articeldemo/cyAPIAutomateProject/Test.py", line 34, in <module>
    res_dict = json.loads(response.text)
AttributeError: 'dict' object has no attribute 'text'

总结

写网络层封装，相当于写一个用于单个接口请求的postman，使用该方法请求就要和使用postman一样方便，只要传入必要参数，url，调用封装的方法就可以拿到响应值，出错也能根据打印信息快速定位问题。
实战是检验封装好坏的唯一标准，封装好的方法，自己不想调用、同事也嫌弃，就有待再次改善。

唠唠嗑

对于代码初学者，如果看完很多封装方面的文章，还是无从下手，可以先把封装代码这事放一放。能够有勇气走入代码的世界，已经很棒。只要能达到你的目的，多写几行代码又何妨，总比抓着封装不放，从而实现不了需求要好。后面随着编程能力的提高，封装自然而然就学会了。