ExcelKit

简介: 简单、好用且轻量级的海量Excel文件导入导出解决方案。

POM.xml

<dependency>
    <groupId>com.wuwenze</groupId>
    <artifactId>ExcelKit</artifactId>
    <version>2.0.72</version>
</dependency>

ExcelKit 2.0.72 要求poi 至少3.17版本

ExcelKit 2.0.6 要求poi 不能高于3.10版本  (老项目推荐引入此版本

示例

1. ExcelMapping (配置Excel与实体之间的映射关系)

现支持两种配置方式: 注解 或者 XML

@Excel("用户信息")
public class User {
  @ExcelField(value = "编号", width = 30)
  private Integer userId;
  @ExcelField(//value = "用户名",//required = true,//validator = UsernameValidator.class,//
      comment = "请填写用户名,最大长度为12,且不能重复"
  )
  private String username;
  @ExcelField(value = "密码", required = true, maxLength = 32)
  private String password;
  @ExcelField(value = "邮箱", validator = UserEmailValidator.class)
  private String email;
  @ExcelField(//value = "性别",//readConverterExp = "未知=0,男=1,女=2",//writeConverterExp = "0=未知,1=男,2=女",//options = SexOptions.class//
  )
  private Integer sex;
  @ExcelField(//value = "用户组",//name = "userGroup.name",//options = UserGroupNameOptions.class
  )
  private UserGroup userGroup;
  @ExcelField(value = "创建时间", dateFormat = "yyyy/MM/dd HH:mm:ss")
  private Date createAt;
  @ExcelField(//value = "自定义字段",//maxLength = 80,//comment = "可以乱填,但是长度不能超过80,导入时最终会转换为数字",//writeConverter = CustomizeFieldWriteConverter.class,// 写文件时,将数字转字符串
      readConverter = CustomizeFieldReadConverter.class// 读文件时,将字符串转数字
  )
  private Integer customizeField;
  // Getter and Setter ..
}


XML 配置方式, 必须需将 xml 文件放置在classpath:excel-mapping/{entityClassName}.xml

public class User2 {
  private Integer userId;
  private String username;
  private String password;
  private String email;
  private Integer sex;
  private UserGroup userGroup;
  private Date createAt;
  private Integer customizeField;
  // Getter and Setter ..
}

classpath:excel-mapping/com.wuwenze.entity.User2.xml

<?xml version="1.0" encoding="UTF-8"?>
<excel-mapping name="用户信息">
    <property name="userId" column="编号" width="30"/>
    <property
        name="username"
        column="用户名"
        required="true"
        validator="com.wuwenze.validator.UsernameValidator"
        comment="请填写用户名,最大长度为12,且不能重复"
      />
      <property name="password" column="密码" required="true" maxLength="32"/>
      <property name="email" column="邮箱" validator="com.wuwenze.validator.UserEmailValidator"/><property
        name="sex"
        column="性别"
        readConverterExp="未知=0,男=1,女=2"
        writeConverterExp="0=未知,1=男,2=女"
        options="com.wuwenze.options.SexOptions"
      />
      <property name="userGroup.name" column="用户组" options="com.wuwenze.options.UserGroupNameOptions"/><property name="createAt" column="创建时间" dateFormat="yyyy/MM/dd HH:mm:ss"/><property
        name="customizeField"
        column="自定义字段"
        maxLength="80"
        comment="可以乱填,但是长度不能超过80,导入时最终会转换为数字"
        writeConverter="com.wuwenze.converter.CustomizeFieldWriteConverter"
        readConverter="com.wuwenze.converter.CustomizeFieldReadConverter"
      />
  </excel-mapping>

以上两种方式2选一即可, ExcelKit 会优先装载 XML 配置文件.


2. 实现相关的转换器

通过实现com.wuwenze.poi.config.Options自定义导入模板的下拉框数据源。


public class UserGroupNameOptions implements Options {
  @Overridepublic String[] get() {
    return new String[]{"管理组", "普通会员组", "游客"};
  }
}
public class UsernameValidator implements Validator {
  final List<String> ERROR_USERNAME_LIST = Lists.newArrayList(
      "admin", "root", "master", "administrator", "sb"
  );
  @Overridepublic String valid(Object o) {
    String username = (String) o;
    if (username.length() > 12) {
      return "用户名不能超过12个字符。";
    }
    if (ERROR_USERNAME_LIST.contains(username)) {
      return "用户名非法,不允许使用。";
    }
    return null;
  }
}
public class CustomizeFieldWriteConverter implements WriteConverter {
  /**
   * 写文件时,将值进行转换(此处示例为将数值拼接为指定格式的字符串)
   */@Overridepublic String convert(Object o) throws ExcelKitWriteConverterException {
    return (o + "_convertedValue");
  }
}
public class CustomizeFieldReadConverter implements ReadConverter {
  /**
   * 读取单元格时,将值进行转换(此处示例为计算单元格字符串char的总和)
   */@Overridepublic Object convert(Object o) throws ExcelKitReadConverterException {
    String value = (String) o;
    int convertedValue = 0;
    for (char c : value.toCharArray()) {
      convertedValue += Integer.valueOf(c);
    }
    return convertedValue;
  }
}

3. 一行代码构建 Excel 导入模板

使用 ExcelKit 提供的API 构建导入模板, 会根据配置生成批注, 下拉框等

// 生成导入模板(含3条示例数据)@RequestMapping(value = "/downTemplate", method = RequestMethod.GET)
public void downTemplate(HttpServletResponse response) {
  List<User> userList = DbUtil.getUserList(3);
  ExcelKit.$Export(User.class, response).downXlsx(userList, true);
}

网络异常,图片无法展示
|


网络异常,图片无法展示
|


4. 执行文件导入

使用边读边处理的方式, 无需担心内存溢出, 也不用理会 Excel 文件到底有多大.

@RequestMapping(value = "/importUser", method = RequestMethod.POST)
public ResponseEntity<?> importUser(@RequestParam MultipartFile file)
    throws IOException {
  long beginMillis = System.currentTimeMillis();
  List<User> successList = Lists.newArrayList();
  List<Map<String, Object>> errorList = Lists.newArrayList();
  ExcelKit.$Import(User.class)
      .readXlsx(file.getInputStream(), new ExcelReadHandler<User>() {
        @Overridepublic void onSuccess(int sheetIndex, int rowIndex, User entity) {
          successList.add(entity); // 单行读取成功,加入入库队列。
        }
        @Overridepublic void onError(int sheetIndex, int rowIndex,
            List<ExcelErrorField> errorFields) {
          // 读取数据失败,记录了当前行所有失败的数据
          errorList.add(MapUtil.newHashMap(//"sheetIndex", sheetIndex,//"rowIndex", rowIndex,//"errorFields", errorFields//
          ));
        }
      });
  // TODO: 执行successList的入库操作。return ResponseEntity.ok(MapUtil.newHashMap(
      "data", successList,
      "haveError", !CollectionUtil.isEmpty(errorList),
      "error", errorList,
      "timeConsuming", (System.currentTimeMillis() - beginMillis) / 1000L
  ));
}


