Java中的Excel框架使用详解

更新时间：2023年11月13日 08:57:21 作者：阿靖哦

这篇文章主要介绍了Java中的Excel框架使用详解,Java解析、生成Excel比较有名的框架有Apache poi、jxl,但他们都存在一个严重的问题就是非常的耗内存,poi有一套SAX模式的API可以一定程度的解决一些内存溢出的问题,需要的朋友可以参考下

一、安装依赖

推荐使用最新版本，可通过文章末尾官方文档链接跳转查看

<dependency>
    <groupId>cn.gjing</groupId>
    <artifactId>tools-excel</artifactId>
    <version>2021.12.3</version>
</dependency>

二、Excel导出

1、单表头

定义Excel映射实体, @Data是lombok的注解

/**
 * @author Gjing
 **/
@Data
@Excel("单级表头")
public class SingleHead {
    @ExcelField("姓名")
    private String userName;

    @ExcelField(value = "年龄", format = "0")
    private Integer userAge;

    @ExcelField("性别")
    private Gender gender;

    @ExcelField("爱好")
    private String favorite;
}

/**
 * @author Gjing
 **/
@RestController
public class UserController {

    @GetMapping("/test_export")
    @ApiOperation("导出一级表头")
    public void testExport(HttpServletResponse response) {
        //指定映射的实体为刚刚定义的
        ExcelFactory.createWriter(SingleHead.class, response)
                .write(null)
                .flush();
    }
}

single

2、多级表头

数组中的每个值代表着一级表头

/**
 * @author Gjing
 **/
@Data
@Excel("多级表头")
public class MultiHead {
    @ExcelField({"用户名","用户名"})
    private String userName;

    @ExcelField({"年龄","年龄"})
    private Integer age;

    @ExcelField({"形态","身高"})
    private BigDecimal height;

    @ExcelField({"形态","体重"})
    private BigDecimal weight;
}

/**
 * @author Gjing
 **/
@RestController
public class TestController {

    @GetMapping("/test_export")
    @ApiOperation("多级表头")
    public void testExport(HttpServletResponse response) {
        ExcelFactory.createWriter(MultiHead.class, response)
                //需要在write前激活多级表头，否则不会自动合并
                .multiHead(true)
                .write(null)
                .flush();
    }
}

multi

3、带大标题

大标题的起始行是你要插入的sheet中最后一条数据的下一行，如果sheet中没有数据，就是第一行。你可以配置大标题占用的行数和起始单元格下标(默认第一个单元格)和结束单元格下标(默认跟随表头的数量)

/**
 * @author Gjing
 **/
@RestController
public class TestController {

    @GetMapping("/test")
    @ApiOperation("含大标题")
    public void testExport(HttpServletResponse response) {
        ExcelFactory.createWriter(SingleHead.class, response)
                //大标题占用两行
                .writeTitle(new BigTitle("我是大标题"))
                .write(null)
                .flush();
    }
}

title

4、下拉框

单元格增加下拉框

注解方式

/**
 * @author Gjing
 **/
@Data
@Excel("下拉框导出")
public class SingleHead {
    @ExcelField("性别")
    @ExcelDropdownBox(combobox = {"男", "女"})
    private Gender gender;

    @ExcelField("爱好")
    private String favorite;
}

/**
 * @author Gjing
 **/
@RestController
public class TestController {

    @GetMapping("/test_export")
    @ApiOperation("带下拉框")
    public void testExport(HttpServletResponse response) {
        ExcelFactory.createWriter(SingleHead.class, response)
                //需要在write前激活校验
                .valid(true)
                .write(null)
                .flush();
    }
}

通过方法设置普通下拉框的选项

/**
 * @author Gjing
 **/
@RestController
public class TestController {

    @GetMapping("/test_export")
    @ApiOperation("带下拉框")
    public void testExport(HttpServletResponse response) {
        Map<String, String[]> genderMap = new HashMap<>(8);
        //key为实体类的字段名，使用方法进行设置时，实体字段的@ExcelDropdownBox注解不在需要指定combobox
        //如果指定了也会去覆盖注解中的值
        genderMap.put("gender", new String[]{"男", "女"});
        ExcelFactory.createWriter(SingleHead.class, response)
                .valid(true)
                .write(null, genderMap)
                .flush();
    }
}

下拉框

5、时间校验

导出时给列表头下方的单元格增加时间校验

/**
 * @author Gjing
 **/
@Data
@Excel
public class SingleHead {
    @ExcelField("姓名")
    private String userName;

    @ExcelField(value = "年龄", format = "0")
    private Integer userAge;

    @ExcelField(value = "生日", format = "yyyy-MM-dd")
    @ExcelDateValid(expr1 = "2000-01-01", operatorType = LESS_OR_EQUAL, errorContent = "出生日期不能超过2000年")
    private Date birthday;
}

/**
 * @author Gjing
 **/
@RestController
public class TestController {

    @GetMapping("/test_export")
    @ApiOperation("带时间校验")
    public void testExport(HttpServletResponse response) {
        ExcelFactory.createWriter(SingleHead.class, response)
                //需要在write前激活校验
                .valid(true)
                .write(null)
                .flush();
    }
}

时间校验

6、数字、文本校验

导出时给列表头下方的单元格增加数值校验。可以对数字的大小，文本的长度进行校验

/**
 * @author Gjing
 **/
@Data
@Excel
public class SingleHead {
    @ExcelField("姓名")
    //对输入的名称字数进行校验，字数限制小于4
    @ExcelNumericValid(validType = TEXT_LENGTH,operatorType = LESS_THAN,expr1 = "4",errorContent = "姓名字数小于4")
    private String userName;
}

