Java 如何快速,优雅的实现导出Excel

我们来详细讲解如何使用Java快速、优雅地实现导出Excel。

一、前置知识

在进行导出Excel之前，我们需要掌握以下前置知识：

使用Java中的POI库操作Excel
使用Java中的注解

这里简单介绍一下：

1.1 POI库

Apache POI是用于读写Microsoft Office格式文件的Java库。它支持Excel、Word和PowerPoint格式的文件操作。我们可以使用POI库中的类来读取、创建和修改Excel文档。

1.2 注解

注解（annotation）是Java 5之后加入的新特性，它可以用来为程序元素（类、方法、变量等）添加元数据（metadata）。我们可以使用注解来标记需要导出的属性，方便快速地实现导出Excel的功能。

二、具体步骤

了解了前置知识之后，我们来具体看一下如何实现导出Excel的步骤：

2.1 创建Excel文件

我们首先需要创建一个工作簿（Workbook），然后创建一个工作表（Sheet），并向其中添加数据。以下是一个示例代码：

// 创建工作簿
Workbook workbook = new XSSFWorkbook();
// 创建工作表
Sheet sheet = workbook.createSheet("sheet1");
// 创建行
Row row = sheet.createRow(0);
// 创建单元格并设置值
Cell cell = row.createCell(0);
cell.setCellValue("姓名");
cell = row.createCell(1);
cell.setCellValue("年龄");

2.2 标记需要导出的数据

在Java中使用注解来标记需要导出的属性，可以使用自定义注解（比如@ExcelColumn）来实现。该注解应该包含以下信息：

标记Excel中该列的列名
标记该属性所在的列的下标（从0开始）

下面是一个@ExcelColumn注解的示例代码：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ExcelColumn {
    String value() default ""; // Excel中该列的列名
    int col() default 0;       // 该属性所在的列的下标
}

2.3 创建实体类

我们需要创建一个实体类，存放需要导出的数据。需要将@ExcelColumn注解放在该类中对应属性上，标记需要导出的属性。以下是一个示例代码：

public class Person {
    @ExcelColumn(value = "姓名", col = 0)
    private String name;
    @ExcelColumn(value = "年龄", col = 1)
    private int age;

    // getter和setter方法省略
}

2.4 读取实体数据并导出到Excel

我们需要将实体类中的数据读取到Excel中，可以使用反射获取每个属性的值，并根据@ExcelColumn注解来确定该属性在Excel中的位置。以下是一个示例代码：

// 获取Excel中表头行
Row headerRow = sheet.createRow(0);
// 获取实体类所有字段
Field[] fields = Person.class.getDeclaredFields();
// 添加表头
for (Field field : fields) {
    if (field.isAnnotationPresent(ExcelColumn.class)) {
        ExcelColumn excelColumn = field.getAnnotation(ExcelColumn.class);
        int colIndex = excelColumn.col();
        String columnName = excelColumn.value();
        Cell cell = headerRow.createCell(colIndex);
        cell.setCellValue(columnName);
    }
}

// 添加数据
List<Person> persons = getPersons();
int rowIndex = 1;
for (Person person : persons) {
    Row row = sheet.createRow(rowIndex++);
    for (Field field : fields) {
        if (field.isAnnotationPresent(ExcelColumn.class)) {
            ExcelColumn excelColumn = field.getAnnotation(ExcelColumn.class);
            int colIndex = excelColumn.col();
            Object value = field.get(person);
            Cell cell = row.createCell(colIndex);
            cell.setCellValue(value.toString());
        }
    }
}

// 将工作簿写入文件中
FileOutputStream fos = new FileOutputStream(new File("person.xlsx"));
workbook.write(fos);
fos.close();
workbook.close();

三、示例说明

下面是两个示例说明：

示例一：导出成绩单

我们需要将一些学生的成绩导出到Excel中，包括姓名、学科、分数等信息。我们可以使用如下的@ExcelColumn注解：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ExcelColumn {
    String value() default "";
    int col() default 0;
}

public class Score {
    @ExcelColumn(value = "姓名", col = 0)
    private String name;
    @ExcelColumn(value = "学科", col = 1)
    private String subject;
    @ExcelColumn(value = "分数", col = 2)
    private int score;
}

然后就可以使用上面的步骤来将数据导出到Excel中了。

示例二：导出订单信息

我们需要将一些订单的信息导出到Excel中，包括订单号、商品名、数量、价格等信息。我们可以使用如下的@ExcelColumn注解：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ExcelColumn {
    String value() default "";
    int col() default 0;
}

public class Order {
    @ExcelColumn(value = "订单号", col = 0)
    private String orderId;
    @ExcelColumn(value = "商品名", col = 1)
    private String productName;
    @ExcelColumn(value = "数量", col = 2)
    private int quantity;
    @ExcelColumn(value = "价格", col = 3)
    private double price;
}