1.官网地址:EasyExcel官方文档 - 基于Java的Excel处理工具 | Easy Excel
EasyExcel 是一个基于 Java 的、快速、简洁、解决大文件内存溢出的 Excel 处理工具。他能让你在不用考虑性能、内存的等因素的情况下,快速完成 Excel 的读、写等功能
常用注解:
@ColumnWith(列宽)` `@ColumnWidth(全局列宽)` `@ExcelProperty(字段配置)` `@HeadFontStyle(头样式)` `@HeadRowHeight(标题高度)` `@ContentFontStyle(内容字体样式)` `@ContentRowHeight(内容高度)` `@ExcelProperty` `必要的一个注解,注解中有三个参数value,index,converter分别代表列明,列序号,数据转换方式 value和index只能二选一,通常不用设置converter` `1.value 通过标题文本对应` `2.index 通过文本行号对应` `3.converter 转换器,通常入库和出库转换使用,如性别入库0和1,出库男和女
2.easyexcel写操作
1.导入依赖:
<dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>最新版本</version> </dependency> 2.创建实体类
@Data @AllArgsConstructor @NoArgsConstructor public class ExcelDemo { //表头 @ExcelProperty("编号") private Integer id; @ExcelProperty("姓名") private String name; @ExcelProperty("年龄") private Integer age; @ExcelIgnore//不会写入excel private String address; } 3.写操作
public class Write { public static void main(String[] args) { String fileName = "D:\\javaidea\\gitpull\\springboot111.xlsx"; // 这里 需要指定写用哪个class去写,然后写到第一个sheet,名字为模板 然后文件流会自动关闭 // 如果这里想使用03 则 传入excelType参数即可 List<ExcelDemo> list=new ArrayList<>(); list.add(new ExcelDemo(1,"张明喆",20,"郑州")); list.add(new ExcelDemo(2,"黄启龙",23,"郑州")); list.add(new ExcelDemo(3,"贾善领",23,"郑州")); list.add(new ExcelDemo(4,"冯旭东",22,"郑州")); EasyExcel.write(fileName, ExcelDemo.class).sheet("模板").doWrite(list); } }
web中的写:
@RestController
public class UploadController {
@GetMapping("download")
public void load(HttpServletResponse response) throws IOException {
List<ExcelDemo> aaa=new ArrayList<>();
aaa.add(new ExcelDemo(1,"张明喆",20,"郑州"));
aaa.add(new ExcelDemo(2,"黄启龙",23,"郑州"));
aaa.add(new ExcelDemo(3,"贾善领",23,"郑州"));
aaa.add(new ExcelDemo(4,"冯旭东",22,"郑州"));
download(response,"qy163测试",aaa);
}
public void download(HttpServletResponse response,String title,List<?> data) throws IOException {
// 这里注意 有同学反应使用swagger 会导致各种问题,请直接用浏览器或者用postman
response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
response.setCharacterEncoding("utf-8");
// 这里URLEncoder.encode可以防止中文乱码 当然和easyexcel没有关系
String fileName = URLEncoder.encode(title, "UTF-8").replaceAll("\\+", "%20");
response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
EasyExcel.write(response.getOutputStream(), ExcelDemo.class).sheet("模板").doWrite(data);
}
}
3.easyexcel读操作
//监听器
@Slf4j
public class DemoDataListener implements ReadListener<ExcelDemo> {
/**
* 每隔5条存储数据库,实际使用中可以100条,然后清理list ,方便内存回收
*/
private static final int BATCH_COUNT = 3;
/**
* 缓存的数据
*/
private List<ExcelDemo> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
/**
* 假设这个是一个DAO,当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
*/
private ExcelDao demoDAO;
public DemoDataListener() {
// 这里是demo,所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数
demoDAO = new ExcelDao();
}
/**
* 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来
*
* @param demoDAO
*/
public DemoDataListener(ExcelDao demoDAO) {
this.demoDAO = demoDAO;
}
/**
* 这个每一条数据解析都会来调用
*
* @param data one row value. Is is same as {@link AnalysisContext#readRowHolder()}
* @param context
*/
@Override
public void invoke(ExcelDemo data, AnalysisContext context) {
log.info("解析到一条数据:{}", JSON.toJSONString(data));
cachedDataList.add(data);
// 达到BATCH_COUNT了,需要去存储一次数据库,防止数据几万条数据在内存,容易OOM
if (cachedDataList.size() >= BATCH_COUNT) {
saveData();
// 存储完成清理 list
cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
}
}
/**
* 所有数据解析完成了 都会来调用
*
* @param context
*/
@Override
public void doAfterAllAnalysed(AnalysisContext context) {
// 这里也要保存数据,确保最后遗留的数据也存储到数据库
saveData();
log.info("所有数据解析完成!");
}
/**
* 加上存储数据库
*/
private void saveData() {
log.info("{}条数据,开始存储数据库!", cachedDataList.size());
demoDAO.save(cachedDataList);
log.info("存储数据库成功!");
}
}
//持久层
/**
* 假设这个是你的DAO存储。当然还要这个类让spring管理,当然你不用需要存储,也不需要这个类。
**/
public class ExcelDao {
public void save(List<ExcelDemo> list) {
// 如果是mybatis,尽量别直接调用多次insert,自己写一个mapper里面新增一个方法batchInsert,所有数据一次性插入
}
}
//测试
public class TestRead {
public static void main(String[] args) {
String fileName = "D:\\javaidea\\gitpull\\springboot111.xlsx";
// 这里 需要指定读用哪个class去读,然后读取第一个sheet 文件流会自动关闭
EasyExcel.read(fileName, ExcelDemo.class, new DemoDataListener()).sheet().doRead();
}
}
web中的读(连接数据库):
1.引入依赖 <dependency> <groupId>com.baomidou</groupId> <artifactId>mybatis-plus-boot-starter</artifactId> <version>3.5.3</version> </dependency> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> </dependency>
//实体类
@Data
@AllArgsConstructor
@NoArgsConstructor
public class Users {
@TableId
@ExcelProperty("编号")
private Integer id;
@ExcelProperty("姓名")
private String name;
@ExcelProperty("年龄")
private Integer age;
}
//mapper接口
@Mapper
public interface UserMapper extends BaseMapper<Users> {
void batchSave(List<Users> cachedDataList);
}
UserMapper.xml配置
<?xml version="1.0" encoding="UTF-8" ?>
<!DOCTYPE mapper PUBLIC "-//mybatis.org//DTD Mapper 3.0//EN"
"http://mybatis.org/dtd/mybatis-3-mapper.dtd">
<!--namesapce的内容必须和对应的接口路径映射-->
<mapper namespace="com.sws.mapper.UserMapper">
<insert id="batchSave">
insert into users values
<foreach collection="list" item="users" separator=",">
(#{users.id},#{users.name},#{users.age})
</foreach>
</insert>
</mapper>
监听器:
@Slf4j
public class UserDataListener implements ReadListener<Users> {
/**
* 每隔5条存储数据库,实际使用中可以100条,然后清理list ,方便内存回收
*/
private static final int BATCH_COUNT = 100;
/**
* 缓存的数据
*/
private List<Users> cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
/**
* 假设这个是一个DAO,当然有业务逻辑这个也可以是一个service。当然如果不用存储这个对象没用。
*/
private UserMapper userDao;
public UserDataListener() {
// 这里是demo,所以随便new一个。实际使用如果到了spring,请使用下面的有参构造函数
}
/**
* 如果使用了spring,请使用这个构造方法。每次创建Listener的时候需要把spring管理的类传进来
*
* @param userDao
*/
public UserDataListener(UserMapper userDao) {
this.userDao = userDao;
}
/**
* 这个每一条数据解析都会来调用
*
* @param data one row value. Is is same as {@link AnalysisContext#readRowHolder()}
* @param context
*/
@Override
public void invoke(Users data, AnalysisContext context) {
log.info("解析到一条数据:{}", JSON.toJSONString(data));
cachedDataList.add(data);
// 达到BATCH_COUNT了,需要去存储一次数据库,防止数据几万条数据在内存,容易OOM
if (cachedDataList.size() >= BATCH_COUNT) {
saveData();
// 存储完成清理 list
cachedDataList = ListUtils.newArrayListWithExpectedSize(BATCH_COUNT);
}
}
/**
* 所有数据解析完成了 都会来调用
*
* @param context 120---》100 20====》
*/
@Override
public void doAfterAllAnalysed(AnalysisContext context) {
// 这里也要保存数据,确保最后遗留的数据也存储到数据库
log.info("~~~~~~~~~~~~~~~~~~~~~~~~~");
saveData();
log.info("所有数据解析完成!");
}
/**
* 加上存储数据库
*/
private void saveData() {
log.info("{}条数据,开始存储数据库!", cachedDataList.size());
userDao.batchSave(cachedDataList);
log.info("存储数据库成功!");
}
}
controller:
@Autowired
private UserMapper userMapper;
@PostMapping("upload2")
@ResponseBody
public String upload2(MultipartFile file) throws IOException {
EasyExcel.read(file.getInputStream(), Users.class, new UserDataListener(userMapper)).sheet().doRead();
return "success";
}