java进阶解析Springboot上传excel存入数据库步骤

米米素材网

项目需要,写了一个,批量导入的接口。因为需要使用excel去批量导入数据,所以写了一个例子,经过测试已经可以用于实际开发,这里记录一下

一、导入依赖

这里还是用了Apache的POI插件,现在一般的springboot解析excel基本都用它 。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
<!-- 文件上传,解析文件需要的依赖-->
      <!--poi对excel2007以上版本的支持-->
      <dependency>
          <groupId>org.apache.poi</groupId>
          <artifactId>poi-ooxml</artifactId>
          <version>5.0.0</version>
      </dependency>
      <!-- poi对excel2003以下版本的支持 -->
      <dependency>
          <groupId>org.apache.poi</groupId>
          <artifactId>poi</artifactId>
          <version>5.0.0</version>
      </dependency>

二、前端实现

?
1
2
3
<button type="button" class="layui-btn layui-btn-normal layui-btn-radius" id="bookFileUpload">
                   <i class="layui-icon">&#xe67c;</i>文件导入
               </button>
?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
/**
   * 文件上传--批量导入
   */
  layui.use('upload', function () {
      var upload = layui.upload;
      var layer = layui.layer;
      // layer.msg('上传中', {icon: 16, time: 0,shade: 0.3});
      //执行实例
      var uploadInst = upload.render({
          elem: '#bookFileUpload', //绑定元素
          url: '/library/book/batchAddBooks/', //上传接口
          exts: 'xlsx|xls', //限制文件类型
          done: function (res) {
              //上传完毕回调
              if (res.code == '1') {
                  successMsg("导入成功");
              } else {
                  errorMsg("导入失败" + res);
              }
          },
          error: function (res) {
              //请求异常回调
              errorMsg("系统异常" + res);
          }
      });
  });

说明一下,这里还是用了layui的框架去实现的,layui是我用过的前端框架里边坑相对较少的一个不错的简单并且很容易入门的框架。

三、后台逻辑

1.首先写一个用于导入数据的model实体类,对应数据库的一张表。

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
/**
 * 书籍实体
 */
@Data
public class Book {
    //主键id
    private int bid;
    //书名
    private String bookname;
    //作者
    private String author;
    //书的类型  武侠、言情等
    private String booktype;
    //出版社
    private String publisher;
    //出版时间
    private String publicationdate;
    //发行价格
    private int price;
    //发行状态
    private String bookstate;
    //备注
    private String comment;
}

这里使用了lombok的插件工具,所以可以省去写setget方法,只需要@Data即可。
lombok的依赖,可用可不用,看你自己:

?
1
2
3
4
5
<dependency>
        <groupId>org.projectlombok</groupId>
        <artifactId>lombok</artifactId>
        <optional>true</optional>
    </dependency>

2.接着写一下前端上传过来excel,后台的解析处理逻辑。
下面是重点:

?
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
package com.example.library.utils.fileUtiles;
import com.example.library.model.Book;
import org.apache.poi.hssf.usermodel.HSSFWorkbook;
import org.apache.poi.ss.usermodel.Cell;
import org.apache.poi.ss.usermodel.Row;
import org.apache.poi.ss.usermodel.Sheet;
import org.apache.poi.ss.usermodel.Workbook;
import org.apache.poi.xssf.streaming.SXSSFWorkbook;
import org.apache.poi.xssf.usermodel.XSSFWorkbook;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.web.multipart.MultipartFile;
import java.io.*;
import java.text.DecimalFormat;
import java.text.SimpleDateFormat;
import java.util.ArrayList;
import java.util.List;
/**
 * @Author Summer_DM
 * @Summary TODO  操作Excel的工具类
 * @Version 1.0
 * @Date 2021/9/16 下午 03:44
 **/
