Spring boot使用Excel工具类简单导出数据

1,209 阅读6分钟

1、引入依赖

<!-- office文件上传解析 -->
<dependency>
   <groupId>org.apache.poi</groupId>
   <artifactId>poi</artifactId>
   <version>3.14</version>
</dependency>
<dependency>
   <groupId>org.apache.poi</groupId>
   <artifactId>poi-ooxml</artifactId>
   <version>3.14</version>
</dependency>

2、Excel工具类

package com.deng.util;

import org.apache.poi.xssf.usermodel.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.http.HttpServletResponse;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.lang.reflect.Field;
import java.text.SimpleDateFormat;
import java.util.*;

public class Excel {
    private static final Logger logger = LoggerFactory.getLogger(ExportExcelUtils.class);

    /**
     *导出Excel
     * @param excelName 要导出的excel名称
     * @param fieldMap 中英文字段对应Map,即要导出的excel表头
     * @param response 使用response可以导出到浏览器
     * @param <T>
     */
    public static <T> void export(String excelName, LinkedHashMap<String, String> fieldMap, HttpServletResponse response){

        // 设置默认文件名为当前时间:年月日时分秒
        if (excelName==null || excelName=="") {
            excelName = new SimpleDateFormat("yyyy-MM-dd:hh:mm:ss").format(
                    new Date()).toString();
        }
        // 设置response头信息
        response.reset();
        // 改成输出excel文件
        response.setContentType("application/vnd.ms-excel");
        try {
            response.setHeader("Content-disposition", "attachment; filename="
                    +new String(excelName.getBytes("gb2312"), "ISO-8859-1")  + ".xlsx");
        } catch (UnsupportedEncodingException e1) {
            logger.info(e1.getMessage());
        }

        try {
            //创建一个WorkBook,对应一个Excel文件
            XSSFWorkbook wb=new XSSFWorkbook();
            //在Workbook中,创建一个sheet,对应Excel中的工作薄(sheet)
            XSSFSheet sheet=wb.createSheet(excelName);
            //创建单元格,并设置值表头 设置表头居中
            XSSFCellStyle style=wb.createCellStyle();
            //创建一个居中格式
            style.setAlignment(XSSFCellStyle.ALIGN_CENTER);
            // 填充工作表
            fillSheet(sheet,fieldMap,style);

            //将文件输出
            OutputStream ouputStream = response.getOutputStream();
            wb.write(ouputStream);
            ouputStream.flush();
            ouputStream.close();
        } catch (Exception e) {
            logger.info("导出Excel失败!");
            logger.error(e.getMessage());
        }
    }

    /**
     * 根据字段名获取字段对象
     *
     * @param fieldName
     *            字段名
     * @param clazz
     *            包含该字段的类
     * @return 字段
     */
    public static Field getFieldByName(String fieldName, Class<?> clazz) {
        logger.info("根据字段名获取字段对象:getFieldByName()");
        // 拿到本类的所有字段
        Field[] selfFields = clazz.getDeclaredFields();

        // 如果本类中存在该字段,则返回
        for (Field field : selfFields) {
            //如果本类中存在该字段,则返回
            if (field.getName().equals(fieldName)) {
                return field;
            }
        }

        // 否则,查看父类中是否存在此字段,如果有则返回
        Class<?> superClazz = clazz.getSuperclass();
        if (superClazz != null && superClazz != Object.class) {
            //递归
            return getFieldByName(fieldName, superClazz);
        }

        // 如果本类和父类都没有,则返回空
        return null;
    }

    /**
     * 根据字段名获取字段值
     *
     * @param fieldName  字段名
     * @param o          对象
     * @return           字段值
     * @throws Exception 异常
     *
     */
    public static Object getFieldValueByName(String fieldName, Object o)
            throws Exception {

        logger.info("根据字段名获取字段值:getFieldValueByName()");
        Object value = null;
        //根据字段名得到字段对象
        Field field = getFieldByName(fieldName, o.getClass());

        //如果该字段存在,则取出该字段的值
        if (field != null) {
            //类中的成员变量为private,在类外边使用属性值,故必须进行此操作
            field.setAccessible(true);
            //获取当前对象中当前Field的value
            value = field.get(o);
        } else {
            throw new Exception(o.getClass().getSimpleName() + "类不存在字段名 "
                    + fieldName);
        }

        return value;
    }

    /**
     * 根据带路径或不带路径的属性名获取属性值,即接受简单属性名,
     * 如userName等,又接受带路径的属性名,如student.department.name等
     *
     * @param fieldNameSequence 带路径的属性名或简单属性名
     * @param o                 对象
     * @return                  属性值
     * @throws Exception        异常
     *
     */
    public static Object getFieldValueByNameSequence(String fieldNameSequence,
                                                     Object o) throws Exception {
        logger.info("根据带路径或不带路径的属性名获取属性值,即接受简单属性名:getFieldValueByNameSequence()");
        Object value = null;

        // 将fieldNameSequence进行拆分
        String[] attributes = fieldNameSequence.split("\.");
        if (attributes.length == 1) {
            value = getFieldValueByName(fieldNameSequence, o);
        } else {
            // 根据数组中第一个连接属性名获取连接属性对象,如student.department.name
            Object fieldObj = getFieldValueByName(attributes[0], o);
            //截取除第一个属性名之后的路径
            String subFieldNameSequence = fieldNameSequence
                    .substring(fieldNameSequence.indexOf(".") + 1);
            //递归得到最终的属性对象的值
            value = getFieldValueByNameSequence(subFieldNameSequence, fieldObj);
        }
        return value;

    }

