当前位置: 主页 > JAVA语言

java实现文件下载-阿里开源的EasyExcel,5分钟搞定下载和上传解析!

发布时间:2023-07-12 09:03   浏览次数:次   作者:佚名

下载文件java写法_java实现文件下载功能_java实现文件下载

作者 | 果汁简历

来源 | 果汁简历

java实现文件下载_下载文件java写法_java实现文件下载功能

工欲善其事必先利其器,果然有道理,之前经常做一些 Excel 的解析和写入,大家估计也对 jxl 和 poi 有所耳闻,操作起来那是一塌糊涂,需要了解里面的各种变量,然而这次我们使用的是阿里开源的 EasyExcel,5分钟搞定下载和上传解析。

我们写代码之前先说一下我们模拟的场景,我们需要使用 EasyExcel 实现文章的批量上传和下载。

访问 /template 可以下载要上传的模板

访问 /upload 把填写好的模板上传

java实现文件下载功能_java实现文件下载_下载文件java写法

访问 /download 下载之前上传的内容

话不多说直接上代码,文末可以获取全部代码。代码运行的环境是 Spring Boot,所以具体的 Spring Boot 搭建细节我们就不说了,直接从引入 EasyExcel 开始。

1. 引入依赖

<dependency>
    <groupId>com.alibabagroupId>
    <artifactId>easyexcelartifactId>
    <version>2.2.4version>
dependency>

2. 下载模板

如果需要上传 Excel,势必需要提前准备好模板,那么这点 EasyExcel 做的更简洁,我们直接上代码。定义一个 download 请求,设置 application/vnd.ms-excel 为了返回内容后直接可以作为 excel 文件下载。下面才是重点。

EasyExcel
  .write(response.getOutputStream(), Article.class)
  .sheet("模板")
  .doWrite(new ArrayList());

java实现文件下载_java实现文件下载功能_下载文件java写法

@GetMapping("tempalte")
public void tempalte(HttpServletResponse response) throws IOException {
    response.setContentType("application/vnd.ms-excel");
    response.setCharacterEncoding("utf-8");
    String fileName = URLEncoder.encode("文章模板""UTF-8");
    response.setHeader("Content-disposition""attachment;filename=" + fileName + ".xlsx");
    EasyExcel.write(response.getOutputStream(), Article.class).sheet("模板").doWrite(new ArrayList());
}

Article.java 类,里面就比较简单了,定义了三个属性,这三个属性分别通过 ExcelProperty 映射 Excel 的标题,也就是列,一定要有 setter 和 getter 方法,这里为了依赖少直接生成的,你也可以使用 。

public class Article {
    @ExcelProperty("文章标题")
    private String title;
    @ExcelProperty("文章链接")
    private String link;
    @ExcelProperty("阅读数")
    private Integer view;

    public String getTitle() {
        return title;
    }

    public void setTitle(String title) {
        this.title = title;
    }

    public String getLink() {
        return link;
    }

    public void setLink(String link) {
        this.link = link;
    }

    public Integer getView() {
        return view;
    }

    public void setView(Integer view) {
        this.view = view;
    }
}

接下来我们运行程序EasyExcelApplication(源码中的启动类),然后访问

http://localhost:8080/tempalte

神奇的一幕出现了,直接下载下来了一个 excel 文件,内容如下,是不是太简单了?

java实现文件下载功能_下载文件java写法_java实现文件下载

java实现文件下载_java实现文件下载功能_下载文件java写法

上传

根据刚刚下载的模板,把我事先准备好的文章录入

java实现文件下载功能_下载文件java写法_java实现文件下载

然后定义一个接口 upload 如下,内容也是非常简练,使用 EasyExcel.read 方法就可以搞定,其中 file.getInputStream() 是对应的文件输入流,Article.class 就是刚才我们下载时候定义好的类,因为类型一样,可以直接复用,ArticleReadListener 就比较重要了,它是用来接收所有解析行。其他的都是固定写法。

@PostMapping("upload")
@ResponseBody
public String upload(MultipartFile file) throws IOException {
    EasyExcel.read(file.getInputStream(), Article.class, new ArticleReadListener(articleDao)).sheet().doRead();
    return "success";
}

ArticleReadListener 需要注意的地方是我不能托管给 Spring 所以需要在构造方法里面把预先注入的 articleDao 写进入,articleDao 是为了模拟数据库操作,为我们稍后的下载提供数据支持。

ArticleReadListener 相对来说也是非常简单,先实现AnalysisEventListener类并传入泛型 Articlejava实现文件下载,复写 invoke 方法解析的每一行 excel,因为传入了泛型,会自动转换为 Article,当然它会自动过滤标题行,所以正式解析的就是第一行内容,doAfterAllAnalysed 是读取完所有内容以后的操作,我们调用 articleDao.save(raws); 把所有解析的内容存入 mock 的数据库。

java实现文件下载_下载文件java写法_java实现文件下载功能

public class ArticleReadListener extends AnalysisEventListener<Article{
    private ArticleDao articleDao;

    public ArticleReadListener(ArticleDao articleDao) {
        this.articleDao = articleDao;
    }

    private static final Logger logger = LoggerFactory.getLogger(ArticleReadListener.class);
    private List
 raws = new ArrayList<>();

    @Override
    public void invoke(Article data, AnalysisContext context) {
        logger.info("开始读取文章:{}", JSON.toJSONString(data));
        raws.add(data);
    }

    @Override
    public void doAfterAllAnalysed(AnalysisContext context) {
        logger.info("一共读取了{}篇文章,标题分别是:", raws.size(), raws.stream().map(Article::getTitle).collect(Collectors.toList()));
        articleDao.save(raws);
    }
}

ArticleDao 代码不需要解释,直接看下

@Service
public class ArticleDao {
    private List
 articles = new ArrayList<>();

    public void save(List
 raws) {
        articles = raws;
    }

    public List
 list() {
        return articles;
    }
}

然后直接使用 Postman 上传文件

java实现文件下载功能_下载文件java写法_java实现文件下载

就可以在控制台直接看到日志内容了

开始读取文章:{"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?]

下载文件java写法_java实现文件下载功能_java实现文件下载

是不是非常简单就读取完了?那么我们继续完成下载

下载

你自己观察可以看到,下载的代码和下载模板的代码基本一样,唯一的不同.doWrite(articleDao.list()),把之前上传存入数据库的内容写入 excel。

@GetMapping("download")
public void download(HttpServletResponse response) throws IOException {
    response.setContentType("application/vnd.ms-excel");
    response.setCharacterEncoding("utf-8");
    String fileName = URLEncoder.encode("文章下载""UTF-8");
    response.setHeader("Content-disposition""attachment;filename=" + fileName + ".xlsx");
    EasyExcel
    .write(response.getOutputStream(), Article.class)
    .sheet("文章")
    .doWrite(articleDao.list());
}

话不多说java实现文件下载,我们直接访问 :8080/download 看下结果,是不是非常简单就可以完成上传和下载?

下载文件java写法_java实现文件下载功能_java实现文件下载

完整代码获取地址

···END···