如何从 JSF 支持 bean 提供文件下载？

Question

有什么方法可以从 JSF 支持 bean 操作方法提供文件下载吗？ 我已经尝试了很多事情。主要问题是我无法弄清楚如何获取响应的 OutputStream 以便写入文件内容。我知道如何使用 Servlet 来完成此操作，但这不能从 JSF 表单调用，并且需要新的请求。

如何从当前 FacesContext 获取响应的 OutputStream？

Answer 1

简介

你可以通过 ExternalContext 获取所有内容。有一堆 getResponseXxx() 和 setResponseXxx() 方法委托给在幕后使用的 HttpServletResponse。

在响应中，您应该设置 Content-Type 标头，以便客户端知道哪个应用程序与提供的文件关联。并且，您应该设置 Content-Length 标头，以便客户端可以计算下载进度，否则将未知。而且，如果您想要“另存为”对话框，则应将 Content-Disposition 标头设置为 attachment，否则客户端将尝试内联显示它。最后只需将文件内容写入响应输出流即可。

最重要的部分是调用 FacesContext #responseComplete() 通知 Jakarta Faces 在将文件写入响应后不应执行导航和渲染，否则结束响应将被页面的 HTML 内容污染，或者在较旧的 Faces 版本中，您将收到 IllegalStateException ，其中包含类似 getoutputstream() 已为此响应调用 的消息> 当 Faces 实现调用 getWriter() 来呈现 HTML 时。

关闭阿贾克斯！

您只需确保操作方法不是由 ajax 请求调用，而是在您使用 和 。由 / 触发的 Ajax 请求由 JavaScript 处理，而出于安全原因，默认情况下没有任何设施可以处理 Ajax 请求。强制与 ajax 响应内容进行另存为对话。

如果您使用的是 PrimeFaces ，那么您需要确保通过 ajax="false" 属性显式关闭 ajax。 也不能使用。如果您使用 ICEfaces，则需要在命令组件中嵌套 。

如果您使用的是 PrimeFaces 10 或更高版本，则可以使用 在下载文件时使用 onstart、<代码>更新，<代码>oncomplete等等。

通用操作方法示例

<h:commandButton value="Download" action="#{bean.download}" />

public void download() throws IOException {
    String fileName = ...;
    String contentType = ...;
    long contentLength = ...;

    FacesContext facesContext = FacesContext.getCurrentInstance();
    ExternalContext externalContext = facesContext.getExternalContext();

    externalContext.responseReset(); // Some Faces component library or some Filter might have set some headers in the buffer beforehand. We want to get rid of them, else it may collide.
    externalContext.setResponseContentType(contentType); // Check https://www.iana.org/assignments/media-types for all types.
    externalContext.setResponseContentLengthLong(contentLength); // Set it with the file size. This header is optional. It will work if it's omitted, but the download progress will be unknown.
    externalContext.setResponseHeader("Content-Disposition", "attachment; filename=\"" + fileName + "\""); // The Save As popup magic is done here. You can give it any file name you want.

    OutputStream output = externalContext.getResponseOutputStream();

    // Now you can write the InputStream of the file to the above OutputStream the usual way.
    // ...

    facesContext.responseComplete(); // Important! Otherwise Faces will attempt to render the response which obviously will fail since it's already written with a file and closed.
}

常见静态文件示例

如果您需要从本地磁盘文件系统流式传输静态文件，请替换如下代码：

    File file = new File("/path/to/file.ext");
    String fileName = file.getName();
    String contentType = externalContext.getMimeType(fileName);
    long contentLength = file.length();

    // ...

    Files.copy(file.toPath(), output);

常见动态文件示例

如果您需要流式传输动态生成的文件，例如 PDF 或 XLS ，然后只需在所使用的 API 需要 OutputStream 的地方提供 output 即可。

例如 iText PDF：

    String fileName = "dynamic.pdf";
    String contentType = "application/pdf";

    // ...

    Document document = new Document();
    PdfWriter writer = PdfWriter.getInstance(document, output);
    document.open();
    // Build PDF content here.
    document.close();

例如 Apache POI HSSF：

    String fileName = "dynamic.xls";
    String contentType = "application/vnd.ms-excel";

    // ...

    HSSFWorkbook workbook = new HSSFWorkbook();
    // Build XLS content here.
    workbook.write(output);
    workbook.close();

请注意，您不能在此处设置内容长度。因此，您需要删除设置响应内容长度的行。这在技术上没有问题，唯一的缺点是最终用户将看到未知的下载进度。如果这很重要，那么您确实需要先写入本地（临时）文件，然后按照上一章所示提供它。

实用方法

