基于POI实现Excel表的导入导出功能

叁歲伎倆 2022-06-14 06:43 171阅读 0赞

对于批量数据的操作，在项目中引进Excel的导入和导出功能是个不错的选择。对于Excel表的结构，简单理解可以把它分成三部分（Sheet，Cell，Row），这三部分可以理解为excel表中的页，列，行。因此，我们想要获取到某一个单元的内容，可以通过获取该单元所在的页数、对应所在的行和对应的列数从而定位到该单位，继而便可执行操作从而获取其中的内容。本文在SSM环境下基于Java的POI实现对excel的导入导出功能也是相似的思路。

准备工作：

导入POI对应的Jar包

<dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-ooxml</artifactId>
        <version>3.14-beta1</version>
    </dependency>
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi-ooxml-schemas</artifactId>
        <version>3.14-beta1</version>
    </dependency>
    <dependency>
        <groupId>org.apache.poi</groupId>
        <artifactId>poi</artifactId>
        <version>3.14-beta1</version>
    </dependency>
    <dependency>
        <groupId>org.apache.httpcomponents</groupId>
        <artifactId>httpclient</artifactId>
        <version>4.5.2</version>
    </dependency>

创建一个ExcelBean实现对数据的封装

public class ExcelBean implements  java.io.Serializable{
        private String headTextName; //列头（标题）名
        private String propertyName; //对应字段名
        private Integer cols; //合并单元格数
        private XSSFCellStyle cellStyle;
        public ExcelBean(){
        }
        public ExcelBean(String headTextName, String propertyName){
            this.headTextName = headTextName;
            this.propertyName = propertyName;
        }
        public ExcelBean(String headTextName, String propertyName, Integer cols) {
            super();
            this.headTextName = headTextName;
            this.propertyName = propertyName;
            this.cols = cols;
        }
        /* 省略了get和set方法 */
    }

创建一个Excel导入导出工具类ExcelUtil

