Spring Boot 文件上传下载、url 映射虚拟路径

傷城~ 2022-03-07 15:06 535阅读 0赞

**目录**

url 映射虚拟路径需求分析

嵌入式 Tomcat 文件上传

url 映射虚拟路径

web 文件下载

The temporary upload location is not valid

--------------------

# url 映射虚拟路径需求分析 #

1、Java web 应用开发完成后如果是导入外置的 Tomcat 的 webapps 目录的话，那么上传的文件可以直接的放在应用的 web 目录下去就好了，浏览器可以很方便的进行访问。

2、Spring Boot 默认使用嵌入式 Tomcat ，将来打包成可执行 Jar 文件进行部署，显然打成 jar 包后，总不可能再将上传的文件放在 resources 目录下去了。

3、Spring Boot 于是提供了 url 地址匹配本地虚拟路径的功能：

<table> 
 <tbody> 
  <tr> 
   <td>1）上传文件到服务器，服务器将文件保存到了本地，如：E:\wmx\uploadFiles\222.png<br> 2）用户访问应该是服务器地址，如：http://localhost:9393/fileServer/uploadFiles/222.png<br> 3）于是通过配置资源映射，使 url 中的 /uploadFiles/ 映射到本地的 E:\wmx\uploadFiles\ 即可，E:\wmx\uploadFiles 则为虚拟路径。</td> 
  </tr> 
 </tbody> 
</table>

# 嵌入式 Tomcat 文件上传 #

1、Java JDK 1.8 + Spring Boot 2.1.3 新建 web 项目，spring boot 版本不同，可能略有差异。

2、spring boot 的 web 组件中的 org.springframework:spring-web 已经集成了文件上传功能，无需再导入以前的 commons-io、以及 commons-fileupload 了，使用方式和之前的 commons-fileupload 完全一样。

**一：pom.xml** 内容如下，为了页面写起来方便，使用了 Thymeleaf 模板引擎，java web 应用，自然需要导入 web 组件。

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

**二：application.yml** 全局配置文件内容如下：

#配置服务器
    server:
      port: 9393 #服务器端口
      servlet:
        context-path: /fileServer #应用上下文路径
    spring:
      servlet:
        multipart: #配置文件上传
          max-file-size: 1000MB #设置上传的单个文件最大值，单位可以是 MB、KB，默认为 1MB
          max-request-size: 1024MB #设置多文件上传时，单次内多个文件的总量的最大值，单位可以是 MB、KB，默认为 10 M
    uploadFile:
      location: E:/wmx/uploadFiles #自定义上传文件本地保存路径

1、上传文件存放的目录，不应该写死在代码中，所以上面提供了在配置文件中配置 uploadFile.location 属性，将来类中使用 @Value 取值即可。

2、文件上传官网介绍：[Handling Multipart File Uploads][]，除了配置上面的单个文件最大值已经单次上传总量以外，官网还提供了如下配置：

# MULTIPART (MultipartProperties)
    spring.servlet.multipart.enabled=true # Whether to enable support of multipart uploads.
    spring.servlet.multipart.file-size-threshold=0B # Threshold after which files are written to disk.
    spring.servlet.multipart.location= # Intermediate location of uploaded files.
    spring.servlet.multipart.max-file-size=1MB # Max file size.
    spring.servlet.multipart.max-request-size=10MB # Max request size.
    spring.servlet.multipart.resolve-lazily=false # Whether to resolve the multipart request lazily at the time of file or parameter access.

**三：UploadFileController ** 文件上传后台控制台层代码如下：

import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.multipart.MultipartFile;
    import javax.servlet.http.HttpServletRequest;
    import java.io.File;
    import java.io.IOException;
    /**
     * Created by Administrator on 2019/3/17 0017.
     */
    @Controller
    public class UploadFileController {
        @Value("${uploadFile.location}")
        private String uploadFileLocation;//上传文件保存的本地目录，使用@Value获取全局配置文件中配置的属性值
        /**
         * 文件上传，因为只是演示，所以使用 @ResponseBody 将结果直接返回给页面
         *
         * @param multipartFile
         * @param request
         * @return
         * @throws IOException
         */
        @PostMapping("uploadFile")
        @ResponseBody
        public String uploadFile(MultipartFile multipartFile, HttpServletRequest request) throws IOException {
            if (multipartFile == null || multipartFile.isEmpty()) {
                return "上传文件为空...";
            }
            //basePath拼接完成后，形如：http://192.168.1.20:8080/fileServer
            String basePath = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort() + request.getContextPath();
            System.out.println("basePath=" + basePath);
    
            String fileName = multipartFile.getOriginalFilename();
            File saveFile = new File(uploadFileLocation, fileName);
            System.out.println("文件保存成功：" + saveFile.getPath());
            multipartFile.transferTo(saveFile);//文件保存
    
            return saveFile.getPath().toString();
        }
    }