如果您使用 Faces 实用程序库 OmniFaces，那么您可以使用三个方便的 Faces#sendFile() 方法采用 Path、File、InputStream 或 byte[]，并指定文件应作为附件下载 (true) 还是内联下载 (false)。

public void download() throws IOException {
    Faces.sendFile(path, true);
}

是的，这段代码是完整的。您不需要自己调用 responseComplete() 等。此方法还可以正确处理 IE 特定的标头和 UTF-8 文件名。您可以找到 源代码在这里。

Answer 2

public void download() throws IOException
{

    File file = new File("file.txt");

    FacesContext facesContext = FacesContext.getCurrentInstance();

    HttpServletResponse response = 
            (HttpServletResponse) facesContext.getExternalContext().getResponse();

    response.reset();
    response.setHeader("Content-Type", "application/octet-stream");
    response.setHeader("Content-Disposition", "attachment;filename=file.txt");

    OutputStream responseOutputStream = response.getOutputStream();

    InputStream fileInputStream = new FileInputStream(file);

    byte[] bytesBuffer = new byte[2048];
    int bytesRead;
    while ((bytesRead = fileInputStream.read(bytesBuffer)) > 0) 
    {
        responseOutputStream.write(bytesBuffer, 0, bytesRead);
    }

    responseOutputStream.flush();

    fileInputStream.close();
    responseOutputStream.close();

    facesContext.responseComplete();

}

Answer 3

这对我有用：

public void downloadFile(String filename) throws IOException {
    final FacesContext fc = FacesContext.getCurrentInstance();
    final ExternalContext externalContext = fc.getExternalContext();

    final File file = new File(filename);

    externalContext.responseReset();
    externalContext.setResponseContentType(ContentType.APPLICATION_OCTET_STREAM.getMimeType());
    externalContext.setResponseContentLength(Long.valueOf(file.lastModified()).intValue());
    externalContext.setResponseHeader("Content-Disposition", "attachment;filename=" + file.getName());

    final HttpServletResponse response = (HttpServletResponse) externalContext.getResponse();

    FileInputStream input = new FileInputStream(file);
    byte[] buffer = new byte[1024];
    final ServletOutputStream out = response.getOutputStream();

    while ((input.read(buffer)) != -1) {
        out.write(buffer);
    }

    out.flush();
    fc.responseComplete();
}

Answer 4

这是我的解决方案，BalusC 的答案的扩展

public static void download(
   ByteArrayOutputStream baos, 
   String downloadFileName, 
   String contentType
) {
    FacesContext context = FacesContext.getCurrentInstance();
    ExternalContext externalContext = context.getExternalContext();
    externalContext.responseReset();
    HttpServletResponse response = (HttpServletResponse) externalContext.getResponse();
    response.reset();
    response.setContentType(contentType);
    response.setHeader("Expires", "0");
    response.setHeader("Cache-Control", "must-revalidate, post-check=0, pre-check=0");
    response.setHeader("Pragma", "public");
    Integer size = baos.size();
    response.setHeader("Content-Length", size.toString());

    response.setHeader(
       "Content-Disposition", 
       "attachment; filename=\"" + downloadFileName + "\""
    );

    try {
       try (OutputStream responseOs = response.getOutputStream()) {
           baos.writeTo(responseOs);
       }
    }
    catch (IOException e) {
       throw new IOUncheckedException(e);
    }

    context.responseComplete();
}

Answer 5

这是完整的代码片段http://bharatonjava。 wordpress.com/2013/02/01/downloading-file-in-jsf-2/

 @ManagedBean(name = "formBean")
 @SessionScoped
 public class FormBean implements Serializable
 {
   private static final long serialVersionUID = 1L;

   /**
    * Download file.
    */
   public void downloadFile() throws IOException
   {
      File file = new File("C:\\docs\\instructions.txt");
      InputStream fis = new FileInputStream(file);
      byte[] buf = new byte[1024];
      int offset = 0;
      int numRead = 0;
      while ((offset < buf.length) && ((numRead = fis.read(buf, offset, buf.length -offset)) >= 0)) 
      {
        offset += numRead;
      }
      fis.close();
      HttpServletResponse response =
         (HttpServletResponse) FacesContext.getCurrentInstance()
        .getExternalContext().getResponse();

     response.setContentType("application/octet-stream");
     response.setHeader("Content-Disposition", "attachment;filename=instructions.txt");
     response.getOutputStream().write(buf);
     response.getOutputStream().flush();
     response.getOutputStream().close();
     FacesContext.getCurrentInstance().responseComplete();
   }
 }

如果您希望在运行时生成文件，您可以更改文件读取逻辑。