SpringBoot2(七):引入easyExcel,導入導出excel

引入依賴

easyExcel依賴

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

只引入easyexcel依賴運行可能會報錯,就還需要引入poi的相關依賴,注意easyExcel和poi的版本兼容問題

<!--POI start-->
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>3.17</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>3.17</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-scratchpad</artifactId>
    <version>3.17</version>
</dependency>
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml-schemas</artifactId>
    <version>3.17</version>
</dependency>
<!--POI end-->

編寫工具類

/**
 * @Description: easyExcel工具類
 * @Author along
 * @Date 2022/9/16 17:56
 */
public class EasyExcelUtils {

    private static final Logger log = LoggerFactory.getLogger(EasyExcelUtils.class);

    /**
     * 單sheet頁導出
     *
     * @param response  HttpServletResponse對象
     * @param excelName 導出文件名
     * @param sheetName sheet名稱
     * @param clazz     類
     * @param data      數據
     * @throws Exception
     */
    public static void export(HttpServletResponse response, String excelName, String sheetName, Class clazz, List data) throws Exception {
        try {
            response.setContentType("application/vnd.ms-excel");
            response.setCharacterEncoding("utf-8");
            // 這里URLEncoder.encode可以防止中文亂碼
            excelName = URLEncoder.encode(excelName, "UTF-8");
            response.setHeader("Content-disposition", "attachment;filename=" + excelName + ExcelTypeEnum.XLSX.getValue());
            EasyExcel.write(response.getOutputStream(), clazz).sheet(sheetName).doWrite(data);
        } catch (Exception e) {
            log.error("", e);
        }
    }


    /**
     * 多sheet頁導出
     *
     * @param response
     * @param excelName     excel名稱
     * @param sheetMessages sheet信息列表
     */
    public static void exportMoreSheet(HttpServletResponse response, String excelName, List<SheetMessage> sheetMessages) {
        ExcelWriter excelWriter = null;
        try {
            // 設置響應頭信息
            response.setContentType("application/vnd.ms-excel");
            response.setCharacterEncoding("utf-8");
            excelName = URLEncoder.encode(excelName, "UTF-8"); // 這里URLEncoder.encode可以防止中文亂碼
            response.setHeader("Content-disposition", "attachment;filename=" + excelName + ExcelTypeEnum.XLSX.getValue());

            // 創建ExcelWriter對象
            excelWriter = EasyExcel.write(response.getOutputStream()).build();
            AtomicInteger count = new AtomicInteger(); // 計數器變量
            for (EasyExcelUtils.SheetMessage message : sheetMessages) {
                WriteSheet sheet = EasyExcel.writerSheet(count.get(), message.getSheetName()).head(message.getClazz()).build();
                // 寫入Sheet數據
                excelWriter.write(message.getData(), sheet);
                count.getAndIncrement();
            }

        } catch (Exception e) {
            log.error("", e);
        } finally {
            // 關閉ExcelWriter
            if (excelWriter != null) {
                excelWriter.finish();
            }
        }

    }

    @Data
    @NoArgsConstructor // 自動生成無參構造方法
    @AllArgsConstructor // 自動生成全參構造方法
    public static class SheetMessage {

        /**
         * sheet頁名稱
         */
        private String sheetName;

        /**
         * Class
         */
        private Class<?> clazz;

        /**
         * 數據
         */
        private List data;
    }
}

應用

單sheet頁excel導出

構建導出對象實體

/**
 * @Description: excel導出對象
 * @Author along
 * @Date 2022/9/16 17:11
 */
@Data
public class Demo {

    /**
     * value:定義表頭名稱,下面是簡單表頭,復雜表頭寫法:value={"aaa","bbb"}
     * index:定義位置,0代表第一列,不寫就默認從上往下排序
     */
    @ColumnWidth(20)
    @ExcelProperty(value = "學號",index = 0)  
    private Long id;

