使用 JSP/Servlet 将文件上载到服务器 2023

介绍

要浏览并选择要上传的文件,您需要表单中的 HTML 字段。如 HTML 规范中所述,您必须使用该方法,并且表单的属性必须设置为 <input type="file">POSTenctype"multipart/form-data"

<form action="upload" method="post" enctype="multipart/form-data">
    <input type="text" name="description" />
    <input type="file" name="file" />
    <input type="submit" />
</form>

提交此类表单后,二进制多部分表单数据在请求正文中的可用格式与未设置时不同

在 Servlet 3.0(2009 年 12 月)之前,Servlet API 本身并不支持 。它仅支持默认表单 的 enctype 。当使用多部分表单数据时,所有的和对应的都会返回。这就是著名的Apache Commons FileUpload出现的地方。 multipart/form-dataapplication/x-www-form-urlencodedrequest.getParameter()null

不要手动解析它!

理论上,您可以基于 ServletRequest#getInputStream() 自己解析请求正文。然而,这是一项精确而繁琐的工作,需要对 RFC2388 有精确的了解。您不应该尝试自己执行此操作或复制粘贴一些在互联网上其他地方找到的本地无库代码。许多在线资源在这方面都失败了,例如 roseindia.net。另请参阅上传 pdf 文件。你应该使用一个真正的库,它被数百万用户使用(并隐式测试!)多年。这样的库已经证明了它的健壮性。

当您已经在使用 Servlet 3.0 或更高版本时,请使用原生API

如果你至少使用 Servlet 3.0(Tomcat 7、Jetty 9、JBoss AS 6、GlassFish 3 等,它们自 2010 年以来就已经存在),那么你可以使用提供的标准 API HttpServletRequest#getPart() 来收集单个多部分表单数据项(大多数 Servlet 3.0 实现实际上都使用 Apache Commons FileUpload 来掩盖这一点!)。此外,普通表单字段可通过常规方式使用。getParameter()

首先用 @MultipartConfig 注释你的 servlet,以便让它识别和支持请求,从而正常运行。multipart/form-datagetPart()

@WebServlet("/upload")
@MultipartConfig
public class UploadServlet extends HttpServlet {
    // ...
}

然后,按如下方式实现其:doPost()

protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    String description = request.getParameter("description"); // Retrieves <input type="text" name="description">
    Part filePart = request.getPart("file"); // Retrieves <input type="file" name="file">
    String fileName = Paths.get(filePart.getSubmittedFileName()).getFileName().toString(); // MSIE fix.
    InputStream fileContent = filePart.getInputStream();
    // ... (do your job here)
}

注意.这是MSIE对获取文件名的一个修正。这个浏览器错误地将完整的文件路径与文件名一起发送,而不是只发送文件名。Path#getFileName()

如果您想通过任一方式上传多个文件,multiple="true"

<input type="file" name="files" multiple="true" />

或采用老式的多路输入方式。

<input type="file" name="files" />
<input type="file" name="files" />
<input type="file" name="files" />
...

那么你可以按以下方法收集它们(不幸的是,没有像这一样的方法:request.getParts("files"))。

protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    // ...
    List<Part> fileParts = request.getParts().stream().filter(part -> "files".equals(part.getName()) && part.getSize() > 0).collect(Collectors.toList()); // Retrieves <input type="file" name="files" multiple="true">

    for (Part filePart : fileParts) {
        String fileName = Paths.get(filePart.getSubmittedFileName()).getFileName().toString(); // MSIE fix.
        InputStream fileContent = filePart.getInputStream();
        // ... (do your job here)
    }
}

当版本不是 Servlet 3.1以上的版本时,请手动获取提交的文件名

请注意,Part#getSubmittedFileName() 是在 Servlet 3.1 中引入的(Tomcat 8、Jetty 9、WildFly 8、GlassFish 4 等,它们自 2013 年以来就已经存在了)。如果你还没有在 Servlet 3.1 上(真的吗?),那么你需要一个额外的实用程序方法来获取提交的文件名。

private static String getSubmittedFileName(Part part) {
    for (String cd : part.getHeader("content-disposition").split(";")) {
        if (cd.trim().startsWith("filename")) {
            String fileName = cd.substring(cd.indexOf('=') + 1).trim().replace("\"", "");
            return fileName.substring(fileName.lastIndexOf('/') + 1).substring(fileName.lastIndexOf('\\') + 1); // MSIE fix.
        }
    }
    return null;
}
String fileName = getSubmittedFileName(filePart);