全部导入成功示例:

网络异常,图片无法展示
|

部分导入失败示例(包含错误信息):

网络异常,图片无法展示
|


5. 一行代码执行 Excel 批量导出.

基于 Apache POI SXSSF 系列API实现导出, 大幅优化导出性能.

@RequestMapping(value = "/downXlsx", method = RequestMethod.GET)
public void downXlsx(HttpServletResponse response) {
  long beginMillis = System.currentTimeMillis();
  List<User> userList = DbUtil.getUserList(100000);// 生成10w条测试数据ExcelKit.$Export(User.class, response).downXlsx(userList, false);
  log.info("#ExcelKit.$Export success, size={},timeConsuming={}s",//
      userList.size(), (System.currentTimeMillis() - beginMillis) / 1000L);
}

网络异常,图片无法展示
|

需要注意的是,虽然ExcelKit针对导出做了大量优化,但导出数据也需要量力而行。

网络异常,图片无法展示
|

目录
相关文章
|
7月前
|
Java API Maven
pom文件的<scope>标签详细含义是什么
【4月更文挑战第13天】pom文件的<scope>标签详细含义是什么
464 3
为什么两个执行很快的SQL,union之后特别慢
UNION获取两个数据集并返回唯一重叠。换句话说,它花费时间去除重复。 所以如果只是想取两个SQL的结果,改成使用union all,不会有去重操作 如果还是想去重,可以在union all之后再包一层查询,使用distinct
|
存储 缓存 前端开发
关于JWT Token 自动续期的解决方案
在前后端分离的开发模式下,前端用户登录成功后后端服务会给用户颁发一个jwt token。前端(如vue)在接收到jwt token后会将token存储到LocalStorage中。
1863 0
|
数据采集 前端开发 开发者
滑动拼图验证码的原理和破解方法~
滑动拼图验证码的原理和破解方法~
2571 0
滑动拼图验证码的原理和破解方法~
|
缓存 Perl
如何修改openeuler为阿里源
修改openeuler为阿里源
4457 0
|
5月前
Element UI 【表格合计】el-table 实战范例 -- 添加单位,自定义计算逻辑
Element UI 【表格合计】el-table 实战范例 -- 添加单位,自定义计算逻辑
431 0
|
5月前
|
存储 JSON 关系型数据库
mysql中find_in_set()函数用法详解及增强函数
总结而言,`FIND_IN_SET()`是MySQL中处理由逗号分隔的字符串列表的一种便捷方法,尤其适用于列表相对较短且不经常更改的场景。然而,对于更为复杂的需要高性能和可扩展性的数据库设计,它可能不是最优选择,应考虑使用更加正规化的数据库结构。
588 2
mysql中find_in_set()函数用法详解及增强函数
|
监控 Dubbo 搜索推荐
No application config found or it‘s not a valid config! Please add <dubbo:application name=“...“ />
No application config found or it‘s not a valid config! Please add <dubbo:application name=“...“ />
1297 1
|
7月前
|
弹性计算 运维 Nacos
nacos常见问题之配置中心加密
Nacos是阿里云开源的服务发现和配置管理平台,用于构建动态微服务应用架构;本汇总针对Nacos在实际应用中用户常遇到的问题进行了归纳和解答,旨在帮助开发者和运维人员高效解决使用Nacos时的各类疑难杂症。
261 4
|
JavaScript
Vue项目实战(05)-多环境配置
Vue项目实战(05)-多环境配置
254 1