实现文件上传下载功能

先浅看一下文件上传三要素:

  1. 表单提交方式:post (get方式提交有大小限制,post没有)
  2. 表单的enctype属性:必须设置为multipart/form-data
  3. 表单必须有文件上传项:file

文件上传介绍

服务端要接收客户端页面上传的文件,通常都会使用Apache的两个组件:

  • commons-fileupload
  • commons-io

Spring框架在spring-web包中对文件上传进行了封装,大大简化了服务端代码,我们只需要在Controller的方法中声明一个MultiparFile类型的参数即可接收上传的文件,例如:
实现文件上传下载功能_第1张图片
实现文件上传下载功能_第2张图片

代码实现

/**
 * @author JUNHAO
 */
@RestController
@Slf4j
@RequestMapping("/common")
public class CommonController {

    @Value("${reggie.path}")
    private String basePath;

    /**
     * 文件上传
     * @param file
     * @return
     */
    @PostMapping("upload")
    public R<String> upload(MultipartFile file) {

        // 获取上传文件的原始文件名
        String originalFilename = file.getOriginalFilename();
        // 获取原始文件名的后缀
        String suffix = originalFilename.substring(originalFilename.lastIndexOf("."));
        // 使用UUID重新生成文件名,防止文件名称重复造成文件覆盖
        String fileName = UUID.randomUUID().toString() + suffix;

        try {
            // file是一个临时文件,需要转存到指定位置,否则本次请求完成后临时文件会被删除
            // basePath 是指定的保存路径,我们在上面声明了一个属性,属性值从yml配置文件读取,以便修改
            // 这里可能会有IO异常,我们需要把它抛出去
            file.transferTo(new File(basePath + fileName));
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }
}
reggie:
  path: D:\

扩展知识:

lastIndexOf() 方法:返回指定字符在此字符串中最后一次出现的索引,如果此字符串中没有这样的字符,则返回 -1

substring() 方法:括号中带的参数不一样,效果就会有很大的区别

  • xx.substring(0,2) 表示取第一个和第二个字符(左开右闭),返回一个新的字符串
  • xx.substring(2) 表示去掉前两个字符,返回一个新的字符串

发现问题

如果说,我们修改了yml配置文件中path的属性

reggie:
  path: D:\images\

但是我们D盘根本就没有images这个文件夹,所以我们需要加一个判断,如果不存在这个目录结构,我们就创建一个

代码实现:

/**
 * @author JUNHAO
 */
@RestController
@Slf4j
@RequestMapping("/common")
public class CommonController {

    @Value("${reggie.path}")
    private String basePath;

    /**
     * 文件上传
     * @param file
     * @return
     */
    @PostMapping("upload")
    public R<String> upload(MultipartFile file) {

        // 获取上传文件的原始文件名
        String originalFilename = file.getOriginalFilename();
        // 获取原始文件名的后缀
        String suffix = originalFilename.substring(originalFilename.lastIndexOf("."));
        // 使用UUID重新生成文件名,防止文件名称重复造成文件覆盖
        String fileName = UUID.randomUUID().toString() + suffix;
        
        
        // 创建一个目录对象
        File dir = new File(basePath);
        // 判断当前目录是否存在
        if (!dir.exists()) {
            // 目录不存在,需要创建
            dir.mkdirs();
        }
        
        
        try {
            // file是一个临时文件,需要转存到指定位置,否则本次请求完成后临时文件会被删除
            // basePath 是指定的保存路径,我们在上面声明了一个属性,属性值从yml配置文件读取,以便修改
            // 这里可能会有IO异常,我们需要把它抛出去
            file.transferTo(new File(basePath + fileName));
        } catch (IOException e) {
            e.printStackTrace();
        }
        return null;
    }
}

这个方法是有返回值的,但是我们是return null;返回一个什么值比较合适呢?其实我们需要返回文件名称。当用户上传完文件之后,会有一个保存操作,我们需要将这个文件名称保存到数据库中去的,所以需要将文件名称返回给前端。


文件下载

文件下载,也称download,是指将文件从服务器传输到本地计算机的过程

通过浏览器进行文件下载,通常有两种表现形式:

  • 以附件形式下载,弹出保存对话框,将文件保存到指定磁盘目录
  • 直接在浏览器中打开

通过浏览器进行文件下载,本质上就是服务端将文件以流的形式写回浏览器的过程。

1、直接在浏览器中打开

[外链图片转存失败,源站可能有防盗链机制,建议将图片保存下来直接上传(img-zMg0PsEK-1652449323476)(img/image-20220513211054474.png)]

从前端发的请求来看,前端传过来了一个name,我们需要将这个name 接收到

/**
 * 文件下载
 * @param name
 * @param response
 */
@GetMapping("download")
public void download(String name, HttpServletResponse response) {

}

为什么还要response呢,因为我们这个输出流需要通过response来获得

/**
 * 文件下载
 * @param name
 * @param response
 */
@GetMapping("download")
public void download(String name, HttpServletResponse response) {
    try {
        // 输入流,通过输入流读取文件内容
        FileInputStream fileInputStream = new FileInputStream(new File(basePath + name));
        // 输出流,通过输出流将文件写回浏览器,在浏览器展示图片
        ServletOutputStream outputStream = response.getOutputStream();
        // 设置响应给客户端的文件格式
        response.setContentType("image/jpeg");
        int len = 0;
        byte[] bytes = new byte[1024];
        while ((len = fileInputStream.read(bytes)) != -1) {
            outputStream.write(bytes, 0, len);
            outputStream.flush();
        }
        // 关闭资源
        outputStream.close();
        fileInputStream.close();
    } catch (Exception e) {
        e.printStackTrace();
    }

}

end…

你可能感兴趣的:(后端,java,spring,开发语言)