SpringBoot整合Web开发之文件上传与@ControllerAdvice

2024-09-27 18:09:00

本章概要

文件上传
@ControllerAdvice

文件上传

Java 中的文件上传一共涉及两个组件，一个是 CommonsMultipartResolver，另一个是 StandardServletMultipartResolver ，其中 CommonsMultipartResolver 使用 commons-fileupload 来处理 multipart 请求，而 StandardServletMultipartResolver 则是基于 Servlet 3.0 来处理。因此若使用 StandardServletMultipartResolver ，则不需要添加额外的 jar 包。Tomcat 7.0 开始就支持 Servlet 3.0 了，而Spring Boot 2.0.4 内嵌的 Tomcat 为 Tomcat 8.5.32 ，因此可以直接使用 StandardServletMultipartResolver 。而在 Spring Boot 提供的上传文件自动化配置类 MultipartAutoConfiguration 中，默认也是采用 StandardServletMultipartResolver ，部分源码如下：

	@Bean(name = DispatcherServlet.MULTIPART_RESOLVER_BEAN_NAME)
	@ConditionalOnMissingBean(MultipartResolver.class)
	public StandardServletMultipartResolver multipartResolver() {
		StandardServletMultipartResolver multipartResolver = new StandardServletMultipartResolver();
		multipartResolver.setResolveLazily(this.multipartProperties.isResolveLazily());
		return multipartResolver;
	}

根据配置可以看出，如果开发者没有提供 MultipartResolver ，那么默认采用的 MultipartResolver 就是 StandardServletMultipartResolver 。因此上传文件甚至可以做到零配置。

单文件上传

首先创建 Spring Boot 项目并添加 spring-boot-starter-web 依赖，然后在 resources 目录下的 static 目录中创建一个 upload.html 文件，内容如下：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>文件上传</title>
</head>
<body>
<form action="/upload" method="post" enctype="multipart/form-data">
    <input type="file" name="uploadFile" value="请选择文件">
    <input type="submit" value="上传">
</form>
</body>
</html>

接着创建文件上传处理接口，代码如下：

@RestController
public class FileUploadController {
    SimpleDateFormat sdf = new SimpleDateFormat("yyyy/MM/dd");
    @PostMapping("/upload")
    public String upload (MultipartFile uploadFile, HttpServletRequest request)  {
        // 原书中是这个上传路径，但是实际上是个虚拟Tomcat的路径，后面无法访问到
        // String realPath = request.getSession().getServletContext().getRealPath("/uploadFile/");
        // 根据实际情况灵活配置上传路径
        String realPath = ClassUtils.getDefaultClassLoader().getResource("").getPath() + "/static/uploadFile/";
        String format = sdf.format(new Date());
        // 设置保存路径为项目运行目录下的uploadFile文件夹，并在文件夹中通过日期对上传的文件归类保存
        File file = new File(realPath + format);
        if (!file.isDirectory()){
            file.mkdirs();
        }
        // 文件重命名，避免文件重名
        String oldName = uploadFile.getOriginalFilename();
        String newName = UUID.randomUUID().toString()+oldName.substring(oldName.lastIndexOf("."),oldName.length());
        try {
            // 文件保存操作
            File file1 = new File(file, newName);
            uploadFile.transferTo(file1);
            // 生成上传文件的访问路径，并返回
            String filePath = request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort() + "/uploadFile/" + format + "/" + newName;
            return filePath;
        }catch (Exception e){
            e.printStackTrace();
        }
        return "上传失败";
    }
}

注意：接口参数名要与html 中input 标签的 name 属性保持一致

运行项目，访问"http://localhost:8081/upload.html"，进行文件上传，如图

单击“选择文件”按钮上传文件，文件上传成功后会返回上传文件的访问路径，如图

在浏览器中访问返回的路径

也可以对文件上传的细节进行配置，如下

