快捷導(dǎo)航

SpringBoot實現(xiàn)文件上傳功能

更新時間：2021年11月09日 14:13:56 作者：NicholasGUB

這篇文章主要為大家詳細介紹了SpringBoot實現(xiàn)文件上傳功能，文中示例代碼介紹的非常詳細，具有一定的參考價值，感興趣的小伙伴們可以參考一下

經(jīng)典的文件上傳

服務(wù)器處理上傳文件一般都是先在請求中讀取文件信息，然后改變名稱保存在服務(wù)器的臨時路徑下，最后保存到服務(wù)器磁盤中。本次以thymeleaf搭建demo，因此需要引入thymeleaf依賴庫。

<dependency>
    <groupId>org.springframework.boot</groupId>
    <artifactId>spring-boot-starter-thymeleaf</artifactId>
    <version>2.5.5</version>
</dependency>

如果使用的是gradle構(gòu)建的項目，需要修改build.gradle文件：

compile 'org.springframework.boot:spring-boot-starter-thymeleaf:2.5.5'

新建一個Action類負責處理上傳的文件：

@RestController
@RequestMapping("/upload/*")
public class UploadAction {

    @PostMapping("/file")
    public Object uploadHandler(HttpServletRequest request, String title, MultipartFile file) {
        Map<String, Object> resultMap = new LinkedHashMap<>();
        resultMap.put("title", title);
        resultMap.put("fileName", file.getName()); // 文件名
        resultMap.put("originalFilename", file.getOriginalFilename()); // 原始名稱
        resultMap.put("content-type", file.getContentType()); // 文件類型
        resultMap.put("fileSize", file.getSize() / 1024 + "K"); // 文件大小
        try {
            // 保存文件
            String uploadedFilePath = saveFile(request, file.getInputStream(), file.getOriginalFilename()
                    .substring(file.getOriginalFilename().lastIndexOf(".") + 1));
            resultMap.put("uploadedFilePath", uploadedFilePath); // 文件大小
        } catch (IOException e) {
            System.err.println("error-path: /upload/file, message: " + e.getMessage());
        }
        return resultMap;
    }

    /**
     * 保存上傳的文件到本地服務(wù)器
     *
     * @param request HttpServletRequest
     * @param input   輸入流
     * @param ext     文件擴展名
     * @return 文件路徑
     * @throws IOException
     */
    public String saveFile(HttpServletRequest request, InputStream input, String ext) throws IOException {
        String realPath = request.getServletContext().getRealPath("/upload/file/"); // 取得服務(wù)器真實路徑
        File file = new File(realPath);
        if (!file.getParentFile().exists()) { // 目錄不存在
            file.mkdirs(); // 創(chuàng)建多級目錄
        }
        String filePath = realPath + UUID.randomUUID() + "." + ext;
        // 取的文件輸出流
        OutputStream out = new FileOutputStream(filePath);
        byte[] data = new byte[2048]; // 緩沖數(shù)組2KB
        int len = 0; // 讀取字節(jié)長度
        while ((len = input.read(data)) != -1) {
            out.write(data, 0, len); // 文件寫入磁盤
        }
        if (input != null) {
            input.close();
        }
        out.close();
        return filePath;
    }
}

在resources目錄下新建templates文件夾，在里面創(chuàng)建index.html文件作為項目首頁展示。

<!doctype HTML>
<html xmlns:th="http://www.thymeleaf.org">
    <head>
        <title>文件上傳測試</title>
        <meta charset="UTF-8" />
    </head>
    <body>
        <form action="/upload/file" method="post" enctype="multipart/form-data">
            <span>標題：</span>
            <input type="text" name="title" /><br>
            <span>文件：</span>
            <input type="file" name="file" /><br>
            <input type="submit" value="上傳"  />
        </form>
    </body>
</html>

啟動項目，直接訪問：http://localhost:8080/將進入index.html頁面。

點擊上傳按鈕，文件將被保存到服務(wù)器磁盤中：

SpringBoot對上傳文件處理的簡化

SpringBoot對FileUpload組件進行了整合，在文件保存的時候可以避免直接操作IO流，通過配置文件的方式指定文件上傳的限制參數(shù)。修改application.yml文件：

server:
  port: 8080
spring:
  servlet:
    multipart:
      enabled: true  # 啟用文件上傳
      max-file-size: 1MB # 單文件上傳最大限制
      max-request-size: 10MB # 文件上傳最大值
      file-size-threshold: 10KB # 上傳文件達到多大時寫入磁盤
      location: / # 臨時文件存儲位置

修改UploadAction，使用MultipartFile類的transferTo方法保存上傳文件。

@RestController
@RequestMapping("/upload/*")
public class UploadAction {
    @PostMapping("/file")
    public Object uploadHandler(HttpServletRequest request, String title, MultipartFile file) {
        Map<String, Object> resultMap = new LinkedHashMap<>();
        resultMap.put("title", title);
        resultMap.put("fileName", file.getName()); // 文件名
        resultMap.put("originalFilename", file.getOriginalFilename()); // 原始名稱
        resultMap.put("content-type", file.getContentType()); // 文件類型
        resultMap.put("fileSize", file.getSize() / 1024 + "K"); // 文件大小
        try {
            // 保存文件
            String etc = file.getOriginalFilename().substring(file.getOriginalFilename().lastIndexOf(".") + 1);
            String serverPath = request.getScheme() + "://" + request.getServerName()
                    + ":" + request.getServerPort() + request.getContextPath() + "/file/upload/";
            String fileName = UUID.randomUUID() + "." + etc;
            resultMap.put("filePath", serverPath + fileName); // 文件地址(服務(wù)器訪問地址)
            // 文件保存再真實路徑下
            File saveFile = new File(request.getServletContext().getRealPath("/file/upload/") + fileName);
            if (!saveFile.getParentFile().exists()) { // 目錄不存在，創(chuàng)建目錄
                saveFile.mkdirs();
            }
            file.transferTo(saveFile); // 保存上傳文件
        } catch (IOException e) {
            System.err.println("error-path: /upload/file, message: " + e.getMessage());
        }
        return resultMap;
    }
}

訪問：http://localhost:8080/