目录
1、简介
本文主要介绍下Spring MVC的文件上传、文件下载和拦截器功能。
2、文件上传
2.1 简述
文件上传功能是系统中比较常用的功能。Spring MVC为文件上传提供了相应的支持,并提供了相关接口(MultipartResolver)和实现类(CommonsMultipartResolver),实现类使用了Apache Commons FileUpload中的技术,所以在使用Spring MVC上传文件功能时需要导入commons-fileupload的相关jar包。在开发文件上传功能时需要注意以下几点:
- 导入Spring相关jar包、导入commons-fileupload相关jar包(commons-fileupload-1.4.jar和commons-io-2.6.jar)
- 表单的method值必须为POST方式
- 需要设置表单的enctype值为multipart/form-data
- 表单中文件的输入文本框类型为file
- 后台通过transferTo方法完成上传文件功能
2.2 springmvc.xml相关配置
<!-- 文件上传配置(上传文件最大10m,默认编码为UTF-8) -->
<bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
<property name="maxUploadSize" value="10485760" />
<property name="defaultEncoding" value="UTF-8" />
</bean>
2.3 示例
controller部分代码如下:
@Controller
@RequestMapping("/demo/")
public class DemoController {
// 单独上传文件
@RequestMapping(value="testUploadFile", method=RequestMethod.POST)
public String testUploadFile(MultipartFile picture) {
uploadPicture(picture);
return "common/success";
}
//以对象的方式传文件 其中DemoDTO 中的picture属性定义为 private MultipartFile picture;
@RequestMapping(value="testUploadObjectFile", method=RequestMethod.POST)
public String testUploadObjectFile(DemoDTO demoDTO) {
uploadPicture(demoDTO.getPicture());
return "common/success";
}
private void uploadPicture(MultipartFile picture) {
if (!picture.isEmpty()) {
String path = DemoConstant.UPLOAD_FILE_PATH + File.separator
+ picture.getOriginalFilename();
try {
picture.transferTo(new File(path));
} catch (IllegalStateException | IOException e) {
e.printStackTrace();
}
}
}
}
jsp部分代码(单独上传和以对象方式上传的方式相似):
<form id="uploadForm" action="testUploadFile" method="post" enctype="multipart/form-data">
<table>
<tr>
<th>上传图片:</th>
<td><input type="file" name="picture" /></td>
</tr>
<tr>
<td><input type="submit" value="提交"></td>
<td><input type="button" id="cancelBtn" value="取消"/></td>
</tr>
</table>
</form>
3、文件下载
文件下载比较简单,可以通过点击页面中的链接进行文件下载,Spring MVC提供了ResponseEntity类型,可设置返回值的HttpHeaders和HttpStatus。示例如下:
controller部分代码如下:
@RequestMapping("download")
public ResponseEntity<byte[]> downloadFile(HttpServletRequest request, String fileName) throws IOException {
String path = DemoConstant.UPLOAD_FILE_PATH + File.separator + fileName;
// 处理文件名中文乱码问题
String downloadFileName = new String(fileName.getBytes("UTF-8"), "ISO-8859-1");
File file = new File(path);
HttpHeaders headers = new HttpHeaders();
// 通知浏览器以下载方式打开文件
headers.setContentDispositionFormData("attachment", downloadFileName);
headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);
return new ResponseEntity<byte[]>(FileUtils.readFileToByteArray(file), headers, HttpStatus.CREATED);
}
jsp部分代码:
<a href="download?fileName=${fileName}">${fileName}</a>
4、拦截器
4.1 简述
拦截器(Interceptor)是Web开发中的一个比较重要的功能,拦截器主要用于拦截用户的请求(例如用户权限校验),Spring MVC也提供了拦截器功能,并且拦截器支持可插拔的,随时可以通过配置文件配置或取消。Spring MVC拦截器可通过实现HandlerInterceptor接口或者继承HandlerInterceptorAdapter类(最终还是实现HandlerInterceptor接口)来实现,HandlerInterceptor接口定义了三个方法,方法如下:
// 在请求处理之前执行,方法中可对请求进行预处理,如果返回true表示请求通过可继续下一步,如果返回false表示请求结束(后续的controller中方法都不会执行)
boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler) throws Exception;
// 会在DispatcherServlet请求视图渲染之前执行,即可以对controller处理之后的ModelAndView进行处理。(preHandle如果返回false,则此方法不会被执行)
void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler, ModelAndView modelAndView) throws Exception;
// 会在DispatcherServlet请求视图渲染之后执行,主要用于资源清理。(preHandle如果返回false,则此方法不会被执行)
void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) throws Exception;
4.2 拦截器相关示例代码
1、实现HandlerInterceptor接口拦截器
package com.common.interceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.HandlerInterceptor;
import org.springframework.web.servlet.ModelAndView;
public class LoginInterceptor implements HandlerInterceptor{
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response, Object handler)
throws Exception {
System.out.println(this.getClass().getName() +"--preHandle--");
System.out.println(this.getClass().getName() + "--url--" + request.getRequestURI());
return true;
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response, Object handler,
ModelAndView modelAndView) throws Exception {
System.out.println(this.getClass().getName() +"--postHandle--");
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response, Object handler,
Exception ex) throws Exception {
System.out.println(this.getClass().getName() +"--afterCompletion--");
}
}
2、继承HandlerInterceptorAdapter类拦截器
package com.common.interceptor;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.springframework.web.servlet.ModelAndView;
import org.springframework.web.servlet.handler.HandlerInterceptorAdapter;
public class TestInterceptorAdapter extends HandlerInterceptorAdapter{
@Override
public boolean preHandle(HttpServletRequest request, HttpServletResponse response,
Object handler) throws Exception {
System.out.println(this.getClass().getName() +"--preHandle--");
System.out.println(this.getClass().getName() + "--url--" + request.getRequestURI());
return super.preHandle(request, response, handler);
}
@Override
public void postHandle(HttpServletRequest request, HttpServletResponse response,
Object handler, ModelAndView modelAndView) throws Exception {
System.out.println(this.getClass().getName() +"--postHandle--");
super.postHandle(request, response, handler, modelAndView);
}
@Override
public void afterCompletion(HttpServletRequest request, HttpServletResponse response,
Object handler, Exception ex) throws Exception {
System.out.println(this.getClass().getName() +"--afterCompletion--");
super.afterCompletion(request, response, handler, ex);
}
@Override
public void afterConcurrentHandlingStarted(HttpServletRequest request,
HttpServletResponse response, Object handler) throws Exception {
System.out.println(this.getClass().getName() +"--afterConcurrentHandlingStarted--");
super.afterConcurrentHandlingStarted(request, response, handler);
}
}
4.3 拦截器配置
<!-- 拦截器配置 -->
<mvc:interceptors>
<mvc:interceptor>
<mvc:mapping path="/**"/>
<mvc:exclude-mapping path="/demo/testUploadFile"/>
<bean class="com.common.interceptor.LoginInterceptor"></bean>
</mvc:interceptor>
<mvc:interceptor>
<mvc:mapping path="/**"/>
<bean class="com.common.interceptor.TestInterceptorAdapter"></bean>
</mvc:interceptor>
</mvc:interceptors>
4.4 运行结果
访问链接:
http://localhost:8090/blog/demo/testInterceptor
http://localhost:8090/blog/demo/testUploadFile
运行结果:
com.common.interceptor.LoginInterceptor--preHandle--
com.common.interceptor.LoginInterceptor--url--/blog/demo/testInterceptor
com.common.interceptor.TestInterceptorAdapter--preHandle--
com.common.interceptor.TestInterceptorAdapter--url--/blog/demo/testInterceptor
--testLoginInterceptor--
com.common.interceptor.TestInterceptorAdapter--postHandle--
com.common.interceptor.LoginInterceptor--postHandle--
com.common.interceptor.TestInterceptorAdapter--afterCompletion--
com.common.interceptor.LoginInterceptor--afterCompletion--
com.common.interceptor.TestInterceptorAdapter--preHandle--
com.common.interceptor.TestInterceptorAdapter--url--/blog/demo/testUploadFile
com.common.interceptor.TestInterceptorAdapter--postHandle--
com.common.interceptor.TestInterceptorAdapter--afterCompletion--