Java實現檔案上傳到伺服器本地並通過url存取的方法步驟

2023-09-06 22:07:11

一、場景

Java實現檔案上傳到伺服器本地，並通過url存取

有個需求，前端上傳檔案，需要用開關的方式同時支援上傳七牛和伺服器本地，方便不同的使用者需求合理分配資源。本篇主要介紹檔案上傳到本地，然後通過url存取。

二、SpringBoot預設靜態資源存取方式

首先想到的就是可以通過SpringBoot通常存取靜態資源的方式，當存取：專案根路徑 + / + 靜態檔名時，SpringBoot會依次去類路徑下的四個靜態資源目錄下查詢（預設設定）。

在資原始檔resources目錄下建立如下四個目錄：

重啟Spring boot，存取

http://localhost:8080/1.jpg
http://localhost:8080/2.jpg
http://localhost:8080/3.jpg
http://localhost:8080/4.jpg

結果：

三、上傳的檔案應該儲存在哪？怎麼存取？

1.檔案儲存在哪？

前文所說外部使用者可通過url存取伺服器資原始檔resources目錄下的靜態資源，但若是將上傳的檔案都儲存在resources相關目錄下，將會導致後續打包過大，程式和程式碼不分離，無法檢視等問題。

解決方案：檔案上傳到伺服器某個目錄，然後SpringBoot設定虛擬路徑，對映到此目錄。

2.怎麼存取？

通過WebMvcConfigurer 的addResourceHandlers將匹配上虛擬路徑的url對映到檔案上傳到伺服器的目錄，這樣就可以通過url來獲取伺服器上的靜態資源了。

範例程式碼

程式碼倉庫github路徑

目標：windows本地測試，將檔案上傳到 D:developworkprojectmyblogmyblog-file-uploadfileStorage 目錄下，然後通過http://localhost:8080/files/檔名存取。

設定類

@Configuration
public class WebMvcConfig implements WebMvcConfigurer {

    @Autowired
    FileServiceImpl fileService;

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        //將匹配上/files/**虛擬路徑的url對映到檔案上傳到伺服器的目錄，獲取靜態資源
        registry.addResourceHandler("/" + fileService.pathPattern + "/**").addResourceLocations("file:" + fileService.filePath);
        WebMvcConfigurer.super.addResourceHandlers(registry);
    }
}

Controller

@RestController
@RequestMapping("/file")
public class FileController {

    @Autowired
    private FileServiceImpl fileService;

    @PostMapping("/upload")
    public FileUploadResponse upload(@RequestParam("file") MultipartFile file) {
        return fileService.upload(file);
    }
}

上傳檔案目錄建立好後，主要通過 file.transferTo(new File(absolutePath)) 完成。

Service

@Slf4j
@Service
public class FileServiceImpl {

    //攔截的url，虛擬路徑
    public String pathPattern = "files";

    //自己設定的目錄
    private static final String fileDir = "fileStorage";

    //上傳檔案存放目錄  =  工作目錄絕對路徑 + 自己設定的目錄，也可以直接自己指定伺服器目錄
    //windows本地測試
    //絕對路徑: D:developworkprojectmyblogmyblog-file-uploadfileStorage202302021010345680.jpg
    //System.getProperty("user.dir")   D:developworkprojectmyblogmyblog-file-upload
    //fileDir                          fileStorage
    //fileName                         202302021010345680.jpg
    public String filePath = System.getProperty("user.dir") + File.separator + fileDir + File.separator;

    private static final AtomicInteger SUFFIX = new AtomicInteger(0);

    @Value(value = "${file.upload.suffix:jpg,jpeg,png,bmp,xls,xlsx,pdf}")
    private String fileUploadSuffix;

    public FileUploadResponse upload(MultipartFile file) {
        FileUploadResponse result = new FileUploadResponse();
        if (file.isEmpty()) {
            log.error("the file to be uploaded is empty");
            return result;
        }
        List<String> suffixList = Lists.newArrayList(fileUploadSuffix.split(","));

        try {
            //校驗檔案字尾
            String originalFilename = file.getOriginalFilename();
            String suffix = originalFilename.substring(originalFilename.lastIndexOf(".") + 1);
            if (!suffixList.contains(suffix)) {
                log.error("unsupported file format");
                return result;
            }

            //首次需生成目錄
            File folder = new File(filePath);
            if (!folder.exists()) {
                folder.mkdirs();
            }

            String fileName = timeFormat(System.currentTimeMillis()) + SUFFIX.getAndIncrement() + "." + suffix;
            String absolutePath = filePath + fileName;
            log.info("absolutePath is {}", absolutePath);
            file.transferTo(new File(absolutePath));

            String separator = "/";
            String path = separator + pathPattern + separator + fileName;
            result.setPath(path);
            result.setFileName(fileName);
        } catch (Exception e) {
            log.error("the file upload error occurred. e ", e);
        }
        return result;
    }

    public static String timeFormat(Long time) {
        if (Objects.isNull(time)) {
            return null;
        }
        DateFormat sdf = new SimpleDateFormat("yyyyMMddHHmmssSSS");
        return sdf.format(time);
    }

}