spring boot 2g文件 spring boot下载大文件

转载

fjfdh 2023-10-05 14:52:03

文章标签 spring boot 2g文件 spring 文件上传上传 文章分类 spring boot 后端开发

关于文件上传和下载其实现在已经有很多较好的组件给我们封装的很到位，我们实际要做的事情很少，但是这里还是介绍基于commons-fileupload组件的文件上传，和基于文件流的文件下载方式。

文件上传

准备工作

1、引入commons-fileupload的pom依赖

<!-- 文件上传组件 -->
<dependency>
    <groupId>commons-fileupload</groupId>
    <artifactId>commons-fileupload</artifactId>
    <version>${commons-fileupload.version}</version><!--版本号根据自己的情况指定-->
</dependency>

2、配置文件上传大小属性

##最大的请求大小（文件上传时的HTTP请求的大小）默认是10MB
spring.servlet.multipart.max-request-size=20MB 
##最大的文件大小限制，默认是1MB
spring.servlet.multipart.max-file-size=10MB

这里说明一下，有些老版本的springboot教程中会让配置如下两个属性，但是在2.0+版本的时候，这个属性已经被标记为过时了，如下所示（来源：org/springframework/boot/spring-boot-autoconfigure/spring-boot-autoconfigure.jar/META-INF/spring-configuration-metadata.json）：

spring boot 2g文件 spring boot下载大文件_spring

完成之后开始文件上传的操作

实例

文件上传中，我们不再依赖普通的HttpServletRequest对象，spring中本身针对这个对象做了扩展，我们需要使用MultipartHttpServletRequest对象，具体源码如下：

public interface MultipartHttpServletRequest extends HttpServletRequest, MultipartRequest {

	/**
	 * Return this request's method as a convenient HttpMethod instance.
	 */
	@Nullable
	HttpMethod getRequestMethod();

	/**
	 * Return this request's headers as a convenient HttpHeaders instance.
	 */
	HttpHeaders getRequestHeaders();

	/**
	 * Return the headers associated with the specified part of the multipart request.
	 * <p>If the underlying implementation supports access to headers, then all headers are returned.
	 * Otherwise, the returned headers will include a 'Content-Type' header at the very least.
	 */
	@Nullable
	HttpHeaders getMultipartHeaders(String paramOrFileName);

}

这个MultipartHttoServletRequest继承了MultipartRequest，后者其中就有一个getFile方法，我们就是靠这个方法来获取HTTP请求中上传的文件。

这里也附上MultipartRequest的源码

package org.springframework.web.multipart;

import java.util.Iterator;
import java.util.List;
import java.util.Map;

import org.springframework.lang.Nullable;
import org.springframework.util.MultiValueMap;

public interface MultipartRequest {

	/**
	 * Return an {@link java.util.Iterator} of String objects containing the
	 * parameter names of the multipart files contained in this request. These
	 * are the field names of the form (like with normal parameters), not the
	 * original file names.
	 * @return the names of the files
	 */
	Iterator<String> getFileNames();

	/**
	 * Return the contents plus description of an uploaded file in this request,
	 * or {@code null} if it does not exist.
	 * @param name a String specifying the parameter name of the multipart file
	 * @return the uploaded content in the form of a {@link MultipartFile} object
	 */
	@Nullable
	MultipartFile getFile(String name);

	/**
	 * Return the contents plus description of uploaded files in this request,
	 * or an empty list if it does not exist.
	 * @param name a String specifying the parameter name of the multipart file
	 * @return the uploaded content in the form of a {@link MultipartFile} list
	 * @since 3.0
	 */
	List<MultipartFile> getFiles(String name);

	/**
	 * Return a {@link java.util.Map} of the multipart files contained in this request.
	 * @return a map containing the parameter names as keys, and the
	 * {@link MultipartFile} objects as values
	 */
	Map<String, MultipartFile> getFileMap();

	/**
	 * Return a {@link MultiValueMap} of the multipart files contained in this request.
	 * @return a map containing the parameter names as keys, and a list of
	 * {@link MultipartFile} objects as values
	 * @since 3.0
	 */
	MultiValueMap<String, MultipartFile> getMultiFileMap();

	/**
	 * Determine the content type of the specified request part.
	 * @param paramOrFileName the name of the part
	 * @return the associated content type, or {@code null} if not defined
	 * @since 3.1
	 */
	@Nullable
	String getMultipartContentType(String paramOrFileName);

}

整体代码逻辑

//其实整体的代码逻辑可以用如下的逻辑来表达
public void uploadFile(MultipatrFile file){
    //1、判断文件对象是否为空
    if(file!=null){
        //2、定义好文件路径和文件名，表示文件要去往何处
        String destFileName = "";
            
        //3、调用transferTo将文件保存到指定的位置
        File file = new File(destFileName);
        file.transferTo(file);
    }
}

下面贴出一个具体的实现：

