从零开始实现放置游戏（六）：Excel批量导入

小篱

前面我们已经实现了在后台管理系统中，对配置数据的增删查改。但每次添加只能添加一条数据，实际生产中，大量数据通过手工一条一条添加不太现实。本章我们就实现通过Excel导入配置数据的功能。这里我们还是以地图数据为例，其他配置项可参照此例。

涉及的功能点主要有对office文档的编程、文件上传功能。流程图大致如下：

一、添加依赖项

解析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.             }
    
11. 
    
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.                         }
    
24. 
    
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.             }
    
36. 
    
37.             return CommonResult.success();
    
38.         } catch (Exception ex) {
    
39.             logger.error(ex.getMessage(), ex);
    
40.             return CommonResult.fail();
    
41.         }
    
42.     }
    
43. 
    
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.         }
    
62. 
    
63.         fileInputStream.close();
    
64.         return wowMapList;
    
65.     }
    
66. 
    
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;
   
2. 
   
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;
   
7. 
   
8. import java.text.DecimalFormat;
   
9. import java.text.SimpleDateFormat;
   
10. import java.util.Date;
    
11. 
    
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.     …………
   
4. 
   
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文件，实现了批量录入的功能。

源码下载地址：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