public class ExcelUtils {
    private static final Logger logger = LoggerFactory.getLogger(ExcelUtils.class);
    //Map<String,Object> map = new HashMap<String, Object>();
    private static final String XLS = "xls";
    private static final String XLSX = "xlsx";
    private final static String DATE_FORMAT = "yyyy-MM-dd";
    /**
     * 根据文件后缀名类型获取对应的工作簿对象
     * @param inputStream 读取文件的输入流
     * @param fileType 文件后缀名类型(xls或xlsx)
     * @return 包含文件数据的工作簿对象
     * @throws IOException
     */
    public static Workbook getWorkbook(InputStream inputStream, String fileType) throws Exception {
        Workbook workbook = null;
        //根据文件后缀名不同(xls和xlsx)获得不同的Workbook实现类对象
        if (fileType.equalsIgnoreCase(XLS)) {
            //2003
            workbook = new HSSFWorkbook(inputStream);
        } else if (fileType.equalsIgnoreCase(XLSX)) {
            //2007及以上
            workbook = new XSSFWorkbook(inputStream);
        }else {
            throw new Exception("请上传excel文件!");
        }
        return workbook;
    }
    /**
     * 读取Excel文件内容
     * @param fileName 要读取的Excel文件所在路径
     * @return 读取结果列表,读取失败时返回null
     */
    public static List<Book> readExcel(String fileName) {
        Workbook workbook = null;
        FileInputStream inputStream = null;
        try {
            // 获取Excel后缀名
            String fileType = fileName.substring(fileName.lastIndexOf(".") + 1, fileName.length());
            // 获取Excel文件
            File excelFile = new File(fileName);
            if (!excelFile.exists()) {
                logger.warn("指定的Excel文件不存在!");
            }
            // 获取Excel工作簿
            inputStream = new FileInputStream(excelFile);
            workbook = getWorkbook(inputStream, fileType);
            // 读取excel中的数据
            List<Book> resultDataList = parseExcel(workbook);
            return resultDataList;
        } catch (Exception e) {
            logger.warn("解析Excel失败,文件名:" + fileName + " 错误信息:" + e.getMessage());
            return null;
        } finally {
            try {
                if (null != workbook) {
                    workbook.close();
                }
                if (null != inputStream) {
                    inputStream.close();
                }
            } catch (Exception e) {
                logger.warn("关闭数据流出错!错误信息:" + e.getMessage());
                return null;
            }
        }
    }
 
    /**
     * 读取Excel文件内容
     * @param file 上传的Excel文件
     * @return 读取结果列表,读取失败时返回null
     */
    public static List<Book> readExcel(MultipartFile file) {
        Workbook workbook = null;
        try {
            //判断文件是否存在
            if(null == file){
                logger.warn("解析Excel失败,文件不存在!");
                return null;
            }
            // 获取Excel后缀名
            String fileName = file.getOriginalFilename();
            if (fileName == null || fileName.isEmpty() || fileName.lastIndexOf(".") < 0) {
                logger.warn("解析Excel失败,因为获取到的Excel文件名非法!");
                return null;
            }
            String fileType = fileName.substring(fileName.lastIndexOf(".") + 1, fileName.length());
 
            // 获取Excel工作簿
            workbook = getWorkbook(file.getInputStream(), fileType);
 
            // 读取excel中的数据
            List<Book> resultDataList = parseExcel(workbook);
            return resultDataList;
        } catch (Exception e) {
            logger.warn("解析Excel失败,文件名:" + file.getOriginalFilename() + " 错误信息:" + e.getMessage());
            return null;
        } finally {
            try {
                if (null != workbook) {
                    workbook.close();
                }
            } catch (Exception e) {
                logger.warn("关闭数据流出错!错误信息:" + e.getMessage());
                return null;
            }
        }
    }
    /**
     * 解析Excel数据
     * @param workbook Excel工作簿对象
     * @return 解析结果
     */
    private static List<Book> parseExcel(Workbook workbook) {
        List<Book> resultDataList = new ArrayList<>();
        //获取所有的工作表的的数量
        int numOfSheet = workbook.getNumberOfSheets();
        System.out.println(numOfSheet+"--->numOfSheet");
        // 解析sheet,此处会读取所有脚页的行数据,若只想读取指定页,不要for循环,直接给sheetNum赋值,
        // 脚页从0开始(通常情况Excel都只有一页,所以此处未进行进一步处理)
        for (int sheetNum = 0; sheetNum < numOfSheet; sheetNum++) {
            //获取一个sheet也就是一个工作本。
            Sheet sheet = workbook.getSheetAt(sheetNum);
            // 校验sheet是否合法
            if (sheet == null) {
                continue;
            }
            //获取一个sheet有多少Row
            //int lastRowNum = sheet.getLastRowNum();
            //if(lastRowNum == 0) {
            //    continue;
            /
THE END

发表评论