> 本文整理自平台文档 docs/wujies/5.x/ruoyi-vue-plus/framework/basic/export.mdx,用于站点内容演示。
(https://console.wujies.cn/remote-apps/cms-assets/doc-c51fd41c8efa-cover.svg)
- - -
框架基于 Apache Fesod(原EasyExcel)(对 Apache POI 的封装与扩展)实现 Excel 导出。
[Apache Fesod 文档地址](https://fesod.apache.org/)
使用流程
### 1. 定义导出实体
以 SysUserExportVo 为例:
/**
* 用户ID
*/
@ExcelProperty(value = "用户序号")
private Long userId;
/**
* 用户性别
*/
@ExcelProperty(value = "用户性别", converter = ExcelDictConvert.class)
@ExcelDictFormat(dictType = "sys_user_sex")
private String sex;
/**
* 帐号状态(0正常 1停用)
*/
@ExcelProperty(value = "帐号状态", converter = ExcelDictConvert.class)
@ExcelDictFormat(dictType = "sys_normal_disable")
private String status;
说明:
- 使用
@ExcelProperty标注需要导出的字段 value为表头字段名,converter为转换器@ExcelDictFormat为自定义注解,与字典转换器配合使用- 建议导出对象单独定义,不要直接把数据库实体原样暴露到 Excel
### 2. 编写导出接口
以 SysUserController#export 为例:
@PostMapping("/export")
public void export(SysUserBo user, HttpServletResponse response) {
List<SysUserVo> list = userService.selectUserList(user);
List<SysUserExportVo> listVo = MapstructUtils.convert(list, SysUserExportVo.class);
ExcelUtil.exportExcel(listVo, "用户数据", SysUserExportVo.class, response);
}
- 常见做法是
Vo -> ExportVo再导出,这样便于控制列顺序、字段脱敏和字典转换 - 导出接口通常是直接写
HttpServletResponse输出流,因此方法返回值一般不再包装成R<?> - 前端按钮权限通常会对应
xxx:export
框架工具说明
### 1. 字典转换器
ExcelDictConvert 与 @ExcelDictFormat 搭配使用。
@ExcelProperty(value = "用户性别", converter = ExcelDictConvert.class)
@ExcelDictFormat(dictType = "sys_user_sex")
private String sex;
也可使用表达式:
@ExcelProperty(value = "用户性别", converter = ExcelDictConvert.class)
@ExcelDictFormat(readConverterExp="0=男,1=女,2=未知", separator=",")
private String sex;
@ExcelDictFormat 属性说明:
| 属性名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| dictType | String | "" | 字典 type(如:sys_user_sex) |
| readConverterExp | String | "" | 读取内容转表达式(如:0=男,1=女,2=未知) |
| separator | String | "," | 表达式分隔符 |
### 2. 枚举转换器
@ExcelProperty(value = "用户类型", index = 1, converter = ExcelEnumConvert.class)
@ExcelEnumFormat(enumClass = UserStatus.class, textField = "info")
private String userStatus;
@ExcelEnumFormat 属性说明:
| 属性名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| enumClass | Enum Class | - | 枚举类 |
| codeField | String | code | 枚举中的 code 字段 |
| textField | String | text | 枚举中的文本字段 |
### 3. 合并单元格
@CellMerge 用于合并相同列数据,需结合 CellMergeStrategy 使用。
@CellMerge
@ExcelProperty(value = "部门id")
private Long deptId;
@CellMerge 属性说明:
| 属性名称 | 类型 | 默认值 | 说明 |
|---|---|---|---|
| index | int | -1 | 合并列下标(建议默认) |
| mergeBy | String[] | {} | 依赖字段名称 |
导出时开启合并:
ExcelUtil.exportExcel(list, "测试单表", TestDemoVo.class, true, response);

### 4. 复杂导出示例
TestExcelController 提供多种导出示例:
- 单列表多数据导出(模板导出)
- 多列表多数据导出(模板导出)
- 导出下拉框(
ExcelDictFormat默认下拉)
模板位置:ruoyi-modules/ruoyi-demo/src/main/resources/excel/
这些模板更适合作为结构示例参考,复杂业务仍建议按自己的导出字段和样式重新整理。
 
 

常用注解
| 类型 | 注解名称 | 使用举例 | 说明 |
|---|---|---|---|
| 格式化 | @DateTimeFormat | @DateTimeFormat(value=格式化值) | 日期格式化 |
| 格式化 | @NumberFormat | @NumberFormat(value=格式化值, roundingMode=舍入模式) | 数值格式化 |
| 样式 | @ColumnWidth | @ColumnWidth |
本文导览
(https://console.wujies.cn/remote-apps/cms-assets/doc-c51fd41c8efa-guide.svg)


评论区需要浏览器启用 JavaScript 才能加载。