    @ColumnWidth(20)
    @ExcelProperty(value = "名字",index = 1)
    private String name;

    @ColumnWidth(20)
    @ExcelProperty(value = "性別",index = 2)
    private String gender;

    @ColumnWidth(20)
    @ExcelProperty(value = "愛好",index = 3)
    private String hobby;
}

導出邏輯代碼,下面是偽代碼,意思一下

// 獲取數據源
List<Demo> list = demoDao.list();

// 填充導出對象ExportTaskObjectVo
List<ExportTaskObjectVo> exportVos = new ArrayList<>();
for (VTopicDialTestInternetTask e : list) {
    ExportTaskObjectVo v = new ExportTaskObjectVo();
    v.setCustomersNum(e.getCustomersNum());
    v.setCustomersName(e.getCustomersName());
    v.setLineId(e.getLineId());
    v.setLineType(e.getLineType());
    exportVos.add(v);
}

// 調用工具類導出Excel
EasyExcelUtils.export(response,
        "demo", // 導出的excel文件的文件名
        "sheet1", // excel第一個sheet的名稱
        ExportTaskObjectVo.class,
        exportVos
);

完畢,單sheet頁導出是開發中最常用的,有時候我們需要導出多sheet頁的excel,如下:

多sheet頁導出

// 獲取數據源
List<Demo1> list1 = demoDao.list1();
List<Demo2> list2 = demoDao.list2();
List<Demo3> list3 = demoDao.list3();
List<Demo4> list4 = demoDao.list4();


List<EasyExcelUtils.SheetMessage> sheetMessages = new LinkedList<>();
sheetMessages.add(new EasyExcelUtils.SheetMessage("sheet1", Demo1.class, list1));
sheetMessages.add(new EasyExcelUtils.SheetMessage("sheet2", Demo2.class, list2));
sheetMessages.add(new EasyExcelUtils.SheetMessage("sheet3", Demo3.class, list3));
sheetMessages.add(new EasyExcelUtils.SheetMessage("sheet4", Demo4.class, list4));

String excelName = "output.xlsx"; // 導出文件名
EasyExcelUtils.exportMoreSheet(response, excelName, sheetMessages);

完事,導出就這樣簡單,基本一看就能用


導入Excel并解析

導入的excel模板如下:

導入excel模板

根據模板Excel內容構建與之匹配的接收類

@Data
public class DemoExcelModel {

    @ExcelProperty(value = "姓名", index = 0)
    private String name;

    @ExcelProperty(value = "愛好", index = 1)
    private String hobby;
}

下面是Controller里的接收解析邏輯

@RestController
@RequestMapping("/demo")
@CrossOrigin
@Slf4j
public class DemoController {

    @PostMapping("/parsing/excel")
    public void excel2Object(@RequestParam("file") MultipartFile file) throws IOException {
        log.info("接收并解析excel");
        InputStream inputStream = file.getInputStream();
        List<Object> excelModels = EasyExcel.read(inputStream)
                .head(DemoExcelModel.class)
                .sheet() // 設置sheet,默認讀取第一個
                .headRowNumber(1) // 設置標題所在行數
                .doReadSync();
        log.info("Excel解析完成:{}", excelModels);

        // 解析完畢,下面想怎么處理這個數據就怎么處理

        for (Object object : excelModels) {
            // 強轉
            DemoExcelModel model = (DemoExcelModel) object;
            // do something
        }
    }
}

完事

