com.auxiliary.http

Class ReadInterfaceFromExcel

java.lang.Object

com.auxiliary.http.ReadInterfaceFromAbstract

com.auxiliary.http.ReadInterfaceFromExcel

All Implemented Interfaces:

ActionEnvironment, AssertResponse, BeforeOperation, ExtractResponse

public class ReadInterfaceFromExcel
extends ReadInterfaceFromAbstract
implements ActionEnvironment, AssertResponse, ExtractResponse, BeforeOperation

文件名：ReadInterfaceFromExcel.java

用途：用于读取excel文件中的接口信息，文件支持“.xls”和“.xlsx”格式，但在读取完后，需要调用close()方法关闭文件的读取

编码时间：2022年9月8日 上午10:48:30

修改时间：2022年9月8日 上午10:48:30

Since:

JDK 1.8, autest 3.7.0

Version:

Ver1.0

Author:

彭宇琦

Nested Class Summary

Nested Classes

Modifier and Type	Class and Description
protected static class	ReadInterfaceFromExcel.ExcelField 文件名：ReadInterfaceFromExcel.java

Field Summary

Fields

Modifier and Type	Field and Description
protected HashMap<String,Entry<Integer,Integer>>	assertMap 存储接口断言
protected HashMap<String,Entry<Integer,Integer>>	beforeInterMap 存储前置接口操作
protected HashMap<String,Entry<Integer,Integer>>	cookieMap 存储cookie参数
protected HashMap<String,String>	envMap 存储环境数据
protected org.apache.poi.ss.usermodel.Workbook	excel 定义模板文件
protected HashMap<String,Entry<Integer,Integer>>	extractMap 存储接口提词
protected HashMap<String,Entry<Integer,Integer>>	fileBodyMap 存储文件类型请求体
protected org.apache.poi.ss.usermodel.DataFormatter	format 用于对单元格内容进行格式化输出
protected HashMap<String,Entry<Integer,Integer>>	formBodyMap 存储表单类型请求体
protected HashMap<String,Entry<Integer,Integer>>	interMap 存储接口数据及接口所在的行号
protected HashMap<String,Entry<Integer,Integer>>	interParamMap 存储接口参数
protected HashMap<String,Entry<Integer,Integer>>	normalBodyMap 存储普通类型请求体
protected HashMap<String,Entry<Integer,Integer>>	requestHeaderMap 存储请求头参数
protected HashMap<String,Entry<Integer,Integer>>	responseMap 存储相应内容参数
protected String	SPECIAL_CONTENT_SYMBOL 用于对特殊内容进行定义的符号

Fields inherited from class com.auxiliary.http.ReadInterfaceFromAbstract

DEFAULT_HOST, DEFAULT_ORD, DEFAULT_SEARCH, interfaceCacheMap

Fields inherited from interface com.auxiliary.http.AssertResponse

ARRAY_END_SYMBOL, ARRAY_START_SYMBOL, JSON_ASSERT_ASSERT_REGEX, JSON_ASSERT_LB, JSON_ASSERT_ORD, JSON_ASSERT_PARAM_NAME, JSON_ASSERT_RB, JSON_ASSERT_SEARCH, JSON_ASSERT_XPATH, SEPARATE_SPLIT_REGEX, SEPARATE_SYMBOL, SEPARATE_TRANSFERRED_MEANING_REGEX

Fields inherited from interface com.auxiliary.http.ExtractResponse

ARRAY_END_SYMBOL, ARRAY_START_SYMBOL, JSON_EXTRACT_LB, JSON_EXTRACT_ORD, JSON_EXTRACT_PARAM_NAME, JSON_EXTRACT_RB, JSON_EXTRACT_SAVE_NAME, JSON_EXTRACT_SEARCH, JSON_EXTRACT_XPATH, SEPARATE_SPLIT_REGEX, SEPARATE_SYMBOL, SEPARATE_TRANSFERRED_MEANING_REGEX

Constructor Summary

Constructors

Constructor and Description
ReadInterfaceFromExcel(File excelFile) 构造对象，读取模板文件，并初始化各个参数

Method Summary

