SpringBoot如何實現檔案上傳與下載功能-java教程-PHP中文網

首頁

Java

java教程

SpringBoot如何實現檔案上傳與下載功能

WBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWBOYWB

May 16, 2023 am 08:46 AM

springboot

Spring Boot文件上傳與下載

在實際的Web應用開發中，為了成功上傳文件，必須將表單的method設定為post，並將enctype設定為multipart/form-data。只有這種設置，瀏覽器才能將所選文件的二進位資料傳送給伺服器。

從Servlet 3.0開始，就提供了處理檔案上傳的方法，但這種檔案上傳需要在Java Servlet中完成，而Spring MVC提供了更簡單的封裝。 Spring MVC是透過Apache Commons FileUpload技術實作一個MultipartResolver的實作類別CommonsMultipartResolver完成檔案上傳的。因此，Spring MVC的檔案上傳需要依賴Apache Commons FileUpload元件。

Spring MVC將上傳檔案自動綁定到MultipartFile物件中，MultipartFile提供了獲取上傳檔案內容、檔案名稱等方法，並透過transferTo方法將檔案上傳到伺服器的磁碟中，MultipartFile的常用方法如下：

byte[] getBytes()：取得檔案資料。
String getContentType()：取得檔案MIME類型，如image/jpeg等。
InputStream getInputStream()：取得檔案流。
String getName()：取得表單中檔案元件的名字。
String getOriginalFilename()：取得上傳檔案的原名。
long getSize()：取得檔案的位元組大小，單位為byte。
boolean isEmpty()：是否有（選擇）上傳檔案。
void transferTo(File dest)：將上傳檔案儲存到一個目標檔案中。

Spring Boot的spring-boot-starter-web已經整合了Spring MVC，所以使用Spring Boot實作檔案上傳，更便捷，只需要引入Apache Commons FileUpload元件依賴即可。

範例說明

下面透過一個實例講解Spring Boot檔案上傳與下載的實作過程。

【範例7】Spring Boot檔案上傳與下載。

具體實作步驟如下。

1.引入Apache Commons FileUpload元件依賴

在Web應用ch7_2的pom.xml檔案中，加入Apache Commons FileUpload元件依賴，具體程式碼如下：

<dependency>
    <groupId>commons-fileupload</groupId>
    <artifactId>commons-fileupload</artifactId>
    <!-- 由于commons-fileupload组件不属于Spring Boot，所以需要加上版本 -->
    <version>1.4</version>
</dependency>

2 .設定上傳檔案大小限制

在Web應用ch7_2的設定檔application.properties中，新增如下設定進行限制上傳檔案大小。

#上传文件时，默认单个上传文件大小是1MB，max-file-size设置单个上传文件大小
spring.servlet.multipart.max-file-size=50MB
#默认总文件大小是10MB，max-request-size设置总上传文件大小
spring.servlet.multipart.max-request-size=500MB

3.建立選擇檔案檢視頁面

在ch7_2套用的src/main/resources/templates目錄下，建立選擇檔案檢視頁面uploadFile.html。該頁面中有個enctype屬性值為multipart/form-data的form表單，具體程式碼如下：

<!DOCTYPE html>
<html xmlns:th="http://www.thymeleaf.org">
<head>
<meta charset="UTF-8">
<title>Insert title here</title>
<link rel="stylesheet" th:href="@{css/bootstrap.min.css}" />
<!-- 默认访问 src/main/resources/static下的css文件夹-->
<link rel="stylesheet" th:href="@{css/bootstrap-theme.min.css}" />
</head>
<body>
<div class="panel panel-primary">
    <div class="panel-heading">
      <h4 id="文件上传示例">文件上传示例</h4>
    </div>
  </div>
  <div class="container">
    <div class="row">
      <div class="col-md-6 col-sm-6">
        <form class="form-horizontal" action="upload" 
method="post" enctype="multipart/form-data">
          <div class="form-group">
            <div class="input-group col-md-6">
              <span class="input-group-addon">
                <i class="glyphicon glyphicon-pencil"></i>
              </span>
              <input class="form-control" type="text"
               name="description" th:placeholder="文件描述"/>
            </div>
          </div>
          <div class="form-group">
            <div class="input-group col-md-6">
              <span class="input-group-addon">
                <i class="glyphicon glyphicon-search"></i>
              </span>
              <input class="form-control" type="file"
               name="myfile" th:placeholder="请选择文件"/>
            </div>
          </div>
          <div class="form-group">
            <div class="col-md-6">
              <div class="btn-group btn-group-justified">
                <div class="btn-group">
                  <button type="submit" class="btn btn-success">
                    <span class="glyphicon glyphicon-share"></span>
                     上传文件
                  </button>
                </div>
              </div>
            </div>
          </div>
        </form>
      </div>
    </div>
  </div>
