投稿
  1. 簡單一點首頁
  2. 投稿

spring上傳到文件服務器「spring文件上傳大小限制」

投稿專員 • • 投稿

零、本篇要點

  • 介紹SpringBoot對文件上傳的自動配置。
  • 介紹MultipartFile接口。
  • 介紹SpringBoot+Thymeleaf文件上傳demo的整合。
  • 介紹對文件類型，文件名長度等判斷方法。

一、SpringBoot對文件處理相關自動配置

自動配置是SpringBoot為我們提供的便利之一，開發者可以在不作任何配置的情況下，使用SpringBoot提供的默認設置，如處理文件需要的MultipartResolver。

@Configuration(proxyBeanMethods = false)
@ConditionalOnClass({ Servlet.class, StandardServletMultipartResolver.class, MultipartConfigElement.class })
@ConditionalOnProperty(prefix = "spring.servlet.multipart", name = "enabled", matchIfMissing = true)
@ConditionalOnWebApplication(type = Type.SERVLET)
@EnableConfigurationProperties(MultipartProperties.class)
public class MultipartAutoConfiguration {

	private final MultipartProperties multipartProperties;

	public MultipartAutoConfiguration(MultipartProperties multipartProperties) {
		this.multipartProperties = multipartProperties;
	}

	@Bean
	@ConditionalOnMissingBean({ MultipartConfigElement.class, CommonsMultipartResolver.class })
	public MultipartConfigElement multipartConfigElement() {
		return this.multipartProperties.createMultipartConfig();
	}

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

}
  • Spring3.1之後支持StandardServletMultipartResolver，且默認使用StandardServletMultipartResolver，它的優點在於：使用Servlet所提供的功能支持，不需要依賴任何其他的項目。
  • 想要自動配置生效，需要配置spring.servlet.multipart.enabled=true，當然這個配置默認就是true。
  • 相關的配置設置在MultipartProperties中，其中字段就是對應的屬性設置，經典字段有：enabled：是否開啟文件上傳自動配置，默認開啟。location：上傳文件的臨時目錄。maxFileSize：最大文件大小，以字節為單位，默認為1M。maxRequestSize：整個請求的最大容量，默認為10M。fileSizeThreshold：文件大小達到該閾值，將寫入臨時目錄，默認為0，即所有文件都會直接寫入磁盤臨時文件中。resolveLazily：是否惰性處理請求，默認為false。
  • 我們也可以自定義處理的細節，需要實現MultipartResolver接口。

二、處理上傳文件MultipartFile接口

SpringBoot為我們提供了MultipartFile強大接口，讓我們能夠獲取上傳文件的詳細信息，如原始文件名，內容類型等等，接口內容如下：

public interface MultipartFile extends InputStreamSource {
    String getName(); //獲取參數名
    @Nullable
    String getOriginalFilename();//原始的文件名
    @Nullable
    String getContentType();//內容類型
    boolean isEmpty();
    long getSize(); //大小
    byte[] getBytes() throws IOException;// 獲取字節數組
    InputStream getInputStream() throws IOException;//以流方式進行讀取
    default Resource getResource() {
        return new MultipartFileResource(this);
    }
    // 將上傳的文件寫入文件系統
    void transferTo(File var1) throws IOException, IllegalStateException;
	// 寫入指定path
    default void transferTo(Path dest) throws IOException, IllegalStateException {
        FileCopyUtils.copy(this.getInputStream(), Files.newOutputStream(dest));
    }
}

三、SpringBoot+Thymeleaf整合demo

1、編寫控制器

/**
 * 文件上傳
 *
 * @author Summerday
 */
@Controller
public class FileUploadController {

    private static final String UPLOADED_FOLDER = System.getProperty("user.dir");

    @GetMapping("/")
    public String index() {
        return "file";
    }

    @PostMapping("/upload")
    public String singleFileUpload(@RequestParam("file") MultipartFile file,
                                   RedirectAttributes redirectAttributes) throws IOException {

        if (file.isEmpty()) {
            redirectAttributes.addFlashAttribute("msg", "文件為空,請選擇你的文件上傳");
            return "redirect:uploadStatus";

        }
        saveFile(file);
        redirectAttributes.addFlashAttribute("msg", "上傳文件" + file.getOriginalFilename() + "成功");
        redirectAttributes.addFlashAttribute("url", "/upload/" + file.getOriginalFilename());
        return "redirect:uploadStatus";
    }

    private void saveFile(MultipartFile file) throws IOException {
        Path path = Paths.get(UPLOADED_FOLDER + "/" + file.getOriginalFilename());
        file.transferTo(path);
    }

    @GetMapping("/uploadStatus")
    public String uploadStatus() {
        return "uploadStatus";
    }
}

2、編寫頁面file.html

<html xmlns:th="http://www.thymeleaf.org">
    <!--suppress ALL-->
