若依框架的Excel导出功能学习总结
·
若依框架的Excel导出功能主要基于Apache POI封装,通过自定义的ExcelUtil工具类实现高效便捷的数据导出。以下是其实现原理和关键步骤的详细解析:
一、核心实现机制
1. ExcelUtil 工具类
ExcelUtil.java 是若依框架中用于处理 Excel 相关操作的工具类。其主要功能如下:
- Excel 导出:支持将数据集合导入到 Excel 表单,可设置工作表名称、标题等,还能生成导入模板。
- Excel 导入:能将 Excel 文件中的数据转换为 Java 对象列表,支持处理图片、日期等不同类型的数据。
- 注解处理:读取
@Excel注解信息,根据注解配置生成和解析 Excel 文件。 - 样式设置:可以设置 Excel 表格的标题、表头样式,以及单元格的对齐方式、背景颜色等。
2. @Excel 注解
package com.ruoyi.common.annotation;
import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;
import java.math.BigDecimal;
import org.apache.poi.ss.usermodel.HorizontalAlignment;
import org.apache.poi.ss.usermodel.IndexedColors;
import com.ruoyi.common.utils.poi.ExcelHandlerAdapter;
/**
* 自定义导出Excel数据注解
*
* @author ruoyi
*/
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Excel
{
/**
* 导出时在excel中排序
*/
public int sort() default Integer.MAX_VALUE;
/**
* 导出到Excel中的名字.
*/
public String name() default "";
/**
* 日期格式, 如: yyyy-MM-dd
*/
public String dateFormat() default "";
/**
* 如果是字典类型,请设置字典的type值 (如: sys_user_sex)
*/
public String dictType() default "";
/**
* 读取内容转表达式 (如: 0=男,1=女,2=未知)
*/
public String readConverterExp() default "";
/**
* 分隔符,读取字符串组内容
*/
public String separator() default ",";
/**
* BigDecimal 精度 默认:-1(默认不开启BigDecimal格式化)
*/
public int scale() default -1;
/**
* BigDecimal 舍入规则 默认:BigDecimal.ROUND_HALF_EVEN
*/
public int roundingMode() default BigDecimal.ROUND_HALF_EVEN;
/**
* 导出时在excel中每个列的高度
*/
public double height() default 14;
/**
* 导出时在excel中每个列的宽度
*/
public double width() default 16;
/**
* 文字后缀,如% 90 变成90%
*/
public String suffix() default "";
/**
* 当值为空时,字段的默认值
*/
public String defaultValue() default "";
/**
* 提示信息
*/
public String prompt() default "";
/**
* 是否允许内容换行
*/
public boolean wrapText() default false;
/**
* 设置只能选择不能输入的列内容.
*/
public String[] combo() default {};
/**
* 是否从字典读数据到combo,默认不读取,如读取需要设置dictType注解.
*/
public boolean comboReadDict() default false;
/**
* 是否需要纵向合并单元格,应对需求:含有list集合单元格)
*/
public boolean needMerge() default false;
/**
* 是否导出数据,应对需求:有时我们需要导出一份模板,这是标题需要但内容需要用户手工填写.
*/
public boolean isExport() default true;
/**
* 另一个类中的属性名称,支持多级获取,以小数点隔开
*/
public String targetAttr() default "";
/**
* 是否自动统计数据,在最后追加一行统计数据总和
*/
public boolean isStatistics() default false;
/**
* 导出类型(0数字 1字符串 2图片)
*/
public ColumnType cellType() default ColumnType.STRING;
/**
* 导出列头背景颜色
*/
public IndexedColors headerBackgroundColor() default IndexedColors.GREY_50_PERCENT;
/**
* 导出列头字体颜色
*/
public IndexedColors headerColor() default IndexedColors.WHITE;
/**
* 导出单元格背景颜色
*/
public IndexedColors backgroundColor() default IndexedColors.WHITE;
/**
* 导出单元格字体颜色
*/
public IndexedColors color() default IndexedColors.BLACK;
/**
* 导出字段对齐方式
*/
public HorizontalAlignment align() default HorizontalAlignment.CENTER;
/**
* 自定义数据处理器
*/
public Class<?> handler() default ExcelHandlerAdapter.class;
/**
* 自定义数据处理器参数
*/
public String[] args() default {};
/**
* 字段类型(0:导出导入;1:仅导出;2:仅导入)
*/
Type type() default Type.ALL;
public enum Type
{
ALL(0), EXPORT(1), IMPORT(2);
private final int value;
Type(int value)
{
this.value = value;
}
public int value()
{
return this.value;
}
}
public enum ColumnType
{
NUMERIC(0), STRING(1), IMAGE(2), TEXT(3);
private final int value;
ColumnType(int value)
{
this.value = value;
}
public int value()
{
return this.value;
}
}
}
二、代码执行流程
以示例代码为例的完整调用链:
1. Controller层入口
@PostMapping("/export")
public void export(HttpServletResponse response, TbCourse tbCourse) {
List<TbCourse> list = tbCourseService.selectTbCourseList(tbCourse);
ExcelUtil<TbCourse> util = new ExcelUtil<>(TbCourse.class);
util.exportExcel(response, list, "课程管理数据");
}
2. 核心处理步骤
① 数据准备阶段:
- 通过Service调用Mapper获取数据列表
- 执行动态SQL过滤
/**
* 查询课程管理列表
*
* @param tbCourse 课程管理
* @return 课程管理集合
*/
public List<TbCourse> selectTbCourseList(TbCourse tbCourse);
/**
* 查询课程管理列表
*
* @param tbCourse 课程管理
* @return 课程管理
*/
@Override
public List<TbCourse> selectTbCourseList(TbCourse tbCourse)
{
return tbCourseMapper.selectTbCourseList(tbCourse);
}
/**
* 查询课程管理列表
*
* @param tbCourse 课程管理
* @return 课程管理集合
*/
public List<TbCourse> selectTbCourseList(TbCourse tbCourse);
<resultMap type="TbCourse" id="TbCourseResult">
<result property="id" column="id" />
<result property="code" column="code" />
<result property="subject" column="subject" />
<result property="name" column="name" />
<result property="price" column="price" />
<result property="applicablePerson" column="applicable_person" />
<result property="info" column="info" />
<result property="createTime" column="create_time" />
<result property="updateTime" column="update_time" />
</resultMap>
<sql id="selectTbCourseVo">
select id, code, subject, name, price, applicable_person, info, create_time, update_time from tb_course
</sql>
<select id="selectTbCourseList" parameterType="TbCourse" resultMap="TbCourseResult">
<include refid="selectTbCourseVo"/>
<where>
<if test="code != null and code != ''"> and code = #{code}</if>
<if test="subject != null and subject != ''"> and subject = #{subject}</if>
<if test="name != null and name != ''"> and name like concat('%', #{name}, '%')</if>
<if test="applicablePerson != null and applicablePerson != ''"> and applicable_person = #{applicablePerson}</if>
</where>
</select>
② Excel生成阶段:RuoYi-Vue\ruoyi-common\src\main\java\com\ruoyi\common\utils\poi\ExcelUtil.java
// ExcelUtil.exportExcel() 关键逻辑
public void exportExcel(HttpServletResponse response, List<T> list, String sheetName) {
// 1. 设置响应头(Content-Type、文件名等)
response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
response.setHeader("Content-disposition", "attachment;filename=" + URLEncoder.encode(sheetName + ".xlsx", "UTF-8"));
// 2. 创建Workbook(使用SXSSF处理大数据量)
Workbook workbook = new SXSSFWorkbook(500); // 内存中保留500行
// 3. 通过反射解析@Excel注解生成表头
List<ExcelColumn> columns = resolveExcelColumns(clazz);
// 4. 填充数据
Sheet sheet = workbook.createSheet(sheetName);
createHeaderRow(sheet, columns); // 生成标题行
fillDataRows(sheet, list, columns); // 填充数据行
// 5. 写入响应流
workbook.write(response.getOutputStream());
}
3. 注解处理细节
实体类示例:
public class TbCourse {
@Excel(name = "课程ID", sort = 1)
private Long id;
@Excel(name = "课程名称", sort = 2)
private String name;
@Excel(name = "价格", sort = 3)
private BigDecimal price;
@Excel(name = "创建时间", sort = 4, dateFormat = "yyyy-MM-dd HH:mm:ss")
private Date createTime;
}
处理逻辑:
- 按
sort值排序生成列顺序 - 自动处理日期格式化(
dateFormat) - 支持字典转换(
dictType关联系统字典表) - 如果不指定sort:
public class TbCourse {
@Excel(name = "课程ID") // 默认排第1列
private Long id;
@Excel(name = "课程名称") // 默认排第2列
private String name;
@Excel(name = "价格") // 默认排第3列
private BigDecimal price;
}
三、性能对比
| 方案 | 1000行耗时 | 内存占用 | 100万行支持 |
|---|---|---|---|
| 原生POI | 200ms | 高 | 不支持 |
| 若依ExcelUtil | 300ms | 中 | 支持 |
| EasyExcel | 250ms | 低 | 支持 |
四、最佳实践建议
- 数据预处理:在Service层完成数据格式化(如金额单位转换)
- 分页查询:导出超万条数据建议先分页查询再合并
- 异步导出:结合若依的
@Async注解实现后台导出 - 安全控制:通过
@PreAuthorize确保导出权限
若依的Excel导出通过高度封装,在保持灵活性的同时极大简化了开发工作量,是中小型项目数据导出的优选方案。对于超大数据量(千万级)场景,建议结合EasyExcel进一步优化。
注意
本文内容仅供参考,不构成任何形式的专业建议。作者尽力确保信息的准确性,但不对因使用本文内容而引发的任何直接或间接损失负责。读者应自行核实信息并咨询相关专业人士。
更多推荐

所有评论(0)