Téléchargement d'un fichier à partir des contrôleurs Spring

J'ai une exigence où je dois télécharger un PDF à partir du site Web. Le PDF doit être généré dans le code, ce que je pensais être une combinaison de freemarker et d'un cadre de génération de PDF comme iText. Une meilleure façon?

Cependant, mon principal problème est de savoir comment autoriser l'utilisateur à télécharger un fichier via un contrôleur Spring?

@RequestMapping(value = "/files/{file_name}", method = RequestMethod.GET)
public void getFile(
    @PathVariable("file_name") String fileName, 
    HttpServletResponse response) {
    try {
      // get your file as InputStream
      InputStream is = ...;
      // copy it to response's OutputStream
      org.apache.commons.io.IOUtils.copy(is, response.getOutputStream());
      response.flushBuffer();
    } catch (IOException ex) {
      log.info("Error writing file to output stream. Filename was '{}'", fileName, ex);
      throw new RuntimeException("IOError writing file to output stream");
    }

}

D'une manière générale, quand vous l'avez response.getOutputStream(), vous pouvez y écrire n'importe quoi. Vous pouvez passer ce flux de sortie comme un endroit pour mettre le PDF généré sur votre générateur. De plus, si vous savez quel type de fichier vous envoyez, vous pouvez définir

response.setContentType("application/pdf");

J'ai pu diffuser cette ligne en utilisant le support intégré de Spring avec son ResourceHttpMessageConverter. Cela définira la longueur et le type de contenu s'il peut déterminer le type MIME

@RequestMapping(value = "/files/{file_name}", method = RequestMethod.GET)
@ResponseBody
public FileSystemResource getFile(@PathVariable("file_name") String fileName) {
    return new FileSystemResource(myService.getFileFor(fileName)); 
}

Vous devriez pouvoir écrire le fichier directement sur la réponse. Quelque chose comme

response.setContentType("application/pdf");      
response.setHeader("Content-Disposition", "attachment; filename=\"somefile.pdf\""); 

puis écrivez le fichier sous forme de flux binaire response.getOutputStream(). N'oubliez pas de faire response.flush()à la fin et cela devrait le faire.

Avec Spring 3.0, vous pouvez utiliser l' HttpEntityobjet de retour. Si vous l'utilisez, votre contrôleur n'a pas besoin d'un HttpServletResponseobjet et il est donc plus facile à tester. Sauf ceci, cette réponse est relative égale à celle d'Infeligo .

Si la valeur de retour de votre framework pdf est un tableau d'octets (lisez la deuxième partie de ma réponse pour d'autres valeurs de retour) :

@RequestMapping(value = "/files/{fileName}", method = RequestMethod.GET)
public HttpEntity<byte[]> createPdf(
                 @PathVariable("fileName") String fileName) throws IOException {

    byte[] documentBody = this.pdfFramework.createPdf(filename);

    HttpHeaders header = new HttpHeaders();
    header.setContentType(MediaType.APPLICATION_PDF);
    header.set(HttpHeaders.CONTENT_DISPOSITION,
                   "attachment; filename=" + fileName.replace(" ", "_"));
    header.setContentLength(documentBody.length);

    return new HttpEntity<byte[]>(documentBody, header);
}

Si le type de retour de votre PDF Framework ( documentBbody) n'est pas déjà un tableau d'octets (et également non ByteArrayInputStream), il serait sage de NE PAS en faire un tableau d'octets en premier. Au lieu de cela, il vaut mieux utiliser:

• InputStreamResource,
• PathResource (depuis le printemps 4.0) ou
• FileSystemResource,

exemple avec FileSystemResource:

@RequestMapping(value = "/files/{fileName}", method = RequestMethod.GET)
public HttpEntity<byte[]> createPdf(
                 @PathVariable("fileName") String fileName) throws IOException {

    File document = this.pdfFramework.createPdf(filename);

    HttpHeaders header = new HttpHeaders();
    header.setContentType(MediaType.APPLICATION_PDF);
    header.set(HttpHeaders.CONTENT_DISPOSITION,
                   "attachment; filename=" + fileName.replace(" ", "_"));
    header.setContentLength(document.length());

    return new HttpEntity<byte[]>(new FileSystemResource(document),
                                  header);
}

