Excel注解ColumnType类型新增文本

RuoYi

2024-03-22 6e5b0e711c9e7924428f2e43825bd4599d73ccd8

 src/main/java/com/ruoyi/common/utils/poi/ExcelUtil.java

@@ -39,6 +39,7 @@
import org.apache.poi.ss.usermodel.CellStyle;

import org.apache.poi.ss.usermodel.CellType;

import org.apache.poi.ss.usermodel.ClientAnchor;

import org.apache.poi.ss.usermodel.DataFormat;

import org.apache.poi.ss.usermodel.DataValidation;

import org.apache.poi.ss.usermodel.DataValidationConstraint;

import org.apache.poi.ss.usermodel.DataValidationHelper;

@@ -97,6 +98,11 @@
    public static final String FORMULA_REGEX_STR = "=|-|\\+|@";



    public static final String[] FORMULA_STR = { "=", "-", "+", "@" };



    /**

     * 用于dictType属性数据存储，避免重复查缓存

     */

    public Map<String, String> sysDictMap = new HashMap<String, String>();



    /**

     * Excel sheet最大行数，默认65536

@@ -283,9 +289,23 @@
     * @param is 输入流

     * @return 转换后集合

     */

    public List<T> importExcel(InputStream is) throws Exception

    public List<T> importExcel(InputStream is)

    {

        return importExcel(is, 0);

        List<T> list = null;

        try

        {

            list = importExcel(is, 0);

        }

        catch (Exception e)

        {

            log.error("导入Excel异常{}", e.getMessage());

            throw new UtilException(e.getMessage());

        }

        finally

        {

            IOUtils.closeQuietly(is);

        }

        return list;

    }



    /**

@@ -331,7 +351,6 @@
        }

        // 获取最后一个非空行的行下标，比如总行数为n，则返回的为n-1

        int rows = sheet.getLastRowNum();



        if (rows > 0)

        {

            // 定义一个map用于存放excel列的序号和field.

@@ -446,7 +465,7 @@
                        {

                            propertyName = field.getName() + "." + attr.targetAttr();

                        }

                        else if (StringUtils.isNotEmpty(attr.readConverterExp()))

                        if (StringUtils.isNotEmpty(attr.readConverterExp()))

                        {

                            val = reverseByExp(Convert.toStr(val), attr.readConverterExp(), attr.separator());

                        }

@@ -456,7 +475,7 @@
                        }

                        else if (!attr.handler().equals(ExcelHandlerAdapter.class))

                        {

                            val = dataFormatHandlerAdapter(val, attr);

                            val = dataFormatHandlerAdapter(val, attr, null);

                        }

                        else if (ColumnType.IMAGE == attr.cellType() && StringUtils.isNotEmpty(pictures))

                        {

@@ -765,6 +784,8 @@
        titleFont.setFontHeightInPoints((short) 16);

        titleFont.setBold(true);

        style.setFont(titleFont);

        DataFormat dataFormat = wb.createDataFormat();

        style.setDataFormat(dataFormat.getFormat("@"));

        styles.put("title", style);



        style = wb.createCellStyle();

@@ -827,6 +848,9 @@
                headerFont.setBold(true);

                headerFont.setColor(excel.headerColor().index);

                style.setFont(headerFont);

                // 设置表格头单元格文本形式

                DataFormat dataFormat = wb.createDataFormat();

                style.setDataFormat(dataFormat.getFormat("@"));

                headerStyles.put(key, style);

            }

        }

@@ -844,32 +868,64 @@
        Map<String, CellStyle> styles = new HashMap<String, CellStyle>();

        for (Object[] os : fields)

        {

            Field field = (Field) os[0];

            Excel excel = (Excel) os[1];

            String key = StringUtils.format("data_{}_{}_{}", excel.align(), excel.color(), excel.backgroundColor());

            if (!styles.containsKey(key))

            if (Collection.class.isAssignableFrom(field.getType()))

            {

                CellStyle style = wb.createCellStyle();

                style.setAlignment(excel.align());

                style.setVerticalAlignment(VerticalAlignment.CENTER);

                style.setBorderRight(BorderStyle.THIN);

                style.setRightBorderColor(IndexedColors.GREY_50_PERCENT.getIndex());

                style.setBorderLeft(BorderStyle.THIN);

                style.setLeftBorderColor(IndexedColors.GREY_50_PERCENT.getIndex());

                style.setBorderTop(BorderStyle.THIN);

                style.setTopBorderColor(IndexedColors.GREY_50_PERCENT.getIndex());

                style.setBorderBottom(BorderStyle.THIN);

                style.setBottomBorderColor(IndexedColors.GREY_50_PERCENT.getIndex());

                style.setFillPattern(FillPatternType.SOLID_FOREGROUND);

                style.setFillForegroundColor(excel.backgroundColor().getIndex());

                Font dataFont = wb.createFont();

                dataFont.setFontName("Arial");

                dataFont.setFontHeightInPoints((short) 10);

                dataFont.setColor(excel.color().index);

                style.setFont(dataFont);

                styles.put(key, style);

                ParameterizedType pt = (ParameterizedType) field.getGenericType();

                Class<?> subClass = (Class<?>) pt.getActualTypeArguments()[0];

                List<Field> subFields = FieldUtils.getFieldsListWithAnnotation(subClass, Excel.class);

                for (Field subField : subFields)

                {

                    Excel subExcel = subField.getAnnotation(Excel.class);

                    annotationDataStyles(styles, subField, subExcel);

                }

            }

            else

            {

                annotationDataStyles(styles, field, excel);

            }

        }

        return styles;

    }



    /**

     * 根据Excel注解创建表格列样式

     * 
     * @param styles 自定义样式列表

     * @param field  属性列信息

     * @param excel  注解信息

     */

    public void annotationDataStyles(Map<String, CellStyle> styles, Field field, Excel excel)

    {

        String key = StringUtils.format("data_{}_{}_{}_{}", excel.align(), excel.color(), excel.backgroundColor(), excel.cellType());

        if (!styles.containsKey(key))

        {

            CellStyle style = wb.createCellStyle();

            style.setAlignment(excel.align());

            style.setVerticalAlignment(VerticalAlignment.CENTER);

            style.setBorderRight(BorderStyle.THIN);

            style.setRightBorderColor(IndexedColors.GREY_50_PERCENT.getIndex());

            style.setBorderLeft(BorderStyle.THIN);

            style.setLeftBorderColor(IndexedColors.GREY_50_PERCENT.getIndex());

            style.setBorderTop(BorderStyle.THIN);

            style.setTopBorderColor(IndexedColors.GREY_50_PERCENT.getIndex());

            style.setBorderBottom(BorderStyle.THIN);

            style.setBottomBorderColor(IndexedColors.GREY_50_PERCENT.getIndex());

            style.setFillPattern(FillPatternType.SOLID_FOREGROUND);

            style.setFillForegroundColor(excel.backgroundColor().getIndex());

            Font dataFont = wb.createFont();

            dataFont.setFontName("Arial");

            dataFont.setFontHeightInPoints((short) 10);

            dataFont.setColor(excel.color().index);

            style.setFont(dataFont);

            if (ColumnType.TEXT == excel.cellType())

            {

                DataFormat dataFormat = wb.createDataFormat();

                style.setDataFormat(dataFormat.getFormat("@"));

            }

            styles.put(key, style);

        }

    }



    /**

@@ -886,7 +942,7 @@
        if (isSubList())

        {

            // 填充默认样式，防止合并单元格样式失效

            sheet.setDefaultColumnStyle(column, styles.get(StringUtils.format("data_{}_{}_{}", attr.align(), attr.color(), attr.backgroundColor())));

            sheet.setDefaultColumnStyle(column, styles.get(StringUtils.format("data_{}_{}_{}_{}", attr.align(), attr.color(), attr.backgroundColor(), attr.cellType())));

            if (attr.needMerge())

            {

                sheet.addMergedRegion(new CellRangeAddress(rownum - 1, rownum, column, column));

@@ -904,7 +960,7 @@
     */

    public void setCellVo(Object value, Excel attr, Cell cell)

    {

        if (ColumnType.STRING == attr.cellType())

        if (ColumnType.STRING == attr.cellType() || ColumnType.TEXT == attr.cellType())

        {

            String cellValue = Convert.toStr(value);

            // 对于任何以表达式触发字符 =-+@开头的单元格，直接使用tab字符作为前缀，防止CSV注入。

@@ -1016,7 +1072,7 @@
                    CellRangeAddress cellAddress = new CellRangeAddress(subMergedFirstRowNum, subMergedLastRowNum, column, column);

                    sheet.addMergedRegion(cellAddress);

                }

                cell.setCellStyle(styles.get(StringUtils.format("data_{}_{}_{}", attr.align(), attr.color(), attr.backgroundColor())));

                cell.setCellStyle(styles.get(StringUtils.format("data_{}_{}_{}_{}", attr.align(), attr.color(), attr.backgroundColor(), attr.cellType())));



                // 用于读取对象中的属性

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

@@ -1034,7 +1090,12 @@
                }

                else if (StringUtils.isNotEmpty(dictType) && StringUtils.isNotNull(value))

                {

                    cell.setCellValue(convertDictByExp(Convert.toStr(value), dictType, separator));

                    if (!sysDictMap.containsKey(dictType + value))

                    {

                        String lable = convertDictByExp(Convert.toStr(value), dictType, separator);

                        sysDictMap.put(dictType + value, lable);

                    }

                    cell.setCellValue(sysDictMap.get(dictType + value));

                }

                else if (value instanceof BigDecimal && -1 != attr.scale())

                {

@@ -1042,7 +1103,7 @@
                }

                else if (!attr.handler().equals(ExcelHandlerAdapter.class))

                {

                    cell.setCellValue(dataFormatHandlerAdapter(value, attr));

                    cell.setCellValue(dataFormatHandlerAdapter(value, attr, cell));

                }

                else

                {

@@ -1255,13 +1316,13 @@
     * @param excel 数据注解

     * @return

     */

    public String dataFormatHandlerAdapter(Object value, Excel excel)

    public String dataFormatHandlerAdapter(Object value, Excel excel, Cell cell)

    {

        try

        {

            Object instance = excel.handler().newInstance();

            Method formatMethod = excel.handler().getMethod("format", new Class[] { Object.class, String[].class });

            value = formatMethod.invoke(instance, value, excel.args());

            Method formatMethod = excel.handler().getMethod("format", new Class[] { Object.class, String[].class, Cell.class, Workbook.class });

            value = formatMethod.invoke(instance, value, excel.args(), cell, this.wb);

        }

        catch (Exception e)

        {