</body>
</html>

4.建立控制器

在ch7_2應用的com.ch.ch7_2. controller包中，建立控制器類別TestFileUpload。在這個類別中有4個處理方法，一個是介面導覽方法uploadFile，一個是實作檔案上傳的upload方法，一個是顯示將會被下載檔案的showDownLoad方法，一個是實作下載功能的download方法。核心程式碼如下：

@Controller
public class TestFileUpload {
  @RequestMapping("/uploadFile")
  public String uploadFile() {
    return "uploadFile";
  }
  /**
   * 上传文件自动绑定到MultipartFile对象中，
   * 在这里使用处理方法的形参接收请求参数。
     */
  @RequestMapping("/upload")
  public String upload(
      HttpServletRequest request,
      @RequestParam("description") String description,
      @RequestParam("myfile") MultipartFile myfile)
throws IllegalStateException, IOException {
    System.out.println("文件描述：" + description);
    //如果选择了上传文件，将文件上传到指定的目录uploadFiles
    if(!myfile.isEmpty()) {
      //上传文件路径
      String path = request.getServletContext().getRealPath("/uploadFiles/");
      //获得上传文件原名
      String fileName = myfile.getOriginalFilename();
      File filePath = new File(path + File.separator + fileName);
      //如果文件目录不存在，创建目录
      if(!filePath.getParentFile().exists()) {
        filePath.getParentFile().mkdirs();
      }
      //将上传文件保存到一个目标文件中
      myfile.transferTo(filePath);
    }
    //转发到一个请求处理方法，查询将要下载的文件
    return "forward:/showDownLoad";
  }
  /**
   * 显示要下载的文件
   */
  @RequestMapping("/showDownLoad")
  public String showDownLoad(HttpServletRequest request, Model model) {
    String path = request.getServletContext().getRealPath("/uploadFiles/");
    File fileDir = new File(path);
    //从指定目录获得文件列表
    File filesList[] = fileDir.listFiles();
    model.addAttribute("filesList", filesList);
    return "showFile";
  }
  /**
   * 实现下载功能
   */
  @RequestMapping("/download")
  public ResponseEntity<byte[]> download(
      HttpServletRequest request,
      @RequestParam("filename") String filename,
      @RequestHeader("User-Agent") String userAgent) throws IOException {
    //下载文件路径
    String path = request.getServletContext().getRealPath("/uploadFiles/");
    //构建将要下载的文件对象
    File downFile = new File(path + File.separator + filename);
    //ok表示HTTP中的状态是200
    BodyBuilder builder = ResponseEntity.ok();
    //内容长度
    builder.contentLength(downFile.length());
    //application/octet-stream：二进制流数据（最常见的文件下载）
    builder.contentType(MediaType.APPLICATION_OCTET_STREAM);
    //使用URLEncoder.encode对文件名进行编码
    filename = URLEncoder.encode(filename,"UTF-8");
    /**
     * 设置实际的响应文件名，告诉浏览器文件要用于“下载”和“保存”。
     * 不同的浏览器，处理方式不同，根据浏览器的实际情况区别对待。
     */
    if(userAgent.indexOf("MSIE") > 0) {
      //IE浏览器，只需要用UTF-8字符集进行URL编码
      builder.header("Content-Disposition", "attachment; filename=" + filename);
    }else {
      /**非IE浏览器，如FireFox、Chrome等浏览器，则需要说明编码的字符集
       * filename后面有个*号，在UTF-8后面有两个单引号
       */
      builder.header("Content-Disposition", "attachment; filename*=UTF-8&#39;&#39;" + filename);
    }
    return builder.body(FileUtils.readFileToByteArray(downFile));
  }
}

5.建立檔案下載檢視頁面

在ch7_2應用的src/main/resources/templates目錄下，建立檔案下載檢視頁面showFile.html。核心程式碼如下：

<body>
  <div class="panel panel-primary">
    <div class="panel-heading">
      <h4 id="文件下载示例">文件下载示例</h4>
    </div>
  </div>
  <div class="container">
    <div class="panel panel-primary">
      <div class="panel-heading">
        <h4 id="文件列表">文件列表</h4>
      </div>
      <div class="panel-body">
        <div class="table table-responsive">
          <table class="table table-bordered table-hover">
            <tbody class="text-center">
              <tr th:each="file,fileStat:${filesList}">
                <td>
                  <span th:text="${fileStat.count}"></span>
                </td>
                <td>
                <!--file.name相当于调用getName()方法获得文件名称 -->
                  <a th:href="@{download(filename=${file.name})}">
                    <span th:text="${file.name}"></span>
                  </a>
                </td>
              </tr>
            </tbody>
          </table>
        </div>
      </div>
    </div>
  </div>
</body>