Servlet ファイルアップロード
Servlet は HTML の form タグと組み合わせて使用でき、ユーザーがサーバーにファイルをアップロードできるようにします。アップロードされるファイルは、テキストファイル、画像ファイル、または任意のドキュメントです。
この記事で使用するファイルは次のとおりです：
- upload.jsp：ファイルアップロードフォーム。
- message.jsp：アップロード成功後に遷移するページ。
- UploadServlet.java：アップロード処理用 Servlet。
- 導入が必要な jar ファイル：commons-fileupload-1.3.2、commons-io-2.5.jar。
構成図は次のとおりです：
注意：Servlet 3.0 にはファイルアップロード機能が組み込まれており、開発者は Commons FileUpload コンポーネントをプロジェクトにインポートする必要がなくなりました。
次に詳しく説明します。
ファイルアップロードフォームを作成する
以下の HTML コードはファイルアップロードフォームを作成します。以下の点に注意してください：
- フォームmethod属性は次のように設定する必要がありますPOSTメソッド。GET メソッドは使用できません。
- フォームenctype属性は次のように設定する必要がありますmultipart/form-data.
- フォームaction属性は、バックエンドサーバーでファイルアップロードを処理する Servlet ファイルに設定する必要があります。次の例ではUploadServletServlet を使用してファイルをアップロードします。
- 単一のファイルをアップロードするには、属性 type="file" を持つ単一の <input .../> タグを使用する必要があります。複数のファイルのアップロードを許可するには、name 属性の値が異なる複数の input タグを含めてください。入力タグはそれぞれ異なる name 属性の値を持ちます。ブラウザは各 input タグに参照ボタンを関連付けます。
upload.jsp ファイルのコードは次のとおりです：
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>文件上传实例 - サンプル</title>
</head>
<body>
<h1>文件上传实例 - サンプル</h1>
<form method="post" action="../TomcatTest/UploadServlet" enctype="multipart/form-data">
选择一个文件:
<input type="file" name="uploadFile" />
<br/><br/>
<input type="submit" value="上传" />
</form>
</body>
</html>
バックエンド Servlet を記述する
以下は UploadServlet のソースコードで、ファイルアップロードを処理します。その前に、依存パッケージがプロジェクトの WEB-INF/lib ディレクトリに導入されていることを確認してください：
- 以下の例は FileUpload に依存しているため、クラスパスに最新バージョンが存在することを必ず確認してください。commons-fileupload.x.x.jarファイル。以下からダウンロードできます。http://commons.apache.org/proper/commons-fileupload/ダウンロード。
- FileUpload は Commons IO に依存しているため、クラスパスに最新バージョンが存在することを必ず確認してください。commons-io-x.x.jarファイル。以下からダウンロードできます。http://commons.apache.org/proper/commons-io/ダウンロード。
このサイトが提供する2つの依存パッケージを直接ダウンロードできます：
- commons-fileupload-1.3.2.jar
- commons-io-2.5.jar
UploadServlet のソースコードは次のとおりです：
package com.サンプル.test;
import java.io.File;
import java.io.IOException;
import java.io.PrintWriter;
import java.util.List;
import javax.servlet.ServletException;
import javax.servlet.annotation.WebServlet;
import javax.servlet.http.HttpServlet;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.HttpServletResponse;
import org.apache.commons.fileupload.FileItem;
import org.apache.commons.fileupload.disk.DiskFileItemFactory;
import org.apache.commons.fileupload.servlet.ServletFileUpload;
/**
* Servlet implementation class UploadServlet
*/
@WebServlet("/UploadServlet")
public class UploadServlet extends HttpServlet {
private static final long serialVersionUID = 1L;
// 上传文件存储目录
private static final String UPLOAD_DIRECTORY = "upload";
// 上传配置
private static final int MEMORY_THRESHOLD = 1024 * 1024 * 3; // 3MB
private static final int MAX_FILE_SIZE = 1024 * 1024 * 40; // 40MB
private static final int MAX_REQUEST_SIZE = 1024 * 1024 * 50; // 50MB
/**
* 上传数据及保存文件
*/
protected void doPost(HttpServletRequest request,
HttpServletResponse response) throws ServletException, IOException {
// 检测是否为多媒体上传
if (!ServletFileUpload.isMultipartContent(request)) {
// 如果不是则停止
PrintWriter writer = response.getWriter();
writer.println("Error: 表单必须包含 enctype=multipart/form-data");
writer.flush();
return;
}
// 配置上传参数
DiskFileItemFactory factory = new DiskFileItemFactory();
// 设置内存临界值 - 超过后将产生临时文件并存储于临时目录中
factory.setSizeThreshold(MEMORY_THRESHOLD);
// 设置临时存储目录
factory.setRepository(new File(System.getProperty("java.io.tmpdir")));
ServletFileUpload upload = new ServletFileUpload(factory);
// 设置最大文件上传值
upload.setFileSizeMax(MAX_FILE_SIZE);
// 设置最大请求值 (包含文件和表单数据)
upload.setSizeMax(MAX_REQUEST_SIZE);
// 中文处理
upload.setHeaderEncoding("UTF-8");
// 构造临时路径来存储上传的文件
// 这个路径相对当前应用的目录
String uploadPath = request.getServletContext().getRealPath("./") + File.separator + UPLOAD_DIRECTORY;
// 如果目录不存在则创建
File uploadDir = new File(uploadPath);
if (!uploadDir.exists()) {
uploadDir.mkdir();
}
try {
// 解析请求的内容提取文件数据
@SuppressWarnings("unchecked")
List<FileItem> formItems = upload.parseRequest(request);
if (formItems != null && formItems.size() > 0) {
// 迭代表单数据
for (FileItem item : formItems) {
// 处理不在表单中的字段
if (!item.isFormField()) {
String fileName = new File(item.getName()).getName();
String filePath = uploadPath + File.separator + fileName;
File storeFile = new File(filePath);
// 在控制台输出文件的上传路径
System.out.println(filePath);
// 保存文件到硬盘
item.write(storeFile);
request.setAttribute("message",
"文件上传成功!");
}
}
}
} catch (Exception ex) {
request.setAttribute("message",
"错误信息: " + ex.getMessage());
}
// 跳转到 message.jsp
request.getServletContext().getRequestDispatcher("/message.jsp").forward(
request, response);
}
}
message.jsp ファイルのコードは次のとおりです：
<%@ page language="java" contentType="text/html; charset=UTF-8"
pageEncoding="UTF-8"%>
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01 Transitional//EN"
"http://www.w3.org/TR/html4/loose.dtd">
<html>
<head>
<meta http-equiv="Content-Type" content="text/html; charset=UTF-8">
<title>文件上传结果</title>
</head>
<body>
<center>
<h2>${message}</h2>
</center>
</body>
</html>
Servlet をコンパイルして実行する
上記の Servlet UploadServlet をコンパイルし、web.xml ファイルに必要なエントリを作成します。次のとおりです：
<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
xmlns="http://java.sun.com/xml/ns/javaee"
xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
xsi:schemaLocation="http://java.sun.com/xml/ns/javaee
http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd"
id="WebApp_ID" version="2.5">
<servlet>
<display-name>UploadServlet</display-name>
<servlet-name>UploadServlet</servlet-name>
<servlet-class>com.サンプル.test.UploadServlet</servlet-class>
</servlet>
<servlet-mapping>
<servlet-name>UploadServlet</servlet-name>
<url-pattern>/TomcatTest/UploadServlet</url-pattern>
</servlet-mapping>
</web-app>
では、上で作成した HTML フォームを使用してファイルをアップロードしてみてください。ブラウザで http://localhost:8080/TomcatTest/upload.jsp にアクセスすると、デモは次のようになります：
