Spring之配置multipartResolver解析器、上傳文件、處理文件過(guò)程

更新時(shí)間：2025年08月08日 09:47:33 作者：CrazyIdeas

文章介紹了Spring中處理multipart表單的兩種解析器（CommonsMultipartResolver和StandardServletMultipartResolver）的配置方法,包括文件大小限制、臨時(shí)存儲(chǔ)路徑設(shè)置,以及通過(guò)enctype和accept屬性控制上傳格式,強(qiáng)調(diào)MultipartFile需配置解析器,而Part接口無(wú)需

配置 StandardServletMultipartResolver 解析器

1、在ApplicationContext 中聲明為 bean：

@Bean
public MultipartResolver multipartResolver(){
    return new StandardServletMultipartResolver();
}

2、在 web.xml 或 Servlet 初始化類中，配置 multipart 的具體細(xì)節(jié)，如：文件大寫，臨時(shí)文件路徑等。

如果已經(jīng)實(shí)現(xiàn)了 WebApplicationInitializer 接口，可以在Servlet registration 上調(diào)用 setMultipartConfig() 方法進(jìn)行配置：

@Override
public void onStartup(ServletContext servletContext) throws ServletException {

    DispatcherServlet dispatcherServlet = new DispatcherServlet();
    ServletRegistration.Dynamic registration = servletContext.addServlet("appServlet", dispatcherServlet);
    registration.addMapping("/");
    registration.setMultipartConfig(new MultipartConfigElement("/tmp/uploads"));
}

若初始化類繼承了AbstractAnnotationConfigDispatcherServletInitializer 或 AbstractDispatcherServletInitializer 通過(guò)重寫 customizeRegistration 方法來(lái)配置 multipart 的具體細(xì)節(jié)

@Override
protected void customizeRegistration(ServletRegistration.Dynamic registration) {
    registration.setMultipartConfig(
            new MultipartConfigElement("/tmp/test/uploads")
    );
}

了解 MultipartConfigElement 類：

new MultipartConfigElement("/tmp/test/uploads",2097152,4194304,0)

指定臨時(shí)存放目錄為/tmp/test/uploads。
上傳文件的最大容量：2097152 = 2MB。
整個(gè) multipart 請(qǐng)求的最大容量 4194304 = 4MB。
文件大寫達(dá)到一定容量，會(huì)寫入臨時(shí)文件路徑中，默認(rèn)是 0，所有上傳的文件都會(huì)寫入磁盤中。

對(duì)應(yīng) 在 web.xml 中的配置：

<servlet>
    <servlet-name>appServlet</servlet-name>
    <servlet-class>org.springframework.web.servlet.DispatcherServlet</servlet-class>
    <load-on-startup>1</load-on-startup>
    <multipart-config>
    	<!-- 臨時(shí)路勁 -->
        <location>/tmp/test/uploads</location>
        <!-- 上傳文件的最大值 -->
        <max-file-size>2097152</max-file-size>
        <!--請(qǐng)求的最大容量-->
        <max-request-size>4194304</max-request-size>
    </multipart-config>
</servlet>

配置 CommonsMultipartResolver 解析器

聲明為 bean

@Bean
public MultipartResolver multipartResolver(){
    return new CommonsMultipartResolver();
}

文件大小，臨時(shí)路徑等在聲明Bean 時(shí)設(shè)置。

 @Bean
public MultipartResolver multipartResolver() throws IOException {
    CommonsMultipartResolver multipartResolver = new CommonsMultipartResolver();
    // 設(shè)置 臨時(shí)目錄
    multipartResolver.setUploadTempDir(new FileSystemResource("/tmp/test/uploads"));
    // 最大文件
    multipartResolver.setMaxUploadSize(2097152);
    
    multipartResolver.setMaxInMemorySize(0);
    return multipartResolver;
}

上傳文件、處理文件

表單的大體樣式：

<form action="" method="post" enctype="multipart/form-data">
    <input type="file" name="picture" accept="image/jpeg">
    <input type="submit" value="提交">
</form>

enctype="multipart/form-data" 告訴瀏覽器以 multipart 數(shù)據(jù)的形式提交表單。
accept="image/jpeg" 限制文件接收的類型為 JPEG。

Controller 上接收上傳的文件

@RequestMapping("/upload")
public String uploadImage(@RequestPart("picture")MultipartFile file) throws IOException {
    // 獲取 文件 名
    String filename = file.getOriginalFilename();
    // 將 上傳的文件 寫入到 文件系統(tǒng)中
    file.transferTo(new File("/data/image"+filename));
    return "index";
}

MultipartFile 接口，為處理 multipart 數(shù)據(jù)提供了內(nèi)容更為豐富的對(duì)象。

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;

    default void transferTo(Path dest) throws IOException, IllegalStateException {
        FileCopyUtils.copy(this.getInputStream(), Files.newOutputStream(dest));
    }
}

可以把 MultipartFile 替換為 Servlet.http.Part

@RequestMapping("/upload")
public String uploadImage(@RequestPart("picture") Part file) throws IOException {
    // 獲取 文件 名
    String filename = file.getSubmittedFileName();
    // 將 上傳的文件 寫入到 文件系統(tǒng)中
    file.write("/data/image"+filename);
    return "index";
}

通過(guò) Part 參數(shù)接收上傳文件，那么沒(méi)有必要配置 MultipartResolver 了。只有使用 MultipartFile 的時(shí)候，才需要配置。