POI&EasyPOI

POI

Java操作Excel

在开发中，我们经常需要写程序还操作办公软件(其中操作得最多的就是Word与Excel)！

因此，我们使用代码过生成，读取这些文件的数据也是很重要的一个功能。

而我们Java中，也是提供了相应的操作办公软件的框架，其中，最常用的是下面两种：

	jxl：只能对Excel进行操作，属于比较老的框
	POI：是apache的项目，可对ms的word,Excel,PPT进行操作，包括office2003和2007。对两种版本的处理都比较好。具体操作请看官方的文档。

数据读取用POI，只要不涉及单元格样式的写入使用jxl效率高点。
POI读取效率高，但是大数据量写入Excel效率比jxl慢。

poi的使用

找到文档

咱们这里直接学习poi的使用,poi针对offices03（xls）与07(xlsx)是单独写了相应的实现api,我们这里直接使用07版的处理方案(注：网上是有相应的兼容方案,可判断)。

引入poi需要的jar包

<!-- poi支持的jar包 -->
<dependency>
  <groupId>org.apache.poi</groupId>
  <artifactId>poi</artifactId>
  <version>3.11</version>
</dependency>
<dependency>
  <groupId>org.apache.poi</groupId>
  <artifactId>poi-ooxml</artifactId>
  <version>3.11</version>
</dependency>

创建Excel(完成99乘法表)

public class ExcelTest {

    //创建一个Excel文件
    //在文件里加一个99乘法法
    //把这文件保存在项目中
    @Test
    public void testCreateExcel() throws Exception{
        //1.创建一个Excel文件(内存中)
        SXSSFWorkbook wb = new SXSSFWorkbook();
        //2.创建一张表
        Sheet sheet = wb.createSheet("99乘法表");
        //3.创建行
        for (int i = 1; i <= 9; i++) {
            Row row = sheet.createRow(i-1);
            //4.创建列(格子)
            for (int j = 1; j <= i; j++) {
                Cell cell = row.createCell(j-1);
                //5.格子中加数据
                cell.setCellValue(i+"*"+j+"="+(i*j));
            }
        }
        //从内存中写出来
        FileOutputStream out = new FileOutputStream("99.xlsx");
        wb.write(out);
        out.close();
    }
}

读取Excel

/**
 * 读取我们使用相应的方案
 * @throws Exception
 */
@Test
public void readExcel() throws Exception{
    File file = new File("employee-3.xlsx");
    FileInputStream fis = new FileInputStream(file);
    //1.读取一个Excel文件(内存中)
    Workbook wb = new XSSFWorkbook(fis);
    //2.拿到第个sheet表
    Sheet sheet = wb.getSheetAt(0);
    //3.拿到wb中的行(不要拿头部)
    int lastRowNum = sheet.getLastRowNum();
    for (int i = 1; i <= lastRowNum; i++) {
        Row row = sheet.getRow(i);
        //4.拿到每一列(格子)
        short lastCellNum = row.getLastCellNum();
        for (int j = 0; j < lastCellNum; j++) {
            Cell cell = row.getCell(j);
            System.out.print(cell.getStringCellValue()+" ");
        }
        System.out.println();
    }
}

EasyPOI

咱们在开发的时候，总会遇到需要通过代码操作办公软件的情况，而excel与word的操作最为频繁。
当然我们Java程序员可以选择JXL或者POI来完成相应的Excel操作，但是大家用过都知道，有些地方感觉还是不够简单，不那么尽如人意。
今天给大家介绍一个EasyPoi，就算我们不会底层的POI,也可以非常轻松的完成Excel的操作。EasyPoi，主打简单，不过功用依然OK(绝对够用)。现在我们就来尝试一步一步还进行它的入门学习：
easyPOI教程：http://easypoi.mydoc.io/

EasyPOI导出

导包

把之前咱们的POI引入去掉(有冲突)

<!-- easypoi的支持 -->
<dependency>
  <groupId>cn.afterturn</groupId>
  <artifactId>easypoi-base</artifactId>
  <version>3.2.0</version>
</dependency>
<dependency>
  <groupId>cn.afterturn</groupId>
  <artifactId>easypoi-web</artifactId>
  <version>3.2.0</version>
</dependency>
<dependency>
  <groupId>cn.afterturn</groupId>
  <artifactId>easypoi-annotation</artifactId>
  <version>3.2.0</version>
</dependency>

Employee对象加注解

/**
 * employee的实体类
 */
@Entity
@Table(name = "employee")
@ExcelTarget("emp")
public class Employee extends BaseDomain {

