SpringBoot + MultipartFile 實現文件上傳以及文件轉移的功能以及配置全局捕獲上傳文件過大異常

2019-03-15

話不多說直接上代碼

application.yml：因為Linux環境與Windows環境路徑不一致，暫時用Windows環境測試

server:
  port: 8891

#文件上傳Windows
upload:
  path:
    #臨時目錄
    temporary: E:/upload/temporary/
    #正式目錄
    formal: E:/upload/formal/
  multipart:
    #單個文件最大內存
    maxFileSize: 512KB
    #所有文件最大內存
    maxRequestSize: 5MB

#文件上傳Linux
#upload:
#  path:
#    #臨時目錄
#    temporary: /usr/upload/temporary/
#    #正式目錄
#    formal: /usr/upload/formal/
#  multipart:
#    #單個文件最大內存
#    maxFileSize: 512KB
#    #所有文件最大內存
#    maxRequestSize: 5MB

spring:
  resources:
    #靜態資源訪問
    static-locations: file:${upload.path.temporary},file:${upload.path.formal}

 FilesConfig：讀取配置文件中文件上傳配置

/**
 * @Author Qin
 * @Date 2019-03-11 13:21
 */
@Component
@Data
public class FilesConfig {

    /**
     * 單文件上傳最大內存
     */
    @Value("${upload.multipart.maxFileSize}")
    private String maxFileSize;

    /**
     * 多文件上傳最大內存
     */
    @Value("${upload.multipart.maxRequestSize}")
    private String maxRequestSize;

    /**
     * 文件上傳臨時目錄
     */
    @Value("${upload.path.temporary}")
    private String temporaryPath;

    /**
     * 文件上傳正式目錄
     */
    @Value("${upload.path.formal}")
    private String formalPath;
}

FilesUploadService：文件上傳Service，返回文件名稱

/**
 * 文件上傳
 *
 * @Author Qin
 * @Date 2019-03-11 13:28
 */
public class UploadService {
    /**
     * 文件上傳時間
     *
     * @return
     */
    public static String getUploudTime() {
        Date date = new Date();
        DateFormat df = new SimpleDateFormat("yyyy/MM/dd");
        return df.format(date);
    }

    /**
     * 給原文件取新的名稱
     *
     * @param fileOriginName
     * @return
     */
    public static String getFileName(String fileOriginName) {
        return UUID.randomUUID().toString().replace("-", "") + fileOriginName.substring(fileOriginName.lastIndexOf("."));
    }

    /**
     * 單文件上傳
     *
     * @param file 文件
     * @param path 文件上傳路徑
     * @return
     * @throws IOException
     */
    public static String uploadOne(MultipartFile file, String path) throws IOException {
        String uploudTime = UploadService.getUploudTime();
        //新的文件存放路徑加上新的文件名
        String newPath = path + uploudTime + "/" + UploadService.getFileName(file.getOriginalFilename());
        File file1 = new File(newPath);
        //判斷文件目錄是否存在
        if (!file1.getParentFile().exists()) {
            //創建文件存放目錄
            //無論是幾個/，都是創建一個文件夾
            //mkdirs(): 創建多層目錄，如：E:/upload/2019
            //mkdir(): 只創建一層目錄，如：E:upload
            //如果不加這一行不會創建新的文件夾，會報系統找不到路徑
            file1.getParentFile().mkdirs();
        }
        //存儲文件
        file.transferTo(file1);
        //去掉目錄名，保留文件總體路徑，通過該路徑訪問圖片
        String filename = newPath.substring(newPath.lastIndexOf(path)).replace(path, "");
        return filename;
    }

    /**
     * 多文件上傳
     *
     * @param files 文件
     * @param path  文件上傳路徑
     * @return
     * @throws IOException
     */
    public static String uploadMore(MultipartFile[] files, String path) throws IOException {
        //多文件文件名
        String uploadName = null;
        String uploudTime = UploadService.getUploudTime();
        for (MultipartFile file : files) {
            //新的文件存放路徑加上新的文件名
            String newPath = path + uploudTime + "/" + UploadService.getFileName(file.getOriginalFilename());
            File file1 = new File(newPath);
            //判斷文件目錄是否存在
            if (!file1.getParentFile().exists()) {
                //創建文件存放目錄
                //無論是幾個/，都是創建一個文件夾
                //mkdirs(): 創建多層目錄，如：E:/upload/2019
                //mkdir(): 只創建一層目錄，如：E:upload
                //如果不加這一行不會創建新的文件夾，會報系統找不到路徑
                file1.getParentFile().mkdirs();
            }
            //存儲文件
            file.transferTo(file1);
            if (uploadName == null) {
                uploadName = newPath.substring(newPath.lastIndexOf(path)).replace(path, "");
            } else {
                uploadName = uploadName + "," + newPath.substring(newPath.lastIndexOf(path)).replace(path, "");
            }
        }
        return uploadName;
    }
}

 FilesUploadController：文件上傳Controller同時包含文件轉移