**四：index.html** 前端文件上传 form 表单如下：

<!DOCTYPE html>
    <html>
    <head lang="en">
        <meta charset="UTF-8">
        <title>文件服务器</title>
    </head>
    <body>
    
    <form id="uploadForm" method="post" action="http://localhost:9393/fileServer/uploadFile" enctype="multipart/form-data">
        <input type="file" name="multipartFile" style="font-size: 20px"/><br>
        <input type="submit" id="uploadButton" value="上传" style="font-size: 30px">
    </form>
    
    </body>
    </html>

![20190317122336515.gif][]

# url 映射虚拟路径 #

1、使用资源映射虚拟路径很简单，使用 WebMvcConfigurer 扩展配置即可，不熟悉的可以参考[《][Link 1][自定义资源映射虚拟路径][Link 2]》.

**一：application.yml** 修改如下：

#配置服务器
    server:
      port: 9393 #服务器端口
      servlet:
        context-path: /fileServer #应用上下文路径
    spring:
      servlet:
        multipart: #配置文件上传
          max-file-size: 1000MB #设置上传的单个文件最大值，单位可以是 MB、KB，默认为 1MB
          max-request-size: 1024MB #设置多文件上传时，单次内多个文件的总量的最大值，单位可以是 MB、KB，默认为 10 M
    uploadFile:
      resourceHandler: /uploadFiles/**   #请求 url 中的资源映射
      location: E:/wmx/uploadFiles/ #自定义上传文件本地保存路径

**二：WebMvcConfigurer** 再扩展 webMvc 配置，设置资源映射：

import org.springframework.beans.factory.annotation.Value;
    import org.springframework.context.annotation.Configuration;
    import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
    import org.springframework.web.servlet.config.annotation.WebMvcConfigurer;
    /**
     * WebMvc 扩展配置类，应用一启动，本类就会执行
     * Created by Administrator on 2019/3/17 0017.
     */
    @Configuration
    public class MyWebMvcConfigurer implements WebMvcConfigurer {
        @Value("${uploadFile.resourceHandler}")
        private String resourceHandler;//请求 url 中的资源映射，不推荐写死在代码中，最好提供可配置，如 /uploadFiles/**
    
        @Value("${uploadFile.location}")
        private String location;//上传文件保存的本地目录，使用@Value获取全局配置文件中配置的属性值，如 E:/wmx/uploadFiles/
        /**
         * 配置静态资源映射
         *
         * @param registry
         */
        @Override
        public void addResourceHandlers(ResourceHandlerRegistry registry) {
            //就是说 url 中出现 resourceHandler 匹配时，则映射到 location 中去,location 相当于虚拟路径
            //映射本地文件时，开头必须是 file:/// 开头，表示协议
            registry.addResourceHandler(resourceHandler).addResourceLocations("file:///" + location);
        }
    }

**三：UploadFileController** 改写一下控制器。特别提醒一句：实际应用中，文件上传之后，应该往数据库插入记录，如 url 相对路径： [uploadFiles/222.png][uploadFiles_222.png]，下面因为只是作为演示，文件上传之后，直接返回了浏览器访问的 url 路径了，并没有保存数据。