Si vous:

• Je ne veux pas charger le fichier entier dans un byte[]avant de l'envoyer à la réponse;
• Vous voulez / devez l'envoyer / le télécharger via InputStream;
• Vous voulez avoir un contrôle total sur le type MIME et le nom du fichier envoyé;
• Ayez d'autres @ControllerAdviceexceptions pour vous (ou non).

Le code ci-dessous est ce dont vous avez besoin:

@RequestMapping(value = "/stuff/{stuffId}", method = RequestMethod.GET)
public ResponseEntity<FileSystemResource> downloadStuff(@PathVariable int stuffId)
                                                                      throws IOException {
    String fullPath = stuffService.figureOutFileNameFor(stuffId);
    File file = new File(fullPath);
    long fileLength = file.length(); // this is ok, but see note below

    HttpHeaders respHeaders = new HttpHeaders();
    respHeaders.setContentType("application/pdf");
    respHeaders.setContentLength(fileLength);
    respHeaders.setContentDispositionFormData("attachment", "fileNameIwant.pdf");

    return new ResponseEntity<FileSystemResource>(
        new FileSystemResource(file), respHeaders, HttpStatus.OK
    );
}

À propos de la partie de la longueur du fichier : File#length()devrait être assez bonne dans le cas général, mais j'ai pensé que je ferais cette observation car elle peut être lente , auquel cas vous devriez l'avoir stockée précédemment (par exemple dans la base de données). Les cas peuvent être lents: si le fichier est volumineux, spécialement si le fichier est dans un système distant ou quelque chose de plus élaboré comme ça - une base de données, peut-être.

InputStreamResource

Si votre ressource n'est pas un fichier, par exemple si vous récupérez les données de la base de données, vous devez utiliser InputStreamResource. Exemple:

    InputStreamResource isr = new InputStreamResource(new FileInputStream(file));
    return new ResponseEntity<InputStreamResource>(isr, respHeaders, HttpStatus.OK);

Ce code fonctionne très bien pour télécharger un fichier automatiquement à partir du contrôleur de printemps en cliquant sur un lien sur jsp.

@RequestMapping(value="/downloadLogFile")
public void getLogFile(HttpSession session,HttpServletResponse response) throws Exception {
    try {
        String filePathToBeServed = //complete file name with path;
        File fileToDownload = new File(filePathToBeServed);
        InputStream inputStream = new FileInputStream(fileToDownload);
        response.setContentType("application/force-download");
        response.setHeader("Content-Disposition", "attachment; filename="+fileName+".txt"); 
        IOUtils.copy(inputStream, response.getOutputStream());
        response.flushBuffer();
        inputStream.close();
    } catch (Exception e){
        LOGGER.debug("Request could not be completed at this moment. Please try again.");
        e.printStackTrace();
    }

}

Le code ci-dessous a fonctionné pour moi pour générer et télécharger un fichier texte.

@RequestMapping(value = "/download", method = RequestMethod.GET)
public ResponseEntity<byte[]> getDownloadData() throws Exception {

    String regData = "Lorem Ipsum is simply dummy text of the printing and typesetting industry. Lorem Ipsum has been the industry's standard dummy text ever since the 1500s, when an unknown printer took a galley of type and scrambled it to make a type specimen book. It has survived not only five centuries, but also the leap into electronic typesetting, remaining essentially unchanged. It was popularised in the 1960s with the release of Letraset sheets containing Lorem Ipsum passages, and more recently with desktop publishing software like Aldus PageMaker including versions of Lorem Ipsum.";
    byte[] output = regData.getBytes();

    HttpHeaders responseHeaders = new HttpHeaders();
    responseHeaders.set("charset", "utf-8");
    responseHeaders.setContentType(MediaType.valueOf("text/html"));
    responseHeaders.setContentLength(output.length);
    responseHeaders.set("Content-disposition", "attachment; filename=filename.txt");

    return new ResponseEntity<byte[]>(output, responseHeaders, HttpStatus.OK);
}

