poi封装导出Excel【java】

朴灿烈づ我的快乐病毒、 2022-07-17 00:30 180阅读 0赞

> 最近做项目的过程中需要实现导出excel，他们有已经写好的实现，但是只是针对他们业务逻辑的，所以我就想能不能封装一个通用的方法，于是找出之前用过的导出方法，然后照着封装了一个，还可以。但是两个方法也有不同，一个用的是WritableWorkbook（JXL），另一个用的是HSSFWorkbook（POI）。我们先来看看两者有什么关系。

## 一、扫盲 ##

### 1、POI ###

对于POI而言，可以说是导出EXCEL的基础，其他的第三方工具都是在其基础上做的封装，但是可操作性上由于要逐行逐列的进行操作，所以可操作性上来说比较繁琐，个人不推荐使用。

### 2、JXL ###

JXL是通过Java操作excel表格的工具类库，丰富了许多的函数来解决POI操作性上的缺陷。

## 二、对比 ##

### 1、POI ###

优点：

> Jxl对中文支持非常好，操作简单，方法看名知意。  
> Jxl是纯javaAPI，在跨平台上表现的非常完美，代码可以再windows或者Linux上运行而无需重新编写  
> 支持Excel 95-2000的所有版本  
> 生成Excel 2000标准格式  
> 支持字体、数字、日期操作  
> 能够修饰单元格属性  
> 支持图像和图表,但是这套API对图形和图表的支持很有限，而且仅仅识别PNG格式。

缺点

> 效率低，图片支持部完善，对格式的支持不如POI强大

### 2、JXL ###

优点

> 效率高，这点很好  
> 支持公式，宏，一些企业应用上会非常实用  
> 能够修饰单元格属性  
> 支持字体、数字、日期操作  
> 缺点  
> 不成熟,代码不能跨平台，貌似不少同行在使用工程中还碰到让人郁闷的BUG

## 三、封装好的导出 ##

### 1、导出工具类 ###

package com.paincupid.springmvc.util.export;
    
    import java.io.OutputStream;
    import java.io.UnsupportedEncodingException;
    import java.lang.reflect.Field;
    import java.text.SimpleDateFormat;
    import java.util.Date;
    import java.util.LinkedHashMap;
    import java.util.List;
    import java.util.Map.Entry;
    import javax.servlet.http.HttpServletResponse;
    
    import org.apache.commons.lang.StringUtils;
    import org.apache.poi.hssf.usermodel.HSSFCell;
    import org.apache.poi.hssf.usermodel.HSSFCellStyle;
    import org.apache.poi.hssf.usermodel.HSSFRow;
    import org.apache.poi.hssf.usermodel.HSSFSheet;
    import org.apache.poi.hssf.usermodel.HSSFWorkbook;
    import org.slf4j.Logger;
    import org.slf4j.LoggerFactory;
    
    public class ExportToExcelUtil { 
        private static final Logger logger = LoggerFactory.getLogger(ExportToExcelUtil.class);
    
        /** * 导出Excel * * @param excelName * 要导出的excel名称 * @param list * 要导出的数据集合 * @param fieldMap * 中英文字段对应Map,即要导出的excel表头 * @param response * 使用response可以导出到浏览器 * @return */
        public static <T> void export(String excelName, List<T> list, LinkedHashMap<String, String> fieldMap,
                HttpServletResponse response) {
    
            // 设置默认文件名为当前时间：年月日时分秒
            if (StringUtils.isBlank(excelName)) {
                excelName = new SimpleDateFormat("yyyy-MM-dd hhmmss").format(new Date()).toString();
            }
            // 设置response头信息
            response.reset();
            response.setContentType("application/vnd.ms-excel"); // 改成输出excel文件
            try {
                response.setHeader("Content-disposition",
                        "attachment; filename=" + new String(excelName.getBytes("gb2312"), "ISO-8859-1") + ".xls");
            } catch (UnsupportedEncodingException e1) {
                logger.info(e1.getMessage());
            }
    
            try {
                // 创建一个WorkBook,对应一个Excel文件
                HSSFWorkbook wb = new HSSFWorkbook();
                // 在Workbook中，创建一个sheet，对应Excel中的工作薄（sheet）
                HSSFSheet sheet = wb.createSheet(excelName);
                // 创建单元格，并设置值表头 设置表头居中
                HSSFCellStyle style = wb.createCellStyle();
                // 创建一个居中格式
                style.setAlignment(HSSFCellStyle.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(), fieldName: "+fieldName);
            // 拿到本类的所有字段
            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) {
                field.setAccessible(true);// 类中的成员变量为private,在类外边使用属性值，故必须进行此操作
                value = field.get(o);// 获取当前对象中当前Field的value
            } else {
                throw new Exception(o.getClass().getSimpleName() + "类不存在字段名 " + fieldName);
            }
            logger.info("value: "+ value);
            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(): "+fieldNameSequence);
            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(HSSFSheet sheet, List<T> list, LinkedHashMap<String, String> fieldMap,
                HSSFCellStyle style) throws Exception {
            logger.info("向工作表中填充数据:fillSheet()");
            // 定义存放英文字段名和中文字段名的数组
            String[] enFields = new String[fieldMap.size()];
            String[] cnFields = new String[fieldMap.size()];
    
            // 填充数组
            int count = 0;
            for (Entry<String, String> entry : fieldMap.entrySet()) {
                enFields[count] = entry.getKey();
                cnFields[count] = entry.getValue();
                count++;
            }
    
            // 在sheet中添加表头第0行,注意老版本poi对Excel的行数列数有限制short
            HSSFRow row = sheet.createRow((int) 0);
    
            // 填充表头
            for (int i = 0; i < cnFields.length; i++) {
                HSSFCell cell = row.createCell(i);
                cell.setCellValue(blank(6)+cnFields[i]+blank(6));
                cell.setCellStyle(style);
    
            }
    
            // 填充内容
            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();
    
                    row.createCell(i).setCellValue(fieldValue);
                }
            }
    
            //列自适应
            for (int i = 0; i < cnFields.length; i++) {
                sheet.autoSizeColumn(i);
            }
        }
    
    
    
        public static String BLANK_SPACE = " ";
        /** * 用来产生空格 * @param numb * @return */
        public static   String blank(int numb){
            if(numb <= 0){
                numb = 1;
            }
            StringBuilder str = new StringBuilder();
            for(int i = 0; i<numb; i++){
                str.append(BLANK_SPACE);
            }
            return str.toString();
        }
    }

### 2、调用工具类导出 ###

@RequestMapping(value = "/excel/exportBankCheckInfo", method = RequestMethod.GET)
        public void ExportBankCheckInfo(HttpServletRequest request, HttpServletResponse response) {
            //得到所要导出的数据
            List<BankCheck> errLst = bankCheckService.selectBankCheckAll();
    
            //定义导出excel的名字
            String excelName="导出银行提现对账记录";
            // 获取需要转出的excle表头的map字段
            LinkedHashMap<String, String> fieldMap =new LinkedHashMap<String, String>() ;
            fieldMap.put("name", "姓名");
            fieldMap.put("age", "年龄");
            //导出银行提现对账记录
            NewExportToExcelUtil.export(excelName, errLst, fieldMap, response);

转载：[笑破苍穹][Link 1]

[Link 1]: http://blog.csdn.net/u010168160/article/details/50497985