Herunterladen einer Datei von Federreglern

Ich habe eine Anforderung, bei der ich ein PDF von der Website herunterladen muss. Das PDF muss innerhalb des Codes generiert werden, was meiner Meinung nach eine Kombination aus Freemarker und einem PDF-Generierungsframework wie iText wäre. Gibt es einen besseren Weg?

Mein Hauptproblem ist jedoch, wie ich dem Benutzer erlaube, eine Datei über einen Spring Controller herunterzuladen.

@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");
    }

}

Im Allgemeinen response.getOutputStream()können Sie dort alles schreiben , wenn Sie haben . Sie können diesen Ausgabestream als Speicherort für generierte PDF-Dateien an Ihren Generator übergeben. Wenn Sie wissen, welchen Dateityp Sie senden, können Sie auch festlegen

response.setContentType("application/pdf");

Ich konnte dies mithilfe der im Frühjahr integrierten Unterstützung mit dem ResourceHttpMessageConverter optimieren. Dadurch werden die Inhaltslänge und der Inhaltstyp festgelegt, wenn der MIME-Typ bestimmt werden kann

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

Sie sollten in der Lage sein, die Datei direkt in die Antwort zu schreiben. Etwas wie

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

und schreiben Sie die Datei dann als Binär-Stream auf response.getOutputStream(). Denken Sie daran, response.flush()am Ende zu tun, und das sollte es tun.

Mit Spring 3.0 können Sie das HttpEntityRückgabeobjekt verwenden. Wenn Sie dies verwenden, benötigt Ihr Controller kein HttpServletResponseObjekt und ist daher einfacher zu testen. Abgesehen davon ist diese Antwort relativ gleich der von Infeligo .

Wenn der Rückgabewert Ihres PDF-Frameworks ein Byte-Array ist (lesen Sie den zweiten Teil meiner Antwort für andere Rückgabewerte) :

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

Wenn der Rückgabetyp Ihres PDF Framework ( documentBbody) noch kein Byte-Array ist (und auch kein Nein ByteArrayInputStream), ist es ratsam , es NICHT zuerst zu einem Byte-Array zu machen. Stattdessen ist es besser zu verwenden:

• InputStreamResource,
• PathResource (seit Frühjahr 4.0) oder
• FileSystemResource,

Beispiel mit 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);
}

Wenn du:

• Sie möchten nicht die gesamte Datei in eine laden, byte[]bevor Sie sie an die Antwort senden.
• Möchten / müssen Sie es senden / herunterladen über InputStream;
• Möchten Sie die volle Kontrolle über den Mime-Typ und den gesendeten Dateinamen haben?
• Haben Sie andere @ControllerAdviceAusnahmen für Sie (oder nicht).

Der folgende Code ist genau das, was Sie brauchen:

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

Über den Teil mit der Dateilänge : File#length()sollte im allgemeinen Fall gut genug sein, aber ich dachte, ich würde diese Beobachtung machen, weil es langsam sein kann. In diesem Fall sollten Sie es vorher gespeichert haben (z. B. in der Datenbank). Zu den Fällen, in denen es langsam sein kann, gehören: Wenn die Datei groß ist, insbesondere wenn sich die Datei in einem Remote-System befindet oder etwas Ähnlicheres - vielleicht eine Datenbank.

InputStreamResource

Wenn Ihre Ressource keine Datei ist, z. B. wenn Sie die Daten aus der Datenbank abrufen, sollten Sie sie verwenden InputStreamResource. Beispiel:

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

Dieser Code funktioniert einwandfrei, um eine Datei automatisch von Spring Controller herunterzuladen, wenn Sie auf einen Link auf jsp klicken.

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

}

Der folgende Code hat für mich funktioniert, um eine Textdatei zu generieren und herunterzuladen.

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

Was mir schnell einfällt, ist, das PDF zu generieren und es in webapp / downloads / <RANDOM-FILENAME> .pdf aus dem Code zu speichern und mit HttpServletRequest eine Weiterleitung an diese Datei zu senden

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

oder wenn Sie Ihren View Resolver so konfigurieren können,

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

dann kehre einfach zurück

return "RANDOM-FILENAME";

Die folgende Lösung funktioniert für mich

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

    }

so etwas wie unten

@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");
    }
}

Sie können PDF - Anzeige oder es Beispiele Download hier

Wenn es jemandem hilft. Sie können das tun, was die akzeptierte Antwort von Infeligo vorgeschlagen hat, aber dieses zusätzliche Bit einfach in den Code für einen erzwungenen Download einfügen.

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

Dies kann eine nützliche Antwort sein.

Ist es in Ordnung, Daten im Frontend als PDF-Format zu exportieren?

Wenn Sie die Inhaltsdisposition als Anhang hinzufügen (Standard), wird die Datei heruntergeladen. Wenn Sie es anzeigen möchten, müssen Sie es auf Inline setzen.

In meinem Fall generiere ich eine Datei bei Bedarf, daher muss auch eine URL generiert werden.

Bei mir funktioniert so etwas:

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

Sehr wichtig ist die Eingabe von MIME producesund auch, dass dieser Name der Datei Teil des Links ist, den Sie verwenden müssen @PathVariable.

HTML-Code sieht so aus:

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

Wo ${file_name}wird von Thymeleaf im Controller generiert und ist dh: result_20200225.csv, so dass der gesamte URL-Behing-Link lautet : example.com/aplication/dbreport/files/result_20200225.csv.

Nach dem Klicken auf den Link fragt mich der Browser, was ich mit der Datei machen soll - speichern oder öffnen.