Excel自定义相关处理

 

ExcelUtil<TestExcel> excelUtil = new ExcelUtil<>(TestExcel.class);
        excelUtil.exportExcel(reslutList, "excelName", response);

import com.mhw.annotation.Excel;
import org.apache.commons.lang3.StringUtils;
import org.apache.poi.hssf.usermodel.*;
import org.apache.poi.hssf.util.HSSFColor;
import org.apache.poi.ss.usermodel.*;
import org.apache.poi.ss.util.CellRangeAddressList;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;

import javax.servlet.http.HttpServletResponse;
import java.io.FileNotFoundException;
import java.lang.reflect.Field;
import java.lang.reflect.Method;
import java.math.BigDecimal;
import java.util.ArrayList;
import java.util.Date;
import java.util.List;
import java.util.UUID;

/**
 * Excel相关处理
 *
 */
public class ExcelUtil<T> {

    private static final Logger log = LoggerFactory.getLogger(ExcelUtil.class);

    public Class<T> clazz;

    public ExcelUtil(Class<T> clazz) {
        this.clazz = clazz;
    }

    /**
     * 对list数据源将其里面的数据导入到excel表单
     *
     * @param sheetName 工作表的名称
     */
    public void exportExcel(List<T> list, String sheetName, HttpServletResponse response) {
        log.info("导出处理开始");
        Field[] allFields = clazz.getDeclaredFields();// 得到所有定义字段
        List<Field> fields = new ArrayList<Field>();
        // 得到所有field并存放到一个list中.
        for (Field field : allFields) {
            if (field.isAnnotationPresent(Excel.class)) {
                fields.add(field);
            }
        }

        log.info("创建工作簿");

        HSSFWorkbook workbook = new HSSFWorkbook();// 产生工作薄对象
        // excel2003中每个sheet中最多有65536行
        int sheetSize = 65536;
        double sheetNo = Math.ceil(list.size() / sheetSize);// 取出一共有多少个sheet.
        for (int index = 0; index <= sheetNo; index++) {

            log.info("创建工作表");
            HSSFSheet sheet = workbook.createSheet();// 产生工作表对象
            if (sheetNo == 0) {
                workbook.setSheetName(index, sheetName);
            } else {
                workbook.setSheetName(index, sheetName + index);// 设置工作表的名称.
            }
            HSSFRow row;
            HSSFCell cell; // 产生单元格

            log.info("写入表头");

            row = sheet.createRow(0); // 产生一行
            // 写入各个字段的列头名称
            for (int i = 0; i < fields.size(); i++) {
                Field field = fields.get(i);
                Excel attr = field.getAnnotation(Excel.class);
                int col = getExcelCol(String.valueOf((char)(i+65))); // 获得列号  attr.column()
                cell = row.createCell(col); // 创建列
                cell.setCellType(CellType.STRING); // 设置列中写入内容为String类型
                HSSFCellStyle cellStyle = workbook.createCellStyle();
                cellStyle.setAlignment(HorizontalAlignment.CENTER);
                cellStyle.setVerticalAlignment(VerticalAlignment.CENTER);
                if (attr.name().indexOf("注：") >= 0) {
                    HSSFFont font = workbook.createFont();
                    font.setColor(HSSFFont.COLOR_RED);
                    cellStyle.setFont(font);
                    cellStyle.setFillForegroundColor(HSSFColor.HSSFColorPredefined.LIGHT_YELLOW.getIndex());
                    sheet.setColumnWidth(i, 6000);
                } else {
                    HSSFFont font = workbook.createFont();
                    font.setBold(true); // 粗体显示
                    cellStyle.setFont(font); // 选择需要用到的字体格式
                    cellStyle.setFillForegroundColor(HSSFColor.HSSFColorPredefined.LIGHT_YELLOW.getIndex());
                    // 设置列宽
                    sheet.setColumnWidth(i, 3766);
                }
                cellStyle.setFillPattern(FillPatternType.SOLID_FOREGROUND);
                cellStyle.setWrapText(true);
                cell.setCellStyle(cellStyle);

                cell.setCellValue(attr.name());// 写入列名

                // 如果设置了提示信息则鼠标放上去提示.
                if (!attr.prompt().trim().equals("")) {
                    setHSSFPrompt(sheet, "", attr.prompt(), 1, 100, col, col); // 这里默认设了2-101列提示.
                }
                // 如果设置了combo属性则本列只能选择不能输入
                if (attr.combo().length > 0) {
                    setHSSFValidation(sheet, attr.combo(), 1, 100, col, col); // 这里默认设了2-101列只能选择不能输入.
                }
            }

            log.info("写入各条记录");

            int startNo = index * sheetSize;
            int endNo = Math.min(startNo + sheetSize, list.size());
            // 写入各条记录,每条记录对应excel表中的一行
            HSSFCellStyle cs = workbook.createCellStyle();
            cs.setAlignment(HorizontalAlignment.CENTER);
            cs.setVerticalAlignment(VerticalAlignment.CENTER);
            for (int i = startNo; i < endNo; i++) {
                row = sheet.createRow(i + 1 - startNo);
                T vo = (T) list.get(i); // 得到导出对象.
                for (int j = 0; j < fields.size(); j++) {
                    Field field = fields.get(j); // 获得field.
                    field.setAccessible(true); // 设置实体类私有属性可访问
                    // 设置行高
                    Excel attr = field.getAnnotation(Excel.class);
                    row.setHeight((short) (attr.height() * 20));
                    try {

                        // 根据Excel中设置情况决定是否导出,有些情况需要保持为空,希望用户填写这一列.
                        if (attr.isExport()) {
                            cell = row.createCell(getExcelCol(String.valueOf((char)(j+65))));//  创建cell attr.column()
                            cell.setCellStyle(cs);
                            try {
                                if (String.valueOf(field.get(vo)).length() > 10)
                                    throw new Exception("长度超过10位就不用转数字了");
                                // 如果可以转成数字则导出为数字类型
                                BigDecimal bc = new BigDecimal(String.valueOf(field.get(vo)));
                                cell.setCellType(CellType.NUMERIC);
                                cell.setCellValue(bc.doubleValue());
                            } catch (Exception e) {
                                cell.setCellType(CellType.STRING);
                                if (vo == null) {
                                    cell.setCellValue(""); // 如果数据存在就填入,不存在填入空格.
                                } else {
                                    cell.setCellValue(field.get(vo) == null ? "" : String.valueOf(field.get(vo)));// 如果数据存在就填入,不存在填入空格.
                                }

                            }

                            Object value = getTargetValue(vo, field, attr);

                            String dateFormat = attr.dateFormat();
                            String readConverterExp = attr.readConverterExp();
                            if (StringUtils.isNotEmpty(dateFormat) && StringUtils.isNotEmpty(String.valueOf(value)))
                            {
                                cell.setCellValue(DateUtils.dateToStr((Date) value, dateFormat));
                            }
                            else if (StringUtils.isNotEmpty(readConverterExp) && StringUtils.isNotEmpty(String.valueOf(value)))
                            {
                                cell.setCellValue(convertByExp(String.valueOf(value), readConverterExp));
                            }
                            else{
                                if (field.getType() == String.class)
                                {
                                    cell.setCellType(CellType.STRING);
                                    cell.setCellValue(StringUtils.isBlank(String.valueOf(value)) ? attr.defaultValue() : value + attr.suffix());
                                }
                                else if (field.getType() == Integer.class)
                                {
                                    cell.setCellType(CellType.NUMERIC);
                                    cell.setCellValue(Integer.parseInt(value + ""));
                                }

                            }
                        }
                    } catch (Exception e) {
                        log.error("导出Excel失败:"+e);
                    }
                }
            }
        }
        try {

            response.setCharacterEncoding("utf-8");
            response.setContentType("application/vnd.ms-excel;charset=UTF-8");
            response.setHeader("Content-Disposition", "attachment; filename="+sheetName+".xls");
            workbook.write(response.getOutputStream());
            response.getOutputStream().flush();
            response.getOutputStream().close();

        } catch (Exception e) {
            log.error("关闭flush失败:"+e);
            log.info("导出Excel失败！");
        }
    }

//    public List<T> importExcel(String sheetName, InputStream input) throws Exception {
//        List<T> list = new ArrayList<T>();
//
//        Workbook workbook = WorkbookFactory.create(input);
//        Sheet sheet = workbook.getSheet(sheetName);
//        if (!sheetName.trim().equals("")) {
//            sheet = workbook.getSheet(sheetName); // 如果指定sheet名,则取指定sheet中的内容.
//        }
//        if (sheet == null) {
//            sheet = workbook.getSheetAt(0); // 如果传入的sheet名不存在则默认指向第1个sheet.
//        }
//        int rows = sheet.getPhysicalNumberOfRows();
//
//        if (rows > 0) {
//            // 有数据时才处理
//            Field[] allFields = clazz.getDeclaredFields(); // 得到类的所有field.
//            Map<Integer, Field> fieldsMap = new HashMap<Integer, Field>(); // 定义一个map用于存放列的序号和field.
//            for (Field field : allFields) {
//                // 将有注解的field存放到map中.
//                if (field.isAnnotationPresent(Excel.class)) {
//                    Excel attr = field.getAnnotation(Excel.class);
//                    int col = getExcelCol(attr.column());// 获得列号
//                    field.setAccessible(true);// 设置类的私有字段属性可访问.
//                    fieldsMap.put(col, field);
//                }
//            }
//            for (int i = 1; i < rows; i++) {
//                // 从第2行开始取数据,默认第一行是表头.
//                Row row = sheet.getRow(i);
//                int cellNum = sheet.getRow(0).getPhysicalNumberOfCells();
//                T entity = null;
//                for (int j = 0; j < cellNum; j++) {
//                    Cell cell = row.getCell(j);
//                    if (cell == null) {
//                        continue;
//                    } else {
//                        // 先设置Cell的类型，然后就可以把纯数字作为String类型读进来了 by zhuyangyong 20171228
//                        row.getCell(j).setCellType(Cell.CELL_TYPE_STRING);
//                        cell = row.getCell(j);
//                    }
//
//                    String c = cell.getStringCellValue();
//                    if (c.equals("")) {
//                        continue;
//                    }
//
//                    entity = (entity == null ? clazz.newInstance() : entity);// 如果不存在实例则新建.
//                    Field field = fieldsMap.get(j);// 从map中得到对应列的field.
//                    // 取得类型,并根据对象类型设置值.
//                    Class<?> fieldType = field.getType();
//                    if (String.class == fieldType) {
//                        field.set(entity, String.valueOf(c));
//                    } else if ((Integer.TYPE == fieldType) || (Integer.class == fieldType)) {
//                        field.set(entity, Integer.parseInt(c));
//                    } else if ((Long.TYPE == fieldType) || (Long.class == fieldType)) {
//                        field.set(entity, Long.valueOf(c));
//                    } else if ((Float.TYPE == fieldType) || (Float.class == fieldType)) {
//                        field.set(entity, Float.valueOf(c));
//                    } else if ((Short.TYPE == fieldType) || (Short.class == fieldType)) {
//                        field.set(entity, Short.valueOf(c));
//                    } else if ((Double.TYPE == fieldType) || (Double.class == fieldType)) {
//                        field.set(entity, Double.valueOf(c));
//                    } else if (Character.TYPE == fieldType) {
//                        if ((c != null) && (c.length() > 0)) {
//                            field.set(entity, Character.valueOf(c.charAt(0)));
//                        }
//                    } else if (java.util.Date.class == fieldType) {
//                        if (cell.getCellType() == Cell.CELL_TYPE_NUMERIC) {
//                            SimpleDateFormat sdf = new SimpleDateFormat("yyyy-MM-dd HH:mm:ss");
//                            cell.setCellValue(sdf.format(cell.getNumericCellValue()));
//                            c = sdf.format(cell.getNumericCellValue());
//                        } else {
//                            c = cell.getStringCellValue();
//                        }
//                    } else if (java.math.BigDecimal.class == fieldType) {
//                        c = cell.getStringCellValue();
//                    }
//                }
//                if (entity != null) {
//                    list.add(entity);
//                }
//            }
//        }
//
//        return list;
//    }


