Comment offrir le téléchargement d'un fichier à partir d'un JSF backing bean?

Introduction

Vous pouvez obtenir tout ce à travers ExternalContext. Dans JSF 1.x, vous pouvez obtenir le raw HttpServletResponse objet par ExternalContext#getResponse(). Dans JSF 2.x, vous pouvez utiliser le bouquet de nouveau délégué méthodes comme ExternalContext#getResponseOutputStream() sans avoir besoin de saisir de la HttpServletResponse sous le JSF hottes.

Sur la réponse, vous devez définir la Content-Type en-tête de sorte que le client sait que l'application à associer avec le fichier. Et, vous devez définir la Content-Length en-tête de sorte que le client peut calculer la progression du téléchargement, sinon il sera inconnu. Et, vous devez définir la Content-Disposition en-tête de attachment si vous voulez un Enregistrer sous dialogue, sinon le client va tenter de les afficher en ligne. Enfin, il suffit d'écrire le contenu du fichier pour la réponse flux de sortie.

Plus important, c'est d'appeler FacesContext#responseComplete() pour informer JSF qu'il ne devrait pas effectuer de navigation et le rendu après que vous avez écrit sur le fichier pour la réponse, sinon la fin de la réponse va être polluée par le contenu HTML de la page, ou dans les anciennes JSF versions, vous obtiendrez un IllegalStateException avec un message comme getoutputstream() has already been called for this response lorsque le JSF mise en œuvre des appels getWriter() rendu HTML.

Désactiver ajax /n'utilisez pas la commande à distance!

Vous avez seulement besoin de s'assurer que la méthode d'action est pas appelé par une requête ajax, mais qu'il est appelé par une requête normale comme vous le feu avec <h:commandLink> et <h:commandButton>. Les requêtes Ajax et des commandes à distance sont traitées par JavaScript qui à son tour a, pour des raisons de sécurité, pas d'installations pour forcer un Enregistrer sous dialogue avec le contenu de la réponse ajax.

Dans le cas où vous êtes en utilisant par exemple PrimeFaces <p:commandXxx>, alors vous devez vous assurer que vous avez explicitement désactiver ajax via ajax="false" attribut. Dans le cas où vous êtes à l'aide de ICEfaces, alors vous avez besoin d'imbriquer une <f:ajax disabled="true" /> dans la commande de composants.

Générique JSF 2.x exemple

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.
}

Générique JSF 1.x exemple

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.
}

Commune de fichier statique exemple

Dans le cas où vous avez besoin de flux d'un fichier statique à partir du disque local du système de fichiers, remplacer le code comme ci-dessous:

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);

Dynamique commune exemple de fichier

Dans le cas où vous avez besoin de flux généré dynamiquement, un fichier, au format PDF ou XLS, il suffit ensuite de fournir output là où l'API utilisée s'attend à une OutputStream.

E. g. 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();

E. g. 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();

Notez que vous ne pouvez pas définir la longueur du contenu ici. Si vous devez supprimer la ligne pour définir le contenu de la réponse de la longueur. Ce n'est techniquement pas de problème, le seul inconvénient est que l'utilisateur final sera présenté un inconnu de la progression du téléchargement. Dans le cas où c'est important, alors vous avez vraiment besoin d'écrire dans un local (temporaire) du premier fichier, et ensuite fournir comme indiqué dans le chapitre précédent.

Méthode utilitaire

Si vous êtes en utilisant JSF bibliothèque utilitaire OmniFaces, alors vous pouvez utiliser l'un des trois commode Visages#sendFile() méthodes de prendre soit un File, ou un InputStream, ou un byte[], et en précisant si le fichier doit être téléchargé sous forme de pièce jointe (true) ou en ligne (false).

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

Oui, ce code est complet est. Vous n'avez pas besoin d'invoquer responseComplete() et donc sur vous-même. De plus, cette méthode traite correctement avec IE-en-têtes spécifiques et UTF-8 dans les noms de fichiers. Vous pouvez trouver le code source ici.

C'est ce qui a fonctionné pour moi:

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();
}