Ce à quoi je peux penser rapidement, c'est de générer le pdf et de le stocker dans webapp / Downloads / <RANDOM-FILENAME> .pdf à partir du code et d'envoyer un transfert vers ce fichier en utilisant HttpServletRequest

request.getRequestDispatcher("/downloads/<RANDOM-FILENAME>.pdf").forward(request, response);

ou si vous pouvez configurer votre résolveur de vue quelque chose comme,

  <bean id="pdfViewResolver"
        class="org.springframework.web.servlet.view.InternalResourceViewResolver">
    <property name="viewClass"
              value="org.springframework.web.servlet.view.JstlView" />
    <property name="order" value=”2″/>
    <property name="prefix" value="/downloads/" />
    <property name="suffix" value=".pdf" />
  </bean>

puis reviens

return "RANDOM-FILENAME";

La solution suivante fonctionne pour moi

    @RequestMapping(value="/download")
    public void getLogFile(HttpSession session,HttpServletResponse response) throws Exception {
        try {

            String fileName="archivo demo.pdf";
            String filePathToBeServed = "C:\\software\\Tomcat 7.0\\tmpFiles\\";
            File fileToDownload = new File(filePathToBeServed+fileName);

            InputStream inputStream = new FileInputStream(fileToDownload);
            response.setContentType("application/force-download");
            response.setHeader("Content-Disposition", "attachment; filename="+fileName); 
            IOUtils.copy(inputStream, response.getOutputStream());
            response.flushBuffer();
            inputStream.close();
        } catch (Exception exception){
            System.out.println(exception.getMessage());
        }

    }

quelque chose comme ci-dessous

@RequestMapping(value = "/download", method = RequestMethod.GET)
public void getFile(HttpServletResponse response) {
    try {
        DefaultResourceLoader loader = new DefaultResourceLoader();
        InputStream is = loader.getResource("classpath:META-INF/resources/Accepted.pdf").getInputStream();
        IOUtils.copy(is, response.getOutputStream());
        response.setHeader("Content-Disposition", "attachment; filename=Accepted.pdf");
        response.flushBuffer();
    } catch (IOException ex) {
        throw new RuntimeException("IOError writing file to output stream");
    }
}

Vous pouvez afficher le PDF ou télécharger des exemples ici

Si cela aide quelqu'un. Vous pouvez faire ce que la réponse acceptée par Infeligo a suggéré mais il suffit de mettre ce bit supplémentaire dans le code pour un téléchargement forcé.

response.setContentType("application/force-download");

Cela peut être une réponse utile.

Est-il possible d'exporter des données au format pdf en frontend?

S'étendant à cela, l'ajout de disposition de contenu en tant que pièce jointe (par défaut) téléchargera le fichier. Si vous voulez le voir, vous devez le mettre en ligne.

Dans mon cas, je génère un fichier à la demande, il faut donc également générer une URL.

Pour moi, ça fonctionne comme ça:

@RequestMapping(value = "/files/{filename:.+}", method = RequestMethod.GET, produces = "text/csv")
@ResponseBody
public FileSystemResource getFile(@PathVariable String filename) {
    String path = dataProvider.getFullPath(filename);
    return new FileSystemResource(new File(path));
}

Très important est le type mime produceset aussi, ce nom du fichier fait partie du lien, vous devez donc l'utiliser @PathVariable.

Le code HTML ressemble à ça:

<a th:href="@{|/dbreport/files/${file_name}|}">Download</a>

Où ${file_name}est généré par Thymeleaf dans le contrôleur et c'est-à-dire: result_20200225.csv, de sorte que le lien entier derrière l'URL est:example.com/aplication/dbreport/files/result_20200225.csv .

Après avoir cliqué sur le navigateur de lien me demande quoi faire avec le fichier - enregistrer ou ouvrir.