public class ExcelUtil {
        private final static String excel2003L =".xls";    //2003- 版本的excel
        private final static String excel2007U =".xlsx";   //2007+ 版本的excel
        /**
         * Excel导入
         */
        public static  List<List<Object>> getBankListByExcel(InputStream in, String fileName) throws Exception{
            List<List<Object>> list = null;
            //创建Excel工作薄
            Workbook work = getWorkbook(in,fileName);
            if(null == work){
                throw new Exception("创建Excel工作薄为空！");
            }
            Sheet sheet = null;
            Row row = null;
            Cell cell = null;
            list = new ArrayList<List<Object>>();
            //遍历Excel中所有的sheet
            for (int i = 0; i < work.getNumberOfSheets(); i++) {
                sheet = work.getSheetAt(i);
                if(sheet==null){continue;}
                //遍历当前sheet中的所有行
                //包涵头部，所以要小于等于最后一列数,这里也可以在初始值加上头部行数，以便跳过头部
                for (int j = sheet.getFirstRowNum(); j <= sheet.getLastRowNum(); j++) {
                    //读取一行
                    row = sheet.getRow(j);
                    //去掉空行和表头
                    if(row==null||row.getFirstCellNum()==j){continue;}
                    //遍历所有的列
                    List<Object> li = new ArrayList<Object>();
                    for (int y = row.getFirstCellNum(); y < row.getLastCellNum(); y++) {
                        cell = row.getCell(y);
                        li.add(getCellValue(cell));
                    }
                    list.add(li);
                }
            }
            return list;
        }
        /**
         * 描述：根据文件后缀，自适应上传文件的版本
         */
        public static  Workbook getWorkbook(InputStream inStr,String fileName) throws Exception{
            Workbook wb = null;
            String fileType = fileName.substring(fileName.lastIndexOf("."));
            if(excel2003L.equals(fileType)){
                wb = new HSSFWorkbook(inStr);  //2003-
            }else if(excel2007U.equals(fileType)){
                wb = new XSSFWorkbook(inStr);  //2007+
            }else{
                throw new Exception("解析的文件格式有误！");
            }
            return wb;
        }
        /**
         * 描述：对表格中数值进行格式化
         */
        public static  Object getCellValue(Cell cell){
            Object value = null;
            DecimalFormat df = new DecimalFormat("0");  //格式化字符类型的数字
            SimpleDateFormat sdf = new SimpleDateFormat("yyy-MM-dd");  //日期格式化
            DecimalFormat df2 = new DecimalFormat("0.00");  //格式化数字
            switch (cell.getCellType()) {
                case Cell.CELL_TYPE_STRING:
                    value = cell.getRichStringCellValue().getString();
                    break;
                case Cell.CELL_TYPE_NUMERIC:
                    if("General".equals(cell.getCellStyle().getDataFormatString())){
                        value = df.format(cell.getNumericCellValue());
                    }else if("m/d/yy".equals(cell.getCellStyle().getDataFormatString())){
                        value = sdf.format(cell.getDateCellValue());
                    }else{
                        value = df2.format(cell.getNumericCellValue());
                    }
                    break;
                case Cell.CELL_TYPE_BOOLEAN:
                    value = cell.getBooleanCellValue();
                    break;
                case Cell.CELL_TYPE_BLANK:
                    value = "";
                    break;
                default:
                    break;
            }
            return value;
        }
        /**
         * 导入Excel表结束
         * 导出Excel表开始
         * @param sheetName 工作簿名称
         * @param clazz  数据源model类型
         * @param objs   excel标题列以及对应model字段名
         * @param map  标题列行数以及cell字体样式
         */
        public static XSSFWorkbook createExcelFile(Class clazz, List objs, Map<Integer, List<ExcelBean>> map, String sheetName) throws 
    IllegalArgumentException,IllegalAccessException,InvocationTargetException,
    ClassNotFoundException, IntrospectionException, ParseException {
            // 创建新的Excel工作簿
            XSSFWorkbook workbook = new XSSFWorkbook();
            // 在Excel工作簿中建一工作表，其名为缺省值, 也可以指定Sheet名称
            XSSFSheet sheet = workbook.createSheet(sheetName);
            // 以下为excel的字体样式以及excel的标题与内容的创建，下面会具体分析;
            createFont(workbook); //字体样式
            createTableHeader(sheet, map); //创建标题（头）
            createTableRows(sheet, map, objs, clazz); //创建内容
            return workbook;
        }
        private static XSSFCellStyle fontStyle;
        private static XSSFCellStyle fontStyle2;
        public static void createFont(XSSFWorkbook workbook) {
            // 表头
            fontStyle = workbook.createCellStyle();
            XSSFFont font1 = workbook.createFont();
            font1.setBoldweight(XSSFFont.BOLDWEIGHT_BOLD);
            font1.setFontName("黑体");
            font1.setFontHeightInPoints((short) 14);// 设置字体大小
            fontStyle.setFont(font1);
            fontStyle.setBorderBottom(XSSFCellStyle.BORDER_THIN); // 下边框
            fontStyle.setBorderLeft(XSSFCellStyle.BORDER_THIN);// 左边框
            fontStyle.setBorderTop(XSSFCellStyle.BORDER_THIN);// 上边框
            fontStyle.setBorderRight(XSSFCellStyle.BORDER_THIN);// 右边框
            fontStyle.setAlignment(XSSFCellStyle.ALIGN_CENTER); // 居中
            // 内容
            fontStyle2=workbook.createCellStyle();
            XSSFFont font2 = workbook.createFont();
            font2.setFontName("宋体");
            font2.setFontHeightInPoints((short) 10);// 设置字体大小
            fontStyle2.setFont(font2);
            fontStyle2.setBorderBottom(XSSFCellStyle.BORDER_THIN); // 下边框
            fontStyle2.setBorderLeft(XSSFCellStyle.BORDER_THIN);// 左边框
            fontStyle2.setBorderTop(XSSFCellStyle.BORDER_THIN);// 上边框
            fontStyle2.setBorderRight(XSSFCellStyle.BORDER_THIN);// 右边框
            fontStyle2.setAlignment(XSSFCellStyle.ALIGN_CENTER); // 居中
        }
        /**
         * 根据ExcelMapping 生成列头（多行列头）
         *
         * @param sheet 工作簿
         * @param map 每行每个单元格对应的列头信息
         */
        public static final void createTableHeader(XSSFSheet sheet, Map<Integer, List<ExcelBean>> map) {
            int startIndex=0;//cell起始位置
            int endIndex=0;//cell终止位置
            for (Map.Entry<Integer, List<ExcelBean>> entry : map.entrySet()) {
                XSSFRow row = sheet.createRow(entry.getKey());
                List<ExcelBean> excels = entry.getValue();
                for (int x = 0; x < excels.size(); x++) {
                    //合并单元格
                    if(excels.get(x).getCols()>1){
                        if(x==0){
                            endIndex+=excels.get(x).getCols()-1;
                            CellRangeAddress range=new CellRangeAddress(0,0,startIndex,endIndex);
                            sheet.addMergedRegion(range);
                            startIndex+=excels.get(x).getCols();
                        }else{
                            endIndex+=excels.get(x).getCols();
                            CellRangeAddress range=new CellRangeAddress(0,0,startIndex,endIndex);
                            sheet.addMergedRegion(range);
                            startIndex+=excels.get(x).getCols();
                        }
                        XSSFCell cell = row.createCell(startIndex-excels.get(x).getCols());
                        cell.setCellValue(excels.get(x).getHeadTextName());// 设置内容
                        if (excels.get(x).getCellStyle() != null) {
                            cell.setCellStyle(excels.get(x).getCellStyle());// 设置格式
                        }
                        cell.setCellStyle(fontStyle);
                    }else{
                        XSSFCell cell = row.createCell(x);
                        cell.setCellValue(excels.get(x).getHeadTextName());// 设置内容
                        if (excels.get(x).getCellStyle() != null) {
                            cell.setCellStyle(excels.get(x).getCellStyle());// 设置格式
                        }
                        cell.setCellStyle(fontStyle);
                    }
                }
            }
        }
        public static void createTableRows(XSSFSheet sheet, Map<Integer, List<ExcelBean>> map, List objs, Class clazz)
                throws IllegalArgumentException, IllegalAccessException, InvocationTargetException, IntrospectionException,
                ClassNotFoundException, ParseException {
            int rowindex = map.size();
            int maxKey = 0;
            List<ExcelBean> ems = new ArrayList<>();
            for (Map.Entry<Integer, List<ExcelBean>> entry : map.entrySet()) {
                if (entry.getKey() > maxKey) {
                    maxKey = entry.getKey();
                }
            }
            ems = map.get(maxKey);
            List<Integer> widths = new ArrayList<Integer>(ems.size());
            for (Object obj : objs) {
                XSSFRow row = sheet.createRow(rowindex);
                for (int i = 0; i < ems.size(); i++) {
                    ExcelBean em = (ExcelBean) ems.get(i);
                    // 获得get方法
                    PropertyDescriptor pd = new PropertyDescriptor(em.getPropertyName(), clazz);
                    Method getMethod = pd.getReadMethod();
                    Object rtn = getMethod.invoke(obj);
                    String value = "";
                    // 如果是日期类型进行转换
                    if (rtn != null) {
                        if (rtn instanceof Date) {
                            value = DateUtils.formatDate((Date)rtn,"yyyy-MM-dd");
                        } else if(rtn instanceof BigDecimal){
                            NumberFormat nf = new DecimalFormat("#,##0.00");
                            value=nf.format((BigDecimal)rtn).toString();
                        } else if((rtn instanceof Integer) && (Integer.valueOf(rtn.toString())<0 )){
                            value="--";
                        }else {
                            value = rtn.toString();
                        }
                    }
                    XSSFCell cell = row.createCell(i);
                    cell.setCellValue(value);
                    cell.setCellType(XSSFCell.CELL_TYPE_STRING);
                    cell.setCellStyle(fontStyle2);
                    // 获得最大列宽
                    int width = value.getBytes().length * 300;
                    // 还未设置，设置当前
                    if (widths.size() <= i) {
                        widths.add(width);
                        continue;
                    }
                    // 比原来大，更新数据
                    if (width > widths.get(i)) {
                        widths.set(i, width);
                    }
                }
                rowindex++;
            }
            // 设置列宽
            for (int index = 0; index < widths.size(); index++) {
                Integer width = widths.get(index);
                width = width < 2500 ? 2500 : width + 300;
                width = width > 10000 ? 10000 + 300 : width + 300;
                sheet.setColumnWidth(index, width);
            }
        }
    }

