【纯干货】SSM 实现将数据导出为 Excel 表格（利用反射实现类型通配）

最新推荐文章于 2023-04-18 13:46:45 发布

寒冰小澈IceClean

最新推荐文章于 2023-04-18 13:46:45 发布

阅读量2.7k

点赞数 8

分类专栏：实用功能文章标签： java excel

本文链接：https://blog.csdn.net/Ice__Clean/article/details/119422919

版权

实用功能专栏收录该内容

18 篇文章 0 订阅

订阅专栏

0. 这里假设 SSM 环境已经搭建完成

1. 需要三个依赖包

<!-- 导出为 Excel -->
<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi-ooxml</artifactId>
    <version>5.0.0</version>
</dependency>

<dependency>
    <groupId>org.apache.poi</groupId>
    <artifactId>poi</artifactId>
    <version>5.0.0</version>
</dependency>

<dependency>
    <groupId>com.alibaba</groupId>
    <artifactId>easyexcel</artifactId>
    <version>2.2.10</version>
</dependency>

2. 核心工具类

目标是传入泛型数据列表 List dataList 实现将所有类型输出为 excel 表格，而不需要自己手动指定属性，所以对类的操作必不可少

这里利用反射达到了类的成员变量名
以及得到成员变量名和其值的映射关系（使用 Map，键是成员变量名 String ，值是成员变量值 Object）

ClassUtils.java

package com.iceclean.utils;

import java.lang.reflect.Field;
import java.util.ArrayList;
import java.util.HashMap;
import java.util.List;
import java.util.Map;

/**
 * @author : Ice'Clean
 * @date : 2021-08-05
 *
 * 对类的操作
 */
public class ClassUtils {

    /**
     * 通过类型返回对应的属性列表
     * @param target 目标类型
     * @return 属性列表
     */
    public static List<String> getFields(Class<?> target) {
        // 获取所有成员变量名称
        List<String> fieldList = new ArrayList<>();
        Field[] declaredFields = target.getDeclaredFields();

        // 放入 List 集合中
        for(Field field : declaredFields) {
            fieldList.add(field.getName());
        }

        return  fieldList;
    }

    /**
     * 获取泛型所有的成员及其值的映射
     * @param data 泛型对象
     * @param <T> 泛型
     * @return 成员变量名和成员变量值的映射
     */
    public static <T> Map<String, Object> getFieldOfValue(T data) throws IllegalAccessException {
        // 获取所有成员变量，并建立一个 Map（大小为成员变量的个数）来存放名字和值的对应关系
        Field[] declaredFields = data.getClass().getDeclaredFields();
        Map<String, Object> fieldMap = new HashMap<>(declaredFields.length);

        // 获取每个成员属性对应的值，并映射
        for (Field field : declaredFields) {
            // 允许访问私有变量的值
            field.setAccessible(true);

            // 获取成员变量的值，并放入 map 中
            fieldMap.put(field.getName(), field.get(data));
        }

        return fieldMap;
    }

}

3. 核心代码

/**
 * 将列表数据导出为 Excel 表格
 * @param dataList 列表数据
 * @param out 输出源
 * @param <T> 数据的类型
 */
public static <T> void exportExcel(List<T> dataList, ServletOutputStream out) throws IllegalAccessException, IOException {
    // 空集合直接返回
    if (dataList.isEmpty()) {
        return;
    }

    // 获取泛型 T 的所有成员变量
    List<String> fieldList = ClassUtils.getFields(dataList.get(0).getClass());

    // 建立一个 Excel 文件，并在文件中创建一个表单
    HSSFWorkbook workbook = new HSSFWorkbook();
    HSSFSheet sheet = workbook.createSheet();

    // 创建行（表头）
    HSSFRow row = sheet.createRow(0);

    // 创建单元格，并设置表头居中
    HSSFCellStyle hssfCellStyle = workbook.createCellStyle();
    hssfCellStyle.setAlignment(HorizontalAlignment.CENTER);

    // 循环设置列名
    HSSFCell hssfCell;
    for (int i = 0; i < fieldList.size(); i++) {
        hssfCell = row.createCell(i);
        hssfCell.setCellValue(fieldList.get(i));
        hssfCell.setCellStyle(hssfCellStyle);
    }

    // 为每一行添加数据
    Map<String, Object> dataMap;
    for (int i = 0; i < dataList.size(); i++) {
        // 添加新的一行
        row = sheet.createRow(i + 1);

        // 获取泛型对象 T 的成员变量和值的对应关系
        dataMap = ClassUtils.getFieldOfValue(dataList.get(i));

        // 将数据写入该行
        for (int j = 0; j < fieldList.size(); j++) {
            // 先通过 list 获取成员变量名，再通过 map 获取对应的值，转化为 String 之后放入表格中
            row.createCell(j).setCellValue("" + dataMap.get(fieldList.get(j)));
        }
    }

    // 将数据输出，刷出，关闭
    workbook.write(out);
    out.flush();;
    out.close();
}

