vertx web client 接收文件上传file-uploads及删除上传文件

偏执的太偏执、 2022-12-22 04:39 227阅读 0赞

最近在弄一个vertx的小项目，最近的一点小记录。。。

vertx post上传文件参数，是需要特殊处理一下的，开始以为用routingContext的getBody就能都获取到，后来翻文档发现这么一句If you want to upload files and send attributes, you can create a `MultipartForm` and use `sendMultipartForm`.

官方示例

MultipartForm form = MultipartForm.create()
      .attribute("imageDescription", "a very nice image")
      .binaryFileUpload("imageFile", "image.jpg", "/path/to/image", "image/jpeg");
    
    // Submit the form as a multipart form body
    client
      .post(8080, "myserver.mycompany.com", "/some-uri")
      .sendMultipartForm(form, ar -> {
        if (ar.succeeded()) {
          // Ok
        }
      });

那么问题来了，binaryFileUpload的参数该怎么传？首先文件可以通过routingContext.fileUploads()中获取，是一个set，然后我们构造一个MultipartForm类型的参数把文件循环塞进去，用来传给sendMultipartForm方法的第一个参数。请求头"multipart/form-data" 这货是不用自己加的，经过翻代码sendMultipartForm默认会带这个请求头。

部分代码如下

MultipartForm multipartForm = MultipartForm.create();
    //处理其他非文件属性
                MultiMap attributes = routingContext.request()
                        .formAttributes();
                attributes.forEach(attribute -> {
                    multipartForm.attribute(attribute.getKey(), attribute.getValue());
                });
    //处理文件上传参数
                routingContext.fileUploads()
                        .forEach(fileUpload -> {
    //注意这四个参数分别传什么
                            multipartForm.binaryFileUpload(fileUpload.name(), fileUpload.fileName(),
                                    fileUpload.uploadedFileName(), fileUpload.contentType());
                        });
    request.timeout(10000).sendMultipartForm(multipartForm, ar -> {
    
                    if (ar.succeeded()) {
                        //
                    }else{
                        //
                    }
    
    });

请求上传的文件默认会放到工程下的file-uploads文件夹，而且会自动命名为一个很长的字符，不是你上传的文件名，且不带扩展名，但不影响使用（）。我这里是做了一个识别，识别完了并不用保存上传的数据，所以需要清理一下。

删除方法如下，vertx fileSystem文件系统是核心包的内容，我用到了递归删除file-uploads文件夹及下面所有文件，如果只是删除某个文件，用`delete(String path, Handler<AsyncResult<Void>> handler)`这个方法就可以。更多详细用法可以看官网api [https://vertx.io/docs/apidocs/io/vertx/core/file/FileSystem.htm][https_vertx.io_docs_apidocs_io_vertx_core_file_FileSystem.htm]

这里如果报空指针基本就是vertx没传进来是null，或者路径写错了。

vertx.fileSystem().exists("file-uploads", result -> {
                                if (result.succeeded() && result.result()) {
    //true 代表使用递归删除
                                    vertx.fileSystem().deleteRecursive("file-uploads", true, r -> logger.info("upload Files deleted"));
                                } else {
                                    logger.error("cannot delete" + result.cause());
                                }
                            });

写到这里有的朋友可能会问了，我不想存到file-uploads这个文件夹怎么办呢。。既然文件是从RoutingContext中获取的，在源码发现重要的一句注释The context must have first been routed to a \* \{@link io.vertx.ext.web.handler.BodyHandler\} for this to work，果然默认设置是在BodyHandler，String DEFAULT\_UPLOADS\_DIRECTORY = "file-uploads"，给route加handler的时候要最先加BodyHandler，示例如下。

Router router = Router.router(vertx);
            router.route("/myapi/*")
    //BodyHandler要放到第一个！！
    .handler(BodyHandler.create()
    //自定义文件上传到哪
    .setUploadsDirectory("mydir")
    //请求结束后是否删除上传文件
    .setDeleteUploadedFilesOnEnd(true));

嗨瞧瞧我又在源码发现了什么，原来不用自己造轮子删除呀，bodyHandler提供了setDeleteUploadedFilesOnEnd方法即在结束的时候干掉已上传的文件， if uploaded files should be removed after handling the request 传true，默认是false。

比较了一下区别，上面的自己写的使用文件系统递归删除简单粗暴，文件夹也干掉了，缺点，路径是写死的。使用setDeleteUploadedFilesOnEnd(true)，文件夹还存在，具体是怎么删除的可以参见BodyHandler的实现类BodyHandlerImpl，顺带可以观摩一下里面写的，原来上传默认生成的文件名是UUID.randomUUID().toString()呀。

其实官方文档和源码注释写的还是挺详细的，示例也不少，还需要多研究。。

[https_vertx.io_docs_apidocs_io_vertx_core_file_FileSystem.htm]: https://vertx.io/docs/apidocs/io/vertx/core/file/FileSystem.htm