处理CXF API中的多部分附件

时间:2012-05-29 14:24:52

标签: cxf inputstream multipart

我正在尝试使用Apache CXF开发API调用,该调用接收附件以及请求。我遵循了this教程,这是我到目前为止所做的。

@POST
@Path("/upload")
@RequireAuthentication(false)
public Response uploadWadl(MultipartBody multipartBody){
    List<Attachment> attachments = multipartBody.getAllAttachments();
    DataHandler dataHandler = attachments.get(0).getDataHandler();
    try {
        InputStream is = dataHandler.getInputStream();
    } catch (IOException e) {
        e.printStackTrace();
    }
    return Response("OK");
}

我正在获取附件的InputStream对象,一切正常。但是,我需要将附件作为java.io.File对象传递给另一个函数。我知道我可以在这里创建一个文件,从输入流中读取并写入它。但是有更好的解决方案吗? CXF是否已将其存储为文件?如果是这样,我可以继续使用它。有什么建议吗?

1 个答案:

答案 0 :(得分:13)

我也对此事感兴趣。在与CXF邮件列表上的Sergey讨论时,我了解到如果附件超过某个阈值,CXF正在使用临时文件。

在此过程中,我发现了blogpost,它解释了如何安全地使用CXF附件。 你可以对this page上的例子感兴趣。

我现在正在调查,这就是我现在可以说的全部内容,我希望有所帮助。


编辑:目前我们处理CXF 2.6.x的附件。关于使用多部分内容类型上传文件。

在我们的REST资源中,我们定义了以下方法:

  @POST
  @Produces(MediaType.APPLICATION_JSON)
  @Consumes(MediaType.MULTIPART_FORM_DATA)
  @Path("/")
  public Response archive(
          @Multipart(value = "title", required = false) String title,
          @Multipart(value = "hash", required = false) @Hash(optional = true) String hash,
          @Multipart(value = "file") @NotNull Attachment attachment) {

    ...

    IncomingFile incomingFile = attachment.getObject(IncomingFile.class);

    ...
  }

关于该片段的一些注释:

  • @Multipart不是JAXRS的标准,它甚至不在JAXRS 2中,它是CXF的一部分。
  • 在我们的代码中,我们已经实现了bean验证(你必须自己在JAXRS 1中完成)
  • 您不必使用MultipartBody,此处的关键是使用Attachment类型的参数

所以是的,据我们所知,还没有可能在方法签名中直接得到我们想要的类型。因此,例如,如果您只想要附件的InputStream,则无法将其放在方法的签名中。您必须使用org.apache.cxf.jaxrs.ext.multipart.Attachment类型并编写以下语句:

InputStream inputStream = attachment.getObject(InputStream.class);

我们在 Sergey Beryozkin 的帮助下发现我们可以转换或包装这个InputStream,这就是为什么我们在上面的代码片段中写道:

IncomingFile incomingFile = attachment.getObject(IncomingFile.class);

IncomingFileInputStream周围的自定义包装器,因为您必须注册MessageBodyReaderParamHandler无效,因为它们无法使用流但是String

@Component
@Provider
@Consumes
public class IncomingFileAttachmentProvider implements MessageBodyReader<IncomingFile> {
  @Override
  public boolean isReadable(Class<?> type, Type genericType, Annotation[] annotations, MediaType mediaType) {
    return type != null && type.isAssignableFrom(IncomingFile.class);
  }

  @Override
  public IncomingFile readFrom(Class<IncomingFile> type,
                              Type genericType,
                              Annotation[] annotations,
                              MediaType mediaType,
                              MultivaluedMap<String, String> httpHeaders,
                              InputStream entityStream
  ) throws IOException, WebApplicationException {

    return createIncomingFile(entityStream, fixedContentHeaders(httpHeaders)); // the code that will return an IncomingFile
  }
}

但请注意,已经进行了一些试验,以了解传递的内容,方法和热修复错误的方法(例如,附件部分的第一个标题的第一个字母是吃的,所以你有ontent-Type代替Content-Type

当然,entityStream代表附件的实际InputStream。此流将从内存或磁盘读取数据,具体取决于CXF放置数据的位置;这个问题有一个大小阈值属性(attachment-memory-threshold)。您还可以说临时附件的去向(attachment-directory)。

完成后不要忘记关闭流(某些工具会为您完成)。

配置完所有内容后,我们使用 Johan Haleby 中的Rest-Assured对其进行了测试。 (有些代码是我们测试工具的一部分)

given().log().all()
        .multiPart("title", "the.title")
        .multiPart("file", file.getName(), file.getBytes(), file.getMimeType())
.expect().log().all()
        .statusCode(200)
        .body("store_event_id", equalTo("1111111111"))
.when()
        .post(host().base().endWith("/store").toStringUrl());

或者如果您需要以这种方式通过curl上传文件:

curl --trace -v -k -f
     --header "Authorization: Bearer b46704ff-fd1d-4225-9dd4-e29065532b73"
     --header "Content-Type: multipart/form-data"
     --form "hash={SHA256}3e954efb149aeaa99e321ffe6fd581f84d5a497b6fab5c86e0d5ab20201f7eb5"
     --form "title=fantastic-video.mp4"
     --form "archive=@/the/path/to/the/file/fantastic-video.mp4;type=video/mp4"
     -X POST http://localhost:8080/api/video/event/store

要完成此答案,我想提一下,可以在多部分中使用JSON有效负载,因为您可以在签名中使用Attachment类型然后编写

Book book = attachment.getObject(Book.class)

或者你可以写一个像:

这样的论点
@Multipart(value="book", type="application/json") Book book

执行请求时,不要忘记将Content-Type标题添加到相关部分。

值得一提的是,可以将所有部分放在列表中,只需编写一个类型为List<Attachment>的单个参数的方法。但是我更喜欢在方法签名中使用实际参数,因为它更清晰,更少样板。

@POST
void takeAllParts(List<Attachment> attachments)