基於SpringWeb MultipartFile文件上傳、下載功能

在Web開發中，文件上傳是一個常見的功能需求。Spring框架提供了MultipartFile介面，用於處理文件上傳請求。MultipartFile可以代表一個多部分文件上傳請求中的一個文件，提供了一系列方法用於獲取文件的各種屬性和內容，使得在後端處理文件上傳變得十分方便。下麵我們將介紹Multip ...

在Web開發中，文件上傳是一個常見的功能需求。Spring框架提供了MultipartFile介面，用於處理文件上傳請求。MultipartFile可以代表一個多部分文件上傳請求中的一個文件，提供了一系列方法用於獲取文件的各種屬性和內容，使得在後端處理文件上傳變得十分方便。下麵我們將介紹MultipartFile在Web應用中的幾種常見使用場景。

1. 圖片上傳

在Web應用中，圖片上傳是一種常見的場景。用戶需要上傳頭像、相片、證件照等圖片文件，而後端需要接收並保存這些文件。使用MultipartFile介面可以輕鬆地實現圖片文件的接收和處理。通過獲取文件的原始文件名、內容類型、大小等屬性，我們可以實現對圖片文件的有效管理和存儲。例如，我們可以將圖片文件保存到伺服器的文件系統中，或者將其存儲到雲存儲服務中。

2. 文件下載

除了文件上傳，文件下載也是Web應用中常見的功能需求。使用MultipartFile介面，我們可以實現文件的下載功能。在伺服器端，我們可以將文件作為MultipartFile對象進行處理，並通過設置響應頭信息，將文件作為下載內容返回給客戶端。客戶端接收到文件後，可以將其保存到本地磁碟或進行其他處理。

3. 文件編輯

在Web應用中，有時候用戶需要對上傳的文件進行編輯操作，例如修改文件名、修改文件內容等。使用MultipartFile介面，我們可以實現對文件的編輯功能。首先，我們可以通過MultipartFile介面獲取上傳的文件對象，然後對其進行相應的編輯操作。例如，我們可以修改文件的名稱、修改文件的內容等。編輯完成後，我們可以將修改後的文件保存到伺服器或返回給客戶端。

4. 文件預覽和展示

在Web應用中，有時候我們需要將上傳的文件進行預覽或展示。例如，在文檔管理系統中，用戶需要預覽或下載文檔文件。使用MultipartFile介面，我們可以實現文件的預覽和展示功能。我們可以將文件作為MultipartFile對象進行處理，然後將其內容轉換為適當的格式進行展示。例如，對於PDF文件，我們可以使用PDF閱讀器插件進行展示；對於圖片文件，我們可以將其直接展示在網頁上。

5. 文件批量上傳和處理

在實際應用中，有時候用戶需要批量上傳多個文件，並對這些文件進行處理。使用MultipartFile介面，我們可以實現文件的批量上傳和處理功能。我們可以將多個文件作為一個多部分文件上傳請求進行處理，然後對每個文件進行相應的操作。例如，我們可以將多個圖片文件批量上傳到伺服器，並對它們進行壓縮、裁剪等處理。

代碼

package com.javagpt.back.controller;

import com.javagpt.application.context.UserAppContextHolder;
import com.javagpt.application.file.FileApplicationService;
import com.javagpt.application.file.FileDTO;
import com.javagpt.common.annotation.RespSuccess;
import com.javagpt.common.constant.EMConstant;
import io.swagger.annotations.Api;
import io.swagger.annotations.ApiOperation;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.springframework.web.bind.annotation.*;
import org.springframework.web.multipart.MultipartFile;

import java.io.IOException;

@Api(tags = "文件介面")
@Slf4j
@RestController
@RequestMapping(EMConstant.API_V1 + "/file")
@RespSuccess
@RequiredArgsConstructor
public class FileController {

    private final FileApplicationService fileApplicationService;

    @ApiOperation("通用文件上傳")
    @PostMapping(value = "/uploadFile")
    public FileDTO uploadFile(@RequestParam("file") MultipartFile multipartFile) throws IOException {
        Long enterpriseId = UserAppContextHolder.getCurrentUser().getEnterpriseId();
        FileDTO fileDTO = fileApplicationService.saveFile(enterpriseId, multipartFile);
        return fileDTO;
    }

    //@PreAuthorize("hasAuthority('mp:file:download')")
    @ApiOperation("下載文件")
    @GetMapping(value = "/downloadFile")
    public void download(@RequestParam(value = "id") Long id, HttpServletResponse response) throws IOException {
        fileApplicationService.downloadFile(response, id, UserAppContextHolder.getCurrentUser().getEnterpriseId());
    }

    @ApiOperation("查看文件信息")
    @GetMapping(value = "/info")
    public FileDTO fileInfo(@RequestParam(value = "id") Long id) throws IOException {
        return fileApplicationService.findById(id);
    }

    @ApiOperation("下載視頻")
    @GetMapping(value = "/downloadFile2")
    public void download2(@RequestParam(value = "id") Long id, HttpServletRequest request, HttpServletResponse response) throws IOException {
        fileApplicationService.downloadVideo(request, response, id, UserAppContextHolder.getCurrentUser().getEnterpriseId());
    }
}

package com.javagpt.application.file;

