基于SpringMVC的文件上传功能

最新推荐文章于 2021-08-18 14:15:05 发布

Hero_shine

最新推荐文章于 2021-08-18 14:15:05 发布

阅读量231

点赞数

分类专栏：技术专区文章标签：文件上传

本文链接：https://blog.csdn.net/Hero_shine/article/details/103267419

版权

技术专区专栏收录该内容

27 篇文章 0 订阅

订阅专栏

基于SpringMVC的文件上传功能

1.创建【maven】项目，生成部署描述文件【web.xml】并指定tomcat服务器，打包方式为【war】。

2.在【web.xml】文件中，加载【DispatcherServlet】及【CharacterEncodingFilter】。

  	<servlet>
		<servlet-name>SpringMVC</servlet-name>
		<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
	</servlet>

	<servlet-mapping>
		<servlet-name>SpringMVC</servlet-name>
		<url-pattern>*.do</url-pattern>
	</servlet-mapping>

	<filter>
		<filter-name>CharacterEncodingFilter</filter-name>
		<filter-class>org.springframework.web.filter.CharacterEncodingFilter</filter-class>
		<init-param>
			<param-name>encoding</param-name>
			<param-value>utf-8</param-value>
		</init-param>
	</filter>

	<filter-mapping>
		<filter-name>CharacterEncodingFilter</filter-name>
		<url-pattern>/*</url-pattern>
	</filter-mapping>

3.在【pom.xml】文件中添加所需要的依赖。

<dependencies>
	<dependency>
		<groupId>org.springframework</groupId>
		<artifactId>spring-webmvc</artifactId>
		<version>4.3.10.RELEASE</version>
	</dependency>

	<dependency>
		<groupId>commons-fileupload</groupId>
		<artifactId>commons-fileupload</artifactId>
		<version>1.4</version>
	</dependency>
</dependencies>

4.自定义前端页面，在【webapp】目录下创建【index.html】页面，作为用户上传文件的操作页面。
注意：form表单请求方式必须为【post】，其【enctype】属性必须为【multipart/form-data】；

<form action="upload.do" enctype="multipart/form-data" method="post">
	<input name="file" type="file" />
	<input id="btn-submit" type="submit" value="提交" />
</form>

添加结束后，输入【http://localhost:8080/SpringMVC-03/】进行测试，具体路径根据实际项目名称决定。

5.使用控制器接受用户的上传请求。

在【web.xml】文件中添加spring的配置文件的配置信息。

 <servlet>
	<servlet-name>SpringMVC</servlet-name>
	<servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
	<init-param>
		<param-name>contextConfigLocation</param-name>
		<param-value>classpath:spring-mvc.xml</param-value>
	</init-param>
	<load-on-startup>1</load-on-startup>
</servlet>

在【src/main/resource】文件夹下，添加【spring-mvc.xml】配置文件，保证其中有关于组件扫描的配置。

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans" 
	xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
	xmlns:context="http://www.springframework.org/schema/context" 
	xmlns:jdbc="http://www.springframework.org/schema/jdbc"  
	xmlns:jee="http://www.springframework.org/schema/jee" 
	xmlns:tx="http://www.springframework.org/schema/tx"
	xmlns:aop="http://www.springframework.org/schema/aop" 
	xmlns:mvc="http://www.springframework.org/schema/mvc"
	xmlns:util="http://www.springframework.org/schema/util"
	xmlns:jpa="http://www.springframework.org/schema/data/jpa"
	xsi:schemaLocation="
		http://www.springframework.org/schema/beans http://www.springframework.org/schema/beans/spring-beans-3.2.xsd
		http://www.springframework.org/schema/context http://www.springframework.org/schema/context/spring-context-3.2.xsd
		http://www.springframework.org/schema/jdbc http://www.springframework.org/schema/jdbc/spring-jdbc-3.2.xsd
		http://www.springframework.org/schema/jee http://www.springframework.org/schema/jee/spring-jee-3.2.xsd
		http://www.springframework.org/schema/tx http://www.springframework.org/schema/tx/spring-tx-3.2.xsd
		http://www.springframework.org/schema/data/jpa http://www.springframework.org/schema/data/jpa/spring-jpa-1.3.xsd
		http://www.springframework.org/schema/aop http://www.springframework.org/schema/aop/spring-aop-3.2.xsd
		http://www.springframework.org/schema/mvc http://www.springframework.org/schema/mvc/spring-mvc-3.2.xsd
		http://www.springframework.org/schema/util http://www.springframework.org/schema/util/spring-util-3.2.xsd">
	
	<!-- 组件扫描 -->
	<context:component-scan base-package="cn.iseahi.upload" />
	<!-- 注解驱动 -->
	<mvc:annotation-driven />
	
</beans>

新建【cn.iseahi.upload.FileUploadController】类，并添加【Controller】注解及处理上传文件的方法【handleUpload】

@Controller
public class FileUploadController {

	@RequestMapping("upload.do")//与前端form的action属性一致
	//暂时没有配置视图解析器及前端模板引擎，添加@ResponseBody注解以响应正文
	@ResponseBody
	public String handUpload(){
		return "OK";
	}
}

此时再做测试，前端应能正常显示【OK】字样。

6.接下来在【spring-mvc.xml】文件中配置【MultipartResolver】作为JavaBean对象来使用。
【MultipartResolver】是一个接口，配置时，bean节点的id值必须是【multipartResolver】。

<!-- 配置MultipartResolver -->
<bean id="multipartResolver" class="org.springframework.web.multipart.MultipartResolver" />

现在可以在控制器中处理用户上传的文件，在控制器中处理文件上传的方法中添加【MultipartFile】类型的参数，名称与前端上传文件时提交文件的参数名称保持一致，本案例中，为【file】,建议添加【@RequestParam】注解，以确保参数名称一致。

public String handUpload(@RequestParam("file") MultipartFile file){
	// ...
	return "OK";
}

此时后端已经可以接收前端提交过来的文件，我们需要在控制器中填写保存该文件的具体代码，注意，此时上传必须将文件上传至tomcat部署项目的文件夹中，才能使文件后期是可以通过该项目访问。

@Controller
public class FileUploadController {

	@RequestMapping("upload.do")
	//暂时没有配置视图解析器及前端模板引擎，添加@ResponseBody注解以便于前端接收
	@ResponseBody
	public String handUpload(@RequestParam("file") MultipartFile file,HttpServletRequest request){
		//指定将该文件放置在哪个文件夹
		//一般为tomcat部署项目的文件夹，需要使用HttpServletRequest对象的方法，因此添加该参数
		//使用以下API以获取tomcat部署该项目的文件夹下"upload"文件夹的实际路径
		String parent = request.getServletContext().getRealPath("upload");
		//利用时间戳防止上传文件重复，或者使用UUID（同一时空不可能相同）
		String name = file.getOriginalFilename();
		//确定文件是否有后缀
		String suffix = "";
		int beginIndex = name.lastIndexOf('.');
		if(beginIndex > 0){//部分文件以'.'开头，如：.java/.class/.project等，不能以index != -1作为判断依据
			suffix = name.substring(beginIndex);
		}
		String fileName = System.nanoTime() + suffix;
		//指定客户端上传的文件对象存储路径
		//检测该路径是否存在，不存在则创建
		File dir = new File(parent);
		if(!dir.exists()||!dir.isDirectory()){
			dir.mkdirs();
		}
		File dest = new File(parent,fileName);
		//执行保存操作
		try {
			file.transferTo(dest);
		} catch (IllegalStateException e) {
			e.printStackTrace();
		} catch (IOException e) {
			e.printStackTrace();
		}
		return "OK";
	}
}

至此，基于SpringMVC的文件上传功能就完成了，文件名称处理还有一些小瑕疵，一般用户上传以后的文件后期可能还要使用，因而部分上传功能可能还要保存客户端上传时的原始文件名（如网盘等）也需要保存，可以再对文件名称进行其他处理。还有一些功能如限制文件上传类型和上传文件的大小，也可以通过配置文件来限定。其他拓展功能可以根据以下API自由发挥。

【关于MultipartFile】

MultipartFile的常用API：

【1】void transerTo(dest) 将文件输出至指定路径（与方法【5】不要同时使用）
【2】String getOriginalFilename() 获取客户端上传文件的原始文件名称
【3】boolean isEmpty() 当没有选择上传文件或者上传文件的大小为【0】时，该判断值为【true】
【4】long getSize() 获取上传文件大小，以字节为单位（可用于显示进度条，判断是否设置缓存区等）
【5】InputStream getInputStream() 获取文件对应的字节流以读取文件内的数据（与方法【1】不要同时使用）
【6】String getContentType() 获取上传文件的MIME类型，完全取决于文件的拓展名，与内容无关，可限制文件类型

MultipartFile的常用配置：

<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
    <!-- maxUploadSize:配置上传的所有文件的最大大小 -->
    <property name="maxUploadSize" value="1048576"></property>
    <!-- maxUploadSizePerFile:配置上传的单个文件的最大大小，取值为字节 -->
    <property name="maxUploadSizePerFile" value="1024"></property>
    <!-- defaultEncoding:网页其他提交数据的字符集形式，如中文文件名 -->
    <property name="defaultEncoding" value="utf-8"/>
</bean>

【1】maxUploadSize：配置上传的所有文件的最大大小，取值为字节，会在提交上传请求后做判断，先于控制器，多用于配置全局限制，项目一般有很多功能都可以上传文件，如上传头像，视频，图片等，一般设置一个较大的值以满足所有功能个别功能在对应的控制器中进行单独配置。

【2】maxUploadSizePerFile：配置上传的单个文件的最大大小，取值为字节。

如果超过这两个限制，会抛出【FileUploadBase$SizeLimitExceededException】异常；

【3】defaultEncoding：配置网页其他提交数据的字符集，如中文文件名需要设置【uft-8】。

【上传多个文件】

在前端页面添加相同的【input】标签，设置不同的【name】属性，后端方法中添加多个【MulitipartFile】类型的参数。
当我们需要同时选择多个文件时，需要对【前端input】标签做如下配置：

<input type="file" multiple="multiple" name="file" />

此时再向后端发送请求，会提交多个文件，我们需要把控制器类中的参数列表修改为使用【MultipartFile[ ]】数组类型进行接收，在方法内部遍历整个数组，逐一进行存储即可。实际入参形式可根据需求自行调整。

【PS】现在前端多数都是Ajax+html，很多请求也都是通过Ajax发送的，在这也贴上前端代码

<script type="text/javascript">
    $("#btn-upload").click(function(){
        $.ajax({
            "url":"/upload_file",
            "data":new FormData($("#form-upload")[0]),
            "processData":false,
            "contentType":false,
            "type":"post",
            "dataType":"json",
            "success":function(result){
                //....
            }
        });
    });
</script>

再补充几个参数：

【async】：是否同步。默认情况下，所有请求均为异步请求，如果要发送同步请求，需要将该参数设置为【true】，改为同步请求后，所有页面请求需要等待该请求结束后才能执行。

【cache】：是否缓存页面，是否将页面缓存至浏览器，默认为【true】。

【timeout】：设置超时时间，值为毫秒。

【processData】：默认为【true】，默认情况下，发送的数据将被转换成字符串对象（并非字符串对象）来传输，以配合默认内容类型【application/x-www-form-urlencoded】，如果不需要转换，需设置为【false】。

【contentType】：默认为【application/x-www-form-urlencoded】，适合绝大多数应用场景，如果需要和上一个参数同时设置。

Hero_shine

关注

0
点赞
踩
1

收藏

觉得还不错? 一键收藏
0
评论
基于SpringMVC的文件上传功能

基于SpringMVC的文件上传功能1.创建【maven】项目，生成部署描述文件【web.xml】并指定tomcat服务器，打包方式为【war】。2.在【web.xml】文件中，加载【DispatcherServlet】及【CharacterEncodingFilter】。 <servlet> <servlet-name>SpringMVC</s...
复制链接

扫一扫