import org.springframework.beans.factory.annotation.Value;
    import org.springframework.stereotype.Controller;
    import org.springframework.web.bind.annotation.PostMapping;
    import org.springframework.web.bind.annotation.ResponseBody;
    import org.springframework.web.multipart.MultipartFile;
    import javax.servlet.http.HttpServletRequest;
    import java.io.File;
    import java.io.IOException;
    /**
     * Created by Administrator on 2019/3/17 0017.
     */
    @Controller
    public class UploadFileController {
        @Value("${uploadFile.resourceHandler}")
        private String resourceHandler;//请求 url 中的资源映射，不推荐写死在代码中，最好提供可配置，如 /uploadFiles/**
        @Value("${uploadFile.location}")
        private String uploadFileLocation;//上传文件保存的本地目录，使用@Value获取全局配置文件中配置的属性值，如 E:/wmx/uploadFiles/
        /**
         * 文件上传，因为只是演示，所以使用 @ResponseBody 将结果直接返回给页面
         *
         * @param multipartFile
         * @param request
         * @return
         * @throws IOException
         */
        @PostMapping("uploadFile")
        @ResponseBody
        public String uploadFile(MultipartFile multipartFile, HttpServletRequest request) throws IOException {
            if (multipartFile == null || multipartFile.isEmpty()) {
                return "上传文件为空...";
            }
            //basePath拼接完成后，形如：http://192.168.1.20:8080/fileServer
            String basePath = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort() + request.getContextPath();
            String fileName = multipartFile.getOriginalFilename();
            String fileServerPath = basePath + resourceHandler.substring(0, resourceHandler.lastIndexOf("/") + 1) + fileName;
            System.out.println("文件访问路径：" + fileServerPath);
    
            File saveFile = new File(uploadFileLocation, fileName);
            multipartFile.transferTo(saveFile);//文件保存
    
            System.out.println("文件保存路径：" + saveFile.getPath());
    
            return "<a href='" + fileServerPath + "'>" + fileServerPath + "</a>";
        }
    }

![20190317132903155.gif][]

代码 GitHub 地址：[https://github.com/wangmaoxiong/fileServer][https_github.com_wangmaoxiong_fileServer]

# web 文件下载 #

get 请求在线演示源码：[src/main/java/com/wmx/www/controller/UploadFileController.java][src_main_java_com_wmx_www_controller_UploadFileController.java]

post 请求在线演示源码：[后端导出接口、POI ][POI][Word工具类、][Word][前端页面][Link 3]

![20201230205312333.gif][]

# The temporary upload location is not valid #

1、Spring boot 文件上传时有时候会出现此错误（临时上传存储位置无效）：java.io.IOException: The temporary upload location \[C:\\Users\\...\\ROOT\] is not valid

2、解决办法如下：

<table> 
 <tbody> 
  <tr> 
   <td> <p>方式1）重启项目，自动重新生成临时存储路径</p> </td> 
  </tr> 
  <tr> 
   <td>方式2）全局配置文件中配置：spring.servlet.multipart.locatio= 上传文件的临时存储目录</td> 
  </tr> 
  <tr> 
   <td> <p>方式3）注入一个 Bean，手动添设置下临时存储路径，代码如下：</p> <p>@Bean &nbsp;<br> MultipartConfigElement multipartConfigElement() { &nbsp;<br> &nbsp;&nbsp; MultipartConfigFactory factory = new MultipartConfigFactory(); &nbsp;<br> &nbsp;&nbsp; factory.setLocation("d://temp"); &nbsp;<br> &nbsp;&nbsp; return factory.createMultipartConfig(); &nbsp;<br> }</p> </td> 
  </tr> 
 </tbody> 
</table>

[Handling Multipart File Uploads]: https://docs.spring.io/spring-boot/docs/2.1.3.RELEASE/reference/htmlsingle/#howto-multipart-file-upload-configuration
[20190317122336515.gif]: /images/20220307/7f18cdecbad24607be1ed683dd3c5c8c.png
[Link 1]: https://blog.csdn.net/wangmx1993328/article/details/81267769#WebMvcConfigurer
[Link 2]: https://blog.csdn.net/wangmx1993328/article/details/81267769#%E8%87%AA%E5%AE%9A%E4%B9%89%E8%B5%84%E6%BA%90%E6%98%A0%E5%B0%84%E8%99%9A%E6%8B%9F%E8%B7%AF%E5%BE%84
[uploadFiles_222.png]: http://localhost:9393/fileServer/uploadFiles/222.png
[20190317132903155.gif]: /images/20220307/c3b424f7f26244cdbda650b3471d78a3.png
[https_github.com_wangmaoxiong_fileServer]: https://github.com/wangmaoxiong/fileServer
[src_main_java_com_wmx_www_controller_UploadFileController.java]: https://github.com/wangmaoxiong/fileServer/blob/master/src/main/java/com/wmx/www/controller/UploadFileController.java
[POI]: https://gitee.com/wangmx1993/database-tow-doc-tools/blob/master/src/main/java/com/wmx/db2doc/controller/DatabaseController.java
[Word]: https://gitee.com/wangmx1993/database-tow-doc-tools/blob/master/src/main/java/com/wmx/db2doc/util/WordTableUtils.java
[Link 3]: https://gitee.com/wangmx1993/database-tow-doc-tools/blob/master/src/main/resources/templates/tableShow.html
[20201230205312333.gif]: /images/20220307/109258b83cac477bb9a7e8937dc150a5.png