com.auxiliary.http

Class EasyResponse

java.lang.Object

com.auxiliary.http.EasyResponse

public class EasyResponse
extends Object

文件名：EasyResponse.java

用途： 对接口响应参数进行处理，可根据不同的返回，对响应结果进行输出，或以格式化的形式输出响应内容

编码时间：2020年6月26日下午7:09:07

修改时间：2020年6月26日下午7:09:07

Since:

autest 3.3.0

Version:

Ver1.0

Author:

彭宇琦

Constructor Summary

Constructors

Modifier	Constructor and Description
protected	EasyResponse(okhttp3.Response response, InterfaceInfo interInfo) 构造对象，指定OKHttp响应类

Method Summary

Modifier and Type	Method and Description
boolean	assertResponse(String assertRegex, SearchType searchType, String paramName) 该方法用于对接口响应报文的指定部分内容进行断言
boolean	assertResponse(String assertRegex, SearchType searchType, String paramName, String xpath) 该方法用于对接口响应报文的指定部分内容进行断言
boolean	assertResponse(String assertRegex, SearchType searchType, String leftBoundary, String rightBoundary, int index) 该方法用于对接口响应报文的指定部分内容进行断言
boolean	assertResponse(String assertRegex, SearchType searchType, String paramName, String xpath, String leftBoundary, String rightBoundary, int index) 该方法用于对接口响应报文的指定部分内容进行断言
boolean	assertResponse(String assertRegex, String paramName) 该方法用于对接口响应报文的指定部分内容进行断言
String	extractKey(SearchType searchType, String paramName) 该方法用于通过指定的搜索参数对接口响应报文指定内容进行提取，返回提取到的内容
String	extractKey(SearchType searchType, String paramName, String xpath) 该方法用于通过指定的搜索参数对接口响应报文指定内容进行提取，返回提取到的内容
String	extractKey(SearchType searchType, String leftBoundary, String rightBoundary, int index) 该方法用于通过指定的边界条件对接口响应报文指定内容进行提取，返回提取到的内容
String	extractKey(SearchType searchType, String paramName, String xpath, String leftBoundary, String rightBoundary, int index) 该方法用于通过指定的条件对接口响应报文指定内容进行提取，返回提取到的内容
String	extractKey(String paramName) 该方法用于通过指定的搜索参数对响应体进行提取，返回提取到的内容
String	getMessage() 该方法用于返回接口响应消息
long	getReceivedResponseAtMillis() 该方法用于返回客户端接收到服务端返回的请求头时的时间戳
InterfaceInfo	getRequestInterfaceInfo() 该方法用于返回接口的实际请求信息
byte[]	getResponseBody() 该方法用于返回响应体
String	getResponseBodyText() 该方法用于以setCharsetName(String)方法设定的编码格式，返回接口的响应体字符串
Map<String,String>	getResponseHeaderMap() 该方法用于返回接口返回的响应头
long	getResponseTimeDifferenceAtMillis() 该方法用于对客户端发送请求的时间戳与客户端接收到返回的时间戳做差，返回其差值，即接口从请求到响应的时间，单位为毫秒
long	getSentRequestAtMillis() 该方法用于返回服务端收到客户端发出请求时的时间戳
int	getStatus() 该方法用于返回接口响应状态码
void	setCharsetName(String charsetName) 该方法用于设置字符集名称
void	setMessageType(int status, Set<MessageType> messageSet) 该方法用于添加响应体的内容格式

Methods inherited from class java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

Constructor Detail

EasyResponse

protected EasyResponse(okhttp3.Response response,
                       InterfaceInfo interInfo)

构造对象，指定OKHttp响应类

Parameters:

response - OKHttp响应类

interInfo -

Method Detail

setCharsetName

public void setCharsetName(String charsetName)

该方法用于设置字符集名称

Parameters:

charsetName - 字符集名称

Since:

autest 3.3.0

setMessageType

public void setMessageType(int status,
                           Set<MessageType> messageSet)

该方法用于添加响应体的内容格式

Parameters:

status - 状态

messageSet - 内容格式集合

Since:

autest 3.3.0

getResponseBodyText

public String getResponseBodyText()

该方法用于以setCharsetName(String)方法设定的编码格式，返回接口的响应体字符串

Since:

autest 3.3.0

getResponseBody

public byte[] getResponseBody()

该方法用于返回响应体

Returns:

响应体

Since:

autest 3.3.0

getResponseHeaderMap

public Map<String,String> getResponseHeaderMap()

该方法用于返回接口返回的响应头

Returns:

响应头

Since:

autest 3.3.0

getStatus

public int getStatus()

该方法用于返回接口响应状态码

Returns:

响应状态码

Since:

autest 3.3.0

getMessage

public String getMessage()

该方法用于返回接口响应消息

Returns:

响应消息

Since:

autest 3.3.0

getSentRequestAtMillis

public long getSentRequestAtMillis()

该方法用于返回服务端收到客户端发出请求时的时间戳

Returns:

