Wie SpringBoot die Funktion zum Herunterladen von Dateien implementiert

1. Lesen Sie die Datei sofort in Form eines Streams in den Speicher ein und geben Sie sie über den Antwortausgabestream an das Frontend aus

/**
 * @param path     想要下载的文件的路径
 * @param response
 * @功能描述 下载文件:
 */
@RequestMapping("/download")
public void download(String path, HttpServletResponse response) {
    try {
        // path是指想要下载的文件的路径
        File file = new File(path);
        log.info(file.getPath());
        // 获取文件名
        String filename = file.getName();
        // 获取文件后缀名
        String ext = filename.substring(filename.lastIndexOf(".") + 1).toLowerCase();
        log.info("文件后缀名：" + ext);

        // 将文件写入输入流
        FileInputStream fileInputStream = new FileInputStream(file);
        InputStream fis = new BufferedInputStream(fileInputStream);
        byte[] buffer = new byte[fis.available()];
        fis.read(buffer);
        fis.close();

        // 清空response
        response.reset();
        // 设置response的Header
        response.setCharacterEncoding("UTF-8");
        //Content-Disposition的作用：告知浏览器以何种方式显示响应返回的文件，用浏览器打开还是以附件的形式下载到本地保存
        //attachment表示以附件方式下载   inline表示在线打开   "Content-Disposition: inline; filename=文件名.mp3"
        // filename表示文件的默认名称，因为网络传输只支持URL编码的相关支付，因此需要将文件名URL编码后进行传输,前端收到后需要反编码才能获取到真正的名称
        response.addHeader("Content-Disposition", "attachment;filename=" + URLEncoder.encode(filename, "UTF-8"));
        // 告知浏览器文件的大小
        response.addHeader("Content-Length", "" + file.length());
        OutputStream outputStream = new BufferedOutputStream(response.getOutputStream());
        response.setContentType("application/octet-stream");
        outputStream.write(buffer);
        outputStream.flush();
    } catch (IOException ex) {
        ex.printStackTrace();
    }
}

2. Schreiben Sie die Daten im Eingabestream in den Antwortausgabestream eine Schleife statt alles auf einmal Einlesen in den Speicher und Ausgabe an das Frontend über den Antwortausgabestream

/**
* @param path     指想要下载的文件的路径
* @param response
* @功能描述 下载文件:将输入流中的数据循环写入到响应输出流中，而不是一次性读取到内存
*/
@RequestMapping("/downloadLocal")
public void downloadLocal(String path, HttpServletResponse response) throws IOException {
   // 读到流中
   InputStream inputStream = new FileInputStream(path);// 文件的存放路径
   response.reset();
   response.setContentType("application/octet-stream");
   String filename = new File(path).getName();
   response.addHeader("Content-Disposition", "attachment; filename=" + URLEncoder.encode(filename, "UTF-8"));
   ServletOutputStream outputStream = response.getOutputStream();
   byte[] b = new byte[1024];
   int len;
   //从输入流中读取一定数量的字节，并将其存储在缓冲区字节数组中，读到末尾返回-1
   while ((len = inputStream.read(b)) > 0) {
       outputStream.write(b, 0, len);
   }
   inputStream.close();
}

3 Laden Sie die Netzwerkdatei auf den lokalen

/**
* @param path       下载后的文件路径和名称
* @param netAddress 文件所在网络地址
* @功能描述 网络文件下载到服务器本地
*/
@RequestMapping("/netDownloadLocal")
public void downloadNet(String netAddress, String path) throws IOException {
	  URL url = new URL(netAddress);
	  URLConnection conn = url.openConnection();
	  InputStream inputStream = conn.getInputStream();
	  FileOutputStream fileOutputStream = new FileOutputStream(path);
	
	  int bytesum = 0;
	  int byteread;
	  byte[] buffer = new byte[1024];
	  while ((byteread = inputStream.read(buffer)) != -1) {
	      bytesum += byteread;
	      System.out.println(bytesum);
	      fileOutputStream.write(buffer, 0, byteread);
	  }
	  fileOutputStream.close();
}

