Pobieranie pliku z kontrolerów wiosennych

Mam wymaganie, aby pobrać plik PDF ze strony internetowej. PDF musi zostać wygenerowany w kodzie, który, jak sądzę, będzie kombinacją freemarkera i frameworka generowania PDF, takiego jak iText. Czy jest lepszy sposób?

Jednak moim głównym problemem jest to, jak mogę pozwolić użytkownikowi na pobranie pliku za pomocą kontrolera 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");
    }

}

Mówiąc ogólnie, kiedy masz response.getOutputStream(), możesz tam napisać wszystko. Możesz przekazać ten strumień wyjściowy jako miejsce do umieszczenia wygenerowanego pliku PDF w generatorze. Ponadto, jeśli wiesz, jaki typ pliku wysyłasz, możesz ustawić

response.setContentType("application/pdf");

Byłem w stanie przesłać strumieniowo ten wiersz, używając wbudowanej obsługi wiosną z ResourceHttpMessageConverter. Spowoduje to ustawienie długości i typu zawartości, jeśli będzie w stanie określić typ MIME

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

Powinieneś być w stanie zapisać plik bezpośrednio w odpowiedzi. Coś jak

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

a następnie zapisz plik jako strumień binarny response.getOutputStream(). Pamiętaj, aby zrobić response.flush()na końcu i to powinno wystarczyć.

W Spring 3.0 możesz użyć HttpEntityobiektu zwracanego. Jeśli tego użyjesz, twój kontroler nie potrzebuje HttpServletResponseobiektu, dlatego łatwiej go przetestować. Poza tym, ta odpowiedź jest względna równa tej z Infeligo .

Jeśli zwracaną wartością twojego frameworka pdf jest tablica bajtów (przeczytaj drugą część mojej odpowiedzi dla innych zwracanych wartości) :

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

Jeśli typ zwracany przez Framework PDF ( documentBbody) nie jest już tablicą bajtów (a także nie ByteArrayInputStream), rozsądnie byłoby NIE uczynić go najpierw tablicą bajtów. Zamiast tego lepiej jest użyć:

• InputStreamResource,
• PathResource (od wiosny 4.0) lub
• FileSystemResource,

przykład z 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);
}

Jeśli ty:

• Nie chcę ładować całego pliku byte[]przed wysłaniem do odpowiedzi;
• Chcesz / muszę wysłać / pobrać za pośrednictwem InputStream;
• Chcesz mieć pełną kontrolę nad typem MIME i nazwą pliku;
• Miej @ControllerAdvicedla ciebie inne wyjątki związane z odbiorem (lub nie).

Poniższy kod jest tym, czego potrzebujesz:

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

O części dotyczącej długości pliku : File#length()powinno być wystarczająco dobre w ogólnym przypadku, ale pomyślałem, że dokonam tej obserwacji, ponieważ może być powolna , w którym to przypadku powinieneś ją wcześniej zapisać (np. W DB). Przypadki mogą być powolne obejmują: jeśli plik jest duży, szczególnie jeśli plik jest w systemie zdalnym lub coś bardziej skomplikowanego - może to być baza danych.

InputStreamResource

Jeśli Twój zasób nie jest plikiem, np. Pobierasz dane z bazy danych, powinieneś użyć InputStreamResource. Przykład:

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

Ten kod działa dobrze, aby automatycznie pobrać plik ze sterownika wiosennego po kliknięciu łącza w 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();
    }

}

Poniższy kod działał dla mnie w celu wygenerowania i pobrania pliku tekstowego.

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

To, co mogę szybko wymyślić, to wygenerować pdf i zapisać go w aplikacji internetowej / download / <RANDOM-FILENAME> .pdf z kodu i wysłać dalej do tego pliku za pomocą HttpServletRequest

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

lub jeśli możesz skonfigurować swój przelicznik widoków w taki sposób,

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

to po prostu wróć

return "RANDOM-FILENAME";

Poniższe rozwiązanie działa dla mnie

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

    }

coś jak poniżej

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

Możesz wyświetlić plik PDF lub pobrać przykłady tutaj

Jeśli to pomoże komukolwiek. Możesz zrobić to, co sugeruje zaakceptowana odpowiedź Infeligo, ale po prostu włóż ten dodatkowy fragment do kodu, aby wymusić pobranie.

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

To może być przydatna odpowiedź.

Czy można eksportować dane do formatu frontend w formacie pdf?

Rozszerzając to, dodanie dyspozycji treści jako załącznika (domyślnie) spowoduje pobranie pliku. Jeśli chcesz go zobaczyć, musisz ustawić go w linii.

W moim przypadku generuję jakiś plik na żądanie, więc trzeba też wygenerować adres URL.

Dla mnie działa coś takiego:

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

Bardzo ważny jest typ MIME, producesa także, że nazwa pliku jest częścią linku, więc musisz go użyć @PathVariable.

Kod HTML wygląda następująco:

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

Gdzie ${file_name}są generowane przez Thymeleaf w sterowniku i jest tzn result_20200225.csv, więc linkujące cały url behing jest: example.com/aplication/dbreport/files/result_20200225.csv.

Po kliknięciu w link przeglądarka pyta mnie, co zrobić z plikiem - zapisz lub otwórz.