Java Excel匯入匯出，基於XML和Easy-excel使用
阿新 • • 發佈：2019-02-20
1.前言
•在工作時，遇到過這樣的需求，需要靈活的對工單進行匯入或匯出，以前自己也做過，但使用不靈活繁瑣。我想能不能像配置檔案一樣可配置的匯入匯出，那樣使用起來就方便許多。
2.SpringMVC專案搭建
•建立基於Maven版本管理Springmvc專案，以下是主要的依賴，用jetty作為內嵌的伺服器，直接啟動。
•架包相關依賴pom.xml。
<!-- 版本定義 --> <properties> <commons-beanutils.version>1.9.2</commons-beanutils.version> <commons-collections.version>3.2.1</commons-collections.version> <commons-lang.version>2.6</commons-lang.version> <poi.version>3.14</poi.version> <xmlbeans.version>2.6.0</xmlbeans.version> <spring.version>4.2.6.RELEASE</spring.version> <log4j.version>1.2.17</log4j.version> <druid.version>1.0.11</druid.version> </properties> <!-- <dependencyManagement> --> <dependencies> <dependency> <groupId>junit</groupId> <artifactId>junit</artifactId> <version>4.12</version> <scope>test</scope> </dependency> <!-- commons --> <dependency> <groupId>commons-beanutils</groupId> <artifactId>commons-beanutils</artifactId> <version>${commons-beanutils.version}</version> </dependency> <dependency> <groupId>commons-collections</groupId> <artifactId>commons-collections</artifactId> <version>${commons-collections.version}</version> </dependency> <dependency> <groupId>commons-lang</groupId> <artifactId>commons-lang</artifactId> <version>${commons-lang.version}</version> </dependency> <dependency> <groupId>org.apache.commons</groupId> <artifactId>commons-lang3</artifactId> <version>3.3.2</version> </dependency> <dependency> <groupId>commons-io</groupId> <artifactId>commons-io</artifactId> <version>2.4</version> </dependency> <!-- POI --> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>${poi.version}</version> </dependency> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml</artifactId> <version>${poi.version}</version> </dependency> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml-schemas</artifactId> <version>${poi.version}</version> </dependency> <dependency> <groupId>org.apache.xmlbeans</groupId> <artifactId>xmlbeans</artifactId> <version>${xmlbeans.version}</version> </dependency> <!-- spring --> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-core</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-beans</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context</artifactId> <version>${spring.version}</version> </dependency> <!-- log --> <dependency> <groupId>log4j</groupId> <artifactId>log4j</artifactId> <version>${log4j.version}</version> </dependency> <!--mybatis start--> <dependency> <groupId>mysql</groupId> <artifactId>mysql-connector-java</artifactId> <version>5.1.38</version> <scope>runtime</scope> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis</artifactId> <version>3.4.0</version> </dependency> <dependency> <groupId>org.mybatis</groupId> <artifactId>mybatis-spring</artifactId> <version>1.3.0</version> </dependency> <!--mybatis end--> <!--spring dao 依賴--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-jdbc</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-tx</artifactId> <version>${spring.version}</version> </dependency> <!--spring web依賴--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-web</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-webmvc</artifactId> <version>${spring.version}</version> </dependency> <!--spring web依賴 end--> <!--spring 其他 依賴--> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-context-support</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-aop</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-aspects</artifactId> <version>${spring.version}</version> </dependency> <dependency> <groupId>org.springframework</groupId> <artifactId>spring-expression</artifactId> <version>${spring.version}</version> </dependency> <!--Severlet Web 相關依賴--> <!--2個標籤庫--> <dependency> <groupId>taglibs</groupId> <artifactId>standard</artifactId> <version>1.1.2</version> </dependency> <dependency> <groupId>jstl</groupId> <artifactId>jstl</artifactId> <version>1.2</version> </dependency> <dependency> <groupId>com.fasterxml.jackson.core</groupId> <artifactId>jackson-databind</artifactId> <version>2.6.5</version> </dependency> <dependency> <groupId>javax.servlet</groupId> <artifactId>javax.servlet-api</artifactId> <version>3.1.0</version> </dependency> <!-- 日誌 java 日誌：slf4j 是規範、介面 log4j\logback\common-logging 是實現 --> <dependency> <groupId>org.slf4j</groupId> <artifactId>slf4j-api</artifactId> <version>1.7.15</version> </dependency> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-core</artifactId> <version>1.1.3</version> </dependency> <!-- 實現了slf4j 介面並整合 --> <dependency> <groupId>ch.qos.logback</groupId> <artifactId>logback-classic</artifactId> <version>1.1.3</version> </dependency> <!--資料庫層依賴--> <!-- connection pool start--> <dependency> <groupId>com.alibaba</groupId> <artifactId>druid</artifactId> <version>${druid.version}</version> </dependency> <!-- connection pool end--> <!-- Jetty --> <dependency> <groupId>org.eclipse.jetty.aggregate</groupId> <artifactId>jetty-all</artifactId> <version>8.1.16.v20140903</version> <scope>test</scope> </dependency> <!-- Jetty Webapp --> <dependency> <groupId>org.eclipse.jetty</groupId> <artifactId>jetty-webapp</artifactId> <version>8.1.16.v20140903</version> <scope>test</scope> </dependency> <dependency> <groupId>org.eclipse.jetty</groupId> <artifactId>jetty-jsp</artifactId> <version>8.1.16.v20140903</version> </dependency> <dependency> <groupId>org.projectlombok</groupId> <artifactId>lombok</artifactId> <version>1.16.8</version> </dependency> <!-- json外掛 --> <dependency> <groupId>org.codehaus.jackson</groupId> <artifactId>jackson-mapper-asl</artifactId> <version>1.9.13</version> </dependency> <!-- 檔案上傳 --> <dependency> <groupId>commons-fileupload</groupId> <artifactId>commons-fileupload</artifactId> <version>1.2.2</version> </dependency> <!--common start--> <dependency> <groupId>com.google.guava</groupId> <artifactId>guava</artifactId> <version>18.0</version> </dependency> <dependency> <groupId>org.mongodb</groupId> <artifactId>mongo-java-driver</artifactId> <version>3.2.2</version> </dependency> <dependency> <groupId>org.springframework.data</groupId> <artifactId>spring-data-mongodb</artifactId> <version>1.8.4.RELEASE</version> </dependency> <dependency> <groupId>org.springframework.data</groupId> <artifactId>spring-data-commons</artifactId> <version>1.11.4.RELEASE</version> </dependency> </dependencies>
•其它相關配置沒啥特別，詳見原始碼。
3.Xml配置和Easy-excel使用
•下面是員工資訊模型。
//員工模型 public class EmployeeModel { /** * ID */ protected Integer id; /** * 建立時間 */ protected Date createTime; /** * 姓名 */ private String name; /** * 性別 0:男 1:女 */ private Integer sex; /** * 年齡 */ private Integer age; /** * 手機號 */ private String mobile; /** * 狀態 0:在職 * 1:離職 */ private Integer status; //省略getter setter }
•有如下的Excel檔案格式，需要對映成學生實體類。
•那麼使用easy-excel 如何匯入呢？
•前一行是屬於不規則的資料，從標題行以後才是規則的資料，也就是從規則資料之後才能正常轉換成JavaBean。
•具體實現程式碼，首先編寫配置檔案：excel-config.xml。
<excels> <excel id="employee" class="org.easy.web.ExcelModel.EmployeeModel" sheetname="員工資訊列表" defaultColumnWidth="5000" enableStyle="true"> <field name="id" title="ID" align="center" isNull="true" uniformStyle="true" columnWidth="5000" /> <field name="createTime" title="入職時間" pattern="yyyy/MM/dd" isNull="true" uniformStyle="true" columnWidth="5000" /> <field name="name" title="姓名" align="center" isNull="true" uniformStyle="true" columnWidth="5000" /> <field name="sex" title="性別" align="center" isNull="true" uniformStyle="true" columnWidth="5000" format="1:女,0:男"/> <field name="age" title="年齡" align="center" isNull="true" uniformStyle="true" columnWidth="5000" regex="^[1-9]\d*$" regexErrMsg="必須是數字"/> <field name="mobile" title="手機" align="center" isNull="true" uniformStyle="true" columnWidth="5000" regex="^[1][3,4,5,8][0-9]{9}$" regexErrMsg="格式錯誤"/> <field name="status" title="在職狀態" align="center" isNull="true" uniformStyle="true" columnWidth="5000" format="1:離職,0:在職" /> </excel> </excels>
•解釋,每個excel表示一種Excel檔案到JavaBean的對映規則,該規則可以是匯入和匯出。
•配置了一個id為employee的對映,要對映對應的JavaBean實體為 EmployeeModel。
•excel檔案中標題為ID的列,把它的值對映到 EmployeeModel.id屬性上。
<field name="id" title="ID"/>
•isNull屬性,表示在excel檔案中標題為【年齡】的單元格的值不能為空,並且符合正則【 regex】,當正則校驗沒有通過時,會提示【xxx行,[ 年齡 ]必須是數字,如果為空同理,xxx行[年齡]不能為空】。
<field name="age" title="年齡" isNull="false" regex="^[1-9]\d*$" regexErrMsg="必須是數字"/>
•pattern：不做過多解釋,SimpleDateFormat(pattern),匯入資料時字串的值如何轉換成日期。支援多種對映pattern，使用【英文逗號】進行分割。
•format屬性,觀察上面的excel檔案結構會發現狀態列是中文,那麼匯入時,可能javaBean中並不是中文,而是數字或其他,那麼如何把它轉換成數字呢？format就是做這個事情的。匯入時它會以【,分割:前面的作為匯入時使用的值，:後面的作為匯出時使用的值】:後面值進行逆推,匯出時同理。思考一個問題？如果這個值不確定如何解決,或者這個值需要到資料庫校驗？比如是個城市地址，這個時候是需要查詢資料庫進行比對的，如果地址不存在則丟擲錯誤提示資訊的,就說這麼多,easy-excel已經做好了,支援自定義的轉換器可以解決。
•那麼核心的程式碼是哪幾行？
//匯入
public Result importExcel(@RequestParam(value = "file", required = true) MultipartFile file) throws Exception {
Boolean excel = StringUtil.isExcel(file.getOriginalFilename());
if (!excel){
return Result.wrapErrorResult("該檔案不是Excel格式");
}
InputStream fis = file.getInputStream();
ExcelContext context = new ExcelContext("excel/config.xml");
ExcelUtil<EmployeeModel> excelUtil = new ExcelUtil(excelContext, "employee");
List<EmployeeModel> stus;
try {
stus = excelUtil.importExcel(1, fis);
} catch (ExcelException e) {//這裡主動返回錯誤資訊
return Result.wrapErrorResult(e.getMessage());
}
List<Employee> list=BdUtil.e2OList(stus,Employee.class);
return Result.wrapSuccessfulResult(list);
}
//匯出
public void exportExcel(HttpServletRequest request, HttpServletResponse response) throws Exception {
ExcelUtil<EmployeeModel> excelUtil = new ExcelUtil(excelContext, "employee");
final List<EmployeeModel> list = getEmployeeList();
List<String> specifyFields = new ArrayList<String>(
ExcelHeader header=new ExcelHeader() {
public void buildHeader(Sheet sheet, ExcelDefinition excelDefinition, List<?> beans,Workbook workbook) {
// 設定第一行樣式
CellStyle style1 = workbook.createCellStyle();
// 水平居中
style1.setAlignment(HSSFCellStyle.ALIGN_CENTER);
// 垂直居中
style1.setVerticalAlignment(HSSFCellStyle.VERTICAL_CENTER);
// 設定字型 大小
Font font1 = workbook.createFont();
font1.setFontHeightInPoints((short) 18);
style1.setFont(font1);
//第一行資料
Row row1 = sheet.createRow(0);
Cell cell1 = row1.createCell(0);
cell1.setCellValue("共匯出【"+list.size()+"】條資料");
// 行高
row1.setHeight((short) 700);
cell1.setCellStyle(style1);
//合併單元格
CellRangeAddress region = new CellRangeAddress(0, 0, 0, 2);
sheet.addMergedRegion(region);
}
};
excelUtil.exportExcel(response,list, header,specifyFields,"員工資訊");
}
•只有準備資料、建立上下文、讀取excel。。通常在真實的常見建立上下文都可以省略了，因為它會交給spring容器管理，整個jvm中，只保持一個例項就夠了。
•關於匯入配置的一個很重要的屬性：resolveFieldValueConverterName。
•它是一個ResolveFieldValueConverter介面的實現類：假設我們的Excel中有地址，或者結合業務中可能是其他，都是需要查詢資料庫，或者經過更復雜的業務邏輯進行校驗的，那麼我們可以配置它。我們來觀察這個介面做了什麼事？
/**
* 解析Excel值解析介面
*
*/
public interface ResolveFieldValueConverter {
/**
* 操作型別，匯入或匯出
*/
enum Type {
EXPORT, IMPORT
}
/**
* 解析配置中Field元素 處理後的值
* @param bean Excel配置的JavaBean物件
* @param value Excel原值
* @param fieldValue FieldValue資訊
* @param type 匯入或匯出
* @param rowNum 行號
* @return 解析結果對應的value
* @throws Exception
*/
public Object resolveFieldValue(Object bean,Object value, FieldValue fieldValue, Type type,int rowNum) throws Exception;
}
•核心只有一個方法resolveFieldValue。
•我們可以自定義它的實現類，然後把全類名註冊到 resolveFieldValueConverterName
屬性上如：假設建立人是需要查詢使用者表進行校驗，如果沒有則不允許匯入，我們則可以在自定義的實現類丟擲一個異常，可以精準的提示使用者多少行，哪一個欄位【標題】的值錯誤了。
•直接上程式碼，下面是匯入匯出封裝好工具類。
/**
* Excel 匯出方法呼叫(主)
*/
public class ExcelUtil<T> {
//建立excel上下文例項,配置檔案路徑
private ExcelContext context;
//Excel配置檔案中配置的id
private String excelId;
public ExcelUtil(ExcelContext context, String excelId) {
this.context = context;
this.excelId = excelId;
}
/**
* @param startRow 頭部從第幾行開始匯入
* @param fis 檔案流
* @return
* @throws Exception
*/
public List<T> importExcel(int startRow, InputStream fis) throws Exception {
//第二個引數需要注意,它是指標題索引的位置,可能你的前幾行並不是標題,而是其他資訊,
//比如資料批次號之類的,關於如何轉換成javaBean,具體參考配置資訊描述
ExcelImportResult result = context.readExcel(excelId, startRow, fis);
// System.out.println(result.getHeader());
List<T> stus = result.getListBean();
return stus;
//這種方式和上面的沒有任何區別,底層方法預設標題索引為0
//context.readExcel(excelId, fis);
}
/**
* 匯出Excel並下載
* @param response
* @param list 結果集,null預設匯出模板
* @param header 自定義表頭,null預設無
* @param specifyFields 匯出欄位,null匯出所有欄位
* @param fileName 下載的檔名
*/
public void exportExcel(HttpServletResponse response, List<T> list,ExcelHeader header, List<String> specifyFields, String fileName) {
File file = null;
OutputStream ops = null;
OutputStream out = null;
Workbook workbook = null;
try {
/**
* Step1:建立臨時xlsx檔案
*/
file = File.createTempFile("tmp", ".xlsx");
/**
* Step2:匯出資料寫入臨時xlsx檔案
*/
String path = file.getAbsolutePath();
ops = new FileOutputStream(path);
//獲取POI建立結果
if (list != null && !list.isEmpty()) {
workbook = context.createExcel(excelId, list, header, specifyFields);
// workbook = context.createExcel(excelId, list);
} else {//查詢結果為空,匯出模板
workbook = context.createExcelTemplate(excelId, header, specifyFields);
}
workbook.write(ops);
/**
* Step3:下載臨時xlsx檔案
*/
response.reset();
response.setContentType("application/octet-stream; charset=utf-8");
fileName = URLEncoder.encode(fileName + ".xlsx", "UTF-8");
response.setHeader("Content-Disposition", "attachment; filename=" + fileName);
out = response.getOutputStream();
out.write(FileUtils.readFileToByteArray(file));
out.flush();
} catch (FileNotFoundException e) {
e.printStackTrace();
} catch (IOException e) {
e.printStackTrace();
} catch (Exception e) {
e.printStackTrace();
} finally {
file.deleteOnExit();//臨時檔案若存在,則刪除
try {
if (ops != null) {
ops.close();
}
if (workbook != null) {
workbook.close();
}
if (out != null) {
out.close();
}
} catch (IOException e) {
e.printStackTrace();
}
}
}
}