Fazendo download de um arquivo dos controladores de mola

Tenho um requisito no qual preciso fazer o download de um PDF no site. O PDF precisa ser gerado dentro do código, que eu pensei que seria uma combinação de freemarker e uma estrutura de geração de PDF como o iText. Alguma maneira melhor?

No entanto, meu principal problema é como permito que o usuário baixe um arquivo através de um Spring Controller?

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

}

De um modo geral, quando você tem response.getOutputStream(), pode escrever qualquer coisa lá. Você pode transmitir esse fluxo de saída como um local para colocar o PDF gerado no seu gerador. Além disso, se você souber que tipo de arquivo está enviando, poderá definir

response.setContentType("application/pdf");

Consegui transmitir isso usando o suporte interno do Spring com o ResourceHttpMessageConverter. Isso definirá o comprimento e o tipo de conteúdo, se puder determinar o tipo mime

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

Você deve poder escrever o arquivo diretamente na resposta. Algo como

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

e depois grave o arquivo como um fluxo binário response.getOutputStream(). Lembre-se de fazer response.flush()no final e isso deve ser feito.

Com o Spring 3.0, você pode usar o HttpEntityobjeto de retorno. Se você usar isso, seu controlador não precisará de um HttpServletResponseobjeto e, portanto, é mais fácil testar. Exceto isso, essa resposta é relativa igual à do infeligo .

Se o valor de retorno da sua estrutura pdf for uma matriz de bytes (leia a segunda parte da minha resposta para outros valores de retorno) :

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

Se o tipo de retorno do seu PDF Framework ( documentBbody) ainda não for uma matriz de bytes (e também não ByteArrayInputStream), seria sensato NÃO torná-la uma matriz de bytes primeiro. Em vez disso, é melhor usar:

• InputStreamResource,
• PathResource (desde a Primavera 4.0) ou
• FileSystemResource,

exemplo com 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);
}

Se vocês:

• Não deseja carregar o arquivo inteiro em um arquivo byte[]antes de enviá-lo para a resposta;
• Deseja / precisa enviar / fazer o download via InputStream;
• Deseja ter controle total do tipo MIME e do nome do arquivo enviado;
• Tenha outras @ControllerAdviceexceções para você (ou não).

O código abaixo é o que você precisa:

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

Sobre a parte do tamanho do arquivo : File#length()deve ser boa o suficiente no caso geral, mas pensei em fazer essa observação porque ela pode ser lenta ; nesse caso, você deve armazená-la anteriormente (por exemplo, no DB). Os casos em que pode ser lento incluem: se o arquivo é grande, especialmente se o arquivo estiver em um sistema remoto ou algo mais elaborado como esse - um banco de dados, talvez.

InputStreamResource

Se o seu recurso não for um arquivo, por exemplo, você coleta os dados do banco de dados, você deve usá-lo InputStreamResource. Exemplo:

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

Este código está funcionando bem para baixar um arquivo automaticamente do spring controller clicando em um link no 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();
    }

}

O código abaixo funcionou para gerar e baixar um arquivo de texto.

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

O que consigo pensar rapidamente é: gerar o pdf e armazená-lo em webapp / downloads / <RANDOM-FILENAME> .pdf a partir do código e enviar um encaminhamento para este arquivo usando HttpServletRequest

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

ou se você pode configurar seu resolvedor de visualizações como,

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

então é só voltar

return "RANDOM-FILENAME";

A seguinte solução funciona para mim

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

    }

algo como abaixo

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

Você pode exibir PDF ou fazer o download de exemplos aqui

Se isso ajuda alguém. Você pode fazer o que a resposta aceita pelo Infeligo sugeriu, mas basta colocar esse bit extra no código para um download forçado.

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

Esta pode ser uma resposta útil.

É possível exportar dados como formato pdf no frontend?

Estendendo a isso, adicionar a disposição do conteúdo como um anexo (padrão) fará o download do arquivo. Se você quiser visualizá-lo, precisará configurá-lo para embutido.

No meu caso, estou gerando algum arquivo sob demanda, portanto também é necessário gerar um URL.

Para mim, funciona algo assim:

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

Muito importante é o tipo MIME producese, além disso, esse nome do arquivo faz parte do link, portanto você deve usar @PathVariable.

O código HTML é assim:

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

Onde ${file_name}é gerado por Thymeleaf no controlador e é isto: result_20200225.csv, de modo que apontam toda url behing é: example.com/aplication/dbreport/files/result_20200225.csv.

Depois de clicar no link, o navegador me pergunta o que fazer com o arquivo - salve ou abra.