4 herunter Der Server wird vom Server verarbeitet und dann an das Frontend geantwortet

/**
 * @param netAddress
 * @param filename
 * @param isOnLine
 * @param response
 * @功能描述 网络文件获取到服务器后，经服务器处理后响应给前端
 */
@RequestMapping("/netDownLoadNet")
public void netDownLoadNet(String netAddress, String filename, boolean isOnLine, HttpServletResponse response) throws Exception {

    URL url = new URL(netAddress);
    URLConnection conn = url.openConnection();
    InputStream inputStream = conn.getInputStream();

    response.reset();
    response.setContentType(conn.getContentType());
    if (isOnLine) {
        // 在线打开方式 文件名应该编码成UTF-8
        response.setHeader("Content-Disposition", "inline; filename=" + URLEncoder.encode(filename, "UTF-8"));
    } else {
        //纯下载方式 文件名应该编码成UTF-8
        response.setHeader("Content-Disposition", "attachment; filename=" + URLEncoder.encode(filename, "UTF-8"));
    }

    byte[] buffer = new byte[1024];
    int len;
    OutputStream outputStream = response.getOutputStream();
    while ((len = inputStream.read(buffer)) > 0) {
        outputStream.write(buffer, 0, len);
    }
    inputStream.close();
}

5. Häufige Ausnahmen und Probleme

(1) Das Antwortobjekt muss nicht über return zurückgegeben werden

Grund: Das Antwortobjekt muss nicht als Methodenrückgabewert zurückgegeben werden. Es hat bereits mit der Ausgabe begonnen, wenn die Methode ausgeführt wird, und kann nicht mit @RestController zusammenarbeiten. Rückkehr zum Frontend im JSON-Format

Lösung: Löschen Sie die Rückgabeanweisung

(2) Der an das Frontend zurückgegebene Dateiname muss URL-codiert sein

Grund: Die Netzwerkübertragung kann nur bestimmte Dutzende von Zeichen, chinesischen Schriftzeichen, Sonderzeichen usw. übertragen. müssen über Base64 und andere Codierungen in bestimmte Zeichen umgewandelt werden, um eine Übertragung ohne verstümmelte Zeichen zu ermöglichen

URLEncoder.encode(fileName, "UTF-8")

(3) Der E/A-Fluss muss gelernt werden

Das Folgende ist der umgeschriebene Satz: Die Funktion read() wird verwendet, um das nächste Datenbyte aus dem Eingabestream zu lesen und den ganzzahligen Wert des Bytes zurückzugeben, wobei der Wert zwischen 0 und 255 liegt. Wenn keine Bytes verfügbar sind, weil das Ende des Streams erreicht wurde, wird -1 zurückgegeben. Diese Methode blockiert, bis Eingabedaten verfügbar sind, das Ende des Streams erkannt wird oder eine Ausnahme ausgelöst wird.

2: read(byte[] b): Liest eine bestimmte Anzahl von Bytes aus dem Eingabestream und speichert sie im Pufferarray b. Gibt die tatsächliche Anzahl der gelesenen Bytes als Ganzzahl zurück. Diese Methode blockiert, bis Eingabedaten verfügbar sind, das Ende der Datei erkannt wird oder eine Ausnahme ausgelöst wird. Wenn die Länge von b 0 ist, werden keine Bytes gelesen und andernfalls wird versucht, mindestens ein Byte zu lesen. Wenn keine Bytes verfügbar sind, weil der Stream am Ende der Datei liegt, ist der Rückgabewert -1

Das obige ist der detaillierte Inhalt vonWie SpringBoot die Funktion zum Herunterladen von Dateien implementiert. Für weitere Informationen folgen Sie bitte anderen verwandten Artikeln auf der PHP chinesischen Website!