Spring MVC 实现文件的上传和下载

  • 时间:2018-08-27 22:56 作者:java高级 来源:java高级 阅读:75
  • 扫一扫,手机访问
摘要:前些天一位江苏经贸的学弟跟我留言问了我这样一个问题:“使用什么技术来实现一般网页上文件的上传和下载?是框架还是Java中的IO流”。我回复他说:“用Spring MVC框架可以做到这一点,由于Spring MVC为文件的上传提供了直接的支持,但需要依赖Apache提供Commons FileUplo

前些天一位江苏经贸的学弟跟我留言问了我这样一个问题:“使用什么技术来实现一般网页上文件的上传和下载?是框架还是Java中的IO流”。我回复他说:“用Spring MVC框架可以做到这一点,由于Spring MVC为文件的上传提供了直接的支持,但需要依赖Apache提供Commons FileUpload组件jar包。”鉴于这个问题,我上网也百度了一下,网上很多都是详情的用IO流来实现文件的上传和下载,也有说到框架的,但详情的并不是很完整,今天小钱将和大家详情用Spring MVC框架来实现文件的上传和下载,本文将做一个项目案例来完整的用Spring MVC框架实现文件的上传和下载。

文件上传

文件上传是项目开发中最常见的功能。为了能上传文件,必需将表单的method设置为POST,并将enctype设置为multipart/form-data。只有在这样的情况下,浏览器才会把使用户选择的文件以二进制数据发送给服务器。

一旦设置了enctype为multipart/form-data,浏览器即会采使用二进制流的方式来解决表单数据,而对于文件上传的解决则涉及在服务器端解析原始的HTTP响应。在2003年,Apache Software Foundation发布了开源的Commons FileUpload组件,其很快成为Servlet/JSP程序员上传文件的最佳选择。

Servlet3.0规范已经提供方法来解决文件上传,但这种上传需要在Servlet中完成。而Spring MVC则提供了更简单的封装。

Spring MVC为文件上传提供了直接的支持,这种支持是使用即插即可使用的MultipartResolver实现的。Spring MVC用Apache Commons FileUpload技术实现了一个MultipartResolver实现类:CommonsMultipartResolver。因而,SpringMVC的文件上传还需要依赖Apache Commons FileUpload的组件。

本项目作为测试案例,在此我就不创立Maven项目了,我直接创立的是一个Dynamic Web Project(动态的web项目),采使用Tomcat 8作为web服务器,我们需要在项目中引入以下jar包,如下图:

Spring MVC 实现文件的上传和下载

下面我们在WebContent/WEB-INF下创立一个content文件夹,使用于放文件的上传、下载等jsp文件,下面我们创立uploadForm.jsp文件,演示Spring MVC的文件上传:

<%@ page language="java" contentType="text/html; charset=UTF-8"

pageEncoding="UTF-8"%>

文件上传

文件上传

文件形容:
请选择文件:

负责上传文件的表单和一般表单有少量区别,负责上传文件的表单的编码类型必需是“multipart/form-data”。

我们再src下创立一个包“cn.edu.jseti.controller”,而后创立一个FileUploadController类,使用于实现文件的上传和下载功能。以下是负责上传文件的表单功能代码:

//上传文件会自动绑定到MultipartFile中

@RequestMapping(value="/upload",method=RequestMethod.POST)

public String upload(HttpServletRequest request,

@RequestParam("description") String description,

@RequestParam("file") MultipartFile file) throws Exception {

System.out.println(description);

//假如文件不为空,写入上传路径

if(!file.isEmpty()) {

//上传文件路径

String path = request.getServletContext().getRealPath("/images/");

//上传文件名

String filename = file.getOriginalFilename();

File filepath = new File(path,filename);

//判断路径能否存在,假如不存在就创立一个

if (!filepath.getParentFile().exists()) {

filepath.getParentFile().mkdirs();

}

//将上传文件保存到一个目标文件当中

file.transferTo(new File(path + File.separator + filename));

return "success";

} else {

return "error";

}

}

