springboot之导出(下载)excel文件

一.maven的依赖见第一篇博文
二.建立BaseFrontController类用于下载excel

package com.nyjk.origin.web.excel;

import org.apache.poi.util.IOUtils;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.util.StringUtils;
import org.springframework.validation.annotation.Validated;

import java.io.InputStream;
import java.net.URLEncoder;
import java.util.HashMap;
import java.util.Map;

/**
 * @ClassName:
 * @Author Mr GuoQing
 * @Date: 2020/1/15 08:57
 * @Description:
 */
@Validated
public class BaseFrontController {

    /**
     * slf4j 日志 logger
     */
    protected final Logger logger = LoggerFactory.getLogger(this.getClass());

    /**
     * 下载文件,纯SpringMVC的API来完成
     *
     * @param is 文件输入流
     * @param name 文件名称,带后缀名
     *
     * @throws Exception
     */
    public ResponseEntity<byte[]> buildResponseEntity(InputStream is, String name) throws Exception {
        logger.info(">>>>>>>>>>>>>>>>>>>>开始下载文件>>>>>>>>>>");
        if (this.logger.isDebugEnabled())
            this.logger.debug("download: " + name);
        HttpHeaders header = new HttpHeaders();
        String fileSuffix = name.substring(name.lastIndexOf('.') + 1);
        fileSuffix = fileSuffix.toLowerCase();

        Map<String, String> arguments = new HashMap<String, String>();
        arguments.put("xlsx", "application/vnd.openxmlformats-officedocument.spreadsheetml.sheet");
        arguments.put("xls", "application/vnd.ms-excel");

        String contentType = arguments.get(fileSuffix);
        header.add("Content-Type", (StringUtils.hasText(contentType) ? contentType : "application/x-download"));
        if(is !=null && is.available()!=0){
            header.add("Content-Length", String.valueOf(is.available()));
            header.add("Content-Disposition", "attachment;filename*=utf-8'zh_cn'" + URLEncoder.encode(name, "UTF-8"));
            byte[] bs = IOUtils.toByteArray(is);
            logger.info(">>>>>>>>>>>>>>>>>>>>结束下载文件-有记录>>>>>>>>>>");
            logger.info(">>>>>>>>>>结束导出excel>>>>>>>>>>");
            return new ResponseEntity<>(bs, header, HttpStatus.OK);
        }else{
            String string="数据为空";
            header.add("Content-Length", "0");
            header.add("Content-Disposition", "attachment;filename*=utf-8'zh_cn'" + URLEncoder.encode(name, "UTF-8"));
            logger.info(">>>>>>>>>>>>>>>>>>>>结束下载文件-无记录>>>>>>>>>>");
            logger.info(">>>>>>>>>>结束导出excel>>>>>>>>>>");
            return new ResponseEntity<>(string.getBytes(), header, HttpStatus.OK);
        }
    }
}

三.执行查询语句

 public ResponseEntity<byte[]> exportCityExcel(HttpServletRequest request, HttpServletResponse response) {
        try {
            logger.info(">>>>>>>>>>开始导出excel>>>>>>>>>>");
            List<CityDO> cityDOS = cityDOMapper.selectAll();
            // 造几条数据
            BaseFrontController baseFrontController = new BaseFrontController();
            return baseFrontController.buildResponseEntity(exportCity(list), "城市信息.xls");
        } catch (Exception e) {
            e.printStackTrace();
            logger.error(">>>>>>>>>>导出excel 异常,原因为:" + e.getMessage());
        }
        return null;
    }

四.执行封装方法构造表格和数据一一对应

 // 城市
    private InputStream exportCity(List<City> list){
        ByteArrayOutputStream output = null;
        InputStream inputStream1 = null;
        SXSSFWorkbook wb = new SXSSFWorkbook(1000);// 保留1000条数据在内存中
        SXSSFSheet sheet = wb.createSheet();
        // 设置报表头样式
        CellStyle header = ExcelFormatUtil.headSytle(wb);// cell样式
        CellStyle content = ExcelFormatUtil.contentStyle(wb);// 报表体样式

        // 每一列字段名
        String[] strs = new String[] {"城市id","城市名","省级名"};
        int[] ints = new int[] { 5000, 5000,5000};
        ExcelFormatUtil.initTitleEX(sheet, header, strs, ints);

        if (list != null && list.size() > 0) {
            logger.info(">>>>>>>>>>>>>>>>>>>>开始遍历数据组装单元格内容>>>>>>>>>>");
            for(int i = 0 ; i < list.size(); i++ ){
                City city = list.get(i);
                SXSSFRow row = sheet.createRow(i + 1);
                int j = 0;

                SXSSFCell cell = row.createCell(j++);
                cell.setCellValue(city.getId());   // 根据表格设置属性

                cell = row.createCell(j++);
                cell.setCellValue(city.getName());

                cell = row.createCell(j++);
                cell.setCellValue(city.getProvinceDO().getName());
            }
        }
        try {
            output = new ByteArrayOutputStream();
            wb.write(output);
            inputStream1 = new ByteArrayInputStream(output.toByteArray());
            output.flush();
        } catch (Exception e) {
            e.printStackTrace();
        } finally {
            try {
                if (output != null) {
                    output.close();
                    if (inputStream1 != null)
                        inputStream1.close();
                }
            } catch (IOException e) {
                e.printStackTrace();
            }
        }
        return inputStream1;

    }

