SpringBoot中使用JeecgBoot的Autopoi匯出Excel的方法步驟
說到匯出 Excel,我們首先會想到 poi、jsxl 等,使用這些工具會顯得笨重,學習難度大。今天學習使用 JeecgBoot 中的 Autopoi 匯出 Excel,底層基於 easypoi,使用簡單,還支援資料字典方式
一、開發前戲
1、引入 maven 依賴
<!-- 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 標籤下面
<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 檔案中
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
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、匯出資料
@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,如下
@Excel(name = "性別",width = 15,dicCode = "sex") @ApiModelProperty(value = "性別(0--未知1--男2--女)") @TableField("sex") @Dict(dictCode = "sex") private Integer sex;
- @Excel(name = “性別”,dicCode = “sex”)
- name:表頭
- width:列寬度
- dicCode :字典型別
這樣,我們就為這個欄位注入了一個字典型別,這樣就能翻譯成文字了
2、配置類
要配合資料字典匯出,我們需要配置 autopoi 的配置類 AutoPoiConfig.java
import org.jeecgframework.core.util.ApplicationContextUtil; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; /** * autopoi 配置類 * * @Author Lizhou */ @Configuration public class AutoPoiConfig { /** * excel註解字典引數支援(匯入匯出字典值,自動翻譯) * 舉例: @Excel(name = "性別",dicCode = "sex") * 1、匯出的時候會根據字典配置,把值1,2翻譯成:男、女; * 2、匯入的時候,會把男、女翻譯成1,2存進資料庫; * @return */ @Bean public ApplicationContextUtil applicationContextUtil() { return new org.jeecgframework.core.util.ApplicationContextUtil(); } }
3、翻譯規則
我們可以根據自己專案中的字典翻譯規則,來重寫 autopoi 的字典翻譯規則 AutoPoiDictService.java
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 = "性別",dicCode = "sex") * 1、匯出的時候會根據字典配置,把值1,2翻譯成:男、女; * 2、匯入的時候,會把男、女翻譯成1,2存進資料庫; * * @Author lizhou */ @Slf4j @Service public 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內容請搜尋我們以前的文章或繼續瀏覽下面的相關文章希望大家以後多多支援我們!