    @Excel(name = "用户名")
    @NotNull(message = "用户名不能空")
    private String username;

    private String password;

    @Excel(name = "邮箱")
    @Pattern(regexp = "/^([A-Za-z0-9_\\-\\.])+\\@([A-Za-z0-9_\\-\\.])+\\.([A-Za-z]{2,4})$/", message = "不是邮箱")
    private String email;
    @Max(value = 60, message = "年龄必须小于60")
    @Min(value = 18, message = "年龄必须小于18")
    @Excel(name = "年龄")
    private Integer age;

    @Excel(name = "头像", type = 2)
    private String headImage;

    //部门
    @ManyToOne
    @JoinColumn(name = "department_id")
    @ExcelEntity
    private Department department;

    //多对多:配置中间表
    @ManyToMany(fetch = FetchType.LAZY)
    @JoinTable(name = "employee_role",
            joinColumns = @JoinColumn(name = "employee_id"),
            inverseJoinColumns = @JoinColumn(name = "role_id")
    )
    //@JsonIgnore //生成json是忽略这个属性(数据大多，全部拿到没有意义，还有可能造成死循环)
    private Set<Role> roles = new HashSet<>();
    ....
    }

/**
 * department的实体类
 */
@Entity
@Table(name = "department")
@ExcelTarget("dept")
public class Department extends BaseDomain {
    @Excel(name = "名称_dept,部门_emp")
    private String name;
    ...
    }

员工的页面 Employee.jsp

根据查询条件导出

<form id="searchForm" action="/employee/download">
    用户名: <input name="username" class="easyui-textbox" style="width:80px">
    邮件: <input name="email" class="easyui-textbox" style="width:80px">
    部门:<input name="departmentId" class="easyui-combobox" name="dept"
              panelHeight="auto"
              data-options="valueField:'id',textField:'name',url:'/util/dept'" />

    <a href="#" class="easyui-linkbutton" data-method="search" iconCls="icon-search">查询</a>
    <!--  button不加type属性就是提交 -->
    <button class="easyui-linkbutton" iconCls="icon-search">导出</button>
</form>

EmployeeController

/**
 * 导出功能:下载
 * @param map
 * @return
 */
@RequestMapping("/download")
public String download(ModelMap map,EmployeeQuery query, HttpServletRequest request) {
    //拿到所有数据
    List<Employee> list = employeeService.findByQuery(query);
    //获取到真实路径
//解决了下载的图片的路径问题
    String realPath = request.getServletContext().getRealPath("");
    list.forEach(e -> {
        e.setHeadImage(realPath+e.getHeadImage());
        System.out.println(e.getHeadImage());
    });

    //设置一些属性
    ExportParams params = new ExportParams("员工管理", "明细", ExcelType.XSSF);
    //params.setFreezeCol(3);
    map.put(NormalExcelConstants.DATA_LIST, list); // 数据集合
    map.put(NormalExcelConstants.CLASS, Employee.class);//导出实体
    map.put(NormalExcelConstants.PARAMS, params);//参数
    map.put(NormalExcelConstants.FILE_NAME, "employee");//文件名称
    //返回的名称 :easypoiExcelView -> 并没有找我的bean，而且当做一个路径去进行访问
    //  现在默认去找的视图解析器，而没有找我的那一个bean
    return NormalExcelConstants.EASYPOI_EXCEL_VIEW;//View名称
}

applicationContext-mvc.xml

 <bean class="org.springframework.web.servlet.view.BeanNameViewResolver">
        <property name="order" value="0"></property>
    </bean>

    <!-- 对于easypoi中准备发的视图(view)的扫描 -->
    <context:component-scan base-package="cn.afterturn.easypoi.view"></context:component-scan>
     <!-- 导入的时候会用到-->
    <context:component-scan base-package="com.cl.easysell.common" />

EasyPOI导入

页面准备

<%@ page contentType="text/html;charset=UTF-8" language="java" %>
<html>
<head>
    <title>Title</title>
    <%@include file="/WEB-INF/views/head.jsp" %>
</head>
<body>
    <!-- 上传必需是:post，enctype="multipart/form-data"-->
    <form action="/import/employeeXlsx" method="post" enctype="multipart/form-data">
        <input class="easyui-filebox" name="empFile" style="width:80%"
               data-options="prompt:'选择一个文件...',buttonText: '选择文件'" />
        <button class="easyui-linkbutton">导入</button>
    </form>
</body>
</html>

准备controller

