README.md

一个基于hutool的导入导出工具

前言:

公司最初基于POI封装了的Excel的工具类. 但后来因为种种原因需要更新这个玩意.

easy-excel它基于注解的形式对于动态表头并不友好

看了一圈网上都没什么现成的工具, 于是只能就自己手撸一个了.

开发目标

• 易于使用
• 符合直觉
• 降低心智负担
• (好玩)

使用示例

构建表头 --> 写入数据 --> 响应数据

//   导出简单表格
//   | 用户名  |  全名  |
//   ------------------
//   |  张三A  | 张三1  | 
//   |  张三B  | 张三2  |
//   |  张三C  | 张三3  |
@GetMapping(value = "/exportExcel")
public void exportExcel(HttpServletRequest request,HttpServletResponse response){
    
        ArrayList<Student> result=createStudentList(60_000);  
        
        ExcelExport.create("excelName",Student.class)            
        .addTitle("用户名",Student::getUserName)            
        .addTitle("全名",Student::getFullName)   //构建表头
        .write(result)                           //写入数据                            
        .response(response);                     //响应数据
 }

//导出多级表头
//   |     用户名       |     年龄   |
//   | 用户名  |  全名  |            |
//   -------------------------------
//   |  张三A  | 张三1  |     20     |
//   |  张三B  | 张三2  |     20     |     
//   |  张三C  | 张三3  |     20     |
@GetMapping(value = "/exportExcel")
public void exportExcel(HttpServletRequest request,HttpServletResponse response){
        
        ArrayList<Student> result=createStudentList(60_000);  
        
        ExcelExport.create("excelName",Student.class)            
        .addTitle("基础信息::用户名",Student::getUserName)          
        .addTitle("基础信息::全名",Student::getFullName)
        .addTitle("年龄",Student::getAge)
        .write(result)                                        
        .response(response);                                
        }

// 多Sheet页支持
@GetMapping(value = "/exportExcel")
public void exportExcel(HttpServletRequest request,HttpServletResponse response){

        ArrayList<Student> students = createStudentList(60_000);
        ArrayList<Teacher> teachers = createTeacherList(60_000);
        
        ExcelExport.create()
        .switchSheet("学生数据", Student.class)
        .addTitle("基础信息::用户名",Student::getUserName)           
        .addTitle("基础信息::全名",Student::getFullName)
        .addTitle("年龄",Student::getAge)
        .write(students)
        
        .switchSheet("老师数据", Teacher.class)
        .addTitle("基础信息::用户名",Teacher::getUserName)
        .addTitle("基础信息::全名",Teacher::getFullName)
        .addTitle("年龄",Teacher::getAge)
        .write(teachers)                                      
        .response(response);                               
     }

// 导入数据
@PostMapping(value = "/importExcel")
public void importExcel(MultipartFile file,HttpServletRequest request,HttpServletResponse response){
        ExcelImport.create(file,Student::new)
        .addConvert("用户名",Student::setUserName)
        .addConvert("全名",Student::setFullName)
        .addConvert("年龄",IntegerConverter::parse,Student::setAge)
        .read(student->{
                System.out.println(student);
        })
        .response(response);
  }

快速开始

1.引入依赖

注意,从 1.3.0 版本开始, 是以Spring Boot 3.0 (JDK17)的版本进行开发.

<dependency>
    <groupId>io.github.creekmoon</groupId>
  <artifactId>excel-utils-boot-starter</artifactId>
  <version>1.3.0</version>
</dependency>

2.使用@EnableExcelUtils注解启用工具类

放在Spring Boot启动类上

@EnableExcelUtils()
@SpringBootApplication()
public class ExampleApplication {

    public static void main(String[] args) {
        SpringApplication.run(ExampleApplication.class, args);
    }
}

参数说明

##### 注解可选参数:

customExceptions: 自定义异常(已检查的异常) 用于告诉组件这是安全的异常.

importMaxParallel: 最大导入并发数量 这个参数可以控制同时进行多少个导入工作.防止OOM.

tempFileLifeMinutes: 临时文件寿命 后台维护一个线程进行定时清理临时文件. 默认是五分钟

@EnableExcelUtils(customExceptions = {MyNewException.class}, importMaxParallel = 4, tempFileLifeMinutes = 5)

更多例子

请参考源码里的example