<html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>文件上傳界面</title>
    </head>
    <body>
        <div>
            <form method="POST" enctype="multipart/form-data" action="/upload">
                <table>
                    <tr><td><input type="file" name="file" /></td></tr>
                    <tr><td></td><td><input type="submit" value="上傳" /></td></tr>
                </table>
            </form>

        </div>
    </body>
</html>

3、編寫頁面uploadStatus.html

<!--suppress ALL-->
<html xmlns:th="http://www.thymeleaf.org">

<html lang="en">
    <head>
        <meta charset="UTF-8">
        <title>文件上傳界面</title>
    </head>
    <body>
        <div th:if="${msg}">
            <h2 th:text="${msg}"/>
        </div>
        <div >
            <img src="" th:src="${url}" alt="">
        </div>
    </body>
</html>

4、編寫配置

server.port=8081
spring.servlet.multipart.max-file-size=10MB
spring.servlet.multipart.max-request-size=10MB

5、配置虛擬路徑映射

這一步是非常重要的，我們將文件上傳到服務器上時，我們需要將我們的請求路徑和服務器上的路徑進行對應，不然很有可能文件上傳成功，但訪問失敗：

@Configuration
public class MvcConfig implements WebMvcConfigurer {

    private static final String UPLOADED_FOLDER = System.getProperty("user.dir");

    @Override
    public void addResourceHandlers(ResourceHandlerRegistry registry) {
        registry.addResourceHandler("/upload/**")
                .addResourceLocations("file:///" + UPLOADED_FOLDER + "/");
    }
}

對應關係需要自己去定義，如果訪問失敗，可以試着打印以下路徑，看看是否缺失了路徑分隔符。

注意：如果addResourceHandler不要寫成處理/**，這樣會攔截掉其他的請求

6、測試頁面

執行mvn spring-boot:run，啟動程序，訪問http://localhost:8081/，選擇文件，點擊上傳按鈕，我們的項目目錄下出現了mongo.jpg，並且頁面也成功顯示：

利用SpirngBoot實現文件上傳功能

四、SpringBoot的Restful風格，返回url

/**
 * 文件上傳
 *
 * @author Summerday
 */
@RestController
public class FileUploadRestController {

    /**
     * 文件名長度
     */
    private static final int DEFAULT_FILE_NAME_LENGTH = 100;

    /**
     * 允許的文件類型
     */
    private static final String[] ALLOWED_EXTENSIONS = {
            "jpg", "img", "png", "gif"
    };

    /**
     * 項目路徑
     */
    private static final String UPLOADED_FOLDER = System.getProperty("user.dir");

    @PostMapping("/restUpload")
    public Map<String,Object> singleFileUpload(@RequestParam("file") MultipartFile file) throws Exception {

        if (file.isEmpty()) {
            throw new Exception("文件為空!");
        }
        String filename = upload(file);
        String url = "/upload/" + filename;
        Map<String,Object> map = new HashMap<>(2);
        map.put("msg","上傳成功");
        map.put("url",url);
        return map;
    }


    /**
     * 上傳方法
     */
    private String upload(MultipartFile file) throws Exception {
        int len = file.getOriginalFilename().length();
        if (len > DEFAULT_FILE_NAME_LENGTH) {
            throw new Exception("文件名超出限制!");
        }
        String extension = getExtension(file);
        if(!isValidExtension(extension)){
            throw new Exception("文件格式不正確");
        }
        // 自定義文件名
        String filename = getPathName(file);
        // 獲取file對象
        File desc = getFile(filename);
        // 寫入file
        file.transferTo(desc);
        return filename;
    }

    /**
     * 獲取file對象
     */
    private File getFile(String filename) throws IOException {
        File file = new File(UPLOADED_FOLDER + "/" + filename);
        if(!file.getParentFile().exists()){
            file.getParentFile().mkdirs();
        }
        if(!file.exists()){
            file.createNewFile();
        }
        return file;
    }

    /**
     * 驗證文件類型是否正確
     */
    private boolean isValidExtension(String extension) {
        for (String allowedExtension : ALLOWED_EXTENSIONS) {
            if(extension.equalsIgnoreCase(allowedExtension)){
                return true;
            }
        }
        return false;
    }

    /**
     * 此處自定義文件名,uuid + extension
     */
    private String getPathName(MultipartFile file) {
        String extension = getExtension(file);
        return UUID.randomUUID().toString() + "." + extension;
    }

    /**
     * 獲取擴展名
     */
    private String getExtension(MultipartFile file) {
        String originalFilename = file.getOriginalFilename();
        return originalFilename.substring(originalFilename.lastIndexOf('.') + 1);
    }
}

原創文章，作者：投稿專員，如若轉載，請註明出處：https://www.506064.com/zh-hant/n/205548.html

贊 (0)
打賞 微信掃一掃 微信掃一掃 支付寶掃一掃 支付寶掃一掃
投稿專員的頭像投稿專員
0 0
上一篇 2024-12-07 17:47
下一篇 2024-12-07 17:47

相關推薦

發表回復

登錄後才能評論