11、SpringMVC之文件下载和上传

创建名为spring_mvc_file的新module，过程参考9.1节和9.5节

11.1、文件下载

11.1.1、创建图片目录并放置图片

11.1.2、页面请求示例

<a th:href="@{/test/down}">下载图片</a>

11.1.3、控制器方法示例

package online.liaojy.controller;

import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpStatus;
import org.springframework.http.ResponseEntity;
import org.springframework.stereotype.Controller;
import org.springframework.util.MultiValueMap;
import org.springframework.web.bind.annotation.RequestMapping;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpSession;
import java.io.*;

/**
 * @author liaojy
 * @date 2023/11/2 - 20:50
 */
@Controller
public class FileDownloadController {

    // ResponseEntity 可以作为控制器方法的返回值，表示响应到浏览器的完整响应报文（包含响应体、响应体和响应状态码）
    @RequestMapping("/test/down")
    public ResponseEntity<byte[]> testResponseEntity(HttpSession session) throws IOException {
        //获取ServletContext对象
        ServletContext servletContext = session.getServletContext();
        //获取服务器中工程的真实路径
        String realPath = servletContext.getRealPath("");
        //拼接工程路径和文件路径
        //File.pathSeparator 表示文件路径分隔符，其能自动适应不同系统的路径分隔符（例如Windows的分隔符是\，Linux的分隔符是/）
        realPath = realPath + File.separator + "img" + File.separator + "Windows.jpg";
        //创建输入流
        InputStream is = new FileInputStream(realPath);
        //创建字节数组作为响应报文的响应体，is.available() 用于获取输入流所对应的文件的字节数
        byte[] bytes = new byte[is.available()];
        //将流读到字节数组中
        is.read(bytes);
        //创建HttpHeaders对象设置响应头信息
        MultiValueMap<String, String> headers = new HttpHeaders();
        //设置下载方式以及下载文件的名字
        //请求头的键不区分大小写，Content Disposition头用来强制浏览器下载文件，而不是在浏览器中显示
        //attachment表示以附件形式下载，即在下载时有提示信息
        //filename表示下载的文件的名字
        headers.add("Content-Disposition", "attachment;filename=Win10.jpg");
        //设置响应状态码
        HttpStatus statusCode = HttpStatus.OK;
        //创建ResponseEntity对象
        ResponseEntity<byte[]> responseEntity = new ResponseEntity<byte[]>(bytes, headers, statusCode);
        //关闭输入流
        is.close();
        return responseEntity;
    }

}

11.1.4、测试效果

11.2、文件上传

11.2.1、页面请求示例

<!--
    文件上传要求form表单的请求方式必须为post
    并且设置属性enctype="multipart/form-data"，表示表单中的数据以二进制的方式提交到服务器中
    enctype属性值默认为application/x-www-form-urlencoded，传输不了文件
-->
<form th:action="@{/test/up}" method="post" enctype="multipart/form-data">
    <!--
        type属性值为file
        name属性值要和控制器方法的形参一致
    -->
    图片：<input type="file" name="photo">
    <br>
    <input type="submit" value="上传图片">
</form>

11.2.2、引入依赖

        <!--文件上传-->
        <dependency>
            <groupId>commons-fileupload</groupId>
            <artifactId>commons-fileupload</artifactId>
            <version>1.3.1</version>
        </dependency>

11.2.3、配置文件上传解析器

注意：springmvc 根据bean的id来获取文件解析器，因此必须设置 id 属性，且属性值必须为 multipartResolver

    <!--配置文件解析器-->
    <!--必须通过文件解析器的解析才能将文件转换为 MultipartFile 对象-->
    <!--文件解析器的id属性值必须为 multipartResolver -->
    <bean id="multipartResolver" class="org.springframework.web.multipart.commons.CommonsMultipartResolver">

        <!--文件上传最大值，默认值为 -1(表示没有限制)-->
        <!--<property name="maxUploadSize" value="-1"></property>-->

        <!--解析请求的默认字符编码，默认值为"ISO-8859-1"，通常设置为"UTF-8"-->
        <!--<property name="defaultEncoding" value="UTF-8"></property>-->

        <!--存储在内存的最大值，默认值为10240B(10KB)-->
        <!--<property name="maxInMemorySize" value="10240"></property>-->

        <!--每个文件上传最大值，默认值为 -1(表示没有限制)-->
        <!--<property name="maxUploadSizePerFile" value="-1"></property>-->

        <!--延迟解析，默认为false(立即解析)-->
        <!--<property name="resolveLazily" value="false"></property>-->

        <!--传文件的临时目录，默认值为WEB应用程序的临时目录-->
        <!--<property name="uploadTempDir" value="classpath:online"></property>-->

    </bean>

11.2.4、控制器方法示例

package online.liaojy.controller;

import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.multipart.MultipartFile;

import javax.servlet.ServletContext;
import javax.servlet.http.HttpSession;
import java.io.File;
import java.io.IOException;

/**
 * @author liaojy
 * @date 2023/11/5 - 18:06
 */
@Controller
public class FileUploadController {

    @RequestMapping("/test/up")
    public String testUp(MultipartFile photo, HttpSession session) throws IOException {
        // 获取上传的文件的文件名
        String originalFilename = photo.getOriginalFilename();
        // 获取ServletContext对象
        ServletContext servletContext = session.getServletContext();
        // 获取服务器中当前工程下photo目录的真实路径
        String photoPath = servletContext.getRealPath("photo");
        // 创建photoPath所对应的file对象
        File file = new File(photoPath);
        // 判断file所对应目录是否存在
        if (!file.exists()){
            // file所对应目录不存在，则创建该目录
            file.mkdir();
        }
        // 拼接目录路径和文件名为最终路径
        String finalPath = photoPath + File.separator + originalFilename;
        // 上传文件
        photo.transferTo(new File(finalPath));
        return "success";
    }

}

11.2.5、测试效果

11.3、文件上传的重名问题

11.3.1、问题描述

如果上传了同名的文件，那新的文件就会覆盖旧的文件；

因此需要通过一个机制，保证上传后的文件名的不会和新上传的文件名重复；

通常，可以使用uuid或时间戳，替换原来的文件名，从而保证文件名的唯一性。

11.3.2、解决方式

        // 获取上传的文件的后缀名
        String suffixName = originalFilename.substring(originalFilename.lastIndexOf("."));
        // 使用uuid生成的字符串和上传文件的后缀名，拼接成一个新的文件名
        String fileName = UUID.randomUUID().toString() + suffixName;

        // 拼接目录路径和新的文件名为最终路径
        String finalPath = photoPath + File.separator + fileName;

11.3.3、测试效果