easyexcel

Documentation

Index

• type ReadExcel
  • func ToBean[T any]() ReadExcel[T]
• type ReadExcelStream
  • func ToBeanStream[T any]() ReadExcelStream[T]
• type WriteExcel
  • func ToExcel[T any]() WriteExcel[T]
• type WriteExcelStream
  • func ToExcelStream[T any]() WriteExcelStream[T]

Types

type ReadExcel

type ReadExcel[T any] interface {

	// SheetName 配置工作簿名称
	SheetName(sheetName string) ReadExcel[T]

	// TimeFormat 配置时间格式化
	TimeFormat(timeFormat string) ReadExcel[T]

	// ReadLocal 从本地文件读取excel，将数据转化为bean列表返回
	ReadLocal(fileName string) []T

	// ReadNet 从网络文件读取excel，将数据转化为bean列表返回
	ReadNet(reader io.Reader) []T
}

func ToBean

func ToBean[T any]() ReadExcel[T]

ToBean 构建excel转化bean的对象

type ReadExcelStream

type ReadExcelStream[T any] interface {

	// SheetName 配置工作簿名称
	SheetName(sheetName string) ReadExcelStream[T]

	// TimeFormat 配置时间格式化
	TimeFormat(timeFormat string) ReadExcelStream[T]

	// BatchSize 配置批处理大小
	BatchSize(batchSize int) ReadExcelStream[T]

	// ReadLocal 从本地文件读取excel，读取一批数据转化为bean列表并调用handler函数处理
	// fileName - 本地文件路径
	// handler - 处理bean列表的函数
	ReadLocal(fileName string, handler func(beans []T))

	// ReadNet 从网络文件读取excel，读取一批数据转化为bean列表并调用handler函数处理
	// reader - 实现io.Reader接口的对象
	// handler - 处理bean列表的函数
	ReadNet(reader io.Reader, handler func(beans []T))
}

func ToBeanStream

func ToBeanStream[T any]() ReadExcelStream[T]

ToBeanStream 构建excel转化bean的流对象，可以处理大数据，从而避免内存溢出

type WriteExcel

type WriteExcel[T any] interface {

	// SheetName 配置工作簿名称
	SheetName(sheetName string) WriteExcel[T]

	// WriteLocal 数据写入excel，并保存到本地
	WriteLocal(fileName string, beans []T)

	// WriteResponse 数据写入excel，并输出到浏览器
	WriteResponse(response http.ResponseWriter, beans []T)

	// WriteNet 数据写入excel，并输出到网络中
	WriteNet(writer io.Writer, beans []T)
}

func ToExcel

func ToExcel[T any]() WriteExcel[T]

ToExcel 构建bean转化excel的对象

type WriteExcelStream

type WriteExcelStream[T any] interface {

	// SheetName 配置工作簿名称
	SheetName(sheetName string) WriteExcelStream[T]

	// WriteLocal 数据写入excel，并保存到本地
	WriteLocal(fileName string, suppleBeans func() []T)

	// WriteResponse 数据写入excel，并输出到浏览器
	WriteResponse(response http.ResponseWriter, suppleBeans func() []T)

	// WriteNet 数据写入excel，并输出到网络中
	WriteNet(writer io.Writer, suppleBeans func() []T)
}

func ToExcelStream

func ToExcelStream[T any]() WriteExcelStream[T]

ToExcelStream 构建bean转化excel的流对象，可以处理大数据，从而避免内存溢出