从客户端发出请求的时刻记录的时间戳

Since:

autest 3.4.0

getReceivedResponseAtMillis

public long getReceivedResponseAtMillis()

该方法用于返回客户端接收到服务端返回的请求头时的时间戳

Returns:

从服务器接收到请求头时记录的时间戳

Since:

autest 3.4.0

getResponseTimeDifferenceAtMillis

public long getResponseTimeDifferenceAtMillis()

该方法用于对客户端发送请求的时间戳与客户端接收到返回的时间戳做差，返回其差值，即接口从请求到响应的时间，单位为毫秒

Returns:

客户端发送请求到客户端收到请求的时间

Since:

autest 4.0.0

getRequestInterfaceInfo

public InterfaceInfo getRequestInterfaceInfo()

该方法用于返回接口的实际请求信息

注意：返回的信息类仅存储请求接口的地址、请求类型、请求头和请求体信息，若通过EasyHttp.requst(InterfaceInfo)请求接口时，其除前面提到的信息外， 其他在InterfaceInfo参数中的信息将不会被存储

Returns:

接口实际请求信息

Since:

autest 3.5.0

assertResponse

public boolean assertResponse(String assertRegex,
                              SearchType searchType,
                              String paramName,
                              String xpath,
                              String leftBoundary,
                              String rightBoundary,
                              int index)

该方法用于对接口响应报文的指定部分内容进行断言

