Excel注解支持导入导出标题信息

RuoYi

2021-09-26 f4a2f909a779d0d2ffa8d5256b3d48648f65e761

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

@@ -4,6 +4,7 @@
import java.io.InputStream;

import java.io.OutputStream;

import java.lang.reflect.Field;

import java.lang.reflect.Method;

import java.math.BigDecimal;

import java.text.DecimalFormat;

import java.util.ArrayList;

@@ -35,7 +36,9 @@
import org.apache.poi.ss.usermodel.VerticalAlignment;

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

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

import org.apache.poi.ss.util.CellRangeAddress;

import org.apache.poi.ss.util.CellRangeAddressList;

import org.apache.poi.util.IOUtils;

import org.apache.poi.xssf.streaming.SXSSFWorkbook;

import org.apache.poi.xssf.usermodel.XSSFClientAnchor;

import org.apache.poi.xssf.usermodel.XSSFDataValidation;

@@ -102,6 +105,16 @@
    private List<Object[]> fields;



    /**

     * 当前行号

     */

    private int rownum;

    
    /**

     * 标题

     */

    private String title;



    /**

     * 最大高度

     */

    private short maxHeight;

@@ -126,7 +139,7 @@
        this.clazz = clazz;

    }



    public void init(List<T> list, String sheetName, Type type)

    public void init(List<T> list, String sheetName, String title, Type type)

    {

        if (list == null)

        {

@@ -135,8 +148,27 @@
        this.list = list;

        this.sheetName = sheetName;

        this.type = type;

        this.title = title;

        createExcelField();

        createWorkbook();

        createTitle();

    }



    /**

     * 创建excel第一行标题

     */

    public void createTitle()

    {

        if (StringUtils.isNotEmpty(title))

        {

            Row titleRow = sheet.createRow(rownum == 0 ? rownum++ : 0);

            titleRow.setHeightInPoints(30);

            Cell titleCell = titleRow.createCell(0);

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

            titleCell.setCellValue(title);

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

                    this.fields.size() - 1));

        }

    }



    /**

@@ -147,46 +179,50 @@
     */

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

    {

        return importExcel(StringUtils.EMPTY, is);

        return importExcel(is, 0);

    }



    /**

     * 对excel表单默认第一个索引名转换成list

     * 
     * @param is 输入流

     * @param titleNum 标题占用行数

     * @return 转换后集合

     */

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

    {

        return importExcel(StringUtils.EMPTY, is, titleNum);

    }



    /**

     * 对excel表单指定表格索引名转换成list

     * 

     * @param sheetName 表格索引名

     * @param titleNum 标题占用行数

     * @param is 输入流

     * @return 转换后集合

     */

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

    public List<T> importExcel(String sheetName, InputStream is, int titleNum) throws Exception

    {

        this.type = Type.IMPORT;

        this.wb = WorkbookFactory.create(is);

        List<T> list = new ArrayList<T>();

        Sheet sheet = null;

        if (StringUtils.isNotEmpty(sheetName))

        {

            // 如果指定sheet名,则取指定sheet中的内容.

            sheet = wb.getSheet(sheetName);

        }

        else

        {

            // 如果传入的sheet名不存在则默认指向第1个sheet.

            sheet = wb.getSheetAt(0);

        }



        // 如果指定sheet名,则取指定sheet中的内容 否则默认指向第1个sheet

        Sheet sheet = StringUtils.isNotEmpty(sheetName) ? wb.getSheet(sheetName) : wb.getSheetAt(0);

        if (sheet == null)

        {

            throw new IOException("文件sheet不存在");

        }



        int rows = sheet.getPhysicalNumberOfRows();

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

        int rows = sheet.getLastRowNum();



        if (rows > 0)

        {

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

            Map<String, Integer> cellMap = new HashMap<String, Integer>();

            // 获取表头

            Row heard = sheet.getRow(0);

            Row heard = sheet.getRow(titleNum);

            for (int i = 0; i < heard.getPhysicalNumberOfCells(); i++)

            {

                Cell cell = heard.getCell(i);

@@ -219,10 +255,15 @@
                    }

                }

            }

            for (int i = 1; i < rows; i++)

            for (int i = titleNum + 1; i <= rows; i++)

            {

                // 从第2行开始取数据,默认第一行是表头.

                Row row = sheet.getRow(i);

                // 判断当前行是否是空行

                if (isRowEmpty(row))

                {

                    continue;

                }

                T entity = null;

                for (Map.Entry<Integer, Field> entry : fieldsMap.entrySet())

                {

@@ -301,6 +342,10 @@
                        {

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

                        }

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

                        {

                            val = dataFormatHandlerAdapter(val, attr);

                        }

                        ReflectUtils.invokeSetter(entity, propertyName, val);

                    }

                }