同样是三步完成~

接下来是简单的使用演示
这里 Controller 层为了简化演示，使用了 Get 请求，制造数据也只起演示作用，可以自行替换

其中使用的 User 包含了 userId（Integer）userName（String）和 userPass（String）三个属性

=== Controller 层 ===

@GetMapping("/excel")
@ResponseBody
public void exportExcel(HttpServletResponse response) throws IOException, IllegalAccessException {
    // 设置 ContentType 和返回头
    response.setContentType("application/binary;charset=UTF-8");
    response.setHeader("Content-Disposition", "attachment;fileName=" + URLEncoder.encode("导出"+new SimpleDateFormat("yyyyMMddHHmmss").format(new Date()) +".xls", "UTF-8"));

    //获得输出流
    ServletOutputStream out = response.getOutputStream();

    // 制造数据
    List<User> userList = new ArrayList<>();
    userList.add(new User(1, "iceclean", "ice123"));
    userList.add(new User(2, "len", "len123"));
    userList.add(new User(3, "rin", "rin123"));
    userList.add(new User(4, "rex", "rex123"));
    userList.add(new User(5, "alsie", "als123"));

    // 输出 excel 表格数据
    fileService.exportExcel(userList, out);
}

=== Service 层 ===

public <T> void exportExcel(List<T> dataList, ServletOutputStream out) throws IOException, IllegalAccessException {
    FileUtils.exportExcel(dataList, out);
}

Postman 上的演示：
什么值也不用传，可以看到返回的是乱码（其实是二进制流）
在这里插入图片描述
所以这里需要放到浏览器中去执行（可以用前端写个 post 方法，这里单纯使用 get 直接测试）

使用浏览器直接访问的效果：
将直接弹出个下载框
在这里插入图片描述
打开看里面的数据

任务圆满完成~~

▲ 与之相关的还有文件导出篇，可以看看这篇【纯干货】SSM 实现文件上传

2021-8-10 更新

对以上方法的不足之处作了改进，包括以下两点：

当字段为空时，表格中直接显示为 null，可以改进为人为指定 null 的代替值
表格中的列名直接为属性英文名，可以改进为人为指定其对应的中文名称

对空值的改进

简单的改进的话，只需要找到工具类 ClassUtils.java 中的 getFieldOfValue() 方法，对里边的值作判断即可
也可以将默认值作为字段提取出来成为形参，供调用者输入，这里不作演示了

// 获取每个成员属性对应的值，并映射
for (Field field : declaredFields) {
    // 允许访问私有变量的值
    field.setAccessible(true);

    // 获取属性值，并在其为空时赋予默认值
    String fieldData = field.get(data).toString();
    fieldData = fieldData == null ? "": fieldData;

    // 获取成员变量的值，并放入 map 中
    fieldMap.put(field.getName(), fieldData);
}

对列名的改进

① 首先添加自定义注解：
其中元注解 Target 表示注解使用在什么地方（这里设置为成员变量），Retention 设置注解在什么时候可以存在（这里设置为在运行期间可以被反射读取到）

/**
 * @author : Ice'Clean
 * @date : 2021-08-10
 *
 * 为实体类的成员变量起名字
 */
@Target(ElementType.FIELD)
@Retention(RetentionPolicy.RUNTIME)
public @interface FieldName {
    String value() default "名字";
}

