Java利用Reflect实现封装Excel导出工具类

下面我来详细为你讲解“Java利用Reflect实现封装Excel导出工具类”的完整攻略。

什么是Reflect（反射）？

Java中的反射机制是指在运行时动态地获取类的信息和调用类的方法的机制。通过反射机制可以实现访问对象的属性和方法，这种机制使得Java具有非常大的灵活性和可扩展性。

需求说明

最近有一个需求是从Java程序中导出数据到Excel表格，需要封装一个工具类完成此功能。为了尽可能地降低耦合度和提高代码的复用性，我们考虑使用Java的反射机制来完成此需求。

Reflect实现Excel导出步骤

下面是使用Java的反射机制来实现Excel导出工具类的步骤：

1. 创建工具类ExcelUtil

public class ExcelUtil {

    // 导出Excel方法
    public static void exportExcel(List<?> list, String[] fields, String[] headers, OutputStream out) {
        try {
            // 创建Workbook
            Workbook wb = new HSSFWorkbook();
            Sheet sheet = wb.createSheet(); // 创建Sheet

            // 创建表头行
            Row headerRow = sheet.createRow(0);
            for (int i = 0; i < headers.length; i++) {
                Cell cell = headerRow.createCell(i);
                cell.setCellValue(headers[i]);
            }

            // 循环写入数据
            for (int i = 0; i < list.size(); i++) {
                Row row = sheet.createRow(i + 1);
                Object obj = list.get(i);

                // 使用反射获取数据
                for (int j = 0; j < fields.length; j++) {
                    Field field = obj.getClass().getDeclaredField(fields[j]);
                    field.setAccessible(true);
                    Object value = field.get(obj);

                    Cell cell = row.createCell(j);
                    cell.setCellValue(value.toString());
                }
            }

            // 输出
            wb.write(out);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

1. 定义注解ExcelField

用于标注Excel表格每一列对应的Java对象属性：

@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface ExcelField {
    String value(); // 表头名称
    int order() default 0; // 表头顺序
}

1. 使用ExcelField注解标记Java对象属性

public class Student {

    @ExcelField("学号")
    private String code;

    @ExcelField("姓名")
    private String name;

    @ExcelField(value="性别", order = 1)
    private String gender;

    @ExcelField(value="出生日期", order = 2)
    private Date birthday;

    // 省略getter和setter方法
}

1. 修改ExcelUtil，使用ExcelField注解来获取数据

public class ExcelUtil {

    // 导出Excel方法
    public static void exportExcel(List<?> list, OutputStream out) {
        try {
            // 创建Workbook
            Workbook wb = new HSSFWorkbook();
            Sheet sheet = wb.createSheet(); // 创建Sheet

            // 获取表头行
            Row headerRow = sheet.createRow(0);        
            Field[] fields = list.get(0).getClass().getDeclaredFields();
            for (Field field : fields) {
                ExcelField excelField = field.getAnnotation(ExcelField.class);
                if (excelField != null) {
                    String header = excelField.value();
                    int order = excelField.order();
                    Cell cell = headerRow.createCell(order);
                    cell.setCellValue(header);
                }
            }

            // 循环写入数据
            for (int i = 0; i < list.size(); i++) {
                Row row = sheet.createRow(i + 1);
                Object obj = list.get(i);

                // 使用反射获取数据
                for (Field field : fields) {
                    ExcelField excelField = field.getAnnotation(ExcelField.class);
                    if (excelField != null) {
                        int order = excelField.order();
                        Object value = field.get(obj);

                        Cell cell = row.createCell(order);
                        cell.setCellValue(value.toString());
                    }
                }
            }

            // 输出
            wb.write(out);
        } catch (Exception e) {
            e.printStackTrace();
        }
    }

}

示例说明

下面我以一个学生管理系统为例来演示如何使用上述工具类进行Excel导出。

1. 生成测试数据

List<Student> list = new ArrayList<>();

// 添加学生数据
Student stu1 = new Student("001", "张三", "男", new Date());
Student stu2 = new Student("002", "李四", "女", new Date());
Student stu3 = new Student("003", "王五", "男", new Date());
list.add(stu1);
list.add(stu2);
list.add(stu3);

1. 调用ExcelUtil导出Excel

try {
    OutputStream out = new FileOutputStream("student.xls");
    ExcelUtil.exportExcel(list, out);
    out.close();
    System.out.println("导出成功");
} catch (Exception e) {
    e.printStackTrace();
}

此时可以在项目根目录下找到生成的Excel表格文件"student.xls"。

总结

本文详细讲解了如何使用Java的Reflect机制来封装一个Excel导出工具类。通过使用注解ExcelField和反射机制，工具类的代码具有非常大的灵活性和可扩展性，实现了高度的耦合度，使得开发者在使用此工具类的时候可以更加便捷和高效。