Alibaba EasyExcel初體驗

小樣樣樣樣樣樣 2021-04-29

展開全文

簡介

EasyExcel是一個基于Java的簡單、省內(nèi)存的讀寫Excel的開源項目。在盡可能節(jié)約內(nèi)存的情況下支持讀寫百M的Excel。相對于Apache POI來說，EasyExcel是從磁盤上一行行的讀取數(shù)據(jù)，然后逐個解析，避免將大量數(shù)據(jù)加載到內(nèi)存從而導(dǎo)致OOM。

相關(guān)依賴：

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

<!-- 可選 -->
<dependency>
<groupId>org.projectlombok</groupId>
<artifactId>lombok</artifactId>
<version>1.18.12</version>
<scope>provided</scope>
</dependency>

Excel導(dǎo)入

需要導(dǎo)入的數(shù)據(jù)：

Model類：


@Data
public class SchoolData {

    @ExcelProperty(value = "地址")
    private String address;

    @ExcelProperty(value = "學(xué)校名稱")
    private String schoolName;

    @ExcelProperty(value = "郵政編碼")
    private String postcode;

    @ExcelProperty(value = "收集時間")
    private Date collectDate;
}

使用@ExcelProperty注解時，可以使用兩種方式將數(shù)據(jù)列和屬性進(jìn)行綁定：

通過value指定名稱，將名稱對應(yīng)的excel列的數(shù)據(jù)綁定到屬性。
通過index指定下標(biāo)，將下標(biāo)對應(yīng)的excel列的數(shù)據(jù)綁定到屬性。

在不使用@ExcelProperty注解時，默認(rèn)Model類屬性和excel列數(shù)據(jù)按照先后順序進(jìn)行綁定的。

監(jiān)聽器：

import com.alibaba.excel.context.AnalysisContext;
import com.alibaba.excel.event.AnalysisEventListener;
import java.util.ArrayList;
import java.util.List;
import java.util.Map;

public class SchoolDataListener extends AnalysisEventListener<SchoolData> {

    List<SchoolData> schoolDataList = new ArrayList<>();

    //需要傳參時，通過構(gòu)造方法傳進(jìn)來
    public SchoolDataListener() {
    }

    /**
     * 每解析一行數(shù)據(jù)都會進(jìn)行調(diào)用
     */
    @Override
    public void invoke(SchoolData data, AnalysisContext context) {
        //一般數(shù)據(jù)量大的時候應(yīng)該分批處理，防止數(shù)據(jù)全部加載到內(nèi)存，導(dǎo)致OOM。
        schoolDataList.add(data);
    }

    /**
     * 數(shù)據(jù)全部解析完成時調(diào)用
     */
    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        System.out.println("數(shù)據(jù)讀取完畢:");
        schoolDataList.stream().forEach(System.out::println);
    }

    /**
     * 每解析一行表頭都會進(jìn)行調(diào)用
     */
    @Override
    public void invokeHeadMap(Map<Integer, String> headMap, AnalysisContext context) {
        System.out.println("表頭:");
        headMap.forEach((k, v) -> System.out.println(v));
        System.out.println();
    }
}

導(dǎo)入測試：

導(dǎo)入有以下兩種寫法，一般使用簡寫的方式就行，當(dāng)需要實現(xiàn)復(fù)雜的功能時可能會需要另外一種復(fù)雜的寫法。

@Test
public void importExcel() {
ExcelReader excelReader = null;
try {
excelReader = EasyExcel.read("F:\\測試數(shù)據(jù).xlsx", SchoolData.class, new SchoolDataListener()).build();
ReadSheet readSheet = EasyExcel.readSheet(0).build();
excelReader.read(readSheet);
} finally {
if (excelReader != null) {
// 這里千萬別忘記關(guān)閉，讀的時候會創(chuàng)建臨時文件，到時磁盤會崩的
excelReader.finish();
}
}
}

@Test
public void importExcelSimple() {
//sheet() 默認(rèn)讀取第一個sheet
EasyExcel.read("F:\\測試數(shù)據(jù).xlsx", SchoolData.class, new SchoolDataListener()).sheet().doRead();
}