    /**
     * 获取bean中的属性值
     *
     * @param vo 实体对象
     * @param field 字段
     * @param excel 注解
     * @return 最终的属性值
     * @throws Exception
     */
    private Object getTargetValue(T vo, Field field, Excel excel) throws Exception
    {
        Object o = field.get(vo);
        if (StringUtils.isNotEmpty(excel.targetAttr()))
        {
            String target = excel.targetAttr();
            if (target.indexOf(".") > -1)
            {
                String[] targets = target.split("[.]");
                for (String name : targets)
                {
                    o = getValue(o, name);
                }
            }
            else
            {
                o = getValue(o, target);
            }
        }
        return o;
    }


    /**
     * 以类的属性的get方法方法形式获取值
     *
     * @param o
     * @param name
     * @return value
     * @throws Exception
     */
    private Object getValue(Object o, String name) throws Exception
    {
        if (StringUtils.isNotEmpty(name))
        {
            Class<?> clazz = o.getClass();
            String methodName = "get" + name.substring(0, 1).toUpperCase() + name.substring(1);
            Method method = clazz.getMethod(methodName);
            o = method.invoke(o);
        }
        return o;
    }


    /**
     * 解析导出值 0=男,1=女,2=未知
     *
     * @param propertyValue 参数值
     * @param converterExp 翻译注解
     * @return 解析后值
     * @throws Exception
     */
    public static String convertByExp(String propertyValue, String converterExp) throws Exception
    {
        try
        {
            String[] convertSource = converterExp.split(",");
            for (String item : convertSource)
            {
                String[] itemArray = item.split("=");
                if (itemArray[0].equals(propertyValue))
                {
                    return itemArray[1];
                }
            }
        }
        catch (Exception e)
        {
            throw e;
        }
        return propertyValue;
    }

