小言_互联网的博客

【Java】导出excel表格用EasyExcel,简单方便一步操作!

482人阅读  评论(0)

一、需求简介

做各种后台时,总会遇到表格导出为excel的功能,那么对于我这样的Java小白,当然是喜欢操作简单、性能还好的方法啦!

我们项目使用的是阿里的EasyExcel包,下面我将这个工具类抽离出来到utils文件夹下ExcelUtil.java文件,需要使用的时候调用即可。

二、项目结构

三、快速上手使用

(一)引入依赖

我们项目使用的是2.1.4版本,

<dependency>
	<groupId>com.alibaba</groupId>
	<artifactId>easyexcel</artifactId>
	<version>2.1.4</version>
	<scope>compile</scope>
</dependency>

(二)utils下封装一个Excel工具类,在接口中使用

package com.myq.utils;

import com.alibaba.excel.EasyExcel;

import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.List;
import java.util.Set;


public class ExcelUtil {

    /**
     * 导出excel
     * @param response 相应response
     * @param title    保存文件的标题
     * @param head     保存excel对象的实体类
     * @param list     需要保存的数据列表
     * @throws IOException  异常捕获
     */
    public static void exportExcel(HttpServletResponse response, String title, Class head, List list) throws IOException {
        exportExcel(response, title, head, list, null);

    }
    
    public static void exportExcel(HttpServletResponse response, String title, Class head, List list, Set<String> set) throws IOException {
        response.setContentType("application/vnd.ms-excel");
        response.setCharacterEncoding("utf-8");
        String fileName = URLEncoder.encode(title, "UTF-8");
        response.setHeader("Content-disposition", "attachment;filename=" + fileName + ".xlsx");
        if(set == null){
            EasyExcel.write(response.getOutputStream(), head).sheet("模板")
                    .doWrite(list);
        }else{
            EasyExcel.write(response.getOutputStream(), head).includeColumnFiledNames(set).sheet("模板")
                    .doWrite(list);
        }

    }
}

(三) 创建一个excel导出对应的实体类

package com.myq.entity;

import com.alibaba.excel.annotation.ExcelProperty;

import java.io.Serializable;

/**
 * @Descriptions user
 * @Author myq
 * @Date 2020-03-31 17:19
 * @Other
 */
public class User implements Serializable {
	// ExcelProperty注释,指定保存到excel时的表头文字
    @ExcelProperty("id")
    private Integer id;

    @ExcelProperty("password")
    private String password;

    @ExcelProperty("name")
    private String name;

    public User() {
    }
    public User(Integer id, String password, String name) {
        this.id = id;
        this.password = password;
        this.name = name;
    }
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public User withId(Integer id){
        this.setId(id);
        return this;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    public User withPassword(String password) {
        this.setPassword(password);
        return this;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public User withName(String name) {
        this.setName(name);
        return this;
    }
}

(四) 在接口中使用

@RequestMapping(value = "/user/excel",  method = RequestMethod.GET)
    public void exportExcelUserList(HttpServletResponse response) throws IOException {
        List<User> list = userService.findList(new HashMap<>());
		
		// ExcelUtil传参:
        // response
        // title:此处我们将保存文件名写死为“用户统计数据”了
        // head:User类
        // list:User列表list
        ExcelUtil.exportExcel(response, "用户统计数据", User.class, list);
    }
}

四、效果展示

定义好/user/excel接口后,可以用本地请求http://localhost:8080/user/excel

这时,浏览器会自动弹出让你保存excel的提示。如图所示:

保存后,在本地可以打开excel,信息如下:

五、完整代码可到GitHub下载

https://github.com/MeiYu7/ExportExcel

如果帮助到你,可以帮我点一个小星星嘛~~


转载:https://blog.csdn.net/qq_42739440/article/details/105226122
查看评论
* 以上用户言论只代表其个人观点,不代表本网站的观点或立场