Spring MVC会将上传的文件绑定到MultipartFile对象中。MultipartFile提供了获取上传文件内容、文件名等方法。通过transferTo()方法还可以将文件存储到硬件中,MultipartFile对象中的常使用方法如下:

  • byte[] getBytes():获取文件数据
  • String getContentType[]:获取文件MIME类型,如image/jpeg等
  • InputStream getInputStream():获取文件流
  • String getName():获取表单中文件组件的名字
  • String getOriginalFilename():获取上传文件的原名
  • Long getSize():获取文件的字节大小,单位为byte
  • boolean isEmpty():能否有上传文件
  • void transferTo(File dest):将上传文件保存到一个目录文件中

SpringMVC上下文中默认没有装配MultipartResolver,因而默认情况下其不能解决文件上传工作。假如想用Spring的文件上传功能,则需要在上下文中配置MultipartResolver。在springmvc-config.xml进行配置文件如下:

<?xml version="1.0" encoding="UTF-8"?>

xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"

xmlns:p="http://www.springframework.org/schema/p"

xmlns:mvc="http://www.springframework.org/schema/mvc"

xmlns:context="http://www.springframework.org/schema/context"

xsi:schemaLocation="

http://www.springframework.org/schema/beans

http://www.springframework.org/schema/beans/spring-beans-4.2.xsd

http://www.springframework.org/schema/mvc

http://www.springframework.org/schema/mvc/spring-mvc-4.2.xsd

http://www.springframework.org/schema/context

http://www.springframework.org/schema/context/spring-context-4.2.xsd">

class="org.springframework.web.servlet.view.InternalResourceViewResolver">

/WEB-INF/content/

.jsp

class="org.springframework.web.multipart.commons.CommonsMultipartResolver">

10485760

UTF-8

部署FileUpload这个Web应使用,在浏览器中输入如下URL来测试应使用:

http://localhost:8088/FileUpload/uploadForm

输入文件形容信息并选择上传文件,如下图:

Spring MVC 实现文件的上传和下载

点上传按钮,这是已将上传的文件通过二进制保存到web服务器上去了,如下图:

Spring MVC 实现文件的上传和下载

用对象接收上传文件

上面我们通过案例演示了Spring MVC上传文件,接下来,我们演示用对象接收上传文件。

在实际项目的开发中,很多时候上传的文件会作为对象的属性被保存。SpringMVC的解决也非常的简单。

下面我们在content文件夹创立registerForm.jsp文件,演示接收文件上传:

<%@ page language="java" contentType="text/html; charset=UTF-8"

pageEncoding="UTF-8"%>

使用户注册

使用户注册

使用户名:
请上传头像:

我们在src下面创立一个名叫“cn.edu.jseti.domain”包,而后再创立一个User类,必需要实现序列化接口,如下案例代码:

package cn.edu.jseti.domain;

import java.io.Serializable;

import org.springframework.web.multipart.MultipartFile;

/**

* 博客:http://blog.csdn.net/qian_ch

* @author Cody

* @version V1.0

*/

//域对象,实现序列化接口

public class User implements Serializable{

private String username;

private MultipartFile image;

public User() {

super();

}

public String getUsername() {

return username;

}

public void setUsername(String username) {

this.username = username;

}

public MultipartFile getImage() {

return image;

}

public void setImage(MultipartFile image) {

this.image = image;

}

}

我们在刚才创立的FileUploadController类继续写使用于接收文件的上传和下载功能。以下是负责接收文件的表单功能代码:

@RequestMapping(value="/register")

public String register(HttpServletRequest request,

@ModelAttribute User user,

Model model) throws Exception {

System.out.println(user.getUsername());

//假如文件不为空,写入上传路径

if(!user.getImage().isEmpty()) {

//上传文件路径

String path = request.getServletContext().getRealPath("/images/");

//上传文件名

String filename = user.getImage().getOriginalFilename();

File filepath = new File(path,filename);

//判断路径能否存在,假如不存在就创立一个

if (!filepath.getParentFile().exists()) {

filepath.getParentFile().mkdirs();

}

//将上传文件保存到一个目标文件当中

user.getImage().transferTo(new File(path + File.separator + filename));

//将使用户增加到model

model.addAttribute("user", user);

return "userInfo";

} else {

return "error";

}

}

