Package com.pig4cloud.plugin.excel.handler

Class AbstractSheetWriteHandler

java.lang.Object

com.pig4cloud.plugin.excel.handler.AbstractSheetWriteHandler

All Implemented Interfaces:

SheetWriteHandler, org.springframework.beans.factory.Aware, org.springframework.context.ApplicationContextAware

Direct Known Subclasses:

ManySheetWriteHandler, SingleSheetWriteHandler

public abstract class AbstractSheetWriteHandler
extends Object
implements SheetWriteHandler, org.springframework.context.ApplicationContextAware

Author:

lengleng, L.cm

Field Summary

Fields

Modifier and Type	Field	Description
private org.springframework.context.ApplicationContext	applicationContext
private final ExcelConfigProperties	configProperties
private final org.springframework.beans.factory.ObjectProvider<List<com.alibaba.excel.converters.Converter<?>>>	converterProvider
private final WriterBuilderEnhancer	excelWriterBuilderEnhance
private I18nHeaderCellWriteHandler	i18nHeaderCellWriteHandler

Constructor Summary

Constructors

Constructor	Description
AbstractSheetWriteHandler()

Method Summary

Modifier and Type	Method	Description
void	check(ResponseExcel responseExcel)	校验
void	export(Object o, jakarta.servlet.http.HttpServletResponse response, ResponseExcel responseExcel)	返回的对象
private void	fillCustomHeadInfo(Class<?> dataClass, Class<? extends HeadGenerator> headEnhancerClass, com.alibaba.excel.write.builder.ExcelWriterSheetBuilder writerSheetBuilder)
com.alibaba.excel.ExcelWriter	getExcelWriter(jakarta.servlet.http.HttpServletResponse response, ResponseExcel responseExcel)	通用的获取ExcelWriter方法
private boolean	isNotInterface(Class<? extends HeadGenerator> headGeneratorClass)	是否为Null Head Generator
void	registerCustomConverter(com.alibaba.excel.write.builder.ExcelWriterBuilder builder)	自定义注入转换器 如果有需要，子类自己重写
void	setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
com.alibaba.excel.write.metadata.WriteSheet	sheet(Sheet sheet, Class<?> dataClass, String template, Class<? extends HeadGenerator> bookHeadEnhancerClass)	获取 WriteSheet 对象

Methods inherited from class java.lang.Object

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

Methods inherited from interface com.pig4cloud.plugin.excel.handler.SheetWriteHandler

support, write

Field Details

configProperties

private final ExcelConfigProperties configProperties

converterProvider

private final org.springframework.beans.factory.ObjectProvider<List<com.alibaba.excel.converters.Converter<?>>> converterProvider

excelWriterBuilderEnhance

private final WriterBuilderEnhancer excelWriterBuilderEnhance

applicationContext

private org.springframework.context.ApplicationContext applicationContext

i18nHeaderCellWriteHandler

@Autowired(required=false)
private I18nHeaderCellWriteHandler i18nHeaderCellWriteHandler

Constructor Details

AbstractSheetWriteHandler

public AbstractSheetWriteHandler()

Method Details

check

public void check(ResponseExcel responseExcel)

Description copied from interface: SheetWriteHandler

校验

Specified by:

check in interface SheetWriteHandler

Parameters:

responseExcel - 注解

export

public void export(Object o,
 jakarta.servlet.http.HttpServletResponse response,
 ResponseExcel responseExcel)

Description copied from interface: SheetWriteHandler

返回的对象

Specified by:

export in interface SheetWriteHandler

Parameters:

o - obj

response - 输出对象

responseExcel - 注解

getExcelWriter

public com.alibaba.excel.ExcelWriter getExcelWriter(jakarta.servlet.http.HttpServletResponse response,
 ResponseExcel responseExcel)

通用的获取ExcelWriter方法

Parameters:

response - HttpServletResponse

responseExcel - ResponseExcel注解

Returns:

ExcelWriter

registerCustomConverter

public void registerCustomConverter(com.alibaba.excel.write.builder.ExcelWriterBuilder builder)

自定义注入转换器 如果有需要，子类自己重写

Parameters:

builder - ExcelWriterBuilder

sheet

public com.alibaba.excel.write.metadata.WriteSheet sheet(Sheet sheet,
 Class<?> dataClass,
 String template,
 Class<? extends HeadGenerator> bookHeadEnhancerClass)

获取 WriteSheet 对象

Parameters:

sheet - sheet annotation info

dataClass - 数据类型

template - 模板

bookHeadEnhancerClass - 自定义头处理器

Returns:

WriteSheet

fillCustomHeadInfo

private void fillCustomHeadInfo(Class<?> dataClass,
 Class<? extends HeadGenerator> headEnhancerClass,
 com.alibaba.excel.write.builder.ExcelWriterSheetBuilder writerSheetBuilder)

isNotInterface

private boolean isNotInterface(Class<? extends HeadGenerator> headGeneratorClass)

是否为Null Head Generator

Parameters:

headGeneratorClass - 头生成器类型

Returns:

true 已指定 false 未指定(默认值)

setApplicationContext

public void setApplicationContext(org.springframework.context.ApplicationContext applicationContext)
                           throws org.springframework.beans.BeansException

Specified by:

setApplicationContext in interface org.springframework.context.ApplicationContextAware

Throws:

org.springframework.beans.BeansException