注意MSIE对获取文件名的修正。该浏览器错误地将完整的文件路径与文件名一起发送,而不是只发送文件名。

当版本小于Servlet 3.0时,使用Apache Commons FileUpload

如果你还没有使用Servlet 3.0(现在还不升级吗?它是十多年前发布的!),通常的做法是利用Apache Commons FileUpload来解析多个表单数据请求。它有一个很好的用户指南常见问题解答(仔细浏览两者)。还有O’Reilly(“cos”),但它有一些(小)错误,并且多年来不再积极维护。我不建议使用它。Apache Commons FileUpload仍然保持活跃,目前非常成熟。MultipartRequest

为了使用Apache Commons FileUpload,您的web应用程序中至少需要以下文件:/WEB-INF/lib

您最初的尝试失败很可能是因为您忘记了公共 IO。

下面是一个启动示例,在使用Apache Commons FileUpload doPost()UploadServlet 时,您的代码可能是什么样子:

protected void doPost(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
    try {
        List<FileItem> items = new ServletFileUpload(new DiskFileItemFactory()).parseRequest(request);
        for (FileItem item : items) {
            if (item.isFormField()) {
                // Process regular form field (input type="text|radio|checkbox|etc", select, etc).
                String fieldName = item.getFieldName();
                String fieldValue = item.getString();
                // ... (do your job here)
            } else {
                // Process form file field (input type="file").
                String fieldName = item.getFieldName();
                String fileName = FilenameUtils.getName(item.getName());
                InputStream fileContent = item.getInputStream();
                // ... (do your job here)
            }
        }
    } catch (FileUploadException e) {
        throw new ServletException("Cannot parse multipart request.", e);
    }

    // ...
}

非常重要的是,你不要事先在同一个请求中调用 ,,,,,,,,,, 等。否则servlet容器会读取并解析请求体,从而Apache Commons FileUpload会得到一个空的请求体。另见: ServletFileUpload#parseRequest(request) returns an empty list.getParameter()getParameterMap()getParameterValues()getInputStream()getReader()

注意.这是MSIE对获取文件名的一个修正。这个浏览器错误地将完整的文件路径与名称一起发送,而不是只发送文件名。FilenameUtils#getName()

或者,您也可以将所有这些包装在一个自动解析所有内容中,并将内容放回请求的参数映射中,以便您可以继续使用通常的方式并通过.您可以在这篇博客文章中找到一个示例Filterrequest.getParameter()request.getAttribute()

GlassFish3 错误仍返回的解决方法getParameter()null

请注意,早于 3.1.2 的 Glassfish 版本有一个错误,其中仍然返回 .如果您的目标是这样的容器并且无法升级它,则需要借助此实用程序方法从中提取值:getParameter()nullgetPart()

private static String getValue(Part part) throws IOException {
    BufferedReader reader = new BufferedReader(new InputStreamReader(part.getInputStream(), "UTF-8"));
    StringBuilder value = new StringBuilder();
    char[] buffer = new char[1024];
    for (int length = 0; (length = reader.read(buffer)) > 0;) {
        value.append(buffer, 0, length);
    }
    return value.toString();
}
String description = getValue(request.getPart("description")); // Retrieves <input type="text" name="description">

保存上传的文件(请勿使用!getRealPath()part.write()

有关将获得的(如上述代码片段所示的变量)正确保存到磁盘或数据库的详细信息,请参阅以下答案:InputStreamfileContent

为上传的文件提供服务

有关将保存的文件从磁盘或数据库正确提供回客户端的详细信息,请参阅以下答案:

Ajax 格式

前往以下有关如何使用 Ajax(和 jQuery)上传的答案。请注意,不需要为此更改用于收集表单数据的 servlet 代码!只有你的响应方式可能会改变,但这相当微不足道(即,不是转发到 JSP,而是打印一些 JSON 或 XML 甚至纯文本,具体取决于负责 Ajax 调用的脚本所期望的任何内容)。


转载自:java – How can I upload files to a server using JSP/Servlet? – Stack Overflow

发表回复