import com.javagpt.common.exception.BusinessRuntimeException;
import com.javagpt.common.oos.OssService;
import com.javagpt.common.util.ModelUtils;
import com.javagpt.common.util.SpringResponseUtils;
import com.javagpt.file.entity.FileEntity;
import com.javagpt.file.repository.FileRepository;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.HttpServletResponse;
import lombok.RequiredArgsConstructor;
import lombok.extern.slf4j.Slf4j;
import org.apache.commons.io.FilenameUtils;
import org.apache.commons.io.IOUtils;
import org.apache.commons.lang3.StringUtils;
import org.springframework.http.HttpHeaders;
import org.springframework.stereotype.Service;
import org.springframework.transaction.annotation.Transactional;
import org.springframework.web.multipart.MultipartFile;

import java.io.*;

@Service
@Slf4j
@RequiredArgsConstructor
public class FileApplicationService {

    private final OssService ossService;

    private final FileRepository fileRepository;


    public FileDTO findById(Long id) {
        FileEntity fileEntity = fileRepository.findById(id);
        return ModelUtils.convert(fileEntity, FileDTO.class);
    }

    @Transactional
    public FileDTO saveFile(Long enterpriseId, MultipartFile file) {
        FileEntity fileEntity = saveFile(enterpriseId, file, null);
        return ModelUtils.convert(fileEntity, FileDTO.class);
    }

    @Transactional
    public FileEntity saveFile(Long enterpriseId, MultipartFile file, String fileName) {
        String originalFilename = file.getOriginalFilename();
        String name = StringUtils.isBlank(fileName) ? FilenameUtils.getBaseName(originalFilename) : fileName;
        String suffix = FilenameUtils.getExtension(originalFilename);
        long size = file.getSize();
        FileEntity fileEntity = new FileEntity();
        fileEntity.setName(name).setSuffix(suffix).setSize(size).setEnterpriseId(enterpriseId);
        fileEntity = fileEntity.save();
        String key = fileEntity.getPath();
        InputStream inputStream = null;
        try {
            inputStream = file.getInputStream();
        } catch (IOException e) {
            log.error("saveFile error:", e);
            throw BusinessRuntimeException.error("上傳文件失敗");
        }
        ossService.uploadFile(inputStream, key);
        IOUtils.closeQuietly(inputStream);
        return fileEntity;
    }


    @Transactional
    public FileEntity saveFile(File file) {
        long size = file.length();
        FileEntity fileEntity = new FileEntity();
        String baseName = FilenameUtils.getBaseName(file.getName());
        String extension = FilenameUtils.getExtension(file.getName());
        fileEntity.setName(baseName).setSuffix(extension).setSize(size);
        fileEntity = fileEntity.save();
        String key = fileEntity.getPath();
        FileInputStream inputStream = null;
        try {
            inputStream = new FileInputStream(file);
            ossService.uploadFile(inputStream, key);
        } catch (FileNotFoundException e) {
            log.error("saveFile error:", e);
            throw BusinessRuntimeException.error("上傳文件失敗");
        }
        IOUtils.closeQuietly(inputStream);
        return fileEntity;
    }


    public void downloadFile(HttpServletResponse response, Long fileId, Long enterpriseId) throws IOException {
        FileEntity fileEntity = fileRepository.findById(fileId);
        if (fileEntity == null) {
            throw BusinessRuntimeException.error("無效的文件Id");
        }
        String key = fileEntity.getPath();
        InputStream inputStream = ossService.downloadFile(key);
        SpringResponseUtils.writeAndFlushResponse(inputStream, response, fileEntity.fileFullName());
    }


    public void downloadVideo(HttpServletRequest request, HttpServletResponse response, Long fileId, Long enterpriseId) throws IOException {

        FileEntity fileEntity = fileRepository.findById(fileId);
        if (fileEntity == null) {
            throw BusinessRuntimeException.error("無效的文件Id");
        }
        response.setHeader(HttpHeaders.ACCEPT_RANGES, "bytes");
        Long fileSize = fileEntity.getSize();
        long start = 0, end = fileSize - 1;
        //判斷前端需不需要分片下載
        if (StringUtils.isNotBlank(request.getHeader("Range"))) {
            response.setStatus(HttpServletResponse.SC_PARTIAL_CONTENT);
            String numRange = request.getHeader("Range").replaceAll("bytes=", "");
            String[] strRange = numRange.split("-");
            if (strRange.length == 2) {
                start = Long.parseLong(strRange[0].trim());
                end = Long.parseLong(strRange[1].trim());
                //若結束位元組超出文件大小 取文件大小
                if (end > fileSize - 1) {
                    end = fileSize - 1;
                }
            } else {
                //若只給一個長度  開始位置一直到結束
                start = Long.parseLong(numRange.replaceAll("-", "").trim());
            }
        }
        long rangeLength = end - start + 1;
        String contentRange = new StringBuffer("bytes ").append(start).append("-").append(end).append("/").append(fileSize).toString();
        response.setHeader(HttpHeaders.CONTENT_RANGE, contentRange);
        response.setHeader(HttpHeaders.CONTENT_LENGTH, String.valueOf(rangeLength));
        String key = fileEntity.getPath();
        InputStream inputStream = ossService.downloadFile2(key, start, end);
        SpringResponseUtils.writeAndFlushResponse(inputStream, response, fileEntity.fileFullName());
    }
}

總之，MultipartFile介面在Web應用中具有廣泛的應用場景，可以實現文件上傳、下載、編輯、預覽和批量處理等功能。通過熟練掌握MultipartFile介面的使用方法和技巧，我們可以更加高效地處理文件上傳和下載請求，提升Web應用的用戶體驗和功能性能。

本文由博客一文多發平臺 OpenWrite 發佈！