    /**
     * 将EXCEL中A,B,C,D,E列映射成0,1,2,3
     *
     * @param col
     */
    public static int getExcelCol(String col) {
//        col = col.toUpperCase();
        // 从-1开始计算,字母从1开始运算。这种总数下来算数正好相同。
        int count = -1;
        char[] cs = col.toCharArray();
        for (int i = 0; i < cs.length; i++) {
            count += (cs[i] - 64) * Math.pow(26, cs.length - 1 - i);
        }
        return count;
    }

    /**
     * 设置单元格上提示
     *
     * @param sheet         要设置的sheet.
     * @param promptTitle   标题
     * @param promptContent 内容
     * @param firstRow      开始行
     * @param endRow        结束行
     * @param firstCol      开始列
     * @param endCol        结束列
     * @return 设置好的sheet.
     */
    public static HSSFSheet setHSSFPrompt(HSSFSheet sheet, String promptTitle, String promptContent, int firstRow,
                                          int endRow, int firstCol, int endCol) {
        // 构造constraint对象
        DVConstraint constraint = DVConstraint.createCustomFormulaConstraint("DD1");
        // 四个参数分别是：起始行、终止行、起始列、终止列
        CellRangeAddressList regions = new CellRangeAddressList(firstRow, endRow, firstCol, endCol);
        // 数据有效性对象
        HSSFDataValidation data_validation_view = new HSSFDataValidation(regions, constraint);
        data_validation_view.createPromptBox(promptTitle, promptContent);
        sheet.addValidationData(data_validation_view);
        return sheet;
    }

