การดาวน์โหลดไฟล์จากสปริงคอนโทรลเลอร์

ฉันมีข้อกำหนดที่ฉันต้องการดาวน์โหลด PDF จากเว็บไซต์ จำเป็นต้องสร้าง PDF ภายในโค้ดซึ่งฉันคิดว่าจะเป็นการรวมกันของ freemarker และกรอบการสร้าง PDF เช่น iText มีวิธีไหนที่ดีกว่านี้?

อย่างไรก็ตามปัญหาหลักของฉันคือฉันจะอนุญาตให้ผู้ใช้ดาวน์โหลดไฟล์ผ่าน 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");
    }

}

โดยทั่วไปเมื่อคุณมีresponse.getOutputStream()คุณสามารถเขียนอะไรก็ได้ คุณสามารถส่งกระแสข้อมูลขาออกนี้เป็นที่สำหรับวาง PDF ที่สร้างไปยังเครื่องกำเนิดของคุณ นอกจากนี้หากคุณรู้ว่าคุณกำลังส่งไฟล์ประเภทใดคุณสามารถตั้งค่าได้

response.setContentType("application/pdf");

ฉันสามารถสตรีมรายการนี้โดยใช้การสนับสนุนในตัวใน Spring ด้วย ResourceHttpMessageConverter สิ่งนี้จะตั้งค่าความยาวเนื้อหาและประเภทเนื้อหาหากสามารถระบุประเภท mime ได้

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

คุณควรจะสามารถเขียนไฟล์ลงบนการตอบกลับได้โดยตรง สิ่งที่ต้องการ

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

response.getOutputStream()แล้วเขียนไฟล์เป็นกระแสไบนารี จำไว้ว่าให้ทำresponse.flush()ตอนท้ายและควรทำ

ด้วย Spring 3.0 คุณสามารถใช้HttpEntityวัตถุส่งคืน หากคุณใช้สิ่งนี้คอนโทรลเลอร์ของคุณไม่จำเป็นต้องมีHttpServletResponseวัตถุดังนั้นจึงง่ายต่อการทดสอบ ยกเว้นนี้คำตอบนี้คือเท่ากับเมื่อเทียบกับหนึ่ง Infeligo

หากค่าส่งคืนของเฟรมเวิร์ก pdf ของคุณเป็นอาร์เรย์ไบต์(อ่านส่วนที่สองของคำตอบของฉันสำหรับค่าส่งคืนอื่น ๆ ) :

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

หากประเภทคืนของ PDF Framework ของคุณ ( documentBbody) ไม่ใช่อาร์เรย์ไบต์ (และไม่ใช่ByteArrayInputStream) ก็จะเป็นการดีที่จะไม่ทำให้เป็นอาร์เรย์ไบต์ก่อน แทนที่จะเป็นการดีกว่าที่จะใช้:

• InputStreamResource,
• PathResource (ตั้งแต่สปริง 4.0) หรือ
• FileSystemResource,

ตัวอย่างด้วย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);
}

ถ้าคุณ:

• ไม่ต้องการโหลดไฟล์ทั้งหมดลงใน a byte[]ก่อนส่งไปยังการตอบกลับ
• ต้องการ / จำเป็นต้องส่ง / ดาวน์โหลดผ่านInputStream;
• ต้องการควบคุมแบบเต็มของประเภท Mime และส่งชื่อไฟล์;
• มี@ControllerAdviceข้อยกเว้นอื่น ๆสำหรับคุณ (หรือไม่)

รหัสด้านล่างคือสิ่งที่คุณต้องการ:

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

เกี่ยวกับส่วนความยาวของไฟล์ : File#length()ควรจะดีพอในกรณีทั่วไป แต่ฉันคิดว่าฉันจะทำการสังเกตนี้เพราะมันอาจจะช้าซึ่งในกรณีนี้คุณควรเก็บมันไว้ก่อนหน้านี้ (เช่นใน DB) ในบางกรณีอาจรวมถึงช้า: หากไฟล์มีขนาดใหญ่โดยเฉพาะอย่างยิ่งหากไฟล์อยู่ในระบบระยะไกลหรือมีเนื้อหาเพิ่มเติมเช่นนั้น - ฐานข้อมูลอาจเป็นไปได้ว่า

InputStreamResource

หากทรัพยากรของคุณไม่ได้เป็นไฟล์เช่นคุณสามารถเลือกข้อมูลขึ้นมาจาก DB InputStreamResourceคุณควรใช้ ตัวอย่าง:

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

รหัสนี้ใช้งานได้ดีเพื่อดาวน์โหลดไฟล์โดยอัตโนมัติจากตัวควบคุมสปริงเมื่อคลิกลิงก์บน 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();
    }

}

รหัสด้านล่างทำงานสำหรับฉันในการสร้างและดาวน์โหลดไฟล์ข้อความ

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

สิ่งที่ฉันคิดได้อย่างรวดเร็วคือสร้าง pdf และเก็บไว้ใน webapp / ดาวน์โหลด / <RANDOM-FILENAME> .pdf จากโค้ดและส่งต่อไปยังไฟล์นี้โดยใช้ HttpServletRequest

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

หรือถ้าคุณสามารถกำหนดค่าตัวแก้ไขมุมมองของคุณเช่น

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

จากนั้นก็กลับมา

return "RANDOM-FILENAME";

วิธีแก้ปัญหาต่อไปนี้ใช้ได้กับฉัน

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

    }

สิ่งที่ต้องการด้านล่าง

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

คุณสามารถแสดง PDF หรือดาวน์โหลดตัวอย่างได้ที่นี่

ถ้ามันช่วยใครได้ คุณสามารถทำสิ่งที่คำตอบที่ได้รับการยอมรับจาก Infeligo ได้แนะนำ แต่เพียงใส่รหัสพิเศษนี้ลงไปในการดาวน์โหลดแบบบังคับ

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

นี่อาจเป็นคำตอบที่มีประโยชน์

การส่งออกข้อมูลเป็นรูปแบบ pdf ที่หน้าได้หรือไม่

เมื่อขยายไปถึงสิ่งนี้การเพิ่มเนื้อหาการจัดการเป็นสิ่งที่แนบมา (ค่าเริ่มต้น) จะดาวน์โหลดไฟล์ หากคุณต้องการดูคุณต้องตั้งค่าเป็นแบบอินไลน์

ในกรณีของฉันฉันกำลังสร้างไฟล์ตามต้องการดังนั้นต้องสร้าง url ด้วย

สำหรับฉันทำงานบางอย่างเช่นนั้น:

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

ที่สำคัญมากคือประเภท MIME ในและว่าชื่อของไฟล์ที่เป็นส่วนหนึ่งของการเชื่อมโยงเพื่อให้คุณมีการใช้งานproduces@PathVariable

โค้ด HTML ดูเหมือนว่า:

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

ในกรณีที่${file_name}ถูกสร้างขึ้นโดย Thymeleaf ในการควบคุมและเป็นเช่น: result_20200225.csv เพื่อให้การเชื่อมโยง URL behing example.com/aplication/dbreport/files/result_20200225.csvทั้งหมด:

หลังจากคลิกที่ลิงค์เบราว์เซอร์ถามฉันว่าจะทำอย่างไรกับไฟล์ - บันทึกหรือเปิด