结束,溜溜球。

Spring Boot 框架本身并没有提供导出 Excel 文件的功能,但可以通过使用一些第三方库来实现。 以下是一种常用的方式: 1. 添加依赖 在 pom.xml 文件中添加以下依赖: ```xml <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi</artifactId> <version>4.1.2</version> </dependency> <dependency> <groupId>org.apache.poi</groupId> <artifactId>poi-ooxml</artifactId> <version>4.1.2</version> </dependency> ``` 这两个依赖分别提供了对 Excel 文件的读写操作。 2. 编写代码 下面是一个简单的示例代码: ```java import org.apache.poi.ss.usermodel.*; import org.apache.poi.xssf.usermodel.XSSFWorkbook; import org.springframework.stereotype.Service; import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.util.List; @Service public class ExcelService { public void exportExcel(List<Student> students, HttpServletResponse response) throws IOException { // 创建 Workbook 对象 Workbook workbook = new XSSFWorkbook(); // 创建 Sheet 对象 Sheet sheet = workbook.createSheet("学生信息"); // 创建表头 Row headerRow = sheet.createRow(0); Cell headerCell1 = headerRow.createCell(0); headerCell1.setCellValue("学号"); Cell headerCell2 = headerRow.createCell(1); headerCell2.setCellValue("姓名"); Cell headerCell3 = headerRow.createCell(2); headerCell3.setCellValue("性别"); // 填充数据 int rowIndex = 1; for (Student student : students) { Row row = sheet.createRow(rowIndex++); Cell cell1 = row.createCell(0); cell1.setCellValue(student.getStudentId()); Cell cell2 = row.createCell(1); cell2.setCellValue(student.getName()); Cell cell3 = row.createCell(2); cell3.setCellValue(student.getGender()); } // 设置响应头 response.setContentType("application/vnd.ms-excel"); response.setHeader("Content-disposition", "attachment;filename=students.xlsx"); // 输出到响应流 workbook.write(response.getOutputStream()); // 关闭 Workbook 对象 workbook.close(); } } ``` 这个示例代码中,我们创建了一个 `ExcelService` 类,其中有一个 `exportExcel()` 方法,该方法接受一个学生列表和一个 `HttpServletResponse` 对象作为参数。该方法会创建一个 Workbook 对象,然后创建一个名为“学生信息”的 Sheet 对象,并填充数据。最后,将 Workbook 对象输出到响应流,实现文件导出。 注意,这里使用的是 XSSFWorkbook 类来创建 Workbook 对象,因为它支持新的 xlsx 格式。如果要支持旧的 xls 格式,可以使用 HSSFWorkbook 类。 3. 调用方法 在控制器中调用 `ExcelService` 的 `exportExcel()` 方法,传入学生列表和响应对象即可实现导出 Excel 文件。 ```java import org.springframework.beans.factory.annotation.Autowired; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.RestController; import javax.servlet.http.HttpServletResponse; import java.io.IOException; import java.util.ArrayList; import java.util.List; @RestController public class StudentController { @Autowired private ExcelService excelService; @GetMapping("/students/export") public void exportStudents(HttpServletResponse response) throws IOException { List<Student> students = new ArrayList<>(); // ... 从数据库或其他地方获取学生列表 excelService.exportExcel(students, response); } } ``` 在上面的代码中,我们通过 `@Autowired` 注解将 `ExcelService` 对象注入到控制器中,然后在 `exportStudents()` 方法中调用 `exportExcel()` 方法实现导出。最后,我们可以在浏览器中访问 `/students/export` 路径,就会自动下载一个名为“students.xlsx”的 Excel 文件
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值