1. 添加依赖
<dependency>
<groupId>com.alibaba</groupId>
<artifactId>easyexcel</artifactId>
<version>最新版本</version> <!-- 请替换为最新的版本号 -->
</dependency>
2. 定义数据模型
定义一个Java类,该类将作为Excel表格的数据模型。使用@ExcelProperty
注解来映射字段到Excel的列。
import com.alibaba.excel.annotation.ExcelProperty;
@Data
public class UserData {
@ExcelProperty(value = "姓名", index = 0)
private String name;
@ExcelProperty(value = "年龄", index = 1)
private Integer age;
@ExcelProperty(value = "邮箱", index = 2)
private String email;
}
3. 导出Excel
在Controller或者Service中,编写一个方法来导出Excel文件。
import com.alibaba.excel.EasyExcel;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.GetMapping;
import javax.servlet.http.HttpServletResponse;
import java.io.IOException;
import java.net.URLEncoder;
import java.util.ArrayList;
import java.util.List;
@Controller
public class ExcelExportController {
@GetMapping("/export")
public void exportExcel(HttpServletResponse response) throws IOException {
// 构造数据
List<UserData> data = new ArrayList<>();
data.add(new UserData("张三", 20, "zhangsan@example.com"));
data.add(new UserData("李四", 25, "lisi@example.com"));
// ... 添加更多数据
// 设置响应头
//如果你的应用部署在需要处理特殊字符的服务器(如Tomcat)上,
//需要使用URL编码来避免文件名中的特殊字符导致问题
String fileName = URLEncoder.encode("用户数据", "UTF-8");
response.setContentType("application/vnd.ms-excel");
response.setCharacterEncoding("utf-8");
response.setHeader("Content-Disposition", "attachment;filename*=UTF-8''" + fileName + ".xlsx");
// 使用EasyExcel导出Excel
EasyExcel.write(response.getOutputStream(), UserData.class).sheet("用户列表").doWrite(data);
}
}
在这个例子中,我们创建了一个简单的HTTP GET端点/export
,当用户访问这个端点时,会触发Excel文件的导出。我们构造了一个包含两个UserData
对象的列表,并使用EasyExcel.write()
方法将其写入到HTTP响应的输出流中。通过设置响应头,我们告诉浏览器这是一个需要下载的Excel文件,并指定了文件名。