從零開始實現放置遊戲（六）：Excel批量匯入

遊資網發表於2019-11-12
遊戲Excel
前面我們已經實現了在後臺管理系統中，對配置資料的增刪查改。但每次新增只能新增一條資料，實際生產中，大量資料通過手工一條一條新增不太現實。本章我們就實現通過Excel匯入配置資料的功能。這裡我們還是以地圖資料為例，其他配置項可參照此例。

涉及的功能點主要有對office文件的程式設計、檔案上傳功能。流程圖大致如下：

從零開始實現放置遊戲（六）：Excel批量匯入

一、新增依賴項

解析office文件推薦使用免費的開源元件POI，已經可以滿足80%的功能需求。上傳檔案需要依賴commons-fileupload包。我們在pom中新增下列程式碼：

  1. <!-- office元件 -->
  2. <dependency>
  3.     <groupId>org.apache.poi</groupId>
  4.     <artifactId>poi</artifactId>
  5.     <version>4.1.0</version>
  6. </dependency>
  7. <dependency>
  8.     <groupId>org.apache.poi</groupId>
  9.     <artifactId>poi-ooxml</artifactId>
  10.     <version>4.1.0</version>
  11. </dependency>
  12. <!-- 檔案上傳 -->
  13. <dependency>
  14.     <groupId>commons-fileupload</groupId>
  15.     <artifactId>commons-fileupload</artifactId>
  16.     <version>1.4</version>
  17. </dependency>
複製程式碼

另外，之前我們配置的mvc檢視解析器只能解析簡單的檢視，上傳檔案需要支援multipart。在spring-mvc.xml中新增如下配置：

  1. <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
  2.     <property name="defaultEncoding" value="UTF-8"></property>
  3.     <property name="maxUploadSize" value="10485770"></property>
  4.     <property name="maxInMemorySize" value="10485760"></property>
  5. </bean>
複製程式碼

這裡配置了上傳最大限制10MB，對於excel上傳來說足矣。


二、檔案上傳、解析、落庫

在MapController中，我們新增3個方法

MapController.java

  1. @ResponseBody
  2.     @RequestMapping(value = "/importExcel", method = RequestMethod.POST)
  3.     public Object importExcel(HttpServletRequest request) {
  4.         try {
  5.             ServletContext servletContext = request.getServletContext();
  6.             String uploadPath = servletContext.getRealPath("/upload");
  7.             File dir = new File(uploadPath);
  8.             if (!dir.exists()) {
  9.                 dir.mkdir();
  10.             }

  12.             CommonsMultipartResolver multipartResolver = new CommonsMultipartResolver(servletContext);
  13.             if (multipartResolver.isMultipart(request)) {
  14.                 MultipartHttpServletRequest multiRequest = (MultipartHttpServletRequest) request;
  15.                 Iterator<String> iter = multiRequest.getFileNames();
  16.                 while (iter.hasNext()) {
  17.                     MultipartFile file = multiRequest.getFile(iter.next());
  18.                     if (file.getSize() > 0) {
  19.                         String fileName = file.getOriginalFilename();
  20.                         String extension = fileName.substring(fileName.lastIndexOf("."));
  21.                         if (!extension.toLowerCase().equals(".xls") && !extension.toLowerCase().equals(".xlsx")) {
  22.                             throw new Exception("不支援的文件格式！請上傳.xls或.xlsx格式的文件！");
  23.                         }

  25.                         String destFileName = fileName + "_" + System.currentTimeMillis() + extension;
  26.                         File destFile = new File(uploadPath, destFileName);
  27.                         file.transferTo(destFile);
  28.                         List<WowMap> dataList = this.loadExcelData(destFile.getPath());
  29.                         this.saveExcelData(dataList);
  30.                         if (!destFile.delete()) {
  31.                             logger.warn("臨時檔案刪除失敗：" + destFile.getAbsolutePath());
  32.                         }
  33.                     }
  34.                 }
  35.             }

  37.             return CommonResult.success();
  38.         } catch (Exception ex) {
  39.             logger.error(ex.getMessage(), ex);
  40.             return CommonResult.fail();
  41.         }
  42.     }

  44.     protected List<WowMap> loadExcelData(String excelPath) throws Exception {
  45.         FileInputStream fileInputStream = new FileInputStream(excelPath);
  46.         XSSFWorkbook workbook = new XSSFWorkbook(fileInputStream);
  47.         Sheet sheet = workbook.getSheet("地圖");
  48.         List<WowMap> wowMapList = new ArrayList<>();
  49.         // 處理當前頁，迴圈讀取每一行
  50.         String createUser = this.currentUserName();
  51.         for (int rowNum = 2; rowNum <= sheet.getLastRowNum(); rowNum++) {
  52.             XSSFRow row = (XSSFRow) sheet.getRow(rowNum);
  53.             String name = PoiUtil.getCellValue(row.getCell(2));
  54.             DataDict.Occupy occupy = DataDict.Occupy.getByDesc(PoiUtil.getCellValue(row.getCell(4)));
  55.             WowMap wowMap = new WowMap();
  56.             wowMap.setName(name);
  57.             wowMap.setOccupy(occupy.getCode());
  58.             wowMap.setDescription("");
  59.             wowMap.setCreateUser(createUser);
  60.             wowMapList.add(wowMap);
  61.         }

  63.         fileInputStream.close();
  64.         return wowMapList;
  65.     }

  67.     protected void saveExcelData(List<WowMap> dataList) {
  68.         wowMapManager.batchInsert(dataList);
  69.     }
複製程式碼