輸出結(jié)果：

表頭:
學(xué)校名稱
地址
郵政編碼
收集時間

數(shù)據(jù)讀取完畢:
SchoolData(address=晉寧縣古城鎮(zhèn)舊寨村　　, schoolName=晉寧縣古城鎮(zhèn)古城中學(xué), postcode=650604, collectDate=Sun Jan 05 00:00:00 CST 2020)
SchoolData(address=云南省昆明市晉寧縣二街鄉(xiāng)老高村　　, schoolName=晉寧縣二街中學(xué), postcode=650608, collectDate=Mon Jan 06 00:00:00 CST 2020)
SchoolData(address=云南省昆明市晉寧縣晉城鎮(zhèn)寺林街　　, schoolName=晉寧縣晉城中學(xué), postcode=650605, collectDate=Tue Jan 07 00:00:00 CST 2020)
SchoolData(address=云南省晉寧縣六街鄉(xiāng)中學(xué)　　, schoolName=晉寧縣六街中學(xué), postcode=650609, collectDate=Wed Jan 08 00:00:00 CST 2020)
SchoolData(address=云南省昆明市晉寧縣新街鄉(xiāng)文河村　　, schoolName=晉寧縣新街中學(xué), postcode=650606, collectDate=Thu Jan 09 00:00:00 CST 2020)
SchoolData(address=晉寧縣中和鄉(xiāng)普照路　　, schoolName=晉寧縣中和中學(xué), postcode=650600, collectDate=Fri Jan 10 00:00:00 CST 2020)
SchoolData(address=云南省昆明市晉寧縣上蒜鄉(xiāng)上蒜中學(xué)　　, schoolName=晉寧縣上蒜鄉(xiāng)上蒜中學(xué), postcode=650607, collectDate=Sat Jan 11 00:00:00 CST 2020)
SchoolData(address=云南省昆明市晉寧縣化樂鄉(xiāng)化樂村　　, schoolName=晉寧縣化樂鄉(xiāng)中學(xué), postcode=650611, collectDate=Sun Jan 12 00:00:00 CST 2020)
SchoolData(address=晉寧縣夕陽鄉(xiāng)夕陽街夕陽民族中學(xué)　　, schoolName=晉寧縣夕陽民族中學(xué), postcode=650603, collectDate=Mon Jan 13 00:00:00 CST 2020)
SchoolData(address=云南省昆明市晉寧縣寶峰鎮(zhèn)古城村委會小古城村　　, schoolName=晉寧縣寶峰鎮(zhèn)寶峰中學(xué), postcode=650601, collectDate=Tue Jan 14 00:00:00 CST 2020)
SchoolData(address=晉寧縣雙河鄉(xiāng)椿樹營　　, schoolName=晉寧縣雙河民族中學(xué), postcode=650602, collectDate=Wed Jan 15 00:00:00 CST 2020)
SchoolData(address=昆明市富民縣永定鎮(zhèn)環(huán)城南路7號永定中學(xué)　　, schoolName=富民縣永定中學(xué), postcode=650400, collectDate=Thu Jan 16 00:00:00 CST 2020)
SchoolData(address=富民縣永定鎮(zhèn)大西山村　　, schoolName=富民縣勤勞中學(xué), postcode=650400, collectDate=Fri Jan 17 00:00:00 CST 2020)
SchoolData(address=富民縣大營鎮(zhèn)大營街16號　　, schoolName=富民縣大營中學(xué), postcode=650400, collectDate=Sat Jan 18 00:00:00 CST 2020)
SchoolData(address=云南省昆明市羅免鄉(xiāng)者北村委會者北街　　, schoolName=富民縣第二中學(xué), postcode=650401, collectDate=Sun Jan 19 00:00:00 CST 2020)

Excel導(dǎo)出

模擬生成數(shù)據(jù)：

public class DataGenerate {