导入：

Excel表导入控制器层实现

@RequestMapping("/import")
    public String impotr(HttpServletRequest request, Model model) throws Exception {
         int adminId = 1;
         //获取上传的文件
         MultipartHttpServletRequest multipart = (MultipartHttpServletRequest) request;
         MultipartFile file = multipart.getFile("upfile");
         String month = request.getParameter("month");
         InputStream in = file.getInputStream();
         //数据导入
         salaryService.importExcelInfo(in,file,month,adminId);
         in.close();
         return "redirect:/salary/index.html";
    }

Service层，这里是接口importExcellnfo的实现方法，调用了ExcelUtil里的方法

public void importExcelInfo(InputStream in, MultipartFile file, String salaryDate,Integer adminId) throws Exception{
        List<List<Object>> listob = ExcelUtil.getBankListByExcel(in,file.getOriginalFilename());
        List<Salarymanage> salaryList = new ArrayList<Salarymanage>();
        //遍历listob数据，把数据放到List中
        for (int i = 0; i < listob.size(); i++) {
            List<Object> ob = listob.get(i);
            Salarymanage salarymanage = new Salarymanage();
            //设置编号
            salarymanage.setSerial(SerialUtil.salarySerial());
            //通过遍历实现把每一列封装成一个model中，再把所有的model用List集合装载
            salarymanage.setAdminId(adminId);
            salarymanage.setCompany(String.valueOf(ob.get(1)));
            salarymanage.setNumber(String.valueOf(ob.get(2)));
            salarymanage.setName(String.valueOf(ob.get(3)));
            salarymanage.setSex(String.valueOf(ob.get(4)));
            salarymanage.setCardName(String.valueOf(ob.get(5)));
            salarymanage.setBankCard(String.valueOf(ob.get(6)));
            salarymanage.setBank(String.valueOf(ob.get(7)));
            //object类型转Double类型
            salarymanage.setMoney(Double.parseDouble(ob.get(8).toString()));
            salarymanage.setRemark(String.valueOf(ob.get(9)));
            salarymanage.setSalaryDate(salaryDate);
            salaryList.add(salarymanage);
        }
        //批量插入
        salarymanageDao.insertInfoBatch(salaryList);
    }

