5分钟就好了(花了5分钟就搞定了)
作者 | 果汁简历
来源 | 果汁简历
工欲善其事必先利其器,果然有道理,之前经常做一些 Excel 的解析和写入,大家估计也对 jxl 和 poi 有所耳闻,操作起来那是一塌糊涂,需要了解里面的各种变量,然而这次我们使用的是阿里开源的 EasyExcel,5分钟搞定下载和上传解析。
我们写代码之前先说一下我们模拟的场景,我们需要使用 EasyExcel 实现文章的批量上传和下载。
- 访问 /template 可以下载要上传的模板
- 访问 /upload 把填写好的模板上传
- 访问 /download 下载之前上传的内容
话不多说直接上代码,文末可以获取全部代码。代码运行的环境是 Spring Boot,所以具体的 Spring Boot 搭建细节我们就不说了,直接从引入 EasyExcel 开始。
1. 引入依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>2.2.4</version>
</dependency>
如果需要上传 Excel,势必需要提前准备好模板,那么这点 EasyExcel 做的更简洁,我们直接上代码。定义一个 download 请求,设置 application/vnd.ms-excel 为了返回内容后直接可以作为 excel 文件下载。下面才是重点。
- EasyExcel.write 是设置具体需要映射的对象到返回的流
- EasyExcel.sheet 设置具体的 sheet 名字
- EasyExcel.doWrite 写入具体的内容,也是 write 里面对应的 Article 对象的列表。
EasyExcel
.write(response.getOutputStream(),Article.class)
.sheet("模板")
.doWrite(newArrayList());
@GetMapping("tempalte")
publicvoidtempalte(HttpServletResponseresponse)throwsIOException{
response.setContentType("application/vnd.ms-excel");
response.setCharacterEncoding("utf-8");
StringfileName=URLEncoder.encode("文章模板","UTF-8");
response.setHeader("Content-disposition","attachment;filename=" fileName ".xlsx");
EasyExcel.write(response.getOutputStream(),Article.class).sheet("模板").doWrite(newArrayList());
}
Article.java 类,里面就比较简单了,定义了三个属性,这三个属性分别通过 ExcelProperty 映射 Excel 的标题,也就是列,一定要有 setter 和 getter 方法,这里为了依赖少直接生成的,你也可以使用 Lombok。
publicclassArticle{
@ExcelProperty("文章标题")
privateStringtitle;
@ExcelProperty("文章链接")
privateStringlink;
@ExcelProperty("阅读数")
privateIntegerview;
publicStringgetTitle(){
returntitle;
}
publicvoidsetTitle(Stringtitle){
this.title=title;
}
publicStringgetLink(){
returnlink;
}
publicvoidsetLink(Stringlink){
this.link=link;
}
publicIntegergetView(){
returnview;
}
publicvoidsetView(Integerview){
this.view=view;
}
}
接下来我们运行程序EasyExcelApplication(源码中的启动类),然后访问
http://localhost:8080/tempalte
神奇的一幕出现了,直接下载下来了一个 excel 文件,内容如下,是不是太简单了?
上传
根据刚刚下载的模板,把我事先准备好的文章录入
然后定义一个接口 upload 如下,内容也是非常简练,使用 EasyExcel.read 方法就可以搞定,其中 file.getInputStream() 是对应的文件输入流,Article.class 就是刚才我们下载时候定义好的类,因为类型一样,可以直接复用,ArticleReadListener 就比较重要了,它是用来接收所有解析行。其他的都是固定写法。
@PostMapping("upload")
@ResponseBody
publicStringupload(MultipartFilefile)throwsIOException{
EasyExcel.read(file.getInputStream(),Article.class,newArticleReadListener(articleDao)).sheet().doRead();
return"success";
}
ArticleReadListener 需要注意的地方是我不能托管给 Spring 所以需要在构造方法里面把预先注入的 articleDao 写进入,articleDao 是为了模拟数据库操作,为我们稍后的下载提供数据支持。
ArticleReadListener 相对来说也是非常简单,先实现AnalysisEventListener类并传入泛型 Article,复写 invoke 方法解析的每一行 excel,因为传入了泛型,会自动转换为 Article,当然它会自动过滤标题行,所以正式解析的就是第一行内容,doAfterAllAnalysed是读取完所有内容以后的操作,我们调用 articleDao.save(raws); 把所有解析的内容存入 mock 的数据库。
publicclassArticleReadListenerextendsAnalysisEventListener<Article>{
privateArticleDaoarticleDao;
publicArticleReadListener(ArticleDaoarticleDao){
this.articleDao=articleDao;
}
privatestaticfinalLoggerlogger=LoggerFactory.getLogger(ArticleReadListener.class);
privateList<Article>raws=newArrayList<>();
@Override
publicvoidinvoke(Articledata,AnalysisContextcontext){
logger.info("开始读取文章:{}",JSON.toJSONString(data));
raws.add(data);
}
@Override
publicvoiddoAfterAllAnalysed(AnalysisContextcontext){
logger.info("一共读取了{}篇文章,标题分别是:",raws.size(),raws.stream().map(Article::getTitle).collect(Collectors.toList()));
articleDao.save(raws);
}
}
ArticleDao 代码不需要解释,直接看下
@Service
publicclassArticleDao{
privateList<Article>articles=newArrayList<>();
publicvoidsave(List<Article>raws){
articles=raws;
}
publicList<Article>list(){
returnarticles;
}
}
然后直接使用 Postman 上传文件
就可以在控制台直接看到日志内容了
开始读取文章:{"link":"https://mp.weixin.qq.com/s/S0RCVJClS0094kjjmAn8yA","title":"让人又爱又恨的Lombok,到底该不该用","view":1378}
开始读取文章:{"link":"https://mp.weixin.qq.com/s/r6toOIgrt4f9M8j4PGGaFQ","title":"Delombok 是个啥?居然可破 Lombok?","view":1559}
一共读取了2篇文章,标题分别是:[让人又爱又恨的 Lombok,到底该不该用, Delombok 是个啥?居然可破 Lombok?]
是不是非常简单就读取完了?那么我们继续完成下载
下载你自己观察可以看到,下载的代码和下载模板的代码基本一样,唯一的不同.doWrite(articleDao.list()),把之前上传存入数据库的内容写入 excel。
@GetMapping("download")
publicvoiddownload(HttpServletResponseresponse)throwsIOException{
response.setContentType("application/vnd.ms-excel");
response.setCharacterEncoding("utf-8");
StringfileName=URLEncoder.encode("文章下载","UTF-8");
response.setHeader("Content-disposition","attachment;filename=" fileName ".xlsx");
EasyExcel
.write(response.getOutputStream(),Article.class)
.sheet("文章")
.doWrite(articleDao.list());
}
话不多说,我们直接访问 http://localhost:8080/download 看下结果,是不是非常简单就可以完成上传和下载?
完整代码获取地址https://github.com/juice-resume/java-programming.git
···END···
,免责声明:本文仅代表文章作者的个人观点,与本站无关。其原创性、真实性以及文中陈述文字和内容未经本站证实,对本文以及其中全部或者部分内容文字的真实性、完整性和原创性本站不作任何保证或承诺,请读者仅作参考,并自行核实相关内容。文章投诉邮箱:anhduc.ph@yahoo.com