@RequestMapping("/employeeXlsx")
public String employeeXlsx(MultipartFile empFile) throws Exception {

    //准备导入的参数
    ImportParams params = new ImportParams();
    params.setTitleRows(1);

    List<Employee> list = ExcelImportUtil.importExcel(
            empFile.getInputStream(),
            Employee.class,
            params);

    list.forEach(e ->{
       // System.out.println(e+","+e.getDepartment());
        //根据部门名称拿到它的部门，再放到对应的员工中
        Department dept = departmentService.findByName(e.getDepartment().getName());
        e.setDepartment(dept);
        //给一个默认密码
        e.setPassword("123");
        employeeService.save(e);
    });

    return "import";
}

准备相应的验证功能

导包

<!-- JSR 303 规范验证包 -->
<dependency>
  <groupId>org.hibernate</groupId>
  <artifactId>hibernate-validator</artifactId>
  <version>5.2.4.Final</version>
</dependency>

Employee加上相应的注解

/**
 * employee的实体类
 */
@Entity
@Table(name = "employee")
@ExcelTarget("emp")
public class Employee extends BaseDomain {

    @Excel(name = "用户名")
    @NotNull(message = "用户名不能空")
    private String username;

    private String password;

    @Excel(name = "邮箱")
    @Pattern(regexp = "/^([A-Za-z0-9_\\-\\.])+\\@([A-Za-z0-9_\\-\\.])+\\.([A-Za-z]{2,4})$/", message = "不是邮箱")
    private String email;
    @Max(value = 60, message = "年龄必须小于60")
    @Min(value = 18, message = "年龄必须小于18")
    @Excel(name = "年龄")
    private Integer age;

    @Excel(name = "头像", type = 2)
    private String headImage;

完成验证的功能

/**
     * 上传的文件使用 MultipartFile类型来接收
     * @param empFile
     * @return
     */
    @RequestMapping("/employeeXlsx")
    public String employeeXlsx(MultipartFile empFile, HttpServletResponse response) throws Exception {
        //准备导入的参数
        ImportParams params = new ImportParams();
       // params.setTitleRows(1);
        params.setHeadRows(1);
        // need:需要  verfiy:核实,验证
        params.setNeedVerfiy(true); //需要验证

        //加入自定义验证
      //  params.setVerifyHandler(employeeExcelVerifyHandler);

        //excel导入的一个结果
        ExcelImportResult<Employee> result = ExcelImportUtil.importExcelMore(
                empFile.getInputStream(),
                Employee.class, params);
        //引入正确的list（正常保存）
        result.getList().forEach(e ->{
            // System.out.println(e+","+e.getDepartment());
            //根据部门名称拿到它的部门，再放到对应的员工中
            Department dept = departmentService.findByName(e.getDepartment().getName());
            e.setDepartment(dept);
            //给一个默认密码
            e.setPassword("123");
            employeeService.save(e);
        });
//        //引入错误的list
//        result.getFailList().forEach(e ->{
//            System.out.println("错误的："+e);
//        });
        //如果有错误，就直接导出错误文件到前台
        // Verfiy:检验 Fail：失败
        if(result.isVerfiyFail()){
            //如果验证失败，代码到这里面来
            //失败的文件已经准备好了
            Workbook failWorkbook = result.getFailWorkbook();
            //把这个文件导出
            response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"); //mime类型
            response.setHeader("Content-disposition", "attachment;filename=error.xlsx");
            response.setHeader("Pragma", "No-cache");//设置不要缓存
            OutputStream ouputStream = response.getOutputStream();
            failWorkbook.write(ouputStream);
            ouputStream.flush();
            ouputStream.close();
        }

        return "import/import";
    }

自定义验证

applicationContext-mvc.xml

扫描我们自定义验证规则的类

<context:component-scan base-package="cn.itsource.aisell.common" />

准备验证规则

自己实现验证的规则

/**
 * 准备一个自定义验证
 */
@Component
public class EmployeeExcelVerifyHandler implements IExcelVerifyHandler<Employee> {

    @Autowired
    private IEmployeeService employeeService;

    @Override
    public ExcelVerifyHandlerResult verifyHandler(Employee employee) {
        ExcelVerifyHandlerResult result = new ExcelVerifyHandlerResult(true);
        //如果存在，返回false
        if(!employeeService.checkUsername(employee.getUsername())){
            //代表用户名重复
            result.setMsg("用户名重复");
            result.setSuccess(false);
        }
        return result;
    }
}

验证规则用起来ImportController

自己实现验证的规则，加入到验证里。

@Autowired
private EmployeeExcelVerifyHandler employeeExcelVerifyHandler;

加入自定义的验证

//加入自定义验证
      //  params.setVerifyHandler(employeeExcelVerifyHandler);