# 是否开启文件上传，默认true
spring.servlet.multipart.enabled=true
# 写入磁盘的阈值，默认0
spring.servlet.multipart.file-size-threshold=0
# 上传文件的临时保存位置
spring.servlet.multipart.location=E:\\Gitee\\my-work-space\\chapter01\\tmp
# 单文件上传大小限制
spring.servlet.multipart.max-file-size=1MB
# 多文件上传大小限制
spring.servlet.multipart.max-request-size=10MB
# 文件是否延迟解析，默认false
spring.servlet.multipart.resolve-lazily=false

注意：spring.servlet.multipart.location 为临时保存位置，确保存在此文件夹且不会删除（此项设置不影响前边上传图片的正常访问）

多文件上传

多文件上传和单文件上传基本一致，首先修改HTML文件，如下：

<!DOCTYPE html>
<html lang="en">
<head>
    <meta charset="UTF-8">
    <title>多文件上传</title>
</head>
<body>
<form action="/upload" method="post" enctype="multipart/form-data">
    <!--  注意多了个multiple  -->
    <input type="file" name="uploadFile" multiple>
    <input type="submit" value="上传">
</form>
</body>
</html>

然后修改控制器参数，如下

   @PostMapping("/upload")
    public String upload (MultipartFile[] uploadFile, HttpServletRequest request) {
        String filePath = "";
        // 遍历文件进行保存操作
        for (int i = 0; i < uploadFile.length; i++) {
            // 原书中是这个上传路径，但是实际上是个虚拟Tomcat的路径，后面无法访问到
            // String realPath = request.getSession().getServletContext().getRealPath("/uploadFile/");
            // 根据实际情况灵活配置上传路径
            String realPath = ClassUtils.getDefaultClassLoader().getResource("").getPath() + "/static/uploadFile/";

            String format = sdf.format(new Date());
            // 设置保存路径为项目运行目录下的uploadFile文件夹，并在文件夹中通过日期对上传的文件归类保存
            File file = new File(realPath + format);
            if (!file.isDirectory()){
                file.mkdirs();
            }
            // 文件重命名，避免文件重名
            String oldName = uploadFile[i].getOriginalFilename();
            String newName = UUID.randomUUID().toString()+oldName.substring(oldName.lastIndexOf("."),oldName.length());
            try {
                // 文件保存操作
                File file1 = new File(file, newName);
                uploadFile[i].transferTo(file1);
                // 生成上传文件的访问路径，并返回
                filePath += request.getScheme() + "://" + request.getServerName() + ":" + request.getServerPort() + "/uploadFile/" + format + "/" + newName + ";";
            }catch (Exception e){
                e.printStackTrace();
            }
        }
        return filePath;
    }
}

@ControllerAdvice

@ControllerAdvice 是 @Controller 的增强版。 @ControllerAdvice 主要用来处理全局数据，一般搭配 @ExceptionHandler 、 @ModelAttribute 以及 @InitBinder 使用

全局异常处理

@ControllerAdvice 最常见的使用场景就是全局异常处理。在4.3章节中文件上传配置，如果超过了限制大小，就会抛出异常，此时可以通过 @ControllerAdvice 结合 @ExceptionHandler 定义全局异常捕获机制，代码如下：

@ControllerAdvice
public class CustomExceptionHandler {
    @ExceptionHandler(MaxUploadSizeExceededException.class)
    public void uploadException(MaxUploadSizeExceededException e , HttpServletResponse response) throws IOException {
        response.setContentType("text/html;charset=utf-8");
        PrintWriter out = response.getWriter();
        out.write("上传文件大小超出限制！");
        out.flush();
        out.close();
    }
}

只需在系统中定义 CustomExceptionHandler 类，然后添加 @ControllerAdvice 注解即可。当项目启动时，该类就会被扫描到 Spring 容器中，然后定义 uploadException 方法，在该方法上添加了 @ExceptionHandler 注解，其中定义的 MaxUploadSizeExceededException.class 表名该方法用来处理 MaxUploadSizeExceededException 类型的异常。如果想让该方法处理所有类型的异常，只需将 MaxUploadSizeExceededException 改为 Exception 即可。方法的参数可以有异常实例、HttpServletResponse 以及 HttpServletRequest 、 Model 等，返回值可以是一段JSON、一个ModelAndView 、一个逻辑视图名等。此时上传一个超大文件会有错误提示给用户，如下：