/**
 * @Author Qin
 * @Date 2019-03-11 10:54
 */
@RestController
@RequestMapping("/api/file")
public class FilesUploadController {

    @Autowired
    private FilesConfig filesConfig;

    /**
     * 設置文件上傳大小：在配置文件中限定
     * @return
     */
    @Bean
    public MultipartConfigElement multipartConfigElement() {
        MultipartConfigFactory factory = new MultipartConfigFactory();
        //單個文件最大
        factory.setMaxFileSize(filesConfig.getMaxFileSize());
        //設置總上傳數據總大小
        factory.setMaxRequestSize(filesConfig.getMaxRequestSize());
        return factory.createMultipartConfig();
    }

    /**
     * 單文件上傳
     * @param file
     * @return
     * @throws IOException
     */
    @PostMapping("/uploadOne")
    public JsonResult uploadOne(MultipartFile file) throws IOException {
        String uploadOne = UploadService.uploadOne(file, filesConfig.getTemporaryPath());
        return ResponseResult.Success(ResultCodeEnums.SUCCESS,uploadOne);
    }

    /**
     * 多文件上傳
     * @param files
     * @return
     * @throws IOException
     */
    @PostMapping("/uploadMore")
    public JsonResult uploadMore(MultipartFile[] files) throws IOException {
        String uploadMore = UploadService.uploadMore(files, filesConfig.getTemporaryPath());
        String[] uploadMores = uploadMore.split(",");
        return ResponseResult.Success(ResultCodeEnums.SUCCESS,uploadMores);
    }

    /**
     * 文件轉移：適用於多文件以及單文件
     * @param uploadPath
     * @return
     * @throws IOException
     */
    @PostMapping("/change")
    public JsonResult filesChange(@RequestBody String [] uploadPath) throws IOException {
        //循環遍歷傳來的String數組
        for (String u : uploadPath) {
            //拿到臨時目錄的文件
            String path = filesConfig.getTemporaryPath() + u;
            File file = new File(path);
            //File類型轉換為MultipartFile類型
            MultipartFile multipartFile = new MockMultipartFile(file.getName(), new FileInputStream(file));
            //正式目錄名與文件名生成一個新的路徑
            String newPath = filesConfig.getFormalPath() + u;
            File newFile = new File(newPath);
            //判斷文件目錄是否存在
            if (!newFile.getParentFile().exists()) {
                //創建文件存放目錄
                //無論是幾個/，都是創建一個文件夾
                //mkdirs(): 創建多層目錄，如：E:/upload/2019
                //mkdir(): 只創建一層目錄，如：E:upload
                //如果不加這一行不會創建新的文件夾，會報系統找不到路徑
                newFile.getParentFile().mkdirs();
            }
            //存儲文件
            multipartFile.transferTo(newFile);
            //去掉目錄名，保留文件總體路徑，通過該路徑訪問圖片
        }
        return ResponseResult.Success(ResultCodeEnums.SUCCESS);
    }
}

 

文件過大異常捕獲

/**
 * @Author Qin
 * @Date 2019-03-13 11:46
 */
@RestControllerAdvice
public class MyExceptionHandler {

    @Autowired
    private FilesConfig filesConfig;

    /**
     * 文件上傳過大返回異常信息
     * @param e
     * @return
     */
    @ExceptionHandler(MaxUploadSizeExceededException.class)
    public JsonResult handleMaxUploadSizeExceededException(MaxUploadSizeExceededException e) {
        String message = ResultCodeEnums.FAIL_10006.msg()
                .replace("${size}",filesConfig.getMaxFileSize())
                .replace("${allsize}",filesConfig.getMaxRequestSize());
        ResultCodeEnums.FAIL_10006.setMsg(message);
        return ResponseResult.Fail(ResultCodeEnums.FAIL_10006);//FAIL_10006("10006","單文件最大不可以超過${size}，多文件最大不可以超過${allsize}"),
    }
}