Mengunduh file dari pengontrol pegas

Saya memiliki persyaratan di mana saya perlu mengunduh PDF dari situs web. PDF perlu dibuat dalam kode, yang saya pikir akan menjadi kombinasi freemarker dan kerangka kerja generasi PDF seperti iText. Ada cara yang lebih baik?

Namun, masalah utama saya adalah bagaimana cara saya mengizinkan pengguna mengunduh file melalui 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");
    }

}

Secara umum, ketika sudah response.getOutputStream(), Anda dapat menulis apa pun di sana. Anda dapat melewatkan aliran output ini sebagai tempat untuk meletakkan PDF yang dihasilkan ke generator Anda. Juga, jika Anda tahu jenis file apa yang Anda kirim, Anda dapat mengatur

response.setContentType("application/pdf");

Saya dapat melakukan streaming garis ini dengan menggunakan dukungan bawaan di Spring dengan ResourceHttpMessageConverter itu. Ini akan mengatur panjang konten dan tipe konten jika dapat menentukan tipe mime

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

Anda harus dapat menulis file pada jawaban secara langsung. Sesuatu seperti

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

dan kemudian tulis file tersebut sebagai aliran biner response.getOutputStream(). Ingatlah untuk melakukan response.flush()di akhir dan itu harus dilakukan.

Dengan Spring 3.0 Anda dapat menggunakan HttpEntityobjek kembali. Jika Anda menggunakan ini, maka pengontrol Anda tidak memerlukan HttpServletResponseobjek, dan karenanya lebih mudah untuk diuji. Kecuali ini, jawaban ini relatif sama dengan jawaban Infeligo .

Jika nilai pengembalian kerangka pdf Anda adalah array byte (baca bagian kedua dari jawaban saya untuk nilai pengembalian lainnya) :

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

Jika jenis kembalinya PDF Anda Framework ( documentBbody) belum menjadi array byte (dan juga tidak ada ByteArrayInputStream) maka akan bijaksana tidak untuk membuat array byte pertama. Sebaliknya lebih baik menggunakan:

• InputStreamResource,
• PathResource (sejak Musim Semi 4.0) atau
• FileSystemResource,

contoh dengan 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);
}

Jika kamu:

• Tidak ingin memuat seluruh file ke dalam byte[] sebelum mengirim ke respons;
• Ingin / perlu mengirim / mengunduhnya via InputStream ;
• Ingin memiliki kontrol penuh dari Mime Type dan nama file yang dikirim;
• Memiliki @ControllerAdvicepengecualian lain untuk Anda (atau tidak).

Kode di bawah ini yang Anda butuhkan:

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

Tentang bagian panjang file : File#length()harus cukup baik dalam kasus umum, tapi saya pikir saya akan membuat pengamatan ini karena memang bisa lambat , dalam hal ini Anda harus menyimpannya sebelumnya (misalnya dalam DB). Kasing bisa lambat termasuk: jika file besar, khususnya jika file tersebut dalam sistem jarak jauh atau sesuatu yang lebih rumit seperti itu - database, mungkin.

InputStreamResource

Jika sumber daya Anda bukan file, misalnya Anda mengambil data dari DB, Anda harus menggunakan InputStreamResource. Contoh:

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

Kode ini berfungsi dengan baik untuk mengunduh file secara otomatis dari pengontrol pegas pada mengklik tautan di 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();
    }

}

Kode di bawah ini berfungsi untuk saya menghasilkan dan mengunduh file teks.

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

Apa yang dapat saya pikirkan dengan cepat adalah, menghasilkan pdf dan menyimpannya di webapp / unduhan / <RANDOM-FILENAME> .pdf dari kode dan mengirimkan pengalihan ke file ini menggunakan HttpServletRequest

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

atau jika Anda dapat mengonfigurasi resolver tampilan Anda seperti,

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

lalu kembali saja

return "RANDOM-FILENAME";

Solusi berikut ini cocok untuk saya

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

    }

sesuatu seperti di bawah ini

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

Anda dapat menampilkan PDF atau mengunduhnya contoh di sini

Jika itu membantu siapa pun. Anda dapat melakukan apa yang disarankan oleh Infeligo, tetapi cukup masukkan kode tambahan ini untuk unduhan paksa.

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

Ini bisa menjadi jawaban yang bermanfaat.

Apakah boleh mengekspor data sebagai format pdf di frontend?

Meluas ke ini, menambahkan disposisi konten sebagai lampiran (default) akan mengunduh file. Jika Anda ingin melihatnya, Anda harus mengaturnya agar sejajar.

Dalam kasus saya, saya membuat beberapa file berdasarkan permintaan, demikian juga url harus dihasilkan.

Bagi saya bekerja seperti itu:

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

Sangat penting adalah ketik mime producesdan juga bahwa, nama file tersebut adalah bagian dari tautan sehingga Anda harus menggunakannya @PathVariable.

Kode HTML terlihat seperti itu:

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

Di mana ${file_name}dihasilkan oleh Thymeleaf dalam controller dan yaitu: result_20200225.csv, sehingga seluruh url behing link adalah: example.com/aplication/dbreport/files/result_20200225.csv.

Setelah mengklik tautan, browser bertanya kepada saya apa yang harus saya lakukan dengan file - simpan atau buka.