@@ -319,11 +364,26 @@
     * @return 结果

     * @throws IOException

     */

    public void exportExcel(HttpServletResponse response, List<T> list, String sheetName) throws IOException

    public void exportExcel(HttpServletResponse response, List<T> list, String sheetName)throws IOException

    {

        response.setContentType("application/vnd.ms-excel");

        exportExcel(response, list, sheetName, StringUtils.EMPTY);

    }



    /**

     * 对list数据源将其里面的数据导入到excel表单

     * 
     * @param response 返回数据

     * @param list 导出数据集合

     * @param sheetName 工作表的名称

     * @param title 标题

     * @return 结果

     * @throws IOException

     */

    public void exportExcel(HttpServletResponse response, List<T> list, String sheetName, String title) throws IOException

    {

        response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");

        response.setCharacterEncoding("utf-8");

        this.init(list, sheetName, Type.EXPORT);

        this.init(list, sheetName, title, Type.EXPORT);

        exportExcel(response.getOutputStream());

    }



@@ -333,11 +393,29 @@
     * @param sheetName 工作表的名称

     * @return 结果

     */

    /**

     * 对list数据源将其里面的数据导入到excel表单

     * 
     * @param sheetName 工作表的名称

     * @return 结果

     */

    public void importTemplateExcel(HttpServletResponse response, String sheetName) throws IOException

    {

        response.setContentType("application/vnd.ms-excel");

        importTemplateExcel(response, sheetName);

    }



    /**

     * 对list数据源将其里面的数据导入到excel表单

     * 
     * @param sheetName 工作表的名称

     * @param title 标题

     * @return 结果

     */

    public void importTemplateExcel(HttpServletResponse response, String sheetName, String title) throws IOException

    {

        response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");

        response.setCharacterEncoding("utf-8");

        this.init(null, sheetName, Type.IMPORT);

        this.init(null, sheetName, title, Type.IMPORT);

        exportExcel(response.getOutputStream());

    }



@@ -346,32 +424,12 @@
     * 

     * @return 结果

     */

    public void exportExcel(OutputStream outputStream)

    public void exportExcel(OutputStream out)

    {

        try

        {

            // 取出一共有多少个sheet.

            double sheetNo = Math.ceil(list.size() / sheetSize);

            for (int index = 0; index <= sheetNo; index++)

            {

                createSheet(sheetNo, index);



                // 产生一行

                Row row = sheet.createRow(0);

                int column = 0;

                // 写入各个字段的列头名称

                for (Object[] os : fields)

                {

                    Excel excel = (Excel) os[1];

                    this.createCell(excel, row, column++);

                }

                if (Type.EXPORT.equals(type))

                {

                    fillExcelData(index, row);

                    addStatisticsRow();

                }

            }

            wb.write(outputStream);

            writeSheet();

            wb.write(out);

        }

        catch (Exception e)

        {

@@ -379,27 +437,35 @@
        }

        finally

        {

            if (wb != null)

            IOUtils.closeQuietly(wb);

            IOUtils.closeQuietly(out);

        }

    }



    /**

     * 创建写入数据到Sheet

     */

    public void writeSheet()

    {

        // 取出一共有多少个sheet.

        int sheetNo = Math.max(1, (int) Math.ceil(list.size() * 1.0 / sheetSize));

        for (int index = 0; index < sheetNo; index++)

        {

            createSheet(sheetNo, index);



            // 产生一行

            Row row = sheet.createRow(rownum);

            int column = 0;

            // 写入各个字段的列头名称

            for (Object[] os : fields)

            {

                try

                {

                    wb.close();

                }

                catch (IOException e1)

                {

                    e1.printStackTrace();

                }

                Excel excel = (Excel) os[1];

                this.createCell(excel, row, column++);

            }

            if (outputStream != null)

            if (Type.EXPORT.equals(type))

            {

                try

                {

                    outputStream.close();

                }

                catch (IOException e1)

                {

                    e1.printStackTrace();

                }

                fillExcelData(index, row);

                addStatisticsRow();

            }

        }

    }