    /**
     * 向工作表中填充数据
     *
     * @param sheet
     *            excel的工作表名称
     * @param fieldMap
     *            中英文字段对应关系的Map
     * @param style
     *            表格中的格式
     * @throws Exception
     *             异常
     *
     */
    public static <T> void fillSheet(XSSFSheet sheet,LinkedHashMap<String, String> fieldMap,XSSFCellStyle style) throws Exception {
        //logger.info("向工作表中填充数据:fillSheet()");
        // 定义存放英文字段名和中文字段名的数组
        String[] enFields = new String[fieldMap.size()];
        String[] cnFields = new String[fieldMap.size()];

        // 填充数组
        int count = 0;
        for (Map.Entry<String, String> entry : fieldMap.entrySet()) {
            enFields[count] = entry.getKey();
            cnFields[count] = entry.getValue();
            count++;
        }

        //在sheet中添加表头第0行,注意老版本poi对Excel的行数列数有限制short
        XSSFRow row=sheet.createRow(0);

        // 填充表头
        for (int i = 0; i < cnFields.length; i++) {
            XSSFCell cell=row.createCell(i);
            cell.setCellValue(cnFields[i]);
            cell.setCellStyle(style);
            //设置自动列宽
            sheet.autoSizeColumn(i);
            sheet.setColumnWidth(i, sheet.getColumnWidth(i) * 17/10);
        }

        }
    }
package com.deng.util;

import org.apache.poi.xssf.usermodel.*;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.http.HttpServletResponse;
import java.io.OutputStream;
import java.io.UnsupportedEncodingException;
import java.lang.reflect.Field;
import java.text.SimpleDateFormat;
import java.util.*;

public class ExportExcelUtils {

    private static final Logger logger = LoggerFactory.getLogger(ExportExcelUtils.class);

    /**
     *导出Excel
     * @param excelName 要导出的excel名称
     * @param list 要导出的数据集合
     * @param fieldMap 中英文字段对应Map,即要导出的excel表头
     * @param response 使用response可以导出到浏览器
     * @param <T>
     */
    public static <T> void export(String excelName, List<T> list, LinkedHashMap<String, String> fieldMap, HttpServletResponse response){

        // 设置默认文件名为当前时间:年月日时分秒
        if (excelName==null || excelName=="") {
            excelName = new SimpleDateFormat("yyyy-MM-dd:hh:mm:ss").format(
                    new Date()).toString();
        }
        // 设置response头信息
        response.reset();
        // 改成输出excel文件
        response.setContentType("application/vnd.ms-excel");
        try {
            response.setHeader("Content-disposition", "attachment; filename="
                    +new String(excelName.getBytes("gb2312"), "ISO-8859-1")  + ".xlsx");
        } catch (UnsupportedEncodingException e1) {
            logger.info(e1.getMessage());
        }

        try {
            //创建一个WorkBook,对应一个Excel文件
            XSSFWorkbook wb=new XSSFWorkbook();
            //在Workbook中,创建一个sheet,对应Excel中的工作薄(sheet)
            XSSFSheet sheet=wb.createSheet(excelName);
            //创建单元格,并设置值表头 设置表头居中
            XSSFCellStyle style=wb.createCellStyle();
            //创建一个居中格式
            style.setAlignment(XSSFCellStyle.ALIGN_CENTER);
            // 填充工作表
            fillSheet(sheet,list,fieldMap,style);

            //将文件输出
            OutputStream ouputStream = response.getOutputStream();
            wb.write(ouputStream);
            ouputStream.flush();
            ouputStream.close();
        } catch (Exception e) {
            logger.info("导出Excel失败!");
            logger.error(e.getMessage());
        }
    }

    /**
     * 根据字段名获取字段对象
     *
     * @param fieldName
     *            字段名
     * @param clazz
     *            包含该字段的类
     * @return 字段
     */
    public static Field getFieldByName(String fieldName, Class<?> clazz) {
        logger.info("根据字段名获取字段对象:getFieldByName()");
        // 拿到本类的所有字段
        Field[] selfFields = clazz.getDeclaredFields();

        // 如果本类中存在该字段,则返回
        for (Field field : selfFields) {
            //如果本类中存在该字段,则返回
            if (field.getName().equals(fieldName)) {
                return field;
            }
        }

        // 否则,查看父类中是否存在此字段,如果有则返回
        Class<?> superClazz = clazz.getSuperclass();
        if (superClazz != null && superClazz != Object.class) {
            //递归
            return getFieldByName(fieldName, superClazz);
        }

        // 如果本类和父类都没有,则返回空
        return null;
    }

