Spring MVCのファイルアップロードの例題チュートリアル – 単一ファイルと複数ファイル
ファイルのアップロードは、どんなウェブアプリケーションでも非常に一般的なタスクです。以前はServletとStruts2でのファイルのアップロード方法を見てきました。今日は、Springのファイルアップロードについて学びます。具体的には、Spring MVCを使用したシングルファイルと複数ファイルのアップロード方法です。
Spring MVCのファイルアップロード
Spring MVCフレームワークは、Apache Commons FileUpload APIを統合することにより、ファイルのアップロードをサポートしています。ファイルをアップロードするプロセスは非常に簡単で、簡単な設定が必要です。以下の画像のように、STSでシンプルなSpring MVCプロジェクトを作成します。ほとんどの部分はSTSツールによって生成されたテンプレートのコードですが、Springのファイルアップロード統合を利用するために必要な変更に焦点を当てます。
Apache Commons FileUploadのためのMavenの依存関係
まず、Webアプリケーションに必要なjarファイルが含まれるように、pom.xmlファイルにApache Commons FileUploadの依存関係を追加する必要があります。以下は私のpom.xmlファイルからの依存性のスニペットです。
<!-- Apache Commons FileUpload -->
<dependency>
<groupId>commons-fileupload</groupId>
<artifactId>commons-fileupload</artifactId>
<version>1.3.1</version>
</dependency>
<!-- Apache Commons IO -->
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.4</version>
</dependency>
Springのファイルアップロードフォームビュー
私たちは、Spring Webアプリケーションで単一および複数のファイルをアップロードできるようにするために、JSPページを2つ作成します。upload.jspのビューコードです。
<%@ taglib uri="https://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ page session="false" %>
<html>
<head>
<title>Upload File Request Page</title>
</head>
<body>
<form method="POST" action="uploadFile" enctype="multipart/form-data">
File to upload: <input type="file" name="file"><br />
Name: <input type="text" name="name"><br /> <br />
<input type="submit" value="Upload"> Press here to upload the file!
</form>
</body>
</html>
【Japanese】
アップロードマルチパートの.jsp表示コード：
<%@ taglib uri="https://java.sun.com/jsp/jstl/core" prefix="c" %>
<%@ page session="false" %>
<html>
<head>
<title>Upload Multiple File Request Page</title>
</head>
<body>
<form method="POST" action="uploadMultipleFile" enctype="multipart/form-data">
File1 to upload: <input type="file" name="file"><br />
Name1: <input type="text" name="name"><br /> <br />
File2 to upload: <input type="file" name="file"><br />
Name2: <input type="text" name="name"><br /> <br />
<input type="submit" value="Upload"> Press here to upload the file!
</form>
</body>
</html>
これらのファイルは単純なHTMLファイルであることに注意してください。JSPやSpringのタグを使用せずに複雑さを避けています。重要なポイントは、formのenctypeがmultipart/form-dataであることです。これにより、Spring Webアプリケーションはリクエストがファイルデータを含んでいると認識し、処理することができます。また、複数のファイルの場合、入力フィールドの「file」と「name」は同じであることに注意してください。これにより、データは配列形式で送信されます。入力配列を取り、ファイルデータを解析し、指定されたファイル名で保存します。
Spring MVCのマルチパート構成
マルチパートリクエストの処理にApache Commons FileUploadを使用するには、multipartResolverビーンをorg.springframework.web.multipart.commons.CommonsMultipartResolverクラスで構成するだけで十分です。最終的なSpringの設定ファイルは下記のようになります。 servlet-context.xmlのコード:
<?xml version="1.0" encoding="UTF-8"?>
<beans:beans xmlns="https://www.springframework.org/schema/mvc"
xmlns:xsi="https://www.w3.org/2001/XMLSchema-instance" xmlns:beans="https://www.springframework.org/schema/beans"
xmlns:context="https://www.springframework.org/schema/context"
xsi:schemaLocation="https://www.springframework.org/schema/mvc https://www.springframework.org/schema/mvc/spring-mvc.xsd
https://www.springframework.org/schema/beans https://www.springframework.org/schema/beans/spring-beans.xsd
https://www.springframework.org/schema/context https://www.springframework.org/schema/context/spring-context.xsd">
<!-- DispatcherServlet Context: defines this servlet's request-processing
infrastructure -->
<!-- Enables the Spring MVC @Controller programming model -->
<annotation-driven />
<!-- Handles HTTP GET requests for /resources/** by efficiently serving
up static resources in the ${webappRoot}/resources directory -->
<resources mapping="/**" location="/" />
<!-- Resolves views selected for rendering by @Controllers to .jsp resources
in the /WEB-INF/views directory -->
<beans:bean
class="org.springframework.web.servlet.view.InternalResourceViewResolver">
<beans:property name="prefix" value="/WEB-INF/views/" />
<beans:property name="suffix" value=".jsp" />
</beans:bean>
<beans:bean id="multipartResolver"
class="org.springframework.web.multipart.commons.CommonsMultipartResolver">
<!-- setting maximum upload size -->
<beans:property name="maxUploadSize" value="100000" />
</beans:bean>
<context:component-scan base-package="com.scdev.spring.controller" />
</beans:beans>
multipartResolverという名前のMultipartResolver変数が以下のメソッドで定義され、初期化されていることが、DispatcherServletクラスのソースコードを見ればわかる。また、maxUploadSizeプロパティの値を提供することで、multipartResolverビーンに最大アップロードサイズ制限を設定していることに注意してください。
private void initMultipartResolver(ApplicationContext context)
{
try
{
this.multipartResolver = ((MultipartResolver)context.getBean("multipartResolver", MultipartResolver.class));
if (this.logger.isDebugEnabled()) {
this.logger.debug("Using MultipartResolver [" + this.multipartResolver + "]");
}
}
catch (NoSuchBeanDefinitionException ex)
{
this.multipartResolver = null;
if (this.logger.isDebugEnabled())
this.logger.debug("Unable to locate MultipartResolver with name 'multipartResolver': no multipart request handling provided");
}
}
この構成では、multipart/form-dataとしてenctypeを持つすべてのリクエストが、Controllerクラスに渡される前に、multipartResolverによって処理されます。
春のファイルアップロードコントローラークラス
コントローラのクラスコードは非常にシンプルであり、uploadFile と uploadMultipleFile のためのハンドラーメソッドを定義する必要があります。FileUploadController.java のコードです。
package com.scdev.spring.controller;
import java.io.BufferedOutputStream;
import java.io.File;
import java.io.FileOutputStream;
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.stereotype.Controller;
import org.springframework.web.bind.annotation.RequestMapping;
import org.springframework.web.bind.annotation.RequestMethod;
import org.springframework.web.bind.annotation.RequestParam;
import org.springframework.web.bind.annotation.ResponseBody;
import org.springframework.web.multipart.MultipartFile;
/**
* Handles requests for the application file upload requests
*/
@Controller
public class FileUploadController {
private static final Logger logger = LoggerFactory
.getLogger(FileUploadController.class);
/**
* Upload single file using Spring Controller
*/
@RequestMapping(value = "/uploadFile", method = RequestMethod.POST)
public @ResponseBody
String uploadFileHandler(@RequestParam("name") String name,
@RequestParam("file") MultipartFile file) {
if (!file.isEmpty()) {
try {
byte[] bytes = file.getBytes();
// Creating the directory to store file
String rootPath = System.getProperty("catalina.home");
File dir = new File(rootPath + File.separator + "tmpFiles");
if (!dir.exists())
dir.mkdirs();
// Create the file on server
File serverFile = new File(dir.getAbsolutePath()
+ File.separator + name);
BufferedOutputStream stream = new BufferedOutputStream(
new FileOutputStream(serverFile));
stream.write(bytes);
stream.close();
logger.info("Server File Location="
+ serverFile.getAbsolutePath());
return "You successfully uploaded file=" + name;
} catch (Exception e) {
return "You failed to upload " + name + " => " + e.getMessage();
}
} else {
return "You failed to upload " + name
+ " because the file was empty.";
}
}
/**
* Upload multiple file using Spring Controller
*/
@RequestMapping(value = "/uploadMultipleFile", method = RequestMethod.POST)
public @ResponseBody
String uploadMultipleFileHandler(@RequestParam("name") String[] names,
@RequestParam("file") MultipartFile[] files) {
if (files.length != names.length)
return "Mandatory information missing";
String message = "";
for (int i = 0; i < files.length; i++) {
MultipartFile file = files[i];
String name = names[i];
try {
byte[] bytes = file.getBytes();
// Creating the directory to store file
String rootPath = System.getProperty("catalina.home");
File dir = new File(rootPath + File.separator + "tmpFiles");
if (!dir.exists())
dir.mkdirs();
// Create the file on server
File serverFile = new File(dir.getAbsolutePath()
+ File.separator + name);
BufferedOutputStream stream = new BufferedOutputStream(
new FileOutputStream(serverFile));
stream.write(bytes);
stream.close();
logger.info("Server File Location="
+ serverFile.getAbsolutePath());
message = message + "You successfully uploaded file=" + name
+ "<br />";
} catch (Exception e) {
return "You failed to upload " + name + " => " + e.getMessage();
}
}
return message;
}
}
Springアノテーションの使用に注意し、私たちの生活を楽にし、コードがより読みやすくなることに注目してください。uploadFileHandlerメソッドは、単一ファイルのアップロードシナリオを処理するために使用されますが、uploadMultipleFileHandlerメソッドは複数のファイルのアップロードシナリオを処理するために使用されます。実際には、両方のシナリオを処理するために単一のメソッドを使用することもできます。今、アプリケーションをWARファイルとしてエクスポートし、Tomcatサーブレットコンテナに展開してください。アプリケーションを実行すると、以下の画像がリクエストとレスポンスを表示します。
Spring MVCのファイルアップロードの例
サーバーログをチェックすれば、ファイルが保存された場所がわかります。上記のリンクからプロジェクトをダウンロードし、それを操作してさらに学習しましょう。
スプリングのファイルアップロードプロジェクトをダウンロードしてください。
