easyPOI的上传和下载(导入和导出功能)
- Java操作办公室软件的框架
a) jxl:只能对Excel进行操作,属于比较老的框架。
POI:是apache的项目,可对ms(微软)的word,Excel,PPT进行操作,包括office2003和2007。
b)
POI框架学习
i.
导包
ii.
第一个demo
- EasyPOI导入导出
a)
导入easyPOI的包
<!– 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>
b)
在我们要进行数据操作的实体类中的属性上打上@Excel(name=”XXX”)
这里的savePath表示是图片在项目中的路径
@Excel(name = “头像”,type = 2,savePath = “/images/head”,height =
23)
private String headImage; //头像的导出
如果是关联对象的话在关联对象的属性上面打上@ExcelEntity
@ExcelEntity
private Department department;
c) 前台JSP页面添加按钮后台写业务逻辑,传入ModelMap,query,request作为参数,写完之后需要在Springmvc的xml配置文件中去配置扫描easypoi的一些view:视图
传入的request参数用来解决图片路径问题,request获取项目根路径与图片路径拼接。
d) 在Employee对象里面去加@Excel注解
@Entity
@Table(name=”employee”)
public class Employee extends BaseDomain {
@Excel(name=”用户名”)
private String username;
private String password;
@Excel(name=”邮件”,width
= 25)
private String email;
@Excel(name=”年纪”)
private Integer age;
@Excel(name =
“头像”,type = 2,savePath = “/images/head”,height =
23)
private String headImage; //头像
@ManyToOne(fetch = FetchType.LAZY)
@JoinColumn(name=”department_id”)
//Json Ignore(忽略) Properties(属性)
//@JsonIgnoreProperties(value={“hibernateLazyInitializer”,”handler”,”fieldHandler”})
@ExcelEntity
private Department department;
这里必须写get和set方法
}
部门有相应的关连
@Entity
@Table(name=”department”)
public class Department extends BaseDomain {
@Excel(name =
“部门名称”)
private String name;
}
e)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>
f)EmployeeController文件下载实现
// 文件导出功能
/**
*
* @param map
* @param employeeQuery
* @param request
* @return
*/
@RequestMapping("/download")
public String downloadExcel(ModelMap map,EmployeeQuery employeeQuery, HttpServletRequest request){
System.out.println("--------------");
// 查询获取到所有的数据
List<Employee> list = employeeService.findByQuery(employeeQuery);
// 解决加载图片时的路径拼接问题
String realPath = request.getServletContext().getRealPath("/");
for (Employee employee : list) {
employee.setHeadImage(realPath+employee.getHeadImage());
System.out.println(employee.getHeadImage());
}
// 设置下载表格的一些属性
ExportParams exportParams = new ExportParams("员工管理","明细", ExcelType.XSSF);
// 导出的集合
map.put(NormalExcelConstants.DATA_LIST, list); // 数据集合
map.put(NormalExcelConstants.CLASS, Employee.class);//导出实体
map.put(NormalExcelConstants.PARAMS, exportParams);//参数
map.put(NormalExcelConstants.FILE_NAME, "employee");//文件名称
//返回的名称 :easypoiExcelView -> 并没有找我的bean,而且当做一个路径去进行访问
// 现在默认去找的视图解析器,而没有找我的那一个bean
// return "forward:/WEB-INF/views/employee.jsp";//View名称,这如果不去MVC的配置文件去坐配置,它会默认去找我妈自己配置的视图解析器,而我们根本没有这个页面,就会报404,
所以要在配置文件去添加扫描easypoi的一些view:视图和导出文件时优先找这个视图解析器出理
return NormalExcelConstants.EASYPOI_EXCEL_VIEW;//View名称
}
添加Springmvc.xml的配置
<!-- 扫描easypoi的一些view:视图 -->
<context:component-scan base-package="cn.afterturn.easypoi.view" />
<!--导出文件时优先找这个视图解析器出理-->
<!-- bean的视图解析器 p:order="0":顺序在最前面 -->
<bean id="beanNameViewResolver" class="org.springframework.web.servlet.view.BeanNameViewResolver"
p:order="0" />
d) easyPOI的文件上传
i. 准备一个上传文件的页面import.JSP
<%--这是个文件上传的页面--%>
<%@ 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>
ii. 写一个文件上传的controller,先跳转到页面,再到后台进行文件上传,进行文件上传的时候传入MultipartFile empFile, HttpServletResponse response这两个关键的对象,
如果说要对导入的数据进行一个验证的话,就需要导入easyPOI的验证包,然后在controller层开启这个验证。
@Controller
@RequestMapping("/import")
public class ImportController {
@Autowired
private IDepartmentService departmentService;
@Autowired
private IEmployeeService employeeService;
@RequestMapping("/index")
public String index(){
return "import";
}
// 具备验证的导入管理
@RequestMapping("/employeeXlsx")
public String employeeXlsx(MultipartFile empFile, HttpServletResponse response) throws Exception {
// 准备要导入的参数
ImportParams params = new ImportParams();
// 设置从第一行开始导入
params.setTitleRows(1);
// 启动导入时的一个验证功能
params.setNeedVerfiy(true);
// 获取导入Excel的方法
ExcelImportResult<Employee> result = ExcelImportUtil.importExcelMore(empFile.getInputStream(), Employee.class, params);
List<Employee> List = result.getList();
// 将正确的list进行保存到数据库
for (Employee employee : List) {
// 解决导入数据时部门问题
Department department = departmentService.findByName(employee.getDepartment().getName());
employee.setDepartment(department);
// employee.setUsername("1111");
// employee.setPassword("2222");
// System.out.println(employee.getUsername());
// 将数据存储到数据库
employeeService.save(employee);
}
// 将错误的list印出来不保存到数据库
List<Employee> failList = result.getFailList();
for (Employee employee : failList) {
System.out.println("有问题的employee"+employee);
}
//如果有错误,就直接导出错误文件到前台
// 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";
}
}
注意页面导入文件的文件属性名要与controller中参数的名称对应,
如果要对导入的数据进行验证的话就要导入EasyPOI验证的jar包
<!– JSR 303 规范验证包 –>
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.2.4.Final</version>
</dependency>
然后在实体类上加上相应的验证的注解
public class Employee{
@Excel(name=”用户名”)
@NotNull(message = “用户名不为空”)
private String username;
private String password;
@Excel(name=”邮件”,width = 25)
private String email;
@Excel(name=”年纪”)
@Max(value = 80,message = “max 最大值不能超过80″)
private Integer age;
getset方法
}