public String uploadFile(MultipartFile file, AppendixDto appendixDto) throws IOException {

    //如果附件为空
    if (file == null) {
        throw new RuntimeException("附件为空");
    }
    
    //获取上传文件的原文件名。
    String fileName = file.getOriginalFilename();
    String suffix = StringUtils.substring(fileName, fileName.lastIndexOf("."));

    //定义最终附件存储的目录——root目录+模块名+日期+文件
    SimpleDateFormat dateFormat = new SimpleDateFormat("yyyyMMdd");
    String dataDirectory = dateFormat.format(new Date());
    String rootUrl = env.getProperty("file.upload.root.url") + File.separator + appendixDto.getModuleType() + File.separator + dataDirectory + File.separator;

    File rootFile = new File(rootUrl);
    if (!rootFile.exists()) {
        rootFile.mkdirs();
    }

    //构造最终附件的文件名
    dateFormat = new SimpleDateFormat("yyyyMMddHHmmss");
    String destFileName = dateFormat.format(new Date()) + suffix;
    File destFile = new File(rootUrl + File.separator + destFileName);

    file.transferTo(destFile);

    String location = File.separator + appendixDto.getModuleType() + File.separator + dataDirectory + File.separator + destFileName;
    return location;
}

其中AppendixDto的具体属性如下（这个只是为了传输数据方便）：

@Data
@ToString
public class AppendixDto implements Serializable {
	//文件所属模块
    private String moduleType;
	//文件存放位置
    private String location;
}

controller中的代码实例：

//这里注意consumes的设置，设置成表单数据，json貌似不能上传文件
@RequestMapping(value = prefix + "/uploadFile", method = RequestMethod.POST, consumes = MediaType.MULTIPART_FORM_DATA_VALUE)
public BaseResponse uploadFile(MultipartHttpServletRequest request) {
    BaseResponse response = new BaseResponse(StatusCode.Success);
    try {
        //都是校验而已
        String moduleType = request.getParameter("moduleType");
        if (StringUtils.isBlank(moduleType)) {
            return new BaseResponse(StatusCode.Invalid_Params);
        }
        MultipartFile file = request.getFile("fileName");
        if (file == null) {
            return new BaseResponse(StatusCode.Invalid_Params);
        }

        //1.上传附件
        AppendixDto appendixDto = new AppendixDto();
        appendixDto.setModuleType(moduleType);

        //调用service上传
        final String location = appendixService.uploadFile(file, appendixDto);
        log.info("该附件最终上传的位置:{}", location);
        response.setData(location);
    } catch (Exception e) {
        response = new BaseResponse(StatusCode.Fail);
        e.printStackTrace();
    }
    return response;
}

顺便提一下：postman中设置表单数据之后，是可以选择文件数据的如下所示（下拉选择文件）：

spring boot 2g文件 spring boot下载大文件_spring_02

文件下载

文件下载就很简单了，其实有些组件封装的很好，这里就直接介绍针对流的传统文件下载方式

/**
 * 通用下载附件
 * @throws Exception
 */
public void downloadFile(HttpServletResponse response, InputStream is, String fileName) throws Exception{
    if(is == null || Strings.isNullOrEmpty(fileName)){
        return;
    }

    BufferedInputStream bis = null;
    OutputStream os = null;
    BufferedOutputStream bos = null;
    try{
        bis = new BufferedInputStream(is);
        os = response.getOutputStream();
        bos = new BufferedOutputStream(os);
        //设置响应头为application/octet-stream
        response.setContentType("application/octet-stream;charset=UTF-8");
        //设置Content-Disposition 附件的描述信息
        response.setHeader("Content-Disposition", "attachment;filename="+new String(fileName.getBytes("utf-8"),"iso-8859-1"));
        byte[] buffer = new byte[10240];
        int len = bis.read(buffer);
        while(len != -1){
            bos.write(buffer, 0, len);
            len = bis.read(buffer);
        }

        bos.flush();
    }catch(IOException e){
        e.printStackTrace();
    }finally{
        if(bis != null){
            try{
                bis.close();
            }catch(IOException e){}
        }
        if(is != null){
            try{
                is.close();
            }catch(IOException e){}
        }
    }
}

总结

在实际开发中，如果与业务相关的文件操作，上传流程上并不是单独的上传，例如：创建一个订单需要上传附件，文件上传操作往往不能作为同步的，如果作为同步的，会降低用户的使用体验。一般是提供单独的一个文件上传接口。在客户上传附件之后，还未点击创建订单之前，后台会保存文件，但是文件提交记录表中并不会关联订单id，文件上传成功之后，会返回文件id给前端，前端在创建订单的时候，一并将这些文件id提交给后端的创建订单接口，在创建订单的逻辑中，后台完成文件与订单的绑定。

本文章为转载内容，我们尊重原作者对文章享有的著作权。如有内容错误或侵权问题，欢迎原作者联系我们进行内容更正或删除文章。