Spring Boot控制器导出Excel

Question

我有一个java/Spring Boot应用程序，我想在其中构建一个APIendpoint，创建并返回一个可下载的excel文件。这是我的控制器endpoint：

@RestController
@RequestMapping("/Foo")
public class FooController {
    private final FooService fooService;

    @GetMapping("/export")
    public ResponseEntity export() {
        Resource responseFile = fooService.export();

        return ResponseEntity.ok()
                             .header(HttpHeaders.CONTENT_DISPOSITION, "attachment; filename="+responseFile.getFilename())
                             .contentType(MediaType.MULTIPART_FORM_DATA)
                             .body(responseFile);
    }
}

然后是服务类

public class FooService {
  public Resource export() throws IOException {
    StringBuilder filename = new StringBuilder("Foo Export").append(" - ")
                                                            .append("Test 1.xlsx");
    return export(filename);
  }

  private ByteArrayResource export(String filename) throws IOException {
      byte[] bytes = new byte[1024];
      try (Workbook workbook = generateExcel()) {
          FileOutputStream fos = write(workbook, filename);
          fos.write(bytes);
          fos.flush();
          fos.close();
      }

      return new ByteArrayResource(bytes);
  }

  private Workbook generateExcel() {
      Workbook workbook = new XSSFWorkbook();
      Sheet sheet = workbook.createSheet();

      //create columns and rows

      return workbook;
  }

  private FileOutputStream write(final Workbook workbook, final String filename) throws IOException {
      FileOutputStream fos = new FileOutputStream(filename);
      workbook.write(fos);
      fos.close();
      return fos;
  }  
}

这段代码使用Apache POI库成功地创建了正确的excel文件。但是这不会正确地将它从控制器中返回，因为< code > ByteArrayResource::getFilename 总是返回null:

/**
 * This implementation always returns {@code null},
 * assuming that this resource type does not have a filename.
 */
@Override
public String getFilename() {
    return null;
}

我可以使用什么类型的资源来返回生成的 excel 文件？

Answer 1

让控制器知道它将使用ReponseEntity编写的内容总是更好的。在服务级别，只需创建和播放对象即可。@RestController或@Controller在这里无关紧要。

您在控制器中期待的内容有点像这样（示例）-

@GetMapping(value = "/alluserreportExcel")
public ResponseEntity<InputStreamResource> excelCustomersReport() throws IOException {
    List<AppUser> users = (List<AppUser>) userService.findAllUsers();
    ByteArrayInputStream in = GenerateExcelReport.usersToExcel(users);
    // return IO ByteArray(in);
    HttpHeaders headers = new HttpHeaders();
    // set filename in header
    headers.add("Content-Disposition", "attachment; filename=users.xlsx");
    return ResponseEntity.ok().headers(headers).body(new InputStreamResource(in));
}

生成Excel类-

public class GenerateExcelReport {

public static ByteArrayInputStream usersToExcel(List<AppUser> users) throws IOException {
...
...
//your list here
int rowIdx = 1;
        for (AppUser user : users) {
            Row row = sheet.createRow(rowIdx++);

            row.createCell(0).setCellValue(user.getId().toString());
            ...
        }

  workbook.write(out);
  return new ByteArrayInputStream(out.toByteArray());

最后，在你看来，在某个地方——

<a href="<c:url value='/alluserreportExcel'  />"
                target="_blank">Export all users to MS-Excel</a>

有关完整示例，请看一眼 - 这里，这里和这里。

Answer 2

基本上，您首先需要了解的几点

1.是否需要在磁盘上创建Excel，或者您可以从内存中流式传输它？

如果它是一个下载弹出窗口，用户可能会让它打开很长时间

其次，如果生成的文件对于每个请求都必须是新的(即要导出的数据是不同的)，那么将它保存在磁盘上就没有意义了(磁盘方法的缺点)。

第三，API代码很难清理磁盘，因为你永远不知道用户什么时候会完成他的下载(磁盘方法的缺点)。

Fizik26的回答是这种内存中的方法，你不需要在磁盘上创建一个文件。。这个答案的唯一内容是，您需要跟踪数组< code>out.toByteArray()的长度

2.下载文件时，您的代码需要一个文件一个文件地流式传输——这就是Java流的用途。类似下面的代码可以做到这一点。

return ResponseEntity.ok().contentLength(inputStreamWrapper.getByteCount())
            .contentType(MediaType.parseMediaType("application/vnd.ms-excel"))
            .cacheControl(CacheControl.noCache())
            .header("Content-Disposition", "attachment; filename=" + "SYSTEM_GENERATED_FILE_NM")
            .body(new InputStreamResource(inputStreamWrapper.getByteArrayInputStream()));

和inpuStreamWrapper就像，

public class ByteArrayInputStreamWrapper {
    private ByteArrayInputStream byteArrayInputStream;
    private int byteCount;


    public ByteArrayInputStream getByteArrayInputStream() {
    return byteArrayInputStream;
    }


    public void setByteArrayInputStream(ByteArrayInputStream byteArrayInputStream) {
    this.byteArrayInputStream = byteArrayInputStream;
    }


    public int getByteCount() {
    return byteCount;
    }


    public void setByteCount(int byteCount) {
    this.byteCount = byteCount;
    }

}

关于文件名，如果文件名不是endpoint的输入-这意味着它的系统生成（每个用户的常量字符串加上变量部分的组合）。我不知道你为什么需要从资源中得到这个。

如果使用-org.springframework.core.io.ByteArray资源，则不需要此包装器。

Answer 3

因为您使用的是< code>ByteArrayResource，所以可以使用下面的控制器代码，假设< code>FooService在控制器类中是自动连接的。

@RequestMapping(path = "/download_excel", method = RequestMethod.GET)
public ResponseEntity<Resource> download(String fileName) throws IOException {

ByteArrayResource resource = fooService.export(fileName);

return ResponseEntity.ok()
        .headers(headers) // add headers if any
        .contentLength(resource.contentLength())
        .contentType(MediaType.parseMediaType("application/vnd.ms-excel"))
        .body(resource);
}