    /**
     * 设置某些列的值只能输入预制的数据,显示下拉框.
     *
     * @param sheet    要设置的sheet.
     * @param textlist 下拉框显示的内容
     * @param firstRow 开始行
     * @param endRow   结束行
     * @param firstCol 开始列
     * @param endCol   结束列
     * @return 设置好的sheet.
     */
    public static HSSFSheet setHSSFValidation(HSSFSheet sheet, String[] textlist, int firstRow, int endRow,
                                              int firstCol, int endCol) {
        // 加载下拉列表内容
        DVConstraint constraint = DVConstraint.createExplicitListConstraint(textlist);
        // 设置数据有效性加载在哪个单元格上,四个参数分别是：起始行、终止行、起始列、终止列
        CellRangeAddressList regions = new CellRangeAddressList(firstRow, endRow, firstCol, endCol);
        // 数据有效性对象
        HSSFDataValidation data_validation_list = new HSSFDataValidation(regions, constraint);
        sheet.addValidationData(data_validation_list);
        return sheet;
    }

    /**
     * 编码文件名
     */
    public String encodingFilename(String filename) {
        filename = UUID.randomUUID().toString() + "_" + filename + ".xls";
        return filename;
    }

}

import java.lang.annotation.ElementType;
import java.lang.annotation.Retention;
import java.lang.annotation.RetentionPolicy;
import java.lang.annotation.Target;

/**
 * 自定义导出Excel数据注解
 *
 */
@Retention(RetentionPolicy.RUNTIME)
@Target(ElementType.FIELD)
public @interface Excel
{
    /**
     * 导出到Excel中的名字.
     */
    public String name();
    /**
     * 配置列的名称
     */
    public String column() default "";
    /**
     * 日期格式, 如: yyyy-MM-dd
     */
    public String dateFormat() default "";

    /**
     * 读取内容转表达式 (如: 0=男,1=女,2=未知)
     */
    public String readConverterExp() default "";

    /**
     * 导出时在excel中每个列的高度 单位为字符
     */
    public double height() default 14;

    /**
     * 导出时在excel中每个列的宽 单位为字符
     */
    public double width() default 20;

    /**
     * 文字后缀,如% 90 变成90%
     */
    public String suffix() default "";

    /**
     * 当值为空时,字段的默认值
     */
    public String defaultValue() default "";

    /**
     * 提示信息
     */
    public String prompt() default "";

    /**
     * 设置只能选择不能输入的列内容.
     */
    public String[] combo() default {};

    /**
     * 是否导出数据,应对需求:有时我们需要导出一份模板,这是标题需要但内容需要用户手工填写.
     */
    public boolean isExport() default true;


    public String targetAttr() default "";
}