Modifier and Type	Method and Description
protected void	addInterNameRowIndex(HashMap<String,Entry<Integer,Integer>> map, int fieldIndex, org.apache.poi.ss.usermodel.Sheet dataSheet) 该方法用于将sheet所有行中指定下标单元格中不为空的内容进行存储，并记录其内容及行号至指定的map集合中
void	close() 该方法用于关闭对接口模板的读取
HashMap<String,String>	getActionEnvironment() 该方法用于返回所有的执行环境集合
Set<String>	getAssertContent(String interName) 该方法用于返回指定接口的断言内容json串
List<BeforeInterfaceOperation>	getBeforeOperation(String interName) 该方法用于返回接口的所有前置操作方法
Set<String>	getExtractContent(String interName) 该方法用于指定接口的报文提词内容json串集合
InterfaceInfo	getInterface(String interName) 该方法用于根据接口名称，返回接口的信息类对象
InterfaceInfo	getInterface(String interName, String environmentName) 该方法用于根据接口名称及所在环境，返回接口的信息类对象
List<String>	getParentInterfaceName(String interName) 该方法用于返回接口的所有父层接口名称（不包括当前接口名称）
protected List<Optional<org.apache.poi.ss.usermodel.Cell>>	getRowAllCell(org.apache.poi.ss.usermodel.Row row, int columnIndex) 该方法用于获取当前行中所有单元格对象的集合
protected List<org.apache.poi.ss.usermodel.Row>	getSheetAllRow(org.apache.poi.ss.usermodel.Sheet sheet) 该方法用于获取当前sheet中所有行对象的集合
protected void	readBodySheetContent(String interName, InterfaceInfo inter)
protected void	readInterSheetContent(String interName, InterfaceInfo inter) 该方法用于读取“接口”sheet页中接口相关的基本信息
protected void	readMultirowSheetContent(String interName, String sheetName, InterfaceInfo inter, HashMap<String,Entry<Integer,Integer>> map) 该方法用于读取一个接口占多行的sheet页内容
void	setActionEnvironment(String environmentName) 该方法用于设置当前执行接口的环境

Methods inherited from class com.auxiliary.http.ReadInterfaceFromAbstract

clearInterfaceInfoCache

Methods inherited from class java.lang.Object

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

Field Detail

SPECIAL_CONTENT_SYMBOL

protected final String SPECIAL_CONTENT_SYMBOL

用于对特殊内容进行定义的符号

See Also:

Constant Field Values

excel

protected org.apache.poi.ss.usermodel.Workbook excel

定义模板文件

format

protected org.apache.poi.ss.usermodel.DataFormatter format

用于对单元格内容进行格式化输出

envMap

protected HashMap<String,String> envMap

存储环境数据

interMap

protected HashMap<String,Entry<Integer,Integer>> interMap

存储接口数据及接口所在的行号

interParamMap

protected HashMap<String,Entry<Integer,Integer>> interParamMap

存储接口参数

beforeInterMap

protected HashMap<String,Entry<Integer,Integer>> beforeInterMap

存储前置接口操作

normalBodyMap

protected HashMap<String,Entry<Integer,Integer>> normalBodyMap

存储普通类型请求体

fileBodyMap

protected HashMap<String,Entry<Integer,Integer>> fileBodyMap

存储文件类型请求体

formBodyMap

protected HashMap<String,Entry<Integer,Integer>> formBodyMap

存储表单类型请求体

requestHeaderMap

protected HashMap<String,Entry<Integer,Integer>> requestHeaderMap

存储请求头参数

cookieMap

protected HashMap<String,Entry<Integer,Integer>> cookieMap

存储cookie参数

responseMap

protected HashMap<String,Entry<Integer,Integer>> responseMap

存储相应内容参数

assertMap

protected HashMap<String,Entry<Integer,Integer>> assertMap

存储接口断言

extractMap

protected HashMap<String,Entry<Integer,Integer>> extractMap

存储接口提词

Constructor Detail

ReadInterfaceFromExcel

public ReadInterfaceFromExcel(File excelFile)

构造对象，读取模板文件，并初始化各个参数

Parameters:

excelFile - 接口模板文件

Method Detail

setActionEnvironment

public void setActionEnvironment(String environmentName)

Description copied from interface: ActionEnvironment

该方法用于设置当前执行接口的环境

Specified by:

setActionEnvironment in interface ActionEnvironment

Parameters:

environmentName - 环境名称

getActionEnvironment

public HashMap<String,String> getActionEnvironment()

Description copied from interface: ActionEnvironment