@@ -416,7 +482,7 @@
        int endNo = Math.min(startNo + sheetSize, list.size());

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

        {

            row = sheet.createRow(i + 1 - startNo);

            row = sheet.createRow(i + 1 + rownum - startNo);

            // 得到导出对象.

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

            int column = 0;

@@ -442,6 +508,16 @@
        // 写入各条记录,每条记录对应excel表中的一行

        Map<String, CellStyle> styles = new HashMap<String, CellStyle>();

        CellStyle style = wb.createCellStyle();

        style.setAlignment(HorizontalAlignment.CENTER);

        style.setVerticalAlignment(VerticalAlignment.CENTER);

        Font titleFont = wb.createFont();

        titleFont.setFontName("Arial");

        titleFont.setFontHeightInPoints((short) 16);

        titleFont.setBold(true);

        style.setFont(titleFont);

        styles.put("title", style);



        style = wb.createCellStyle();

        style.setAlignment(HorizontalAlignment.CENTER);

        style.setVerticalAlignment(VerticalAlignment.CENTER);

        style.setBorderRight(BorderStyle.THIN);

@@ -471,7 +547,7 @@
        headerFont.setColor(IndexedColors.WHITE.getIndex());

        style.setFont(headerFont);

        styles.put("header", style);

        


        style = wb.createCellStyle();

        style.setAlignment(HorizontalAlignment.CENTER);

        style.setVerticalAlignment(VerticalAlignment.CENTER);

@@ -535,8 +611,7 @@
        }

        else if (ColumnType.IMAGE == attr.cellType())

        {

            ClientAnchor anchor = new XSSFClientAnchor(0, 0, 0, 0, (short) cell.getColumnIndex(), cell.getRow().getRowNum(), (short) (cell.getColumnIndex() + 1),

                    cell.getRow().getRowNum() + 1);

            ClientAnchor anchor = new XSSFClientAnchor(0, 0, 0, 0, (short) cell.getColumnIndex(), cell.getRow().getRowNum(), (short) (cell.getColumnIndex() + 1), cell.getRow().getRowNum() + 1);

            String imagePath = Convert.toStr(value);

            if (StringUtils.isNotEmpty(imagePath))

            {

@@ -546,7 +621,7 @@
            }

        }

    }

    


    /**

     * 获取画布

     */

@@ -638,6 +713,10 @@
                else if (value instanceof BigDecimal && -1 != attr.scale())

                {

                    cell.setCellValue((((BigDecimal) value).setScale(attr.scale(), attr.roundingMode())).toString());

                }

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

                {

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

                }

                else

                {

@@ -786,6 +865,28 @@
    }



    /**

     * 数据处理器

     * 
     * @param value 数据值

     * @param excel 数据注解

     * @return

     */

    public String dataFormatHandlerAdapter(Object value, Excel excel)

    {

        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());

        }

        catch (Exception e)

        {

            log.error("不能格式化数据 " + excel.handler(), e.getMessage());

        }

        return Convert.toStr(value);

    }



    /**

     * 合计统计信息

     */

    private void addStatisticsData(Integer index, String text, Excel entity)

@@ -815,10 +916,9 @@
    {

        if (statistics.size() > 0)

        {

            Cell cell = null;

            Row row = sheet.createRow(sheet.getLastRowNum() + 1);

            Set<Integer> keys = statistics.keySet();

            cell = row.createCell(0);

            Cell cell = row.createCell(0);

            cell.setCellStyle(styles.get("total"));

            cell.setCellValue("合计");



@@ -914,7 +1014,7 @@
        this.fields = this.fields.stream().sorted(Comparator.comparing(objects -> ((Excel) objects[1]).sort())).collect(Collectors.toList());

        this.maxHeight = getRowHeight();

    }

    


    /**

     * 根据注解获取最大行高

     */

@@ -946,6 +1046,9 @@
    public void createWorkbook()

    {

        this.wb = new SXSSFWorkbook(500);

        this.sheet = wb.createSheet();

        wb.setSheetName(0, sheetName);

        this.styles = createStyles(wb);

    }



    /**

@@ -954,17 +1057,13 @@
     * @param sheetNo sheet数量

     * @param index 序号

     */

    public void createSheet(double sheetNo, int index)

    public void createSheet(int sheetNo, int index)

    {

        this.sheet = wb.createSheet();

        this.styles = createStyles(wb);

        // 设置工作表的名称.

        if (sheetNo == 0)

        if (sheetNo > 1 && index > 0)

        {

            wb.setSheetName(index, sheetName);

        }

        else

        {

            this.sheet = wb.createSheet();

            this.createTitle();

            wb.setSheetName(index, sheetName + index);

        }

    }

@@ -1028,4 +1127,27 @@
        }

        return val;

    }



    /**

     * 判断是否是空行

     * 
     * @param row 判断的行

     * @return

     */

    private boolean isRowEmpty(Row row)

    {

        if (row == null)

        {

            return true;

        }

        for (int i = row.getFirstCellNum(); i < row.getLastCellNum(); i++)

        {

            Cell cell = row.getCell(i);

            if (cell != null && cell.getCellType() != CellType.BLANK)

            {

                return false;

            }

        }

        return true;

    }

}