在content文件夹下创立userInfo.jsp文件,该页面主要是文件的下载页面,如下jsp代码:

<%@ page language="java" contentType="text/html; charset=UTF-8"

pageEncoding="UTF-8"%>

文件下载

文件下载

${requestScope.user.image.originalFilename }

在浏览器中输入如下URL来测试应使用:

http://localhost:8088/FileUpload/registerForm

文件下载

上面我们通过案例演示了用对象接收上传文件,接下来,我们演示Spring MVC的下载文件。

文件下载比较简单,直接在页面给出了一个超链接,该链接href的属性等于要下载文件的文件名,即可以实现文件下载了。但是假如该文件的文件名为中文文件名,在某些早起的浏览器上就会导致下载失败;假如用最新的Firefox、Chrome、Opera、Safari则都可以正常下载文件名为中文的文件了。

SpringMVC提供了一个ResponseEntity类型,用它可以很方便地定义返回的HttpHeaders和HttpStatus。以下代码演示文件的下载功能:

@RequestMapping(value="/download")

public ResponseEntity download(HttpServletRequest request,

@RequestParam("filename") String filename,

Model model)throws Exception {

//下载文件路径

String path = request.getServletContext().getRealPath("/images/");

File file = new File(path + File.separator + filename);

HttpHeaders headers = new HttpHeaders();

//下载显示的文件名,处理中文名称乱码问题

String downloadFielName = new String(filename.getBytes("UTF-8"),"iso-8859-1");

//通知浏览器以attachment(下载方式)打开图片

headers.setContentDispositionFormData("attachment", downloadFielName);

//application/octet-stream : 二进制流数据(最常见的文件下载)。

headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);

return new ResponseEntity(FileUtils.readFileToByteArray(file),

headers, HttpStatus.CREATED);

}

download解决方法接收页面传递的文件名filename后,用Apache Commons FileUpload组件的FileUtils读取项目的上传文件,并将其构建成ResponseEntity对象返回用户端下载。

用ResponseEntity对象,可以很方便的定义返回的HttpHeaders和HttpStatus。上面代码中的MediaType,代表的是Internet Media Type,即互联网媒体类型,也叫做MIME类型。在Http协议消息头中,用Content-Type来表示具体请求中的媒体类型信息。HttpStatus类型代表的是Http协议中的状态。有关MediaType和HttpStatus类可以参考Spring MVC的API文档。

单击“浏览”按钮,可以选择下载文件的保存路径,而后单击“确定”按钮,文件就会顺利的下载并保存。

本文中的少量功能案例代码和配置文件不是很完整,下面附上完整代码:

FileUploadController类完整的代码如下:

package cn.edu.jseti.controller;

import java.io.File;

import javax.servlet.http.HttpServletRequest;

import org.apache.commons.io.FileUtils;

import cn.edu.jseti.domain.User;

import org.springframework.http.HttpHeaders;

import org.springframework.http.HttpStatus;

import org.springframework.http.MediaType;

import org.springframework.http.ResponseEntity;

import org.springframework.stereotype.Controller;

import org.springframework.ui.Model;

import org.springframework.web.bind.annotation.ModelAttribute;

import org.springframework.web.bind.annotation.PathVariable;

import org.springframework.web.bind.annotation.RequestMapping;

import org.springframework.web.bind.annotation.RequestMethod;

import org.springframework.web.bind.annotation.RequestParam;

import org.springframework.web.multipart.MultipartFile;

/**

* @author Cody

* @version V1.0

*/

@Controller