如果返回参数是一个ModelAndView，假设使用的页面模版为 Thymeleaf （注意添加相关依赖），此时异常处理方法定义如下：

    @ExceptionHandler(MaxUploadSizeExceededException.class)
    public ModelAndView uploadException(MaxUploadSizeExceededException e) {
        ModelAndView mv = new ModelAndView();
        mv.addObject("msg","上传文件大小超出限制！");
        mv.setViewName("error");
        return mv;
    }

然后在 resources/templages 目录下创建error.html 文件，内容如下：

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

重启项目，查看效果

添加全局数据

@ControllerAdvice 是一个全局数据处理组件，因此也可以在 @ControllerAdvice 配置全局数据，代码如下

@ControllerAdvice
public class GlobalConfig {
    @ModelAttribute(value = "info")
    public Map<String,String> userInfo(){
        HashMap<String, String> map = new HashMap<>();
        map.put("username","唐三");
        map.put("sex","男");
        return map;
    }
}

代码解释：

在全局配置中添加 userInfo 方法，返回一个map。该方法有一个注解 @ModelAttribute ，其中 value 的属性表示这条返回数据的 key ，而方法的返回值是返回数据的 value
此时在任意请求的 Controller 中，通过方法参数中的Model 都可以获取 info 的数据

Controller 示例代码如下：

@GetMapping("/hello")
public void hello(Model model){
    Map<String, Object> map = model.asMap();
    Set<String> keySet = map.keySet();
    Iterator<String> iterator = keySet.iterator();
    while (iterator.hasNext()){
        String key = iterator.next();
        Object value = map.get(key);
        System.out.println(key + ">>>>" + value);
    }
}

访问接口，打印如下：

info>>>>{sex=男, username=唐三}

请求参数预处理

@ControllerAdvice 结合 @InitBinder 还能实现请求参数预处理，即将表单中的数据绑定到实体类上时进行一些额外处理。

例如有两个实体类 Book 和 Author ，代码如下：

public class Book {
    private String name;
    private String author;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public String getAuthor() {
        return author;
    }
    public void setAuthor(String author) {
        this.author = author;
    }
}

public class Author {
    private String name;
    private int age;
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public int getAge() {
        return age;
    }
    public void setAge(int age) {
        this.age = age;
    }
}

在 Controller 上需要接收两个实体类的数据，Controller 中的方法定义如下：

@GetMapping(value = "/book")
public String books(Book book, Author author){
    return book.toString() + ">>>" + author.toString();
}

此时在参数传递时，两个实体类中的 name 属性会混淆，@ControllerAdvice 结合 @InitBinder 可以顺利解决问题。配置步骤如下。

先给Controller 中方法的参数添加 @ModelAttribute 注解，代码如下：

@GetMapping(value = "/book")
public String books(@ModelAttribute("b") Book book, @ModelAttribute("a") Author author){
    return book.toString() + ">>>" + author.toString();
}

然后配置 @ControllerAdvice ，代码如下：

@ControllerAdvice
public class GlobalConfig {
    @InitBinder("b")
    public void init1 (WebDataBinder binder){
        binder.setFieldDefaultPrefix("b.");
    }
    @InitBinder("a")
    public void init2 (WebDataBinder binder){
        binder.setFieldDefaultPrefix("a.");
    }
}

代码解释：

在 GlobalConfig 类中创建两个方法，第一个 @InitBinder(“b”) 标识该方法是处理 @ModelAttribute(“b”) 对应的参数的，第二个 @InitBinder(“b”) 是处理 @ModelAttribute(“a”) 对应的参数的
在每个方法中给相应的 Filed 设置一个前缀，然后在浏览器中请求 “http://localhost:8081?b.name=斗罗大陆&b.author=唐家三少&a.name=唐三&a.age=18”，即可成功区分出name属性
在WebDataBinder 对象中，还可以设置允许的字段、禁止的字段、必填字段一级验证器等

到此这篇关于SpringBoot整合Web开发之文件上传与@ControllerAdvice的文章就介绍到这了,更多相关SpringBoot文件上传内容请搜索我们以前的文章或继续浏览下面的相关文章希望大家以后多多支持我们！

