com.gongbo.export.annotations

注释类型 AutoExport

@Repeatable(value=AutoExports.class)
 @Target(value=METHOD)
 @Retention(value=RUNTIME)
 @Documented
public @interface AutoExport

可选元素概要

可选元素

限定符和类型	可选元素和说明
Class<? extends AfterExportHandler>	afterExportHandler
Class<? extends ExportDataConvert>	dataConvert 数据转换
com.alibaba.excel.support.ExcelTypeEnum	excelType excel文件格式
Class<? extends FieldFilter>	fieldFilter 字段过滤
String	fileName 导出文件名,否则为时间戳
Class<? extends FileNameConvert>	fileNameConvert 动态名称，优先级大于fileName
boolean	formula 是否执行公式
Class<?>	modelClass 导出模型类 值为Object.class（默认）时代表根据方法返回类型查找（要求该方法返回类型为ResponseEntity> / 或 ResponseEntity） 值为EnableExport。
String	outputPath 输出文件地址.这时excel将输出到指定目录，且不会通过http响应
String	sheetName 导出sheet名称,为空时默认为Sheet1
String	tag 导出分组，同一个接口支持多种导出时，可以根据前端请求参数中的export_tag匹配对应的导出注解配置
String	template 导出模板文件名称
Class<? extends WriteHandler>	writeHandler 生成文件执行器

元素详细资料

fileName

public abstract String fileName

导出文件名,否则为时间戳

默认值:

""

sheetName

public abstract String sheetName

导出sheet名称,为空时默认为Sheet1

默认值:

""

template

public abstract String template

导出模板文件名称

默认值:

""

tag

public abstract String tag

导出分组，同一个接口支持多种导出时，可以根据前端请求参数中的export_tag匹配对应的导出注解配置

默认值:

""

modelClass

public abstract Class<?> modelClass

导出模型类 值为Object.class（默认）时代表根据方法返回类型查找（要求该方法返回类型为ResponseEntity> / 或 ResponseEntity） 值为EnableExport。NoneModel.class时代表没有模型类，注意这时导出方式不能为AUTO 值为其他时代表指定为该模型类

默认值:

java.lang.Object.class

outputPath

public abstract String outputPath

输出文件地址.这时excel将输出到指定目录，且不会通过http响应

默认值:

""

fileNameConvert

public abstract Class<? extends FileNameConvert> fileNameConvert

动态名称，优先级大于fileName

默认值:

com.gongbo.export.core.handler.defaults.DefaultFileNameConvert.class

fieldFilter

public abstract Class<? extends FieldFilter> fieldFilter

字段过滤

默认值:

com.gongbo.export.core.handler.defaults.DefaultFieldFilter.class

dataConvert

public abstract Class<? extends ExportDataConvert> dataConvert

数据转换

默认值:

com.gongbo.export.core.handler.defaults.DefaultExportDataConvert.class

writeHandler

public abstract Class<? extends WriteHandler> writeHandler

生成文件执行器

默认值:

com.gongbo.export.core.handler.defaults.DefaultWriteHandler.class

afterExportHandler

public abstract Class<? extends AfterExportHandler> afterExportHandler

默认值:

com.gongbo.export.core.handler.defaults.DefaultAfterExportHandler.class

excelType

public abstract com.alibaba.excel.support.ExcelTypeEnum excelType

excel文件格式

默认值:

com.alibaba.excel.support.ExcelTypeEnum.XLSX

formula

public abstract boolean formula

是否执行公式

默认值:

true