最后編輯于
?著作權歸作者所有,轉載或內容合作請聯系作者
平臺聲明:文章內容(如有圖片或視頻亦包括在內)由作者上傳并發布,文章內容僅代表作者本人觀點,簡書系信息發布平臺,僅提供信息存儲服務。
  • 序言:七十年代末,一起剝皮案震驚了整個濱河市,隨后出現的幾起案子,更是在濱河造成了極大的恐慌,老刑警劉巖,帶你破解...
    沈念sama閱讀 230,431評論 6 544
  • 序言:濱河連續發生了三起死亡事件,死亡現場離奇詭異,居然都是意外死亡,警方通過查閱死者的電腦和手機,發現死者居然都...
    沈念sama閱讀 99,637評論 3 429
  • 文/潘曉璐 我一進店門,熙熙樓的掌柜王于貴愁眉苦臉地迎上來,“玉大人,你說我怎么就攤上這事。” “怎么了?”我有些...
    開封第一講書人閱讀 178,555評論 0 383
  • 文/不壞的土叔 我叫張陵,是天一觀的道長。 經常有香客問我,道長,這世上最難降的妖魔是什么? 我笑而不...
    開封第一講書人閱讀 63,900評論 1 318
  • 正文 為了忘掉前任,我火速辦了婚禮,結果婚禮上,老公的妹妹穿的比我還像新娘。我一直安慰自己,他們只是感情好,可當我...
    茶點故事閱讀 72,629評論 6 412
  • 文/花漫 我一把揭開白布。 她就那樣靜靜地躺著,像睡著了一般。 火紅的嫁衣襯著肌膚如雪。 梳的紋絲不亂的頭發上,一...
    開封第一講書人閱讀 55,976評論 1 328
  • 那天,我揣著相機與錄音,去河邊找鬼。 笑死,一個胖子當著我的面吹牛,可吹牛的內容都是我干的。 我是一名探鬼主播,決...
    沈念sama閱讀 43,976評論 3 448
  • 文/蒼蘭香墨 我猛地睜開眼,長吁一口氣:“原來是場噩夢啊……” “哼!你這毒婦竟也來了?” 一聲冷哼從身側響起,我...
    開封第一講書人閱讀 43,139評論 0 290
  • 序言:老撾萬榮一對情侶失蹤,失蹤者是張志新(化名)和其女友劉穎,沒想到半個月后,有當地人在樹林里發現了一具尸體,經...
    沈念sama閱讀 49,686評論 1 336
  • 正文 獨居荒郊野嶺守林人離奇死亡,尸身上長有42處帶血的膿包…… 初始之章·張勛 以下內容為張勛視角 年9月15日...
    茶點故事閱讀 41,411評論 3 358
  • 正文 我和宋清朗相戀三年,在試婚紗的時候發現自己被綠了。 大學時的朋友給我發了我未婚夫和他白月光在一起吃飯的照片。...
    茶點故事閱讀 43,641評論 1 374
  • 序言:一個原本活蹦亂跳的男人離奇死亡,死狀恐怖,靈堂內的尸體忽然破棺而出,到底是詐尸還是另有隱情,我是刑警寧澤,帶...
    沈念sama閱讀 39,129評論 5 364
  • 正文 年R本政府宣布,位于F島的核電站,受9級特大地震影響,放射性物質發生泄漏。R本人自食惡果不足惜,卻給世界環境...
    茶點故事閱讀 44,820評論 3 350
  • 文/蒙蒙 一、第九天 我趴在偏房一處隱蔽的房頂上張望。 院中可真熱鬧,春花似錦、人聲如沸。這莊子的主人今日做“春日...
    開封第一講書人閱讀 35,233評論 0 28
  • 文/蒼蘭香墨 我抬頭看了看天上的太陽。三九已至,卻和暖如春,著一層夾襖步出監牢的瞬間,已是汗流浹背。 一陣腳步聲響...
    開封第一講書人閱讀 36,567評論 1 295
  • 我被黑心中介騙來泰國打工, 沒想到剛下飛機就差點兒被人妖公主榨干…… 1. 我叫王不留,地道東北人。 一個月前我還...
    沈念sama閱讀 52,362評論 3 400
  • 正文 我出身青樓,卻偏偏與公主長得像,于是被迫代替她去往敵國和親。 傳聞我的和親對象是個殘疾皇子,可洞房花燭夜當晚...
    茶點故事閱讀 48,604評論 2 380

推薦閱讀更多精彩內容