EasyExcel根据模板生成excel文件【xls、xlsx】

news2024/11/15 12:59:47

1、简介
如下图所示，template目录下是准备好的模板，export目录下是生成数据文件。我们这里以第一个模板《theUser蒸汽历史数据.xls》为例进行测试，theUser为占位符，生成的文件中会被替换成对应的用户名。

我这里的代码逻辑是根据选取的用户、起始时间导出用户的历史数据，一个用户一个excel文件，所有用户数据文件在一个目录下，最后把这个目录再压缩成zip，最后用户点击导出的就是这个压缩文件。
———————————————

提示：红色框框都是使用到的，其它的不用管，这里使用的 EasyExcel 所以需要引入依赖：如下

 <!-- knife4j -->
        <dependency>
            <groupId>com.github.xiaoymin</groupId>
            <artifactId>knife4j-spring-boot-starter</artifactId>
            <version>3.0.3</version>
        </dependency>

        <dependency>
            <groupId>com.alibaba</groupId>
            <artifactId>easyexcel</artifactId>
            <version>2.2.6</version>
        </dependency>

2、模板格式

占位符这里分两种：

{字段名} ：{theUser} 和 {reportDate}
{自定义名称.字段名}：数据类字段占位符，字段对应entity文件夹中的HistoryData对象的字段，hisData在代码中定义。

HistoryData对象：如下

package com.example.fengqing.ExcelTemplates.entity;

import lombok.AllArgsConstructor;
import lombok.Builder;
import lombok.Data;
import lombok.NoArgsConstructor;

/**
 * @author FengQing
 * @program fengqing
 * @description
 * @date 2024/03/19
 */
@AllArgsConstructor
@NoArgsConstructor
@Data
@Builder
public class HistoryData {

    // 时间
    private String time;

    // 温度
    private Double temp;

    // 压力
    private Double press;

    // 瞬时流量
    private Double insFlow;

    // 累计流量
    private Double accFlow;

    // 瞬时热量
    private Double insHeat;

    // 累计热量
    private Double accHeat;
}

3、这里为方便没有编写impl业务层，直接写在Controller 层（一般情况下不建议在Controller层写业务

package com.example.fengqing.ExcelTemplates.controller;

import cn.hutool.core.date.DateUtil;
import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.ExcelWriter;
import com.alibaba.excel.write.metadata.WriteSheet;
import com.alibaba.excel.write.metadata.fill.FillConfig;
import com.alibaba.excel.write.metadata.fill.FillWrapper;
import com.example.fengqing.ExcelTemplates.ExcelGenerator;
import com.example.fengqing.ExcelTemplates.entity.HistoryData;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RestController;
import javax.servlet.http.HttpServletResponse;
import java.io.FileNotFoundException;
import java.io.IOException;
import java.io.InputStream;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author FengQing
 * @program fengqing
 * @description
 * @date 2024/03/20
 */
@Slf4j
@RestController
@RequestMapping("/template")
public class TemplatesController {

    /**
     * 指定模板下载
     * @param response
     * @throws IOException
     */
    @PostMapping("/downFrozenTemplate")
    public void downFrozenTemplate(HttpServletResponse response) throws IOException {
        try {
            String reportDate = DateUtil.date().toString("yyyy年MM月dd日");
　　　　　　　// 获取resources/templates目录下的模板文件
            InputStream templateStream = TemplatesController.class.getResourceAsStream("/templates/theUser蒸汽历史数据.xlsx");
            if (templateStream == null) {
                throw new FileNotFoundException("未找到模板文件");
            }
            String resultFileName = "蒸汽模板.xlsx";
            // 生成目标文件
            ExcelWriter excelWriter = EasyExcel.write(response.getOutputStream()).withTemplate(templateStream).build();
            WriteSheet writeSheet = EasyExcel.writerSheet().build();
            // 每次都会重新生成新的一行，而不是使用下面的空行
            FillConfig fillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();
            // 替换第一种占位符
            Map<String, Object> map = new HashMap<>();
            map.put("theUser", "测试有限公司");
            map.put("reportDate", reportDate);
            excelWriter.fill(map, writeSheet);
            // 第二种占位符替换，这里定义了 hisData
            excelWriter.fill(new FillWrapper("thsData", hisData()), fillConfig, writeSheet);
            excelWriter.finish();
            // 设置响应头
            response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
            response.setCharacterEncoding("utf-8");
            response.setHeader("Content-Disposition", "attachment; filename=\"" + resultFileName + "\"");
            // 关闭模板流
            templateStream.close();
        } catch (FileNotFoundException e) {
            // 处理文件未找到异常
            response.setStatus(HttpServletResponse.SC_NOT_FOUND);
            // 返回适当的错误消息
            response.getWriter().write("未找到模板文件");
        } catch (Exception e) {
            // 处理其他异常
            response.setStatus(HttpServletResponse.SC_INTERNAL_SERVER_ERROR);
            // 返回适当的错误消息
            response.getWriter().write("内部服务器错误");
        }
    }

    private static List<HistoryData> hisData(){
        List<HistoryData> resList = new ArrayList<>();
        String today = DateUtil.now();
        String yesterday = DateUtil.yesterday().toString();
        HistoryData yesData = HistoryData.builder()
                .time(today)
                .temp(34.211)
                .press(1.222)
                .insFlow(34.211)
                .accFlow(233.125)
                .insHeat(20.532)
                .accHeat(112.562)
                .build();
        HistoryData nowData = HistoryData.builder()
                .time(yesterday)
                .temp(34.211)
                .press(1.222)
                .insFlow(34.211)
                .accFlow(233.125)
                .insHeat(20.532)
                .accHeat(112.562)
                .build();
        resList.add(yesData);
        resList.add(nowData);
        return resList;
    }

}

4、以上代码已完成，接下来使用 postman 来测试，如图：