8、Spring Boot——文件上传

最新推荐文章于 2025-06-13 16:49:12 发布

原创最新推荐文章于 2025-06-13 16:49:12 发布 · 346 阅读

0 ·

CC 4.0 BY-SA版权

文章标签：

#Spring Boot #文件上传

Spring Boot 专栏收录该内容

18 篇文章

订阅专栏

本文详细介绍如何在SSM框架中实现文件上传功能，包括引入依赖、配置参数、控制器设计及异常处理。同时，探讨了如何解决参数冲突问题，确保接口设计的健壮性。

在SSM中要做文件上传，首先引入commons-fileupload依赖，然后在SpringMVC的XML文件中配置CommonsMultipartResolver以及其中的文件限制大小等参数。在配置CommonsMultipartResolver的时候，它的id必须叫multipartResolver，但是其他的就无所谓（比如视图解析器）可以配置id，也可以不配置id,如果配置id，id名字也可以随便取。
创建一个Spring Boot工程，在创建好的工程下的resources目录下的static中创建一个upload.html文件，用于上传文件：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<!-- multipart/form-data是指表单数据有多部分构成，既有文本数据，又有文件等二进制数据的意思。

默认情况下，enctype的值是application/x-www-form-urlencoded，不能用于文件上传，只有使用了multipart/form-data，才能完整的传递文件数据。

application/x-www-form-urlencoded不是不能上传文件，是只能上传文本格式
的文件，multipart/form-data是将文件以二进制的形式上传，这样可以实现多
种类型的文件上传。-->
<form action="/upload" method="post" enctype="multipart/form-data">
    <!-- 必须要有name属性-->
    <input type="file" name="file">
    <input type="submit" value="提交">
</form>
</body>
</html>

然后创建一个UploadController,用于接收上传的文件：

@RestController
public class UploadController {
    SimpleDateFormat sdf=new SimpleDateFormat("/yyyy/MM/dd/");
    @PostMapping("/upload")
    public String upload(MultipartFile file, HttpServletRequest req){
        //getRealPath("/img")获取到项目实际运行的目录下的图片文件家
        String format = sdf.format(new Date());
        String realPath = req.getServletContext().getRealPath("/img")+ format;
        File folder = new File(realPath);
        if (!folder.exists()){
            //如果文件不存在，创建文件
            folder.mkdirs();
        }

        System.out.println(realPath);
        //给文件重命名，命名一个不会重复的名字
        String oldName = file.getOriginalFilename();
        String newName=UUID.randomUUID().toString()+ oldName.substring(oldName.lastIndexOf("."));

        try {
            //file.transferTo()上传文件，folder目录，newName文件名
            file.transferTo(new File(folder,newName));
            //保存完成后获取图片的访问路径
            // req.getScheme()根据实际情况，获取请求协议（http,https）
            //req.getServerName()获取主机名（localhost）
            //req.getServerPort()获取端口号

            String s=req.getScheme()+"://"+req.getServerName()+":"+req.getServerPort()+"/img"+format+newName;
            return s;
        } catch (IOException e) {
            e.printStackTrace();
        }
        return "上传失败！";
    }
}

上传成功：
在这里插入图片描述也可以在application.properties中配置文件的大小，文件的临时位置等等
这时候如果选择上传的文件大小超出了配置的大小，就会抛出异常，抛异常前就能看到错误的页面，那么这个页面，包括异常信息，我们是可以统一处理的。

定义一个CustomException类，给它加一个注解@ControllerAdvice(全局异常处理):

@ControllerAdvice
public class CustomException {
    //异常范围，此处表示发生任何异常都会进入这个方法
    @ExceptionHandler(Exception.class)
    public ModelAndView  customException(Exception e){
        ModelAndView mv=new ModelAndView();
        mv.addObject("error",e.getMessage());
        mv.setViewName("aaa");
        return mv;
    }
}

由于此处要返回一个ModelAndView，所以要引入页面模板的也来，这里引入的是Thymeleaf

  <dependency>
            <groupId>org.springframework.boot</groupId>
            <artifactId>spring-boot-starter-thymeleaf</artifactId>
        </dependency>

然后创建一个动态页面aaa.html，用于显示错误信息

<!DOCTYPE html>
<html lang="en" xmlns:th="http://www.thymeleaf.org">
<head>
    <meta charset="UTF-8">
    <title>Title</title>
</head>
<body>
<div th:text="${error}"></div>
</body>
</html>

注意：
在这里插入图片描述这样在上传文件的时候，如果出现错误，就可以在页面中显示：
另外@ControllerAdvice注解，除了有全局异常处理的功能还有全局数据绑定和全局数据预处理。

全局数据绑定：
全局数据绑定就是说，比如在每个Controller中，都需要一些初始化的数据，那么这个数据就可以通过@ControllerAdvice去定义：

在Controller中加一个方法：

//如果想在每一个接口都获取一个公共的参数，
    @GetMapping("/hello")
    public void hello(Model model){
        Map<String,Object>map=model.asMap();
        Set<String> keySet=map.keySet();
        for (String s:keySet){
            System.out.println(s+":"+map.get(s));
        }
    }

在CustomExcprion类中预设数据：

@ControllerAdvice
public class CustomException {

    @ModelAttribute
    public Map<String,Object> mydate(){
        HashMap<String, Object> map = new HashMap<>();
        map.put("username","sp");
        map.put("address","shenzhen");
        return map;
    }
    }

这样在所有的接口都能访问到预设的数据,访问hello接口：
在这里插入图片描述
可以得到预设的数据：
全局全数据预处理
比如定义一个Book类和一个Author类:

public class Book {
    private String name;

    private  Double price;

     }

public class Author {
    private String name;

    private Integer age;

}

此时创建一个Controller，用于接收book和author的值：

@RestController
public class BookController {
    @PostMapping("/book")
    //key-value的形式传参
    public void addBook(Book book,Author author){
        System.out.println(book);
        System.out.println(author);
    }
}

然后使用postman测试：
在这里插入图片描述这时我们会发现接收到的数据为：
那么如果这样呢？
结果如下：
一般来说，设计接口的时候不应该出现参数冲突的问题，但是如果已经出现了这种问题该怎么解决呢？就是使用@ControllerAdvice注解（请求参数预处理），给每一个参数取一个别名：
在这里插入图片描述
然后在@ControllerAdvice标记的类中添加绑定设置一个默认的前缀
使用postman测试带上前缀：
这样就成功解决了参数冲突的问题了