Excel注解支持wrapText是否允许内容换行

RuoYi

2024-12-03 eb77d5245a329d16699f974ea322a6cada65c2cb

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

@@ -195,6 +195,11 @@
    public Class<T> clazz;



    /**

     * 需要显示列属性

     */

    public String[] includeFields;



    /**

     * 需要排除列属性

     */

    public String[] excludeFields;

@@ -205,10 +210,19 @@
    }



    /**

     * 仅在Excel中显示列属性

     *

     * @param fields 列属性名 示例[单个"name"/多个"id","name"]

     */

    public void showColumn(String... fields)

    {

        this.includeFields = fields;

    }



    /**

     * 隐藏Excel中列属性

     *

     * @param fields 列属性名 示例[单个"name"/多个"id","name"]

     * @throws Exception

     */

    public void hideColumn(String... fields)

    {

@@ -238,8 +252,6 @@
    {

        if (StringUtils.isNotEmpty(title))

        {

            subMergedFirstRowNum++;

            subMergedLastRowNum++;

            int titleLastCol = this.fields.size() - 1;

            if (isSubList())

            {

@@ -250,7 +262,7 @@
            Cell titleCell = titleRow.createCell(0);

            titleCell.setCellStyle(styles.get("title"));

            titleCell.setCellValue(title);

            sheet.addMergedRegion(new CellRangeAddress(titleRow.getRowNum(), titleRow.getRowNum(), titleRow.getRowNum(), titleLastCol));

            sheet.addMergedRegion(new CellRangeAddress(titleRow.getRowNum(), titleRow.getRowNum(), 0, titleLastCol));

        }

    }



@@ -261,23 +273,31 @@
    {

        if (isSubList())

        {

            subMergedFirstRowNum++;

            subMergedLastRowNum++;

            Row subRow = sheet.createRow(rownum);

            int excelNum = 0;

            int column = 0;

            int subFieldSize = subFields != null ? subFields.size() : 0;

            for (Object[] objects : fields)

            {

                Field field = (Field) objects[0];

                Excel attr = (Excel) objects[1];

                Cell headCell1 = subRow.createCell(excelNum);

                headCell1.setCellValue(attr.name());

                headCell1.setCellStyle(styles.get(StringUtils.format("header_{}_{}", attr.headerColor(), attr.headerBackgroundColor())));

                excelNum++;

            }

            int headFirstRow = excelNum - 1;

            int headLastRow = headFirstRow + subFields.size() - 1;

            if (headLastRow > headFirstRow)

            {

                sheet.addMergedRegion(new CellRangeAddress(rownum, rownum, headFirstRow, headLastRow));

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

                {

                    Cell cell = subRow.createCell(column);

                    cell.setCellValue(attr.name());

                    cell.setCellStyle(styles.get(StringUtils.format("header_{}_{}", attr.headerColor(), attr.headerBackgroundColor())));

                    if (subFieldSize > 1)

                    {

                        CellRangeAddress cellAddress = new CellRangeAddress(rownum, rownum, column, column + subFieldSize - 1);

                        sheet.addMergedRegion(cellAddress);

                    }

                    column += subFieldSize;

                }

                else

                {

                    Cell cell = subRow.createCell(column++);

                    cell.setCellValue(attr.name());

                    cell.setCellStyle(styles.get(StringUtils.format("header_{}_{}", attr.headerColor(), attr.headerBackgroundColor())));

                }

            }

            rownum++;

        }

@@ -471,7 +491,12 @@
                        }

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

                        {

                            val = reverseDictByExp(Convert.toStr(val), attr.dictType(), attr.separator());

                            if (!sysDictMap.containsKey(attr.dictType() + val))

                            {

                                String dictValue = reverseDictByExp(Convert.toStr(val), attr.dictType(), attr.separator());

                                sysDictMap.put(attr.dictType() + val, dictValue);

                            }

                            val = sysDictMap.get(attr.dictType() + val);

                        }

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

                        {

@@ -706,64 +731,91 @@
    {

        int startNo = index * sheetSize;

        int endNo = Math.min(startNo + sheetSize, list.size());

        int rowNo = (1 + rownum) - startNo;

        int currentRowNum = rownum + 1; // 从标题行后开始



        for (int i = startNo; i < endNo; i++)

        {

            rowNo = isSubList() ? (i > 1 ? rowNo + 1 : rowNo + i) : i + 1 + rownum - startNo;

            row = sheet.createRow(rowNo);

            // 得到导出对象.

            row = sheet.createRow(currentRowNum);

            T vo = (T) list.get(i);

            Collection<?> subList = null;

            if (isSubList())

            {

                if (isSubListValue(vo))

                {

                    subList = getListCellValue(vo);

                    subMergedLastRowNum = subMergedLastRowNum + subList.size();

                }

                else

                {

                    subMergedFirstRowNum++;

                    subMergedLastRowNum++;

                }

            }

            int column = 0;

            int maxSubListSize = getCurrentMaxSubListSize(vo);

            for (Object[] os : fields)

            {

                Field field = (Field) os[0];

                Excel excel = (Excel) os[1];

                if (Collection.class.isAssignableFrom(field.getType()) && StringUtils.isNotNull(subList))

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

                {

                    boolean subFirst = false;

                    for (Object obj : subList)

                    try

                    {

                        if (subFirst)

                        Collection<?> subList = (Collection<?>) getTargetValue(vo, field, excel);

                        if (subList != null && !subList.isEmpty())

                        {

                            rowNo++;

                            row = sheet.createRow(rowNo);

                        }

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

                        int subIndex = 0;

                        for (Field subField : subFields)

                        {

                            if (subField.isAnnotationPresent(Excel.class))

                            int subIndex = 0;

                            for (Object subVo : subList)

                            {

                                subField.setAccessible(true);

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

                                this.addCell(attr, row, (T) obj, subField, column + subIndex);

                                Row subRow = sheet.getRow(currentRowNum + subIndex);

                                if (subRow == null)

                                {

                                    subRow = sheet.createRow(currentRowNum + subIndex);

                                }



                                int subColumn = column;

                                for (Field subField : subFields)

                                {

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

                                    addCell(subExcel, subRow, (T) subVo, subField, subColumn++);

                                }

                                subIndex++;

                            }

                            subIndex++;

                            column += subFields.size();

                        }

                        subFirst = true;

                    }

                    this.subMergedFirstRowNum = this.subMergedFirstRowNum + subList.size();

                    catch (Exception e)

                    {

                        log.error("填充集合数据失败", e);

                    }

                }

                else

                {

                    this.addCell(excel, row, vo, field, column++);

                    // 创建单元格并设置值

                    addCell(excel, row, vo, field, column);

                    if (maxSubListSize > 1 && excel.needMerge())

                    {

                        sheet.addMergedRegion(new CellRangeAddress(currentRowNum, currentRowNum + maxSubListSize - 1, column, column));

                    }

                    column++;

                }

            }

            currentRowNum += maxSubListSize;

        }

    }



    /**

     * 获取子列表最大数

     */

    private int getCurrentMaxSubListSize(T vo)

    {

        int maxSubListSize = 1;

        for (Object[] os : fields)

        {

            Field field = (Field) os[0];

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

            {

                try

                {

                    Collection<?> subList = (Collection<?>) getTargetValue(vo, field, (Excel) os[1]);

                    if (subList != null && !subList.isEmpty())

                    {

                        maxSubListSize = Math.max(maxSubListSize, subList.size());

                    }

                }

                catch (Exception e)

                {

                    log.error("获取集合大小失败", e);

                }

            }

        }

        return maxSubListSize;

    }



    /**

@@ -898,7 +950,7 @@
     */

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

    {

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

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

        if (!styles.containsKey(key))

        {

            CellStyle style = wb.createCellStyle();

@@ -914,6 +966,7 @@
            style.setBottomBorderColor(IndexedColors.GREY_50_PERCENT.getIndex());

            style.setFillPattern(FillPatternType.SOLID_FOREGROUND);

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

            style.setWrapText(excel.wrapText());

            Font dataFont = wb.createFont();

            dataFont.setFontName("Arial");

            dataFont.setFontHeightInPoints((short) 10);

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

        {

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

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

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

            if (attr.needMerge())

            {

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

@@ -1037,17 +1090,28 @@
            // 设置列宽

            sheet.setColumnWidth(column, (int) ((attr.width() + 0.72) * 256));

        }

        if (StringUtils.isNotEmpty(attr.prompt()) || attr.combo().length > 0)

        if (StringUtils.isNotEmpty(attr.prompt()) || attr.combo().length > 0 || attr.comboReadDict())

        {

            if (attr.combo().length > 15 || StringUtils.join(attr.combo()).length() > 255)

            String[] comboArray = attr.combo();

            if (attr.comboReadDict())

            {

                if (!sysDictMap.containsKey("combo_" + attr.dictType()))

                {

                    String labels = DictUtils.getDictLabels(attr.dictType());

                    sysDictMap.put("combo_" + attr.dictType(), labels);

                }

                String val = sysDictMap.get("combo_" + attr.dictType());

                comboArray = StringUtils.split(val, DictUtils.SEPARATOR);

            }

            if (comboArray.length > 15 || StringUtils.join(comboArray).length() > 255)

            {

                // 如果下拉数大于15或字符串长度大于255，则使用一个新sheet存储，避免生成的模板下拉值获取不到

                setXSSFValidationWithHidden(sheet, attr.combo(), attr.prompt(), 1, 100, column, column);

                setXSSFValidationWithHidden(sheet, comboArray, attr.prompt(), 1, 100, column, column);

            }

            else

            {

                // 提示信息或只能选择不能输入的列内容.

                setPromptOrValidation(sheet, attr.combo(), attr.prompt(), 1, 100, column, column);

                setPromptOrValidation(sheet, comboArray, attr.prompt(), 1, 100, column, column);

            }

        }

    }

@@ -1069,10 +1133,12 @@
                cell = row.createCell(column);

                if (isSubListValue(vo) && getListCellValue(vo).size() > 1 && attr.needMerge())

                {

                    CellRangeAddress cellAddress = new CellRangeAddress(subMergedFirstRowNum, subMergedLastRowNum, column, column);

                    sheet.addMergedRegion(cellAddress);

                    if (subMergedLastRowNum >= subMergedFirstRowNum)

                    {

                        sheet.addMergedRegion(new CellRangeAddress(subMergedFirstRowNum, subMergedLastRowNum, column, column));

                    }

                }

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

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



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

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

@@ -1413,6 +1479,7 @@
     */

    private Object getTargetValue(T vo, Field field, Excel excel) throws Exception

    {

        field.setAccessible(true);

        Object o = field.get(vo);

        if (StringUtils.isNotEmpty(excel.targetAttr()))

        {

@@ -1472,46 +1539,83 @@
        List<Field> tempFields = new ArrayList<>();

        tempFields.addAll(Arrays.asList(clazz.getSuperclass().getDeclaredFields()));

        tempFields.addAll(Arrays.asList(clazz.getDeclaredFields()));

        for (Field field : tempFields)

        if (StringUtils.isNotEmpty(includeFields))

        {

            if (!ArrayUtils.contains(this.excludeFields, field.getName()))

            for (Field field : tempFields)

            {

                // 单注解

                if (field.isAnnotationPresent(Excel.class))

                if (ArrayUtils.contains(this.includeFields, field.getName()) || field.isAnnotationPresent(Excels.class))

                {

                    Excel attr = field.getAnnotation(Excel.class);

                    if (attr != null && (attr.type() == Type.ALL || attr.type() == type))

                    addField(fields, field);

                }

            }

        }

        else if (StringUtils.isNotEmpty(excludeFields))

        {

            for (Field field : tempFields)

            {

                if (!ArrayUtils.contains(this.excludeFields, field.getName()))

                {

                    addField(fields, field);

                }

            }

        }

        else

        {

            for (Field field : tempFields)

            {

                addField(fields, field);

            }

        }

        return fields;

    }



    /**

     * 添加字段信息

     */

    public void addField(List<Object[]> fields, Field field)

    {

        // 单注解

        if (field.isAnnotationPresent(Excel.class))

        {

            Excel attr = field.getAnnotation(Excel.class);

            if (attr != null && (attr.type() == Type.ALL || attr.type() == type))

            {

                fields.add(new Object[] { field, attr });

            }

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

            {

                subMethod = getSubMethod(field.getName(), clazz);

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

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

                this.subFields = FieldUtils.getFieldsListWithAnnotation(subClass, Excel.class);

            }

        }



        // 多注解

        if (field.isAnnotationPresent(Excels.class))

        {

            Excels attrs = field.getAnnotation(Excels.class);

            Excel[] excels = attrs.value();

            for (Excel attr : excels)

            {

                if (StringUtils.isNotEmpty(includeFields))

                {

                    if (ArrayUtils.contains(this.includeFields, field.getName() + "." + attr.targetAttr())

                            && (attr != null && (attr.type() == Type.ALL || attr.type() == type)))

                    {

                        field.setAccessible(true);

                        fields.add(new Object[] { field, attr });

                    }

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

                    {

                        subMethod = getSubMethod(field.getName(), clazz);

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

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

                        this.subFields = FieldUtils.getFieldsListWithAnnotation(subClass, Excel.class);

                    }

                }



                // 多注解

                if (field.isAnnotationPresent(Excels.class))

                else

                {

                    Excels attrs = field.getAnnotation(Excels.class);

                    Excel[] excels = attrs.value();

                    for (Excel attr : excels)

                    if (!ArrayUtils.contains(this.excludeFields, field.getName() + "." + attr.targetAttr())

                            && (attr != null && (attr.type() == Type.ALL || attr.type() == type)))

                    {

                        if (!ArrayUtils.contains(this.excludeFields, field.getName() + "." + attr.targetAttr())

                                && (attr != null && (attr.type() == Type.ALL || attr.type() == type)))

                        {

                            field.setAccessible(true);

                            fields.add(new Object[] { field, attr });

                        }

                        fields.add(new Object[] { field, attr });

                    }

                }

            }

        }

        return fields;

    }



    /**