SpringBoot整合Web開發(fā)之文件上傳與@ControllerAdvice

更新時(shí)間：2022年08月15日 09:03:37 作者：一只小熊貓呀

@ControllerAdvice注解是Spring3.2中新增的注解,學(xué)名是Controller增強(qiáng)器,作用是給Controller控制器添加統(tǒng)一的操作或處理。對(duì)于@ControllerAdvice,我們比較熟知的用法是結(jié)合@ExceptionHandler用于全局異常的處理,但其作用不止于此

本章概要

文件上傳
@ControllerAdvice

文件上傳

Java 中的文件上傳一共涉及兩個(gè)組件，一個(gè)是 CommonsMultipartResolver，另一個(gè)是 StandardServletMultipartResolver ，其中 CommonsMultipartResolver 使用 commons-fileupload 來處理 multipart 請(qǐng)求，而 StandardServletMultipartResolver 則是基于 Servlet 3.0 來處理。因此若使用 StandardServletMultipartResolver ，則不需要添加額外的 jar 包。Tomcat 7.0 開始就支持 Servlet 3.0 了，而Spring Boot 2.0.4 內(nèi)嵌的 Tomcat 為 Tomcat 8.5.32 ，因此可以直接使用 StandardServletMultipartResolver 。而在 Spring Boot 提供的上傳文件自動(dòng)化配置類 MultipartAutoConfiguration 中，默認(rèn)也是采用 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;
	}

根據(jù)配置可以看出，如果開發(fā)者沒有提供 MultipartResolver ，那么默認(rèn)采用的 MultipartResolver 就是 StandardServletMultipartResolver 。因此上傳文件甚至可以做到零配置。

單文件上傳

首先創(chuàng)建 Spring Boot 項(xiàng)目并添加 spring-boot-starter-web 依賴，然后在 resources 目錄下的 static 目錄中創(chuàng)建一個(gè) upload.html 文件，內(nèi)容如下：

<!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="請(qǐng)選擇文件">
    <input type="submit" value="上傳">
</form>
</body>
</html>

接著創(chuàng)建文件上傳處理接口，代碼如下：

@RestController
public class FileUploadController {
    SimpleDateFormat sdf = new SimpleDateFormat("yyyy/MM/dd");
    @PostMapping("/upload")
    public String upload (MultipartFile uploadFile, HttpServletRequest request)  {
        // 原書中是這個(gè)上傳路徑，但是實(shí)際上是個(gè)虛擬Tomcat的路徑，后面無法訪問到
        // String realPath = request.getSession().getServletContext().getRealPath("/uploadFile/");
        // 根據(jù)實(shí)際情況靈活配置上傳路徑
        String realPath = ClassUtils.getDefaultClassLoader().getResource("").getPath() + "/static/uploadFile/";
        String format = sdf.format(new Date());
        // 設(shè)置保存路徑為項(xiàng)目運(yùn)行目錄下的uploadFile文件夾，并在文件夾中通過日期對(duì)上傳的文件歸類保存
        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 "上傳失敗";
    }
}

注意：接口參數(shù)名要與html 中input 標(biāo)簽的 name 屬性保持一致

運(yùn)行項(xiàng)目，訪問"http://localhost:8081/upload.html"，進(jìn)行文件上傳，如圖

單擊“選擇文件”按鈕上傳文件，文件上傳成功后會(huì)返回上傳文件的訪問路徑，如圖

在瀏覽器中訪問返回的路徑

也可以對(duì)文件上傳的細(xì)節(jié)進(jìn)行配置，如下

# 是否開啟文件上傳，默認(rèn)true
spring.servlet.multipart.enabled=true
# 寫入磁盤的閾值，默認(rèn)0
spring.servlet.multipart.file-size-threshold=0
# 上傳文件的臨時(shí)保存位置
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
# 文件是否延遲解析，默認(rèn)false
spring.servlet.multipart.resolve-lazily=false

注意：spring.servlet.multipart.location 為臨時(shí)保存位置，確保存在此文件夾且不會(huì)刪除（此項(xiàng)設(shè)置不影響前邊上傳圖片的正常訪問）

多文件上傳

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

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

然后修改控制器參數(shù)，如下

   @PostMapping("/upload")
    public String upload (MultipartFile[] uploadFile, HttpServletRequest request) {
        String filePath = "";
        // 遍歷文件進(jìn)行保存操作
        for (int i = 0; i < uploadFile.length; i++) {
            // 原書中是這個(gè)上傳路徑，但是實(shí)際上是個(gè)虛擬Tomcat的路徑，后面無法訪問到
            // String realPath = request.getSession().getServletContext().getRealPath("/uploadFile/");
            // 根據(jù)實(shí)際情況靈活配置上傳路徑
            String realPath = ClassUtils.getDefaultClassLoader().getResource("").getPath() + "/static/uploadFile/";

            String format = sdf.format(new Date());
            // 設(shè)置保存路徑為項(xiàng)目運(yùn)行目錄下的uploadFile文件夾，并在文件夾中通過日期對(duì)上傳的文件歸類保存
            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 的增強(qiáng)版。 @ControllerAdvice 主要用來處理全局?jǐn)?shù)據(jù)，一般搭配 @ExceptionHandler 、 @ModelAttribute 以及 @InitBinder 使用