    /**
     * 根据字段名获取字段值
     *
     * @param fieldName  字段名
     * @param o          对象
     * @return           字段值
     * @throws Exception 异常
     *
     */
    public static Object getFieldValueByName(String fieldName, Object o)
            throws Exception {

        logger.info("根据字段名获取字段值:getFieldValueByName()");
        Object value = null;
        //根据字段名得到字段对象
        Field field = getFieldByName(fieldName, o.getClass());

        //如果该字段存在,则取出该字段的值
        if (field != null) {
            //类中的成员变量为private,在类外边使用属性值,故必须进行此操作
            field.setAccessible(true);
            //获取当前对象中当前Field的value
            value = field.get(o);
        } else {
            throw new Exception(o.getClass().getSimpleName() + "类不存在字段名 "
                    + fieldName);
        }

        return value;
    }

    /**
     * 根据带路径或不带路径的属性名获取属性值,即接受简单属性名,
     * 如userName等,又接受带路径的属性名,如student.department.name等
     *
     * @param fieldNameSequence 带路径的属性名或简单属性名
     * @param o                 对象
     * @return                  属性值
     * @throws Exception        异常
     *
     */
    public static Object getFieldValueByNameSequence(String fieldNameSequence,
                                                     Object o) throws Exception {
        logger.info("根据带路径或不带路径的属性名获取属性值,即接受简单属性名:getFieldValueByNameSequence()");
        Object value = null;

        // 将fieldNameSequence进行拆分
        String[] attributes = fieldNameSequence.split("\.");
        if (attributes.length == 1) {
            value = getFieldValueByName(fieldNameSequence, o);
        } else {
            // 根据数组中第一个连接属性名获取连接属性对象,如student.department.name
            Object fieldObj = getFieldValueByName(attributes[0], o);
            //截取除第一个属性名之后的路径
            String subFieldNameSequence = fieldNameSequence
                    .substring(fieldNameSequence.indexOf(".") + 1);
            //递归得到最终的属性对象的值
            value = getFieldValueByNameSequence(subFieldNameSequence, fieldObj);
        }
        return value;

    }

    /**
     * 向工作表中填充数据
     *
     * @param sheet
     *            excel的工作表名称
     * @param list
     *            数据源
     * @param fieldMap
     *            中英文字段对应关系的Map
     * @param style
     *            表格中的格式
     * @throws Exception
     *             异常
     *
     */
    public static <T> void fillSheet(XSSFSheet sheet, List<T> list,
                                     LinkedHashMap<String, String> fieldMap,XSSFCellStyle style) throws Exception {
        logger.info("向工作表中填充数据:fillSheet()");
        // 定义存放英文字段名和中文字段名的数组
        String[] enFields = new String[fieldMap.size()];
        String[] cnFields = new String[fieldMap.size()];

        // 填充数组
        int count = 0;
        for (Map.Entry<String, String> entry : fieldMap.entrySet()) {
            enFields[count] = entry.getKey();
            cnFields[count] = entry.getValue();
            count++;
        }

        //在sheet中添加表头第0行,注意老版本poi对Excel的行数列数有限制short
        XSSFRow row=sheet.createRow(0);

        // 填充表头
        for (int i = 0; i < cnFields.length; i++) {
            XSSFCell cell=row.createCell(i);
            cell.setCellValue(cnFields[i]);
            cell.setCellStyle(style);
            //设置自动列宽
            sheet.autoSizeColumn(i);
            sheet.setColumnWidth(i, sheet.getColumnWidth(i) * 17/10);
        }

        // 填充内容
        for (int index = 0; index < list.size(); index++) {
            row = sheet.createRow(index + 1);
            // 获取单个对象
            T item = list.get(index);
            for (int i = 0; i < enFields.length; i++) {
                Object objValue = getFieldValueByNameSequence(enFields[i], item);
                String fieldValue = objValue == null ? "" : objValue.toString();
                //设置自动列宽
                sheet.autoSizeColumn(i);
                sheet.setColumnWidth(i, sheet.getColumnWidth(i) * 17/10);
                row.createCell(i).setCellValue(fieldValue);
            }
        }
    }

}

3、控制层实现

/**
 * 
 * @param response 导出信息
 */
@RequestMapping("VolunteerExcel")
public void ExportBankVolunteerInfo(HttpServletResponse response){
    //获取数据库用户信息
    List<Volunteerapplication> list=volunteerapplicationDao.selectList(Wrappers.lambdaQuery());

    //定义导出的excel表名
    String excelName = "用户信息表";

    //获取需要转出的excel表头的map字段
    LinkedHashMap<String, String> fieldMap = new LinkedHashMap<>();
    fieldMap.put("username","姓名");
    fieldMap.put("sex","性别");
    fieldMap.put("nation","国家/地区");
    fieldMap.put("politicalStatus","政治面貌");
    fieldMap.put("education","学历");
    fieldMap.put("nationality","民族");

    //导出用户相关信息
    new ExportExcelUtils().export(excelName,list,fieldMap,response);
}

4、前端页面

只需要一个a标签就可以了

<a href="/VolunteerExcel"></a>

这样就OK啦

image.png