其中，importExcel方法，時候對應前端點選匯入按鈕時的後端入口，在這個方法中，我們定義了臨時檔案上傳路徑，校驗了檔名字尾，儲存上傳的檔案到伺服器，並在操作結束後將臨時檔案刪除; loadExcelData方法，利用POI元件讀取解析Excel資料，Excel資料怎麼配我們可以自由定義，這裡讀取時自由調整對應的行列即可，本例使用的Excel在文末給出的原始碼中可以找到; saveExcelData方法，將解析到的資料列表存入資料庫，這裡呼叫的batchInsert批量新增方法，在前面講增刪查改的時候已經提前實現了。

另外，在使用POI元件讀取Excel資料時，需要先判斷單元格格式，我們建立一個工具類PoiUtil來實現此功能，這種在以後的其他專案中也可以使用的工具類，我們把它提取出來，放到util模組中，作為我們的通用工具包，以便日後使用。在util模組新建包com.idlewow.util.poi，並新增PoiUtil類：

PoiUtil.java

  1. package com.idlewow.util.poi;

  3. import org.apache.commons.lang3.StringUtils;
  4. import org.apache.poi.ss.usermodel.Cell;
  5. import org.apache.poi.ss.usermodel.CellType;
  6. import org.apache.poi.ss.usermodel.DateUtil;

  8. import java.text.DecimalFormat;
  9. import java.text.SimpleDateFormat;
  10. import java.util.Date;

  12. public class PoiUtil {
  13.     public static String getCellValue(Cell cell) {
  14.         CellType cellType = cell.getCellType();
  15.         if (cellType.equals(CellType.STRING)) {
  16.             return cell.getStringCellValue();
  17.         } else if (cellType.equals(CellType.NUMERIC)) {
  18.             if (DateUtil.isCellDateFormatted(cell)) {
  19.                 Date date = cell.getDateCellValue();
  20.                 return date == null ? "" : new SimpleDateFormat("yyyy-MM-dd HH:mm:ss").format(date);
  21.             } else {
  22.                 return new DecimalFormat("0.##").format(cell.getNumericCellValue());
  23.             }
  24.         } else if (cellType.equals(CellType.FORMULA)) {
  25.             if (StringUtils.isNotBlank(cell.getStringCellValue())) {
  26.                 return cell.getStringCellValue();
  27.             } else {
  28.                 return cell.getNumericCellValue() + "";
  29.             }
  30.         } else if (cellType.equals(CellType.BOOLEAN)) {
  31.             return cell.getBooleanCellValue() ? "TRUE" : "FALSE";
  32.         } else {
  33.             return "";
  34.         }
  35.     }
  36. }
複製程式碼

工具類提取到util模組後，需要在util模組也新增對Poi的依賴，並在rms模組新增對util的依賴。這裡util模組中，依賴項的scope為provided即可，僅在編譯階段使用，因為在引用此工具包的模組中肯定已經引入了POI依賴，無需重複打包：

  1. <dependencies>
  2.     <dependency>
  3.         <groupId>org.apache.poi</groupId>
  4.         <artifactId>poi</artifactId>
  5.         <version>4.1.0</version>
  6.         <scope>provided</scope>
  7.     </dependency>
  8.     <dependency>
  9.         <groupId>org.apache.poi</groupId>
  10.         <artifactId>poi-ooxml</artifactId>
  11.         <version>4.1.0</version>
  12.         <scope>provided</scope>
  13.     </dependency>
  14. </dependencies>
複製程式碼

三、修改前端頁面

在地圖列表頁面list.jsp中，新增匯入excel的按鈕。

  1. <form>
  2.     …………
  3.     …………
  4.     <div class="layui-inline layui-show-xs-block">
  5.         <button type="button" class="layui-btn" onclick="xadmin.open('新增地圖','add',500,500)">
  6.             <i class="layui-icon"></i>新增地圖
  7.         </button>
  8.     </div>
  9.     <div class="layui-upload layui-inline layui-show-xs-block">
  10.         <button type="button" class="layui-btn layui-btn-normal" id="btnSelectFile">選擇Excel</button>
  11.         <button type="button" class="layui-btn" id="btnImport">開始匯入</button>
  12.     </div>
  13. </form>
複製程式碼

在列表頁面的list.js中，繫結相應的按鈕事件。

  1. layui.use(['upload', 'table', 'form'], function () {
  2.     …………
  3.     …………

  5.     layui.upload.render({
  6.         elem: '#btnSelectFile',
  7.         url: '/manage/map/importExcel',
  8.         accept: 'file',
  9.         exts: 'xls|xlsx',
  10.         auto: false,
  11.         bindAction: '#btnImport',
  12.         done: function (result) {
  13.             if (result.code === 1) {
  14.                 layer.alert(result.message, {icon: 6},
  15.                     function () {
  16.                         layui.layer.closeAll();
  17.                         layui.table.reload('datatable');
  18.                     });
  19.             } else {
  20.                 layer.alert(result.message, {icon: 5});
  21.             }
  22.         }
  23.     });
  24. });
複製程式碼


四、執行效果

以上，excel匯入的功能就全部完成了，我們執行下看下效果：

從零開始實現放置遊戲（六）：Excel批量匯入

小結

本章通過匯入Excel檔案，實現了批量錄入的功能。

原始碼下載地址：https://idlestudio.ctfile.com/fs/14960372-383760599

本文原文地址：https://www.cnblogs.com/lyosaki88/p/idlewow_6.html

相關閱讀：
從零開始實現放置遊戲（一）：準備工作
從零開始實現放置遊戲（二）：整體框架搭建
從零開始實現放置遊戲（三）：後臺管理系統搭建
從零開始實現放置遊戲（四）後臺數值配置的增刪查改
從零開始實現放置遊戲（五）：管理系統搭建之實現切面日誌

作者：丶謙信
部落格地址：https://www.cnblogs.com/lyosaki88/p/idlewow_6.html


相關文章