Springboot导出Excel方法（若依实例）

本文介绍springboot中将前端展示的数据导出为Excel表格文件的方法，方法来自若依ruoyi。

1. 相关配置

   1.1 引入环境

   （此处通常包括Spring Boot项目的依赖配置，例如引入poi和poi-ooxml依赖用于Excel操作）

   1.2 配置用注解

   使用自定义的@Excel注解来标记需要导出的实体类字段。例如：

   @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 "";
       /** 如果是字典类型，后缀 */
       public String suffix() default "";
       /** 当值为空时,字段的默认值 */
       public String defaultValue() default "";
       /** 提示信息 */
       public String prompt() default "";
       /** 设置只能选择不能输入的列内容 */
       public String[] combo() default {};
       /** 是否导出数据,应对需求:有时我们需要导出一份模板,这是标题需要但内容需要用户手工填写 */
       public boolean isExport() default true;
       /** 另一个类中的属性名称,支持多级获取,以小数点隔开 */
       public String relatedField() default "";
       // 其他字段配置...
   }
   

   1.3 添加注解所用字段

   为需要导出的实体类字段添加@Excel注解。例如：

   public class Order {
       /** 订单编号 */
       @Excel(name = "订单编号")
       private String orderId;
   
       /** 客户编号 */
       @Excel(name = "客户编号")
       private Long customerId;
   
       /** 姓名 */
       @Excel(name = "姓名")
       private String name;
   
       // 其他字段...
   }
   

   1.4 添加注解

   确保所有需要导出的字段都已添加@Excel注解。

2. Excel方法类

   创建一个工具类用于处理Excel的导出。这个类将使用反射来读取实体类的注解信息，并根据这些信息生成Excel文件。

   2.1 定义变量字段

   定义一些必要的变量，例如工作簿对象、工作表对象、样式列表等。

   2.2 Controller层

   在Controller层创建一个方法来处理Excel的导出请求。例如：

   @RestController
   @RequestMapping("/export")
   public class ExportController {
   
       @GetMapping("/orders")
       public void exportOrders(HttpServletResponse response) throws Exception {
           List<Order> orderList = orderService.getOrderList(); // 获取订单列表
           ExcelUtil<Order> util = new ExcelUtil<>(Order.class);
           util.exportExcel(response, orderList, "订单列表");
       }
   }
   

   2.3 exportExcel(List<T> list, String sheetName)方法

   在ExcelUtil类中实现exportExcel方法。这个方法将负责创建工作簿、工作表、填充数据以及设置样式等。

   2.3.1 init方法（初始化）

   初始化方法用于设置一些默认的样式和配置。

   2.3.2 其他方法（如设置行高、日期格式、导出类型等）

   为实现代码的复用和功能的多样性，应使用注解的方法为不同的实体类、不同的数据类型进行单个配置。

3. 导出方法的具体实现

   导出方法的主要步骤包括：

   • 创建工作簿和工作表。
   • 根据注解信息创建表头。
   • 遍历数据列表填充数据行。
   • 设置样式（如字体、对齐方式、边框等）。
   • 将工作簿写入HttpServletResponse对象，以便下载。

   注意：在实际实现中，需要处理各种异常和边界情况，例如数据为空、字段类型不匹配等。

4. 示例代码

   由于篇幅限制，这里只给出了一个简化的示例代码框架。实际项目中需要根据具体需求进行详细的实现和测试。