脚本之家 服务器常用软件
快捷导航
您的位置：首页 → 软件编程 → java → SpringBoot文件上传

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

 更新时间：2022年08月15日 09:03:37   作者：一只小熊猫呀  
@ControllerAdvice注解是Spring3.2中新增的注解,学名是Controller增强器,作用是给Controller控制器添加统一的操作或处理。对于@ControllerAdvice,我们比较熟知的用法是结合@ExceptionHandler用于全局异常的处理,但其作用不止于此

本章概要

  • 文件上传
  • @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文件上传内容请搜索脚本之家以前的文章或继续浏览下面的相关文章希望大家以后多多支持脚本之家！

您可能感兴趣的文章:

相关文章

最新评论