导出功能
准备导出按钮
<form id="searchForm" action="/employee/export" method="post">
...
<button class="easyui-linkbutton" iconCls="icon-search">导出</button>
</form>
准备好view
applicationContext-mvc.xml 中配置如下
<!--配置一下beanName的视图解析器
p:order="0":设置属性优先级
-->
<bean class="org.springframework.web.servlet.view.BeanNameViewResolver" p:order="0" />
<!--
<bean class="org.springframework.web.servlet.view.BeanNameViewResolver">
<property name="order" value="0" />
</bean>
-->
<!-- 对于easypoi中准备发的视图(view)的扫描 -->
<context:component-scan base-package="cn.afterturn.easypoi.view" />
完成后台的导出
EmployeeController中添加如下方法
/**
* 导出就是下载(下载就是把一个流 从服务器端 -> 客户端)
*
* EasypoiSingleExcelView : 注解导出的view
*/
@RequestMapping("/export")
public String export(EmployeeQuery query,ModelMap map, HttpServletRequest request){
//根据查询条件拿到所有数据
List<Employee> list = employeeService.queryAll(query);
//导出的属性
ExportParams params = new ExportParams("员工数据", "员工表", ExcelType.XSSF);
//params.setFreezeCol(2); 冻结
//request:获取到真实路径
String realPath = request.getServletContext().getRealPath("");
System.out.println(realPath);
list.forEach(e->{
e.setHeadImage(realPath+e.getHeadImage());
});
map.put(NormalExcelConstants.DATA_LIST, list); // 数据集合
map.put(NormalExcelConstants.CLASS, Employee.class);//导出实体
map.put(NormalExcelConstants.PARAMS, params);//参数
map.put(NormalExcelConstants.FILE_NAME, "employee");//文件名称
//根据返回的名称去找一个bean对象(在SpringMVC称之为view)
// /WEB-INF/views/easypoiExcelView
// 我们直接要文档的的操作是没有成功的 2.文档的情况和我们项目中的情况有一点区别
return NormalExcelConstants.EASYPOI_EXCEL_VIEW;//View名称 "easypoiExcelView"
}
导入功能
注意 必需配置上传解析器,名字必需叫 multipartResolver
准备导入页面
<%@ 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"
--%>
<!-- 上传必需是: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("/import")
public class ImportController extends BaseController {
@Autowired
private IDepartmentService departmentService;
@RequestMapping("/index")
public String index(){
return "import";
}
/**
* 上传的文件使用 MultipartFile类型来接收
* @param empFile
* @return
*/
@RequestMapping("/employeeXlsx")
public String employeeXlsx(MultipartFile empFile) throws Exception {
// System.out.println(empFile);
// System.out.println(empFile.getName()); //empFile:上传控件的名称
// System.out.println(empFile.getOriginalFilename()); //emp-poi.xlsx:上传文件的名称
// System.out.println(empFile.getContentType()); //mime类型 office excel 2007
// System.out.println(empFile.getSize()); //文件大小
//我们需要拿到上传的文件(输入流)
// empFile.getInputStream()
//一.使用EasyPoi获取文件数据
//1.1 设置参数
ImportParams params = new ImportParams();
//params.setTitleRows(1);
params.setHeadRows(1);
// 1.2 拿到文件中的数据
List<Employee> list = ExcelImportUtil.importExcel(empFile.getInputStream(),
Employee.class, params);
//二.保存员工数据
list.forEach(e->{
//导入时加上一个默认密码 -> 大家可以去研究一个扩展功能:第一次登录要求修改密码
e.setPassword("123");
//通过部门名称拿到部门数据(要有id)
Department dept = departmentService.findByName(e.getDepartment().getName());
//把部门设置到员工数据中
e.setDepartment(dept);
employeeService.save(e);
} );
return "import";
}
}
导入验证功能
导入验证包支持
<!-- JSR 303 规范验证包 -->
<dependency>
<groupId>org.hibernate</groupId>
<artifactId>hibernate-validator</artifactId>
<version>5.2.4.Final</version>
</dependency>
domain中添加验证的方法
@Entity
@Table(name = "employee")
public class Employee extends BaseDomain {
@Excel(name = "用户名")
@NotNull(message = "用户名不能空")
private String username;
private String password;
@Excel(name = "年龄")
@Max(value = 100)
@Min(value = 18)
private Integer age;
@Excel(name = "邮箱",width = 20)
@NotNull
private String email;
...
}
自定义验证
实现IExcelVerifyHandler
把这个类交给Spring管理(千万不要忘了让Spring去扫描到它)
/**
* 自定义验证(我们会在这里做唯一性的验证)
*/
@Component
public class EmployeeExcelVerifyHandler implements IExcelVerifyHandler<Employee> {
@Autowired
private IEmployeeService employeeService;
/**
*
* ExcelVerifyHandlerResult
* suceess :代表验证成功还是失败(如果用户名重复,就代表失败)
* msg:失败的原因
*/
@Override
public ExcelVerifyHandlerResult verifyHandler(Employee employee) {
ExcelVerifyHandlerResult result = new ExcelVerifyHandlerResult(true);
//如果根据用户名获取到用户,代表这个用户已经存在
Employee tempEmp = employeeService.findByUsername(employee.getUsername());
if(tempEmp!=null){
result.setSuccess(false);
result.setMsg("用户名重复");
}
return result;
}
}
实现验证功能
@Controller
@RequestMapping("/import")
public class ImportController extends BaseController {
@Autowired
private IEmployeeService employeeService;
@Autowired
private IDepartmentService departmentService;
@Autowired
private EmployeeExcelVerifyHandler employeeExcelVerifyHandler;
@RequestMapping("/index")
public String index(){
return "import";
}
@RequestMapping("/employeeXlsx")
public String employeeXlsx(MultipartFile empFile, HttpServletResponse response) throws Exception {
//一.使用EasyPoi获取文件数据
ImportParams params = new ImportParams();
params.setHeadRows(1);
params.setNeedVerfiy(true); //设置验证支持
params.setVerifyHandler(employeeExcelVerifyHandler); //设置一个验证处理器
//二.获取excel中的数据,封装成了一个结果对象(有很多东西)
ExcelImportResult<Employee> result = ExcelImportUtil.importExcelMore(
empFile.getInputStream(),
Employee.class, params);
//三.获到正确的数据,并把它们保存到数据库
List<Employee> list = result.getList();
list.forEach(e->{
e.setPassword("123");
Department dept = departmentService.findByName(e.getDepartment().getName());
e.setDepartment(dept);
employeeService.save(e);
});
//四.如果有错误,把错误数据返回到前台(让前台下载一个错误的excel)
//4.1判断是否有错误
if(result.isVerfiyFail()){
//4.2拿到错误的文件薄
Workbook failWorkbook = result.getFailWorkbook();
//把这个文件导出
response.setContentType("application/vnd.openxmlformats-officedocument.spreadsheetml.sheet"); //mime类型
response.setHeader("Content-disposition", "attachment;filename=error.xlsx"); //告诉浏览下载的是一个附件,名字叫做error.xlsx
response.setHeader("Pragma", "No-cache");//设置不要缓存
OutputStream ouputStream = response.getOutputStream();
failWorkbook.write(ouputStream);
ouputStream.flush();
ouputStream.close();
}
return "import";
}
}
总结
今天在项目中完成的功能是Java操作办公软件,使用到的框架是EasyPOI,关于EasyPOI的使用在我前面的文章有详细的介绍,所有我在项目里就是直接使用了!不难,主要是细节问题