    /**
     * 數(shù)據(jù)生成
     */
    public static List<SchoolData> data() {
        List<SchoolData> schoolDataList = new ArrayList<>();
        SchoolData schoolData;
        for (int i = 0; i < 15; i++) {
            schoolData = new SchoolData();
            schoolData.setSchoolName("第" + i + "XXX中學(xué)");
            schoolData.setAddress("云南省昆明市XXXXX");
            schoolData.setPostcode("123456");
            schoolData.setCollectDate(new Date());
            schoolDataList.add(schoolData);
        }

        return schoolDataList;
    }
}

測試導(dǎo)出：

同導(dǎo)入，導(dǎo)出也有以下兩種寫法。LongestMatchColumnWidthStyleStrategy用來設(shè)置自動列寬，如果需要設(shè)置列寬、行高等屬性，可以在Model類上添加對應(yīng)注解進(jìn)行設(shè)置，如@ColumnWidth、@ContentRowHeight、@HeadRowHeight等等。

@Test
public void exportExcel() {
ExcelWriter excelWriter = null;
try {
excelWriter = EasyExcel.write("F:\\測試數(shù)據(jù)_副本.xlsx", SchoolData.class).build();
WriteSheet writeSheet = EasyExcel.writerSheet("學(xué)校數(shù)據(jù)").registerWriteHandler(new LongestMatchColumnWidthStyleStrategy()).build();
excelWriter.write(DataGenerate.data(), writeSheet);
} finally {
// 千萬別忘記finish 會幫忙關(guān)閉流
if (excelWriter != null) {
excelWriter.finish();
}
}
}

@Test
public void exportExcelSimple() {
EasyExcel.write("F:\\測試數(shù)據(jù)_副本.xlsx", SchoolData.class).registerWriteHandler(new LongestMatchColumnWidthStyleStrategy()).sheet("學(xué)校數(shù)據(jù)").doWrite(DataGenerate.data());
}

導(dǎo)出結(jié)果：

基于Excel模板的填充

模板：

{} 代表普通變量 {.} 代表是list的變量。

模板填充測試：

@Test
public void excelTemplateFill() {
ExcelWriter excelWriter = EasyExcel.write("F:\\測試數(shù)據(jù)_副本3.xlsx").withTemplate("F:\\模板.xlsx").build();
WriteSheet writeSheet = EasyExcel.writerSheet().build();
FillConfig fillConfig = FillConfig.builder().forceNewRow(Boolean.TRUE).build();

//填充列表數(shù)據(jù)
excelWriter.fill(DataGenerate.data(), fillConfig, writeSheet);

//填充普通數(shù)據(jù)
Map<String, Object> map = new HashMap<String, Object>();
map.put("name", "狗子");
map.put("date", "2021-02-19");
excelWriter.fill(map, writeSheet);
excelWriter.finish();
}

填充結(jié)果：

Web中的導(dǎo)入和導(dǎo)出

import com.alibaba.excel.EasyExcel;
import com.alibaba.excel.write.style.column.LongestMatchColumnWidthStyleStrategy;
import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RestController;
import org.springframework.web.multipart.MultipartFile;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.net.URLEncoder;

@RestController
public class SchoolDataController {

    /**
     * 導(dǎo)入Excel
     */
    @PostMapping("/import")
    public String importExcel(MultipartFile file) throws IOException {
        EasyExcel.read(file.getInputStream(), SchoolData.class, new SchoolDataListener()).sheet().doRead();
        return "success";
    }

    /**
     * 導(dǎo)出Excel
     */
    @GetMapping("/export")
    public void exportExcel(HttpServletResponse response) throws IOException {
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        // 這里URLEncoder.encode可以防止中文亂碼 當(dāng)然和easyexcel沒有關(guān)系
        String fileName = URLEncoder.encode("測試", "UTF-8").replaceAll("\\+", "%20");
        response.setHeader("Content-disposition", "attachment;filename*=utf-8''" + fileName + ".xlsx");
        // 這里需要設(shè)置不關(guān)閉流
        EasyExcel.write(response.getOutputStream(), SchoolData.class).autoCloseStream(Boolean.FALSE).registerWriteHandler(new LongestMatchColumnWidthStyleStrategy()).sheet("學(xué)校數(shù)據(jù)").doWrite(DataGenerate.data());
    }
}

參考：官方文檔