public class FileUploadController {

@RequestMapping(value="/{formName}")

public String loginForm(@PathVariable String formName) {

// 动态跳转页面

return formName;

}

//上传文件会自动绑定到MultipartFile中

@RequestMapping(value="/upload",method=RequestMethod.POST)

public String upload(HttpServletRequest request,

@RequestParam("description") String description,

@RequestParam("file") MultipartFile file) throws Exception {

System.out.println(description);

//假如文件不为空,写入上传路径

if(!file.isEmpty()) {

//上传文件路径

String path = request.getServletContext().getRealPath("/images/");

//上传文件名

String filename = file.getOriginalFilename();

File filepath = new File(path,filename);

//判断路径能否存在,假如不存在就创立一个

if (!filepath.getParentFile().exists()) {

filepath.getParentFile().mkdirs();

}

//将上传文件保存到一个目标文件当中

file.transferTo(new File(path + File.separator + filename));

return "success";

} else {

return "error";

}

}

@RequestMapping(value="/register")

public String register(HttpServletRequest request,

@ModelAttribute User user,

Model model) throws Exception {

System.out.println(user.getUsername());

//假如文件不为空,写入上传路径

if(!user.getImage().isEmpty()) {

//上传文件路径

String path = request.getServletContext().getRealPath("/images/");

//上传文件名

String filename = user.getImage().getOriginalFilename();

File filepath = new File(path,filename);

//判断路径能否存在,假如不存在就创立一个

if (!filepath.getParentFile().exists()) {

filepath.getParentFile().mkdirs();

}

//将上传文件保存到一个目标文件当中

user.getImage().transferTo(new File(path + File.separator + filename));

//将使用户增加到model

model.addAttribute("user", user);

return "userInfo";

} else {

return "error";

}

}

@RequestMapping(value="/download")

public ResponseEntity download(HttpServletRequest request,

@RequestParam("filename") String filename,

Model model)throws Exception {

//下载文件路径

String path = request.getServletContext().getRealPath("/images/");

File file = new File(path + File.separator + filename);

HttpHeaders headers = new HttpHeaders();

//下载显示的文件名,处理中文名称乱码问题

String downloadFielName = new String(filename.getBytes("UTF-8"),"iso-8859-1");

//通知浏览器以attachment(下载方式)打开图片

headers.setContentDispositionFormData("attachment", downloadFielName);

//application/octet-stream : 二进制流数据(最常见的文件下载)。

headers.setContentType(MediaType.APPLICATION_OCTET_STREAM);

return new ResponseEntity(FileUtils.readFileToByteArray(file),

headers, HttpStatus.CREATED);

}

}

文件上传成功的jsp代码:

<%@ page language="java" contentType="text/html; charset=UTF-8"

pageEncoding="UTF-8"%>

测试文件上传

恭喜,您的上传文件成功!

文件上传失败的jsp代码:

<%@ page language="java" contentType="text/html; charset=UTF-8" pageEncoding="UTF-8"%>

测试文件上传

上传文件失败!

web.xml的配置文件:

<?xml version="1.0" encoding="UTF-8"?>

MultipartFileTest

springmvc

org.springframework.web.servlet.DispatcherServlet

contextConfigLocation

/WEB-INF/springmvc-config.xml

1

springmvc

/

characterEncodingFilter

org.springframework.web.filter.CharacterEncodingFilter

encoding

UTF-8

characterEncodingFilter

/*

OK,以上就是完整的用Spring MVC框架实现了文件的上传和下载。本中所有的案例都是本人亲身测试,如有写的不对,欢迎朋友们留言一起交流,谢谢!

关注我:私信回复“架构资料”获取往期架构视频 手写SpringMVC实战视频

  • 全部评论(0)
最新发布的资讯信息
【系统环境|】2019蚂蚁金服面试总结(Java方向)(2019-04-18 16:19)
【系统环境|】notepad++ 三位数字正则替换规则(2019-04-12 23:02)
【系统环境|服务器应用】网络工程师跨交换机的Vlan配置与管理知识(2019-03-26 02:14)
【系统环境|服务器应用】最小化的定制版linux系统:CoreOS(2019-03-26 02:14)
【系统环境|服务器应用】分布式系统面试题:分布式事务处理方案?(2019-03-26 02:13)
【系统环境|服务器应用】带着网关去旅行(系列二):防止vps上ssh端口被恶意扫描(2019-03-26 02:13)
【系统环境|服务器应用】美团iOS面试总结(2019-03-26 02:13)
【系统环境|服务器应用】百度iOS面试总结(2019-03-26 02:13)
【系统环境|服务器应用】Java大佬之学习历程(三)(2019-03-26 02:13)
【系统环境|服务器应用】Android面试集锦系列(38)——在项目中使用AsyncTask会有什么问题吗?(2019-03-26 02:13)
手机二维码手机访问领取大礼包
返回顶部