② 然后在实体类中使用该注解
自定义属性名对应的中文名称

/**
 * @author : Ice'Clean
 * @date : 2021-08-05
 */
public class User {

    @FieldName("用户 Id")
    private Integer userId;

    @FieldName("用户名")
    private String userName;

    @FieldName("用户密码")
    private String userPass;

	//... 省略
}

③ 在 ClassUtils.java 工具类中添加以下方法

/**
 * 通过类型返回对应的属性名称列表
 * 名称为该属性上的 FieldName（自定义注解） 的值
 * @param target 目标类型
 * @return 属性对应的中文名称列表
 */
public static List<String> getFieldNames(Class<?> target) {
    // 获取所有成员变量名称
    List<String> fieldList = new ArrayList<>();
    Field[] declaredFields = target.getDeclaredFields();

    // 放入 List 集合中
    for(Field field : declaredFields) {
        // 获取该成员变量注解 FieldName 的值，即其对应的中文名称
        // 这里通过反射，取出了属性中的 value 值，即属性对象的中文名称
        fieldList.add(field.getAnnotation(FieldName.class).value());
    }

    return  fieldList;
}

④ 对核心代码进行改进
改动的地方很简单，增加一个中文名称列表（从上面方法中获得），将列名的填充值改成由该列表填充即可

/**
 * 将列表数据导出为 Excel 表格
 * @param dataList 列表数据
 * @param out 输出源
 * @param <T> 数据的类型
 */
public static <T> void exportExcel(List<T> dataList, ServletOutputStream out) throws IllegalAccessException, IOException {
    // 空集合直接返回
    if (dataList.isEmpty()) {
        return;
    }

    // 获取泛型 T 的所有成员变量
    // 这里的第一种是获取原属性名，第二种是获取属性对应的注解 FieldName 的值，即对应的中文名称
    List<String> fieldList = ClassUtils.getFields(dataList.get(0).getClass());
    List<String> fieldNameList = ClassUtils.getFieldNames(dataList.get(0).getClass());

    // 建立一个 Excel 文件，并在文件中创建一个表单
    HSSFWorkbook workbook = new HSSFWorkbook();
    HSSFSheet sheet = workbook.createSheet();

    // 创建行（表头）
    HSSFRow row = sheet.createRow(0);

    // 创建单元格，并设置表头居中
    HSSFCellStyle hssfCellStyle = workbook.createCellStyle();
    hssfCellStyle.setAlignment(HorizontalAlignment.CENTER);

    // 循环设置列名（这里使用注解对应的中文名）
    HSSFCell hssfCell;
    for (int i = 0; i < fieldNameList.size(); i++) {
        hssfCell = row.createCell(i);
        hssfCell.setCellValue(fieldNameList.get(i));
        hssfCell.setCellStyle(hssfCellStyle);
    }

    // 为每一行添加数据
    Map<String, Object> dataMap;
    for (int i = 0; i < dataList.size(); i++) {
        // 添加新的一行
        row = sheet.createRow(i + 1);

        // 获取泛型对象 T 的成员变量和值的对应关系
        dataMap = ClassUtils.getFieldOfValue(dataList.get(i));

        // 将数据写入该行
        for (int j = 0; j < fieldList.size(); j++) {
            // 先通过 list 获取成员变量名，再通过 map 获取对应的值，转化为 String 之后放入表格中
            row.createCell(j).setCellValue("" + dataMap.get(fieldList.get(j)));
        }
    }

    // 将数据输出，刷出，关闭
    workbook.write(out);
    out.flush();;
    out.close();
}

⑤ 最终效果：
在这里插入图片描述

晨露夜集（IceClean）

寒冰小澈IceClean

关注

8
点赞
踩
27

收藏

觉得还不错? 一键收藏
打赏
6
评论
【纯干货】SSM 实现将数据导出为 Excel 表格（利用反射实现类型通配）

利用反射实现了将任意的 List<T> 导出为 Excel 表格，不需要再去手动指定参数和值啦！全部自动读取自动生成，只包含了一个工具类和一个核心函数
复制链接

扫一扫