easyexcel--springboot

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";
    }

### 集成 EasyExcelSpring Boot 项目 #### 添加依赖项 为了在 Spring Boot 应用程序中使用 EasyExcel,需向 `pom.xml` 文件添加 Maven 依赖: ```xml <dependency> <groupId>com.alibaba</groupId> <artifactId>easyexcel</artifactId> <version>3.0.5</version> </dependency> ``` 此配置使得应用程序能够访问 EasyExcel 提供的功能[^1]。 #### 创建实体类映射 Excel 表头 定义 Java 类来表示每一行的数据结构。假设有一个简单的员工信息表单如下所示: ```java public class EmployeeData { @ExcelProperty("Employee ID") private String employeeId; @ExcelProperty("Name") private String name; // Getters and Setters omitted for brevity. } ``` 上述代码片段展示了如何通过注解的方式指定列名与字段之间的对应关系[^2]。 #### 编写服务层逻辑实现文件读取功能 创建一个 Service 接口及其对应的实现类用于处理业务需求。这里展示了一个简单的方法用来解析上传的 Excel 文件并将其转换为对象列表的形式返回给控制器调用方。 ```java @Service public class ExcelService { public List<EmployeeData> readExcel(MultipartFile file) throws IOException { EasyExcel.read(file.getInputStream(), EmployeeData.class, new PageReadListener<EmployeeData>(dataList -> { System.out.println(dataList); })).sheet().doRead(); return dataList; } } ``` 这段代码实现了基本的读取流程,并利用了回调机制实时获取每一页的数据集合[^3]。 #### 实现 Controller 层接口暴露 RESTful API 给前端调用者 最后一步是在 Web 控制器里编写 HTTP 请求处理器方法以便接收客户端提交过来待处理的文档资源。 ```java @RestController @RequestMapping("/api/excel") public class ExcelController { @Autowired private ExcelService excelService; @PostMapping("/upload") public ResponseEntity<List<EmployeeData>> uploadFile(@RequestParam("file") MultipartFile file){ try{ List<EmployeeData> result = this.excelService.readExcel(file); return ResponseEntity.ok(result); } catch (Exception e){ return ResponseEntity.status(HttpStatus.INTERNAL_SERVER_ERROR).build(); } } } ``` 以上就是完整的基于 Spring BootEasyExcel 的 Excel 文档导入解决方案[^4]。
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值