/**
 * @author Gjing
 **/
@RestController
public class TestController {

    @GetMapping("/test_export")
    @ApiOperation("带数值校验")
    public void testExport(HttpServletResponse response) {
        ExcelFactory.createWriter(SingleHead .class, response)
                //需要在write前激活校验
                .valid(true)
                .write(null)
                .flush();
    }
}

数值校验

7、数据转换

导出时对数据进行加工或者添加默认值，支持注解方式和接口方式

注解方式

/**
 * @author Gjing
 **/
@Data
@Excel
public class SingleHead {
    @ExcelField("姓名")
    private String userName;

    @ExcelField(value = "年龄", format = "0")
    //对每个人的年龄乘以10
    @ExcelDataConvert(expr1 = "#userAge * 10")
    private Integer userAge;
}

接口方式

/**
 * @author Gjing
 **/
public class MyDataConvert implements DataConvert<SingleHead> {

    @Override
    public Object toEntityAttribute(Object o, Field field) {
        return null;
    }

    @Override
    public Object toExcelAttribute(SingleHead singleHead, Object value, Field field) {
        return (int) value * 10;
    }
}

实现接口后需要在你需要转换的字段上指定转换器

/**
 * @author Gjing
 **/
@Data
@Excel
public class SingleHead {
    @ExcelField("姓名")
    private String userName;

    @ExcelField(value = "年龄", format = "0", convert = MyDataConvert.class)
    private Integer userAge;
}

导出方法调用最后一定要使用flush()方法进行数据刷新到Excel文件中

三、导入

导入的实体类皆采用导出的实体类

1、单表头

/**
 * @author Gjing
 **/
@RestController
public class TestController {
    @Resource
    private UserService userService;
	
    @PostMapping("/user_import")
    @ApiOperation("导入单表头")
    public void userImport(MultipartFile file) throws IOException {
        ExcelFactory.createReader(file, SingleHead.class)
                //在read()方法前通过订阅方法增加一个结果监听器，该监听器会在每一次read()结束之后触发
                .subscribe(e -> this.userService.saveUsers(e))
                .read()
                .finish();
    }
}

2、多级表头

前文有提到多级表头时，最后一级为实际表头，所以要在导入时指定实际表头开始下标，由于导出的模板映射实体设置两级表头，因此这里的实际表头为下标为1(Excel行和列下标都是默认0开始的)

/**
 * @author Gjing
 **/
@RestController
public class TestController {
    @Resource
    private UserService userService;
	
    @PostMapping("/user_import")
    @ApiOperation("导入单表头")
    public void userImport(MultipartFile file) throws IOException {
        ExcelFactory.createReader(file, SingleHead.class)
                //在read()方法前通过订阅方法增加一个结果监听器，该监听器会在每一次read()结束之后触发
                //如果Excel中数据量太大，不建议使用结果监听器，会造成生成了过多的映射实体对象造成内存溢出
                .subscribe(e -> this.userService.saveUsers(e))
                .read(1)
                .finish();
    }
}

在导入调用结束后，一定要在最后调用finish()方法对流进行关闭

到此这篇关于Java中的Excel框架使用详解的文章就介绍到这了,更多相关Java中的Excel框架内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

springcloud安装rabbitmq并配置延迟队列插件的过程详解
本期主要讲解如何利用docker快速安装rabbitmq并且配置延迟队列插件，本文给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2022-05-05
详解java各种集合的线程安全
这篇文章主要介绍了详解java各种集合的线程安全,小编觉得挺不错的，这里分享给大家，供需要的朋友参考。
2017-10-10
springmvc处理模型数据ModelAndView过程详解
这篇文章主要介绍了springmvc处理模型数据ModelAndView过程详解,文中通过示例代码介绍的非常详细，对大家的学习或者工作具有一定的参考学习价值,需要的朋友可以参考下
2020-01-01
Spring Security6中@PostAuthorize注解的具体使用
@PostAuthorize是Spring Security提供的方法级安全注解,用于在方法执行后根据返回结果进行权限校验,本文就来详细的介绍一下 @PostAuthorize注解的使用,感兴趣的可以了解一下
2025-10-10
Java8 ArrayList之forEach的使用
这篇文章主要介绍了Java8 ArrayList之forEach的使用，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2021-08-08
springboot带有进度条的上传功能完整实例
这篇文章主要介绍了springboot带有进度条的上传功能,结合完整实例形式分析了springboot带进度条上传的原理、实现步骤与相关操作技巧,需要的朋友可以参考下
2019-11-11
安装IDEA和配置Maven的步骤详解
这篇文章主要介绍了安装IDEA和配置Maven的步骤详解,本文通过图文并茂的形式给大家介绍的非常详细，对大家的学习或工作具有一定的参考借鉴价值，需要的朋友可以参考下
2020-12-12
Assert.assertEquals的使用方法及注意事项说明
这篇文章主要介绍了Assert.assertEquals的使用方法及注意事项说明，具有很好的参考价值，希望对大家有所帮助。如有错误或未考虑完全的地方，望不吝赐教
2022-05-05
Springboot+WebSocket实现在线聊天功能
WebSocket协议是基于TCP的一种新的网络协议。这篇文章主要为大家介绍了如何利用Springboot和WebSocket实现在线聊天功能，感兴趣的小伙伴可以了解一下
2023-02-02
Java替换视频背景音乐的实现示例
FFmpeg 是一个强大的开源多媒体处理工具，被广泛应用于音视频的录制、转码、编辑等方面，本文主要介绍了Java替换视频背景音乐，具有一定的参考价值，感兴趣的可以了解一下
2024-03-03