Java全面深入探究SpringBoot拦截器与文件上传

目录拦截器拦截器的概念拦截器的配置配置拦截器拦截器的原理文件上传更改文件上传大小拦截器拦截器的概念动态拦截Actioon调用的对象,使开发者在一个Actioon执行的前后执行一段代码,也可以在Action执行前阻止其执行,同时也提供了一种可以提取Action中可重用部分代码的方式. 作用: 动态拦截Action调用的对象(也就是实际项目中的controller层的接口) 一般拦截器用于对用户访问的限制.如当用户没有登录时访问主页面,则可以使用拦截器进行拦截并重定向到登录页面.
SpringBoot @ControllerAdvice 拦截异常并统一处理

在spring 3.2中,新增了@ControllerAdvice 注解,可以用于定义@ExceptionHandler.@InitBinder.@ModelAttribute,并应用到所有@RequestMapping中.参考:@ControllerAdvice 文档一.介绍创建 MyControllerAdvice,并添加 @ControllerAdvice注解. package com.sam.demo.controller; import org.springframework.ui
springboot大文件上传、分片上传、断点续传、秒传的实现

对于大文件的处理,无论是用户端还是服务端,如果一次性进行读取发送.接收都是不可取,很容易导致内存问题.所以对于大文件上传,采用切块分段上传,从上传的效率来看,利用多线程并发上传能够达到最大效率. 本文是基于 springboot + vue 实现的文件上传,本文主要介绍服务端实现文件上传的步骤及代码实现,vue的实现步骤及实现请移步本人的另一篇文章 vue 大文件分片上传 - 断点续传.并发上传上传分步: 本人分析上传总共分为: 检查文件是否已上传,如已上传可实现秒传创建临时文件(._tmp
SpringBoot实现简单文件上传功能

通过 SpringBoot 实现了表单下的文件上传,前后端分离情况下的文件上传.本案例不连接数据库,只做基本的文件上传操作. 在 SpringBoot 中不需要额外导入其他依赖,正常引入即可. 后端 controller 的写法 package com.dailyblue.java.controller; import org.springframework.util.ResourceUtils; import org.springframework.web.bind.annotation.
SpringBoot实现文件上传与下载功能的示例代码

目录 Spring Boot文件上传与下载举例说明 1.引入Apache Commons FileUpload组件依赖 2.设置上传文件大小限制 3.创建选择文件视图页面 4.创建控制器 5.创建文件下载视图页面 6.运行 Spring Boot文件上传与下载在实际的Web应用开发中,为了成功上传文件,必须将表单的method设置为post,并将enctype设置为multipart/form-data.只有这种设置,浏览器才能将所选文件的二进制数据发送给服务器. 从Servlet 3.0开
SpringBoot整合Web开发之文件上传与@ControllerAdvice

目录本章概要文件上传单文件上传多文件上传 @ControllerAdvice 全局异常处理添加全局数据请求参数预处理本章概要文件上传 @ControllerAdvice 文件上传 Java 中的文件上传一共涉及两个组件,一个是 CommonsMultipartResolver,另一个是 StandardServletMultipartResolver ,其中 CommonsMultipartResolver 使用 commons-fileupload 来处理 multipart
SpringBoot集成FastDFS依赖实现文件上传的示例

前言对FastDFS文件系统安装后的使用. FastDFS的安装请参考这篇:Docker中搭建FastDFS文件系统(多图) 本文环境:IDEA + JDK1.8 + Maven 本文项目代码:fastdfs_jb51.rar 1.引入依赖简单说一下这个依赖部分,目前大部分都是采用的如下依赖:  <dependency&
使用最小 WEB API 实现文件上传的Swagger支持

目录前言: 一.允许ContentType 二.自定义OperationFilter 前言: 上回,我们使用最小 WEB API 实现文件上传功能< 使用最小 WEB API 实现文件上传会遇到的坑>,虽然客户端访问是正常的,但是当打开 Swagger 页面时,发现是这样的: 没法使用 Swagger 页面测试. 一.允许 Content Type 正常的 Swagger 页面应该是这样的: 看来,我们需要指定 Content Type: app.MapPost("/upl
使用最小 WEB API 实现文件上传会遇到的坑

目录前言: 一.实现代码二.允许ContentType 三.惊现BUG 四.解决方案结论: 前言: 在 .NET 6 之前,实现文件上传功能十分简单: [HttpPost("upload")] public async Task<IActionResult> Upload(IFormFile file) { //对file执行操作 return Ok(file.FileName); } 但是,当使用 .NET 6 的最小 WEB API 来实现相同功能
SpringBoot+微信小程序实现文件上传与下载功能详解

目录 1.文件上传 1.1 后端部分 1.2 小程序前端部分 1.3 实现效果 2.文件下载 2.1 后端部分 2.2 小程序前端部分 2.3 实现效果 1.文件上传 1.1 后端部分 1.1.1 引入Apache Commons FIleUpload组件依赖  <dependency> <groupId>commons-fileupload</groupId> <artifactId>commons-fil
SpringBoot集成SFTP客户端实现文件上传下载实例

目录背景依赖创建工具类 SFTP链接池化 SFTP链接池的使用集成到SpringBoot中配置 java Bean注入背景在项目开发中,一般文件存储很少再使用SFTP服务,但是也不排除合作伙伴使用SFTP来存储项目中的文件或者通过SFTP来实现文件数据的交互. 我遇到的项目中,就有银行和保险公司等合作伙伴通过SFTP服务来实现与我们项目的文件数据的交互. 为了能够顺利地完成与友商的SFTP服务的连通,我们需要在自己的项目中实现一套SFTP客户端工具.一般我们会采用Jsch来实现SF
SpringBoot整合腾讯云COS对象存储实现文件上传的示例代码

目录 1.开通腾讯云对象存储服务 2.创建存储桶 3.密钥管理,新建密钥 4.yml配置密钥.COS信息 5.COSConfig配置类 6.COS文件上传工具类 7.Controller测试上传接口: 8.PostMan接口调用 9.浏览器预览效果企业级项目开发中都会有文件.图片.视频等文件上传并能够访问的场景,对于初学者Demo可能会直接存储在应用服务器上:对于传统项目可能会单独搭建FastDFS.MinIO等文件服务来实现存储,这种方案可能对于企业成本较小,但缺点也是很多,例如:1.增加技
springboot操作阿里云OSS实现文件上传,下载,删除功能

参考资料:Java操作阿里云OSS操作官方文档学会看文档,并实际运用也是一种习惯和技能下面就来简单入门一下,用当下比较热门的Springboot 去操作阿里云OSS文件存储. 1.需求 (没踩过下面的坑的小伙伴可以直接跳过这一章节) 问题简述首先,我在之前自己做一些开源小项目案例中遇到一些文件上传下载的问题,比如在本机文件上传和下载都可以正常使用,通过将文件上传到Springboot项目的根目录下,按日期分文件夹,文件访问也很方便,可以直接返回文件相对路径地址,并直接可以访问. 问题然而
java组件commons-fileupload文件上传示例

文件上传在Web应用中非常普遍,要在Java Web环境中实现文件上传功能非常容易,因为网上已经有许多用Java开发的组件用于文件上传,本文以使用最普遍的commons-fileupload组件为例,演示如何为Java Web应用添加文件上传功能. commons-fileupload组件是Apache的一个开源项目之一,可以从http://commons.apache.org/fileupload/下载.该组件简单易用,可实现一次上传一个或多个文件,并可限制文件大小. 下载后解压zip包,将c
Spring Boot实现文件上传示例代码

使用SpringBoot进行文件上传的方法和SpringMVC差不多,本文单独新建一个最简单的DEMO来说明一下. 主要步骤包括: 1.创建一个springboot项目工程,本例名称(demo-uploadfile). 2.配置 pom.xml 依赖. 3.创建和编写文件上传的 Controller(包含单文件上传和多文件上传). 4.创建和编写文件上传的 HTML 测试页面. 5.文件上传相关限制的配置(可选). 6.运行测试. 项目工程截图如下: 文件代码: <dependencies>