注意：断言规则为正则表达式，若断言非正则表达式的内容，需要自行进行转义，例如断言“(”符号，则需要传入“\\(”。方法中各个参数的解释，可参考extractKey(SearchType, String, String, String, String, int)方法

Parameters:

assertRegex - 断言规则

searchType - 搜索范围枚举

paramName - 搜索变量

xpath - 提取内容xpath

leftBoundary - 断言内容左边界

rightBoundary - 断言内容右边界

index - 指定下标内容

Returns:

断言结果

Since:

autest 3.3.0

assertResponse

public boolean assertResponse(String assertRegex,
                              SearchType searchType,
                              String leftBoundary,
                              String rightBoundary,
                              int index)

该方法用于对接口响应报文的指定部分内容进行断言

注意：断言规则为正则表达式，若断言非正则表达式的内容，需要自行进行转义，例如断言“(”符号，则需要传入“\\(”。 方法中各个参数的解释，可参考extractKey(SearchType, String, String, int)方法

Parameters:

assertRegex - 断言规则

searchType - 搜索范围枚举

leftBoundary - 断言内容左边界

rightBoundary - 断言内容右边界

index - 指定下标内容

Returns:

断言结果

Since:

autest 3.3.0

assertResponse

public boolean assertResponse(String assertRegex,
                              SearchType searchType,
                              String paramName,
                              String xpath)

该方法用于对接口响应报文的指定部分内容进行断言

注意：断言规则为正则表达式，若断言非正则表达式的内容，需要自行进行转义，例如断言“(”符号，则需要传入“\\(”。 方法中各个参数的解释，可参考extractKey(SearchType, String, String)方法

Parameters:

assertRegex - 断言规则

searchType - 搜索范围枚举

paramName - 搜索变量

xpath - 提取内容xpath

Returns:

断言结果

Since:

autest 3.3.0

assertResponse

public boolean assertResponse(String assertRegex,
                              SearchType searchType,
                              String paramName)

该方法用于对接口响应报文的指定部分内容进行断言

注意：断言规则为正则表达式，若断言非正则表达式的内容，需要自行进行转义，例如断言“(”符号，则需要传入“\\(”。 方法中各个参数的解释，可参考extractKey(SearchType, String)方法

Parameters:

assertRegex - 断言规则

searchType - 搜索范围枚举

paramName - 搜索变量

Returns:

断言结果

Since:

autest 3.3.0

assertResponse

public boolean assertResponse(String assertRegex,
                              String paramName)

该方法用于对接口响应报文的指定部分内容进行断言

注意：断言规则为正则表达式，若断言非正则表达式的内容，需要自行进行转义，例如断言“(”符号，则需要传入“\\(”。 方法中各个参数的解释，可参考extractKey(String)方法

Parameters:

assertRegex - 断言规则

paramName - 搜索变量

Returns:

断言结果

Since:

autest 3.3.0

extractKey

public String extractKey(SearchType searchType,
                         String paramName,
                         String xpath,
                         String leftBoundary,
                         String rightBoundary,
                         int index)

该方法用于通过指定的条件对接口响应报文指定内容进行提取，返回提取到的内容

提取规则如下：

1. 必须指定搜索范围SearchType枚举，否则抛出HttpResponseException异常
2. 当搜索范围为SearchType.MESSAGE或SearchType.STATUS时，则paramName不生效
3. 当搜索范围为SearchType.HEADER时，若指定了paramName内容，则获取响应头对应键的内容（没有该键值则返回空串）；若未指定paramName参数，则将响应头以AbstractMap.toString()方法的形式返回
4. 当搜索范围为SearchType.BODY时，存在以下情况：
   1. 当响应体为MessageType.JSON类型时，其xpath参数不生效，判断paramName参数的方式与SearchType.HEADER类似
   2. 当响应体为MessageType.XML或MessageType.HTML类型时，则优先判断xpath参数，若其为空时，则再判断paramName参数，其判断方式与SearchType.HEADER类似
   3. 当响应体为其他类型时，则xpath与paramName参数均不生效
5. 通过paramName或xpath提取后，仍会对内容进行指定边界的提取，其两种提取方式不独立
6. 若同时未指定左右边界，则不进行边界内容提取
7. 当边界提取到多条数据时，则根据指定的index进行提取，其下标从1开始计算（1为第一条元素），若值小于1，则获取第一条数据；若值大于提取到的数据集合数量，则返回最后一条数据
8. 左右边界允许为正则表达式

Parameters:

searchType - 提词搜索范围枚举

paramName - 提取内容参数名

xpath - 提取内容xpath

leftBoundary - 提取内容左边界

rightBoundary - 提取内容右边界

index - 边界提取到多条内容时指定的获取下标

Returns:

对响应体提取到的内容

Since:

autest 3.3.0

extractKey

public String extractKey(SearchType searchType,
                         String leftBoundary,
                         String rightBoundary,
                         int index)

该方法用于通过指定的边界条件对接口响应报文指定内容进行提取，返回提取到的内容

提取规则如下：

1. 通过paramName或xpath提取后，仍会对内容进行指定边界的提取，其两种提取方式不独立
2. 若同时未指定左右边界，则不进行边界内容提取
3. 当边界提取到多条数据时，则根据指定的index进行提取，其下标从1开始计算（1为第一条元素），若值小于1，则获取第一条数据；若值大于提取到的数据集合数量，则返回最后一条数据
4. 左右边界允许为正则表达式

Parameters:

searchType - 提词搜索范围枚举

leftBoundary - 提取内容左边界

rightBoundary - 提取内容右边界

index - 边界提取到多条内容时指定的获取下标

Returns:

对响应体提取到的内容

Since:

autest 3.3.0

extractKey

public String extractKey(SearchType searchType,
                         String paramName,
                         String xpath)

该方法用于通过指定的搜索参数对接口响应报文指定内容进行提取，返回提取到的内容

提取规则如下：

1. 必须指定搜索范围SearchType枚举，否则抛出HttpResponseException异常
2. 当搜索范围为SearchType.MESSAGE或SearchType.STATUS时，则paramName不生效
3. 当搜索范围为SearchType.HEADER时，若指定了paramName内容，则获取响应头对应键的内容（没有该键值则返回空串）；若未指定paramName参数，则将响应头以AbstractMap.toString()方法的形式返回
4. 当搜索范围为SearchType.BODY时，存在以下情况：
   1. 当响应体为MessageType.JSON类型时，其xpath参数不生效，判断paramName参数的方式与SearchType.HEADER类似
   2. 当响应体为MessageType.XML或MessageType.HTML类型时，则优先判断xpath参数，若其为空时，则再判断paramName参数，其判断方式与SearchType.HEADER类似
   3. 当响应体为其他类型时，则xpath与paramName参数均不生效

Parameters:

searchType - 提词搜索范围枚举

paramName - 提取内容参数名

xpath - 提取内容xpath

Returns:

对响应体提取到的内容

Since:

autest 3.3.0

extractKey

public String extractKey(SearchType searchType,
                         String paramName)

该方法用于通过指定的搜索参数对接口响应报文指定内容进行提取，返回提取到的内容

提取规则如下：

1. 必须指定搜索范围SearchType枚举，否则抛出HttpResponseException异常
2. 当搜索范围为SearchType.MESSAGE或SearchType.STATUS时，则paramName不生效
3. 当搜索范围为SearchType.HEADER时，若指定了paramName内容，则获取响应头对应键的内容（没有该键值则返回空串）；若未指定paramName参数，则将响应头以AbstractMap.toString()方法的形式返回
4. 当搜索范围为SearchType.BODY时，存在以下情况：
   1. 当响应体为MessageType.JSON或MessageType.XML或MessageType.HTML类型时，其判断paramName参数的方式与SearchType.HEADER类似
   2. 当响应体为其他类型时，则paramName参数均不生效

Parameters:

searchType - 提词搜索范围枚举

paramName - 提取内容参数名

Returns:

对响应体提取到的内容

Since:

autest 3.3.0

extractKey

public String extractKey(String paramName)

该方法用于通过指定的搜索参数对响应体进行提取，返回提取到的内容

提取规则如下：

1. 当响应体为MessageType.JSON或MessageType.XML或MessageType.HTML类型时，其判断paramName参数的方式与SearchType.HEADER类似
2. 当响应体为其他类型时，则paramName参数均不生效

Parameters:

paramName - 提取内容参数名

Returns:

对响应体提取到的内容

Since:

autest 3.3.0