EasyPoi教程和使用案例
先上文檔:http://easypoi.mydoc.io/java
基於Apache poi 開發的EasyPoi,比起poi更加簡單易用,可是功能沒有poi強大,。web
特性總結:數據庫
優勢:併發
- 經過簡單的註解和模板 語言(熟悉的表達式語法),完成之前複雜的寫法。推薦使用註解功能。
- 支持Excel導入與導出,同時支持xls和xlsm,即07版本和03版本(官方建議03版本不要超過2000行)的Excel文件格式。
- 支持pojo註釋時,映射成爲java實體模型。
缺點:app
- 多表頭導出最多支持2層表頭;(導出複雜表頭建議用easyExcel)
- easypoi的解析方式是dom解析,把結果一次都讀入內存操做,這樣的操做平時是不會有問題的,可是併發量上來的時候就會出現OOM
此處推薦一個別人造好的輪子【easypoi】:
<dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-base</artifactId> <version>3.0.3</version> </dependency> <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-web</artifactId> <version>3.0.3</version> </dependency> <dependency> <groupId>cn.afterturn</groupId> <artifactId>easypoi-annotation</artifactId> <version>3.0.3</version> </dependency>
編寫實體類dom
此處注意必需要有空構造函數,不然會報錯「對象建立錯誤」 關於註解@Excel,其餘還有@ExcelCollection,@ExcelEntity ,@ExcelIgnore,@ExcelTarget等,此處咱們用不到,能夠去官方查看更多函數
屬性 | 類型 | 類型 | 說明 |
---|---|---|---|
name | String | null | 列名 |
needMerge | boolean | fasle | 縱向合併單元格 |
orderNum | String | "0" | 列的排序,支持name_id |
replace | String[] | {} | 值得替換 導出是{a_id,b_id} 導入反過來 |
savePath | String | "upload" | 導入文件保存路徑 |
type | int | 1 | 導出類型 1 是文本 2 是圖片,3 是函數,10 是數字 默認是文本 |
width | double | 10 | 列寬 |
height | double | 10 | 列高,後期打算統一使用@ExcelTarget的height,這個會被廢棄,注意 |
isStatistics | boolean | fasle | 自動統計數據,在追加一行統計,把全部數據都和輸出這個處理會吞沒異常,請注意這一點 |
isHyperlink | boolean | false | 超連接,若是是須要實現接口返回對象 |
isImportField | boolean | true | 校驗字段,看看這個字段是否是導入的Excel中有,若是沒有說明是錯誤的Excel,讀取失敗,支持name_id |
exportFormat | String | "" | 導出的時間格式,以這個是否爲空來判斷是否須要格式化日期 |
importFormat | String | "" | 導入的時間格式,以這個是否爲空來判斷是否須要格式化日期 |
format | String | "" | 時間格式,至關於同時設置了exportFormat 和 importFormat |
databaseFormat | String | "yyyyMMddHHmmss" | 導出時間設置,若是字段是Date類型則不須要設置 數據庫若是是string 類型,這個須要設置這個數據庫格式,用以轉換時間格式輸出 |
numFormat | String | "" | 數字格式化,參數是Pattern,使用的對象是DecimalFormat |
imageType | int | 1 | 導出類型 1 從file讀取 2 是從數據庫中讀取 默認是文件 一樣導入也是同樣的 |
suffix | String | "" | 文字後綴,如% 90 變成90% |
isWrap | boolean | true | 是否換行 即支持\n |
mergeRely | int[] | {} | 合併單元格依賴關係,好比第二列合併是基於第一列 則{1}就能夠了 |
mergeVertical | boolean | fasle | 縱向合併內容相同的單元格 |
import cn.afterturn.easypoi.excel.annotation.Excel; import java.util.Date; public class Person { @Excel(name = "姓名", orderNum = "0") private String name; @Excel(name = "性別", replace = {"男_1", "女_2"}, orderNum = "1") private String sex; @Excel(name = "生日", exportFormat = "yyyy-MM-dd", orderNum = "2") private Date birthday; public Person(String name, String sex, Date birthday) { this.name = name; this.sex = sex; this.birthday = birthday; } public String getName() { return name; } public void setName(String name) { this.name = name; } public String getSex() { return sex; } public void setSex(String sex) { this.sex = sex; } public Date getBirthday() { return birthday; } public void setBirthday(Date birthday) { this.birthday = birthday; } }
導入導出公用方法:測試
public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass,String fileName,boolean isCreateHeader, HttpServletResponse response){ ExportParams exportParams = new ExportParams(title, sheetName); exportParams.setCreateHeadRows(isCreateHeader); defaultExport(list, pojoClass, fileName, response, exportParams); } public static void exportExcel(List<?> list, String title, String sheetName, Class<?> pojoClass,String fileName, HttpServletResponse response){ defaultExport(list, pojoClass, fileName, response, new ExportParams(title, sheetName)); } public static void exportExcel(List<Map<String, Object>> list, String fileName, HttpServletResponse response){ defaultExport(list, fileName, response); } private static void defaultExport(List<?> list, Class<?> pojoClass, String fileName, HttpServletResponse response, ExportParams exportParams) { Workbook workbook = ExcelExportUtil.exportExcel(exportParams,pojoClass,list); if (workbook != null); downLoadExcel(fileName, response, workbook); } private static void downLoadExcel(String fileName, HttpServletResponse response, Workbook workbook) { try { response.setCharacterEncoding("UTF-8"); response.setHeader("content-Type", "application/vnd.ms-excel"); response.setHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(fileName, "UTF-8")); workbook.write(response.getOutputStream()); } catch (IOException e) { throw new NormalException(e.getMessage()); } } private static void defaultExport(List<Map<String, Object>> list, String fileName, HttpServletResponse response) { Workbook workbook = ExcelExportUtil.exportExcel(list, ExcelType.HSSF); if (workbook != null); downLoadExcel(fileName, response, workbook); } public static <T> List<T> importExcel(String filePath,Integer titleRows,Integer headerRows, Class<T> pojoClass){ if (StringUtils.isBlank(filePath)){ return null; } ImportParams params = new ImportParams(); params.setTitleRows(titleRows); params.setHeadRows(headerRows); List<T> list = null; try { list = ExcelImportUtil.importExcel(new File(filePath), pojoClass, params); }catch (NoSuchElementException e){ throw new NormalException("模板不能爲空"); } catch (Exception e) { e.printStackTrace(); throw new NormalException(e.getMessage()); } return list; } public static <T> List<T> importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class<T> pojoClass){ if (file == null){ return null; } ImportParams params = new ImportParams(); params.setTitleRows(titleRows); params.setHeadRows(headerRows); List<T> list = null; try { list = ExcelImportUtil.importExcel(file.getInputStream(), pojoClass, params); }catch (NoSuchElementException e){ throw new NormalException("excel文件不能爲空"); } catch (Exception e) { throw new NormalException(e.getMessage()); } return list; }
測試:this
@RequestMapping("export") public void export(HttpServletResponse response){ //模擬從數據庫獲取須要導出的數據 List<Person> personList = new ArrayList<>(); Person person1 = new Person("路飛","1",new Date()); Person person2 = new Person("娜美","2", DateUtils.addDate(new Date(),3)); Person person3 = new Person("索隆","1", DateUtils.addDate(new Date(),10)); Person person4 = new Person("小狸貓","1", DateUtils.addDate(new Date(),-10)); personList.add(person1); personList.add(person2); personList.add(person3); personList.add(person4); //導出操做 FileUtil.exportExcel(personList,"花名冊","草帽一夥",Person.class,"海賊王.xls",response); } @RequestMapping("importExcel") public void importExcel(){ String filePath = "F:\\海賊王.xls"; //解析excel, List<Person> personList = FileUtil.importExcel(filePath,1,1,Person.class); //也可使用MultipartFile,使用 FileUtil.importExcel(MultipartFile file, Integer titleRows, Integer headerRows, Class<T> pojoClass)導入 System.out.println("導入數據一共【"+personList.size()+"】行"); //TODO 保存數據庫 }