程序包 com.elitesland.ystdms.sys.util

接口 DataExport<T extends Serializable,E extends OrderQueryParam>

public interface DataExport<T extends Serializable,E extends OrderQueryParam>

方法概要

修饰符和类型	方法	说明
default PagingVO<T>	execute(E queryParam, int page, int pageSize)	已过时, 待删除: 此 API 元素将从以后的版本中删除。 自3.3.0版本起已弃用，请使用 executeExport(OrderQueryParam)
default PagingVO<T>	executeExport(E queryParam)	执行数据导出（推荐方法）.
default String	exportFileName()	获取导出文件名称.
default int	getDefaultPageSize()	获取分页查询的默认页大小.
default int	getMaxPageSize()	获取单页最大导出记录数限制.
String	getTmplCode()	获取模板编号.
default boolean	requireTemplate()	判断导出是否必须配置模板.

方法详细资料

getTmplCode

String getTmplCode()

获取模板编号.

该编号用于关联导出模板，如果 返回false，则此方法可以返回null

返回:

模板编号，如果不需要模板则返回null

execute

@Deprecated(forRemoval=true,
            since="3.3.0")
default PagingVO<T> execute(E queryParam,
 int page,
 int pageSize)

已过时, 待删除: 此 API 元素将从以后的版本中删除。

自3.3.0版本起已弃用，请使用 executeExport(OrderQueryParam)

执行数据导出（已弃用）.

注意：此方法将在未来版本中移除，请使用 executeExport(OrderQueryParam) 替代

参数:

queryParam - 查询参数，不能为null

page - 页数，从1开始，必须为正数

pageSize - 页大小，取值范围1~1000，必须为正数

返回:

分页数据

抛出:

IllegalArgumentException - 如果参数不合法

executeExport

default PagingVO<T> executeExport(E queryParam)

执行数据导出（推荐方法）.

此方法从查询参数中提取分页信息（current和size）进行数据查询。

参数:

queryParam - 查询参数，包含分页信息（current和size）

返回:

分页数据，如果参数为null则返回空结果

exportFileName

default String exportFileName()

获取导出文件名称.

文件名称可以包含扩展名，如"export.xlsx"、"data.csv"等。 如果返回null或空字符串，系统将使用默认的文件命名规则。

返回:

导出文件的名称，如果返回null则使用默认名称

getDefaultPageSize

default int getDefaultPageSize()

获取分页查询的默认页大小.

该值控制每次导出时从数据库查询的记录数量。 建议根据数据量和性能要求合理设置，过大可能导致内存溢出。

返回:

默认页大小，默认值为20

requireTemplate

default boolean requireTemplate()

判断导出是否必须配置模板.

如果返回true，则必须配置模板（getTmplCode()不能返回null）； 如果返回false（默认值），则可以根据实际情况选择是否使用模板。

返回:

true表示必须配置模板，false表示可以不配置模板

另请参阅:

• getTmplCode()

getMaxPageSize

default int getMaxPageSize()

获取单页最大导出记录数限制.

该方法用于限制单次查询的最大记录数，防止大数据量导出导致系统性能问题。 默认值为1000，子类可以根据需要覆盖此值。

返回:

单页最大记录数，默认值为1000