說到導出 Excel，我們首先會想到 poi、jsxl 等，使用這些工具會顯得笨重，學習難度大。今天學習使用 JeecgBoot 中的 Autopoi 導出 Excel，底層基于 easypoi，使用簡單，還支持數據字典方式
一、開發前戲
1、引入 maven 依賴
|
1
2
3
4
5
6
7
8
9
10
11
12
|
<!-- AutoPoi Excel工具類--><dependency> <groupId>org.jeecgframework</groupId> <artifactId>autopoi-web</artifactId> <version>1.1.1</version> <exclusions> <exclusion> <groupId>commons-codec</groupId> <artifactId>commons-codec</artifactId> </exclusion> </exclusions></dependency> |
exclusions 是將 commons-codec 從 autopoi 中排除，避免沖突
2、切換 Jeecg 鏡像
以下代碼放在 pom.xml 文件中的 parent 標簽下面
|
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
|
<repositories><repository> <id>aliyun</id> <name>aliyun Repository</name> <url>http://maven.aliyun.com/nexus/content/groups/public</url> <snapshots> <enabled>false</enabled> </snapshots></repository><repository> <id>jeecg</id> <name>jeecg Repository</name> <url>http://maven.jeecg.org/nexus/content/repositories/jeecg</url> <snapshots> <enabled>false</enabled> </snapshots></repository></repositories> |
可以看到，這里我們配置了 aliyun 的國內鏡像，還配置了 jeecg 的鏡像，這樣方便我們下載依賴文件
3、導出工具類
我們把導出 Excel 通用方法寫在 ExcelUtils.java 文件中
|
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
|
import org.jeecgframework.poi.excel.def.NormalExcelConstants;import org.jeecgframework.poi.excel.entity.ExportParams;import org.jeecgframework.poi.excel.view.JeecgEntityExcelView;import org.springframework.web.servlet.ModelAndView;import java.util.List;/** * 導出excel工具類 * * @author lizhou */public class ExcelUtils { /** * 導出excel * * @param title 文件標題 * @param clazz 實體類型 * @param exportList 導出數據 * @param <T> * @return */ public static <T> ModelAndView export(String title, Class<T> clazz, List<T> exportList) { ModelAndView mv = new ModelAndView(new JeecgEntityExcelView()); mv.addObject(NormalExcelConstants.FILE_NAME, title); mv.addObject(NormalExcelConstants.CLASS, clazz); mv.addObject(NormalExcelConstants.PARAMS, new ExportParams(title, title)); mv.addObject(NormalExcelConstants.DATA_LIST, exportList); return mv; }} |
這樣我們導出數據的時候，只需要傳入文件的標題（標題同樣作為表格的標題）、數據類型、數據集合，就可以導出數據了
二、開始導出
1、給實體類加注解
我們將需要導出的實體類或 VO 類中的屬性加上注解 @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
|
package com.zyxx.sys.entity;import com.baomidou.mybatisplus.annotation.*;import com.baomidou.mybatisplus.extension.activerecord.Model;import com.zyxx.common.annotation.Dict;import io.swagger.annotations.ApiModel;import io.swagger.annotations.ApiModelProperty;import lombok.Data;import lombok.EqualsAndHashCode;import lombok.experimental.Accessors;import org.jeecgframework.poi.excel.annotation.Excel;import java.io.Serializable;/** * <p> * 用戶信息表 * </p> * * @author lizhou * @since 2020-07-06 */@Data@EqualsAndHashCode(callSuper = false)@Accessors(chain = true)@TableName("sys_user_info")@ApiModel(value = "SysUserInfo對象", description = "用戶信息表")public class SysUserInfo extends Model<SysUserInfo> { @ApiModelProperty(value = "ID") @TableId(value = "id", type = IdType.AUTO) private Long id; @Excel(name = "賬號", width = 15) @ApiModelProperty(value = "登錄賬號") @TableField("account") private String account; @ApiModelProperty(value = "登錄密碼") @TableField("password") private String password; @Excel(name = "姓名", width = 15) @ApiModelProperty(value = "姓名") @TableField("name") private String name; @Excel(name = "電話", width = 15) @ApiModelProperty(value = "電話") @TableField("phone") private String phone; @ApiModelProperty(value = "頭像") @TableField("avatar") private String avatar; @Excel(name = "性別", width = 15) @ApiModelProperty(value = "性別（0--未知1--男2--女）") @TableField("sex") private Integer sex; @Excel(name = "狀態", width = 15) @ApiModelProperty(value = "狀態（0--正常1--凍結）") @TableField("status") private Integer status; @Excel(name = "創建時間", width = 30) @ApiModelProperty(value = "創建時間") @TableField("create_time") private String createTime;} |
- @Excel(name = “性別”, width = 15)
- name：表頭
- width：列寬度
導出 Excel 時，只會導出加了 @Excel 注解的字段，不然不會導出
2、導出數據
|
1
2
3
4
5
|
@ApiOperation(value = "導出用戶信息", notes = "導出用戶信息")@GetMapping(value = "/export")public ModelAndView exportXls(SysUserInfo sysUserInfo) { return ExcelUtils.export("用戶信息統計報表", SysUserInfo.class, sysUserInfoService.list(1, Integer.MAX_VALUE, sysUserInfo).getData());} |
我們傳入了文件的標題，類型為 SysUserInfo，傳入了數據的集合，這樣我們請求這個 API 就能導出數據了
可以看出數據已經成功導出，但是性別、狀態這些屬性值還屬于魔法值，我們需要自己寫 SQL 來翻譯這些值，或者配合數據字典來翻譯這些值
三、配合數據字典導出
上面介紹了數據的簡單導出，下面介紹配合數據字典導出數據，如果對數據字典不熟悉的同學，可先看看我的另一篇博客：【SpringBoot】廿四、SpringBoot中實現數據字典
1、@Excel 注解
與上面注解相比，我們需要多加一個屬性，dicCode，如下
|
1
2
3
4
5
|
@Excel(name = "性別", width = 15, dicCode = "sex")@ApiModelProperty(value = "性別（0--未知1--男2--女）")@TableField("sex")@Dict(dictCode = "sex")private Integer sex; |
- @Excel(name = “性別”, width = 15, dicCode = “sex”)
- name：表頭
- width：列寬度
- dicCode ：字典類型
這樣，我們就為這個字段注入了一個字典類型，這樣就能翻譯成文本了
2、配置類
要配合數據字典導出，我們需要配置 autopoi 的配置類 AutoPoiConfig.java
|
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
|
import org.jeecgframework.core.util.ApplicationContextUtil;import org.springframework.context.annotation.Bean;import org.springframework.context.annotation.Configuration;/** * autopoi 配置類 * * @Author Lizhou */@Configurationpublic class AutoPoiConfig { /** * excel注解字典參數支持(導入導出字典值，自動翻譯) * 舉例： @Excel(name = "性別", width = 15, dicCode = "sex") * 1、導出的時候會根據字典配置，把值1,2翻譯成：男、女; * 2、導入的時候，會把男、女翻譯成1,2存進數據庫; * @return */ @Bean public ApplicationContextUtil applicationContextUtil() { return new org.jeecgframework.core.util.ApplicationContextUtil(); }} |
3、翻譯規則
我們可以根據自己項目中的字典翻譯規則，來重寫 autopoi 的字典翻譯規則 AutoPoiDictService.java
|
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
|
import com.zyxx.sys.entity.SysDictDetail;import com.zyxx.sys.mapper.SysDictDetailMapper;import lombok.extern.slf4j.Slf4j;import org.jeecgframework.dict.service.AutoPoiDictServiceI;import org.springframework.beans.factory.annotation.Autowired;import org.springframework.stereotype.Service;import java.util.ArrayList;import java.util.List;/** * 描述：AutoPoi Excel注解支持字典參數設置 * 舉例： @Excel(name = "性別", width = 15, dicCode = "sex") * 1、導出的時候會根據字典配置，把值1,2翻譯成：男、女; * 2、導入的時候，會把男、女翻譯成1,2存進數據庫; * * @Author lizhou */@Slf4j@Servicepublic class AutoPoiDictService implements AutoPoiDictServiceI { @Autowired private SysDictDetailMapper sysDictDetailMapper; /** * 通過字典翻譯字典文本 * * @Author lizhou */ @Override public String[] queryDict(String dicTable, String dicCode, String dicText) { List<String> dictReplaces = new ArrayList<>(); List<SysDictDetail> dictList = sysDictDetailMapper.queryDictItemsByCode(dicCode); for (SysDictDetail t : dictList) { if (t != null) { dictReplaces.add(t.getName() + "_" + t.getCode()); } } if (dictReplaces != null && dictReplaces.size() != 0) { return dictReplaces.toArray(new String[dictReplaces.size()]); } return null; }} |
實現了 AutoPoiDictServiceI 接口，重寫 queryDict 方法，這里我只使用了 dicCode 來查詢字典列表，這樣就能配合數據字典導出了
4、導出數據
導出數據如圖所示
可以看出，數據已經成功導出，性別、狀態等魔法值已經被翻譯成文本，這樣，我們的字典翻譯是成功的
四、總結
以上介紹了 JeecgBoot 中的 Autopoi 導出 Excel 的方法，還有配合數據字典導出等操作，可以看出，比以往我們使用的 poi、jsxl 使用方便，導出方便，大大提高了我們的工作效率。更多相關SpringBoot Autopoi導出Excel內容請搜索服務器之家以前的文章或繼續瀏覽下面的相關文章希望大家以后多多支持服務器之家！
原文鏈接：https://blog.csdn.net/qq_40065776/article/details/107824221
