Как обеспечить загрузку файла из JSF backing bean?

введение

вы можете получить все через ExternalContext. В JSF 1.x, вы можете получить raw . В случае, если вы используете ICEfaces, то вам нужно вложить a <f:ajax disabled="true" /> в командной деталь.

Generic JSF 2.пример х

public void download() throws IOException {
    FacesContext fc = FacesContext.getCurrentInstance();
    ExternalContext ec = fc.getExternalContext();

    ec.responseReset(); // Some JSF 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.
    ec.setResponseContentType(contentType); // Check http://www.iana.org/assignments/media-types for all types. Use if necessary ExternalContext#getMimeType() for auto-detection based on filename.
    ec.setResponseContentLength(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.
    ec.setResponseHeader("Content-Disposition", "attachment; filename=\"" + fileName + "\""); // The Save As popup magic is done here. You can give it any file name you want, this only won't work in MSIE, it will use current request URL as file name instead.

    OutputStream output = ec.getResponseOutputStream();
    // Now you can write the InputStream of the file to the above OutputStream the usual way.
    // ...

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

Generic JSF 1.пример х

public void download() throws IOException {
    FacesContext fc = FacesContext.getCurrentInstance();
    HttpServletResponse response = (HttpServletResponse) fc.getExternalContext().getResponse();

    response.reset(); // Some JSF 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.
    response.setContentType(contentType); // Check http://www.iana.org/assignments/media-types for all types. Use if necessary ServletContext#getMimeType() for auto-detection based on filename.
    response.setContentLength(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.
    response.setHeader("Content-Disposition", "attachment; filename=\"" + fileName + "\""); // The Save As popup magic is done here. You can give it any file name you want, this only won't work in MSIE, it will use current request URL as file name instead.

    OutputStream output = response.getOutputStream();
    // Now you can write the InputStream of the file to the above OutputStream the usual way.
    // ...

    fc.responseComplete(); // Important! Otherwise JSF 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 = ec.getMimeType(fileName); // JSF 1.x: ((ServletContext) ec.getContext()).getMimeType(fileName);
int contentLength = (int) file.length();

// ...

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

общий пример динамического файла

если вам нужно передать динамически сгенерированный файл, например PDF или XLS, то просто предоставьте output там, где API находится используется ожидает OutputStream.

например, 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();

обратите внимание, что вы не можете установить длину содержимого здесь. Поэтому вам нужно удалить строку, чтобы установить длину содержимого ответа. Это технически не проблема, единственным недостатком является то, что конечному пользователю будет представлен неизвестный прогресс загрузки. В случае, если это важно, то вам действительно нужно сначала написать в локальный (временный) файл, а затем предоставить его, как показано на рисунке в предыдущих главах.

служебный метод

если вы используете служебную библиотеку JSF OmniFaces, то вы можете использовать один из трех удобных Faces#sendFile() методы, принимающие либо a File или InputStream или byte[], и указание, следует ли загружать файл в виде вложения (true) или inline (false).

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

Да, этот код является полным как есть. Вам не нужно вызывать responseComplete() и так далее себе. Этот метод также правильно работает с заголовками IE-specific и именами файлов UTF-8. Вы можете найти здесь исходный код.