全局異常處理

@ControllerAdvice 最常見的使用場(chǎng)景就是全局異常處理。在4.3章節(jié)中文件上傳配置，如果超過了限制大小，就會(huì)拋出異常，此時(shí)可以通過 @ControllerAdvice 結(jié)合 @ExceptionHandler 定義全局異常捕獲機(jī)制，代碼如下：

@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();
    }
}

只需在系統(tǒng)中定義 CustomExceptionHandler 類，然后添加 @ControllerAdvice 注解即可。當(dāng)項(xiàng)目啟動(dòng)時(shí)，該類就會(huì)被掃描到 Spring 容器中，然后定義 uploadException 方法，在該方法上添加了 @ExceptionHandler 注解，其中定義的 MaxUploadSizeExceededException.class 表名該方法用來處理 MaxUploadSizeExceededException 類型的異常。如果想讓該方法處理所有類型的異常，只需將 MaxUploadSizeExceededException 改為 Exception 即可。方法的參數(shù)可以有異常實(shí)例、HttpServletResponse 以及 HttpServletRequest 、 Model 等，返回值可以是一段JSON、一個(gè)ModelAndView 、一個(gè)邏輯視圖名等。此時(shí)上傳一個(gè)超大文件會(huì)有錯(cuò)誤提示給用戶，如下：

如果返回參數(shù)是一個(gè)ModelAndView，假設(shè)使用的頁面模版為 Thymeleaf （注意添加相關(guān)依賴），此時(shí)異常處理方法定義如下：

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

然后在 resources/templages 目錄下創(chuàng)建error.html 文件，內(nèi)容如下：

<!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>

重啟項(xiàng)目，查看效果

添加全局?jǐn)?shù)據(jù)

@ControllerAdvice 是一個(gè)全局?jǐn)?shù)據(jù)處理組件，因此也可以在 @ControllerAdvice 配置全局?jǐn)?shù)據(jù)，代碼如下

@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 方法，返回一個(gè)map。該方法有一個(gè)注解 @ModelAttribute ，其中 value 的屬性表示這條返回?cái)?shù)據(jù)的 key ，而方法的返回值是返回?cái)?shù)據(jù)的 value
此時(shí)在任意請(qǐng)求的 Controller 中，通過方法參數(shù)中的Model 都可以獲取 info 的數(shù)據(jù)

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=唐三}

請(qǐng)求參數(shù)預(yù)處理

@ControllerAdvice 結(jié)合 @InitBinder 還能實(shí)現(xiàn)請(qǐng)求參數(shù)預(yù)處理，即將表單中的數(shù)據(jù)綁定到實(shí)體類上時(shí)進(jìn)行一些額外處理。

例如有兩個(gè)實(shí)體類 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 上需要接收兩個(gè)實(shí)體類的數(shù)據(jù)，Controller 中的方法定義如下：

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

此時(shí)在參數(shù)傳遞時(shí)，兩個(gè)實(shí)體類中的 name 屬性會(huì)混淆，@ControllerAdvice 結(jié)合 @InitBinder 可以順利解決問題。配置步驟如下。

先給Controller 中方法的參數(shù)添加 @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 類中創(chuàng)建兩個(gè)方法，第一個(gè) @InitBinder(“b”) 標(biāo)識(shí)該方法是處理 @ModelAttribute(“b”) 對(duì)應(yīng)的參數(shù)的，第二個(gè) @InitBinder(“b”) 是處理 @ModelAttribute(“a”) 對(duì)應(yīng)的參數(shù)的
在每個(gè)方法中給相應(yīng)的 Filed 設(shè)置一個(gè)前綴，然后在瀏覽器中請(qǐng)求 “http://localhost:8081?b.name=斗羅大陸&b.author=唐家三少&a.name=唐三&a.age=18”，即可成功區(qū)分出name屬性
在WebDataBinder 對(duì)象中，還可以設(shè)置允許的字段、禁止的字段、必填字段一級(jí)驗(yàn)證器等

到此這篇關(guān)于SpringBoot整合Web開發(fā)之文件上傳與@ControllerAdvice的文章就介紹到這了,更多相關(guān)SpringBoot文件上傳內(nèi)容請(qǐng)搜索腳本之家以前的文章或繼續(xù)瀏覽下面的相關(guān)文章希望大家以后多多支持腳本之家！

您可能感興趣的文章: