easyexcel快速入門

一 前言

本篇是EasyExcel快速入門知識,講解如何讀取,寫入excel ,並給出了簡單web示例;爲何要使用easyexcel;緣由是相比於poi,easyexcel更加輕量級,讀取寫入API方便,而且在工做中佔用內存較小;java

官方描述以下:git

Java解析、生成Excel比較有名的框架有Apache poi、jxl。但他們都存在一個嚴重的問題就是很是的耗內存,poi有一套SAX模式的API能夠必定程度的解決一些內存溢出的問題,但POI仍是有一些缺陷,好比07版Excel解壓縮以及解壓後存儲都是在內存中完成的,內存消耗依然很大。easyexcel重寫了poi對07版Excel的解析,可以本來一個3M的excel用POI sax依然須要100M左右內存下降到幾M,而且再大的excel不會出現內存溢出,03版依賴POI的sax模式。在上層作了模型轉換的封裝,讓使用者更加簡單方便github

知識追尋者(Inheriting the spirit of open source, Spreading technology knowledge;)web

二 讀取excel

讀取的大致流程以下markdown

  1. 讀取數據流
  2. 將數據流映射到listener
  3. listener中處理讀取的每條記錄
  4. 讀取完畢,進行清理;

2.1 讀取

讀取的方法以下,本方法是基於模型映射方法讀取,其它方法請讀者自行參考官方文檔;app

模型是User.class;框架

listener是UserDataListeneride

讀取 第一個sheet;學習

@Test
    public void testRead1(){
        InputStream inputStream = null;
        try {
            // 獲取輸入流
            inputStream = new FileInputStream("C:\\mydata\\generator\\zszxz.xlsx");
            // 解析每行結果在listener中處理
            AnalysisEventListener listener = new UserDataListener();
            // 讀取excel
            ExcelReader excelReader = EasyExcel.read(inputStream, User.class, listener)
                    .build();
            // 讀取sheet0
            ReadSheet readSheet = EasyExcel.readSheet(0).build();
            // 將 sheet 寫入 Reader
            excelReader.read(readSheet);

        } catch (Exception e) {
        } finally {
            try {
                inputStream.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }
複製代碼

2.2 模型實例

以下所示,index 參數表明excel對應的列,0表示第一列; value表示列對應的名稱,在寫入excel時做用較大;ui

@Data
@NoArgsConstructor
@AllArgsConstructor
public class User {

    // id
    @ExcelProperty(index = 0,value = "編號")
    private Long id;
    // 名稱
    @ExcelProperty(index = 1,value = "名稱")
    private String name;
    // 建立時間
    @ExcelProperty(index = 2,value = "建立時間")
    private String createTime;
    // 描述
    @ExcelProperty(index = 3,value = "描述")
    private String description;

}
複製代碼

2.3 AnalysisEventListener

實現 AnalysisEventListener接口;

invoke方法用於處理每條數據,讀者能夠在這邊進行業務邏輯處理

doAfterAllAnalysed方法是隻處理完全部數據後進行的動做;

@Component
public class UserDataListener extends AnalysisEventListener<User> {



    // 用於存儲讀取到的數據
    private List<User> datas = new ArrayList<User>();

    // 這邊你能夠注入servie,或者mapper 進行業務邏輯處理後數據入庫

    /* * * @Author lsc * <p>解析每條數據處理的動做 </p> * @Param [user, analysisContext] * @Return void */
    @Override
    public void invoke(User user, AnalysisContext analysisContext) {
        datas.add(user);
        // do something

    }

    /* * * @Author lsc * <p> 解析全部數據以後處理的動做 </p> * @Param [analysisContext] * @Return void */
    @Override
    public void doAfterAllAnalysed(AnalysisContext analysisContext) {
        // 打印
        System.out.println(datas);
        // do something
        // 清理
        datas.clear();
    }

}
複製代碼

三 寫入excel

3.1 準備的數據

準備的數據也是一個List集合,存儲讀取的每行數據;

public class DataUtils {

    public static List<User> getUserData(){
        // 寫入響應
        List<User> datas = new ArrayList<User>();
        User user = new User();
        user.setId(666L);
        user.setName("知識追尋者");
        user.setCreateTime(LocalDateTime.now().toString());
        user.setDescription("跟着知識追尋者學習吧");
        datas.add(user);
        return datas;
    }
}
複製代碼

3.2 寫入

寫入的數據更加簡單,由於有了以前的模型映射;

@Test
    public void simpleWrite() {
        // 文件名
        String fileName = "C:\\mydata\\generator\\知識追尋者.xlsx";
        // 寫入
        EasyExcel.write(fileName, User.class).sheet("知識追尋者").doWrite(DataUtils.getUserData());
    }
複製代碼

四 web上傳下載示例

@RestController
public class ExcelController {

    @GetMapping("download")
    public void download(HttpServletResponse response) throws IOException {
        // 設置 ContentType
        response.setContentType("application/vnd.ms-excel");
        // 設置字符集
        response.setCharacterEncoding("utf-8");
        // 防止中文亂碼
        String fileName = URLEncoder.encode("知識追尋者", "UTF-8");
        // 設置 header
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xlsx");
        // 寫入
        EasyExcel.write(response.getOutputStream(), User.class)
                .sheet("知識追尋者")// 指定sheet名稱
                .doWrite(DataUtils.getUserData());//寫入數據
    }

    @PostMapping("upload")
    @ResponseBody
    public String upload(MultipartFile file) throws IOException {
        EasyExcel.read(file.getInputStream(), User.class, new UserDataListener())
                .sheet()
                .doRead();
        return "success";
    }

}
複製代碼

五參考連接

github.com/alibaba/eas…

本文同步分享在 博客「知識追尋者」(JueJin)。
若有侵權,請聯繫 support@oschina.cn 刪除。
本文參與「OSC源創計劃」,歡迎正在閱讀的你也加入,一塊兒分享。

相關文章
相關標籤/搜索