接着是mapper.xml，用<foreach></foreach>实现数据批量插入

<insert id="insertInfoBatch" parameterType="java.util.List">
        insert into salarymanage (admin_id, serial,company, number, name,sex, card_name, bank_card,
          bank, money, remark,salary_date)
        values
        <foreach collection="list" item="item" index="index" separator=",">
          (#{item.adminId}, #{item.serial}, #{item.company},#{item.number}, #{item.name},
          #{item.sex}, #{item.cardName},#{item.bankCard}, #{item.bank},
          #{item.money}, #{item.remark}, #{item.salaryDate})
        </foreach>
    </insert>

到这里，excel表的导入功能便完成了。这里补充一下mybatis里<foreach>里面的部分参数，collection是传入参数的类型，如果传入参数是List，这里便是list，如果是一个数组，便是array，separator指的是数据之间用“，”隔开，这也是借鉴了mysql插入多条数据的写法，具体的执行效率还没做多的探讨，我试过导入100条数据，效率还是可以接受的，如果有人有更好的写法，欢迎留言交流。

导出：

Excel导出Controller端实现

@RequestMapping("/export")
    public @ResponseBody void export(HttpServletRequest request, HttpServletResponse response) throwsClassNotFoundException, IntrospectionException, IllegalAccessException, ParseException, InvocationTargetException {
        String salaryDate = request.getParameter("salaryDate");
        if(salaryDate!=""){
            response.reset(); //清除buffer缓存
            Map<String,Object> map=new HashMap<String,Object>();
            // 指定下载的文件名，浏览器都会使用本地编码，即GBK，浏览器收到这个文件名后，用ISO-8859-1来解码，然后用GBK来显示
            // 所以我们用GBK解码，ISO-8859-1来编码，在浏览器那边会反过来执行。
            response.setHeader("Content-Disposition", "attachment;filename=" + new String(salaryDate.getBytes("GBK"),"ISO-8859-1"));
            response.setContentType("application/vnd.ms-excel;charset=UTF-8");
            response.setHeader("Pragma", "no-cache");
            response.setHeader("Cache-Control", "no-cache");
            response.setDateHeader("Expires", 0);
            XSSFWorkbook workbook=null;
            //导出Excel对象
            workbook = salaryService.exportExcelInfo(salaryDate);
            OutputStream output;
            try {
                output = response.getOutputStream();
                BufferedOutputStream bufferedOutPut = new BufferedOutputStream(output);
                bufferedOutPut.flush();
                workbook.write(bufferedOutPut);
                bufferedOutPut.close();
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
    }

Service层，这里是exportExcelInfo的实现方法

public XSSFWorkbook exportExcelInfo(String salaryDate) throws InvocationTargetException, ClassNotFoundException, IntrospectionException, ParseException, IllegalAccessException {
        //根据条件查询数据，把数据装载到一个list中
        List<Salarymanage> list = salarymanageDao.selectApartInfo(salaryDate);
        for(int i=0;i<list.size();i++){
            //查询财务名字
            int adminId = list.get(i).getAdminId();
            String adminName = salarymanageDao.selectAdminNameById(adminId);
            list.get(i).setAdminName(adminName);
            list.get(i).setId(i+1);
        }
        List<ExcelBean> excel=new ArrayList<>();
        Map<Integer,List<ExcelBean>> map=new LinkedHashMap<>();
        XSSFWorkbook xssfWorkbook=null;
        //设置标题栏
        excel.add(new ExcelBean("序号","id",0));
        excel.add(new ExcelBean("厂名","company",0));
        excel.add(new ExcelBean("工号","number",0));
        excel.add(new ExcelBean("姓名","name",0));
        excel.add(new ExcelBean("性别","sex",0));
        excel.add(new ExcelBean("开户名","cardName",0));
        excel.add(new ExcelBean("银行卡号","bankCard",0));
        excel.add(new ExcelBean("开户行","bank",0));
        excel.add(new ExcelBean("金额","money",0));
        excel.add(new ExcelBean("备注","remark",0));
        map.put(0, excel);
        String sheetName = salaryDate + "月份收入";
        //调用ExcelUtil的方法
        xssfWorkbook = ExcelUtil.createExcelFile(Salarymanage.class, list, map, sheetName);
        return xssfWorkbook;
    }

这里不写出导出功能的mapper.xml实现语句了，具体实现也就是数据查询，把查询出来的数据转载到一个List中。前端的话便是一个链接的请求，同时补充一点，ajax请求是不支持excel表导出的，因此对于导出时间较长，需要对导出成功做出判断的可以选择在后端生成json数据，在前端利用js进行excel表导出。

以上便是在SSM下使用POI实现excel表的导入和导出的整体思路，主要的导入和导出的核心方法都封装在ExcelUtil这个工具类中，但面对具体的表格需要具体分析循环的开始，以便能够去除表头或者标题栏。