Tomcat NIO(17)-流式上传文件

在上一篇文章中我们主要介绍 tomcat nio 中对文件上传的原生支持，其本质是通过调用消费 servlet inputstream 相关 API ，先把文件上传到 tomcat 的工作目录中。然后通过 getPart() 等 API 得到已经在工作目录中文件的磁盘 inputstream ，name，size 等信息，然后根据自身逻辑进行操作。这种上传方式需要考虑 tomcat 工作目录磁盘空间大小，清理，权限等问题，由于涉及网络设备，磁盘设备，os 内核空间和程序的用户空间多次切换，所以在数量比较大的情况下会有效率问题。这里我们主要介绍流式上传，以解决原生上传带来的问题。

对于原生上传来说，是把 http 请求的文件输入流写入 tomcat 工作目录的磁盘中，流式上传的思路是不把输入流写入磁盘，而是直接把输入流交给应用程序，这样就避免了写磁盘的中转操作，提高了效率。所以我们可以从 tomcat 源码中把请求的文件输入流写入磁盘中的逻辑入手，核心代码在 ServletFileUpload 的 parseRequest() 方法中：

//ServletFileUpload
public FileItemIterator getItemIterator(HttpServletRequest request) throws FileUploadException, IOException {
        return super.getItemIterator(new ServletRequestContext(request));
}
// FileUploadBase
public List<FileItem> parseRequest(RequestContext ctx)throws FileUploadException {
    List<FileItem> items = new ArrayList<>();
    boolean successful = false;
    try {
        FileItemIterator iter = getItemIterator(ctx);
        FileItemFactory fac = getFileItemFactory();
        final byte[] buffer = new byte[Streams.DEFAULT_BUFFER_SIZE];
        if (fac == null) {
            throw new NullPointerException("No FileItemFactory has been set.");
        }
        while (iter.hasNext()) {
            final FileItemStream item = iter.next();
            // Don't use getName() here to prevent an InvalidFileNameException.
            final String fileName = ((FileItemIteratorImpl.FileItemStreamImpl) item).name;
            FileItem fileItem = fac.createItem(item.getFieldName(), item.getContentType(), item.isFormField(), fileName);
            items.add(fileItem);
            try {
                Streams.copy(item.openStream(), fileItem.getOutputStream(), true, buffer);
            } catch (FileUploadIOException e) {
                throw (FileUploadException) e.getCause();
            } catch (IOException e) {
                throw new IOFileUploadException(String.format("Processing of %s request failed. %s", MULTIPART_FORM_DATA, e.getMessage()), e);
            }
            final FileItemHeaders fih = item.getHeaders();
            fileItem.setHeaders(fih);
        }
        successful = true;
        return items;
    } catch (FileUploadIOException e) {
        throw (FileUploadException) e.getCause();
    } catch (IOException e) {
        throw new FileUploadException(e.getMessage(), e);
    } finally {
        if (!successful) {
            for (FileItem fileItem : items) {
                try {
                    fileItem.delete();
                } catch (Exception ignored) {
                    // ignored TODO perhaps add to tracker delete failure list somehow?
                }
            }
        }
    }
}

• 由上述代码逻辑分析，原生文件上传是调用 FileUploadBase 的 getItemIterator() 方法得到每个文件的 socket 输入流。

• 遍历每个文件的 socket 输入流，对每个输入流创建磁盘文件，用工具类 Streams 的 copy() 方法将文件输入流写入磁盘。

• 如果有异常发生则删除这个请求中对应的所有磁盘文件。

根据以上 tomcat 原生文件上传的分析，对于流式上传来说我们应该保证如下两点：

• 不要去调会用消费 servlet inputstream 的API，例如 getPart()/getParameter() 等。

• 在应用程序里利用 ServletFileUpload 对象的 getItemIterator() 方法得到每个文件的 socket 输入流，根据业务逻辑做相应处理，示例代码：

  ServletFileUpload upload = new ServletFileUpload();
  FileItemIterator fileItemIterator = upload.getItemIterator(httpServletRequest);
  while (fileItemIterator.hasNext()) {
      FileItemStream item = fileItemIterator.next();
      InputStream inputStream = item.openStream();
      try{
          String fileName = item.getName();
          //Logic to process with inputStrean data
      }catch(Exception e){
        //Handle exception here 
      }finally{
          inputStream.close();
      }
  }
  

• 对于以上方式，从应用程序角度看，数据经过了网络设备，os 的内核空间，应用程序的用户空间。避免了和磁盘设备打交道，提高了效率，同时也不必考虑 tomcat 工作目录磁盘大小，权限，清空等问题。

  

• 对于流式上传一定要注意关闭每个文件的网络输入流，需要循环处理完所有的文件，并且顺序是不可以变的，因为每个文件在网络输入流中是依次发送的，没有办法修改处理顺序。

目前先写到这里，下一篇文章里我们继续介绍 tomcat 中的 server sent event(SSE) 。