该方法用于返回所有的执行环境集合

Specified by:

getActionEnvironment in interface ActionEnvironment

Returns:

所有执行环境集合

getBeforeOperation

public List<BeforeInterfaceOperation> getBeforeOperation(String interName)

Description copied from interface: BeforeOperation

该方法用于返回接口的所有前置操作方法

Specified by:

getBeforeOperation in interface BeforeOperation

Returns:

前置操作封装类集合

getParentInterfaceName

public List<String> getParentInterfaceName(String interName)

Description copied from interface: BeforeOperation

该方法用于返回接口的所有父层接口名称（不包括当前接口名称）

Specified by:

getParentInterfaceName in interface BeforeOperation

Parameters:

interName - 接口名称

Returns:

父层接口名称集合

getExtractContent

public Set<String> getExtractContent(String interName)

Description copied from interface: ExtractResponse

该方法用于指定接口的报文提词内容json串集合

json串的键值可通过静态属性获取，当没有断言内容时，则json中的键都为空值

Specified by:

getExtractContent in interface ExtractResponse

Parameters:

interName - 接口名称

Returns:

接口响应报文提词内容json串集合

getAssertContent

public Set<String> getAssertContent(String interName)

Description copied from interface: AssertResponse

该方法用于返回指定接口的断言内容json串

json串的键值可通过静态属性获取，当没有断言内容时，则json中的键都为空值

Specified by:

getAssertContent in interface AssertResponse

Parameters:

interName - 接口名称

Returns:

接口断言内容json串

getInterface

public InterfaceInfo getInterface(String interName)

Description copied from class: ReadInterfaceFromAbstract

该方法用于根据接口名称，返回接口的信息类对象

Specified by:

getInterface in class ReadInterfaceFromAbstract

Parameters:

interName - 接口名称

Returns:

接口信息类对象

getInterface

public InterfaceInfo getInterface(String interName,
                                  String environmentName)

Description copied from interface: ActionEnvironment

该方法用于根据接口名称及所在环境，返回接口的信息类对象

Specified by:

getInterface in interface ActionEnvironment

Parameters:

interName - 接口名称

environmentName - 环境名称

Returns:

接口信息类对象

readBodySheetContent

protected void readBodySheetContent(String interName,
                                    InterfaceInfo inter)

readMultirowSheetContent

protected void readMultirowSheetContent(String interName,
                                        String sheetName,
                                        InterfaceInfo inter,
                                        HashMap<String,Entry<Integer,Integer>> map)

该方法用于读取一个接口占多行的sheet页内容

Parameters:

interName - 接口名称

sheetName - sheet页名称

inter - 接口信息类对象

Since:

autest 3.7.0

readInterSheetContent

protected void readInterSheetContent(String interName,
                                     InterfaceInfo inter)

该方法用于读取“接口”sheet页中接口相关的基本信息

Parameters:

interName - 接口名称

inter - 接口信息类对象

Since:

autest 3.7.0

close

public void close()

该方法用于关闭对接口模板的读取

Since:

autest 3.7.0

getSheetAllRow

protected List<org.apache.poi.ss.usermodel.Row> getSheetAllRow(org.apache.poi.ss.usermodel.Sheet sheet)

该方法用于获取当前sheet中所有行对象的集合

Parameters:

sheet - sheet对象

Returns:

当前sheet所有行对象集合

Since:

autest 3.7.0

getRowAllCell

protected List<Optional<org.apache.poi.ss.usermodel.Cell>> getRowAllCell(org.apache.poi.ss.usermodel.Row row,
                                                                         int columnIndex)

该方法用于获取当前行中所有单元格对象的集合

Parameters:

row - 行对象

columnIndex - 当前行下的列数

Returns:

当前行中所有单元格对象的集合

Since:

autest 3.7.0

addInterNameRowIndex

protected void addInterNameRowIndex(HashMap<String,Entry<Integer,Integer>> map,
                                    int fieldIndex,
                                    org.apache.poi.ss.usermodel.Sheet dataSheet)

该方法用于将sheet所有行中指定下标单元格中不为空的内容进行存储，并记录其内容及行号至指定的map集合中

Parameters:

map - 存储内容及下标的集合

fieldIndex - 指定字段所在的列的下标

dataSheet - 数据sheet页

Since:

autest 3.7.0