Используйте MTOM для эффективной передачи двоичного содержимого в SOAP

В то время как MTOM описывает абстрактную функцию оптимизации передачи в SOAP, конкретная реализация, использующая мультипартии MIME, хранится в отдельной спецификации: XOP , XML-двоичная оптимизированная упаковка. Тем самым он может использоваться независимо от SOAP для любого двоичного содержимого в документах XML. Поэтому вы часто найдете формулировку MTOM / XOP.

Пример приложения

Чтобы дать вам пример, с которым можно поиграться, я подготовил простой SOAP-сервер и клиент на github, реализованный с использованием Spring Boot. Они построены с помощью STS , но вы можете создавать и запускать их с помощью простой Java; просто проверьте файл Readme. Клонируйте репозиторий и переключитесь на ветку base64, он обеспечивает начальную настройку с двумя весенними проектами mtom-serverи mtom-client. Просто запустите сервер и клиент, как описано в файле Readme. Клиент запрашивает размер документа для загрузки. Если вы введете размер, клиент сгенерирует документ такого размера (содержащий некоторые случайные двоичные данные) и загрузит его на сервер. И клиент, и сервер также отслеживают запрос и ответ, так что вы можете проверить их.

Вывод клиентской консоли:

enter size of document to upload, or just press enter to exit: 30

Storing document of size 30
2015-09-07 17:27:22.645 TRACE 13988 --- [main] o.s.ws.client.MessageTracing.received: Received response [<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"><SOAP-ENV:Header/><SOAP-ENV:Body><ns2:storeDocumentResponse xmlns:ns2="https://github.com/ralfstuckert/mtom"><ns2:success>true</ns2:success></ns2:storeDocumentResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>] for request [<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"><SOAP-ENV:Header/><SOAP-ENV:Body><ns2:storeDocumentRequest xmlns:ns2="https://github.com/ralfstuckert/mtom"><ns2:document><ns2:name>30</ns2:name><ns2:author>Bert</ns2:author><ns2:content>UZrGmb6QfI78BHRezp2VvzCvtyzRkTYwXhP0FmM/</ns2:content></ns2:document></ns2:storeDocumentRequest></SOAP-ENV:Body></SOAP-ENV:Envelope>]
success: true

received 30 bytes
[2015-09-07 17:27:22.592] boot - 13712 TRACE [http-nio-9090-exec-1] --- sent: Sent response [<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"><SOAP-ENV:Header/><SOAP-ENV:Body><ns2:storeDocumentResponse xmlns:ns2="https://github.com/ralfstuckert/mtom"><ns2:success>true</ns2:success></ns2:storeDocumentResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>] for request [<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"><SOAP-ENV:Header/><SOAP-ENV:Body><ns2:storeDocumentRequest xmlns:ns2="https://github.com/ralfstuckert/mtom"><ns2:document><ns2:name>30</ns2:name><ns2:author>Bert</ns2:author><ns2:content>UZrGmb6QfI78BHRezp2VvzCvtyzRkTYwXhP0FmM/</ns2:content></ns2:document></ns2:storeDocumentRequest></SOAP-ENV:Body></SOAP-ENV:Envelope>]

<xs:element name="storeDocumentRequest">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="document" type="tns:document" />
    </xs:sequence>
  </xs:complexType>
</xs:element>

<xs:element name="storeDocumentResponse">
  <xs:complexType>
    <xs:sequence>
      <xs:element name="success" type="xs:boolean" />
    </xs:sequence>
  </xs:complexType>
</xs:element>

<xs:complexType name="document">
  <xs:sequence>
    <xs:element name="name" type="xs:string" />
    <xs:element name="author" type="xs:string" />
    <xs:element name="content" type="xs:base64Binary" />
  </xs:sequence>
</xs:complexType>

<wsdl:portType name="DocumentsPort">
  <wsdl:operation name="storeDocument">
    <wsdl:input message="tns:storeDocumentRequest" name="storeDocumentRequest"></wsdl:input>
    <wsdl:output message="tns:storeDocumentResponse" name="storeDocumentResponse"></wsdl:output>
  </wsdl:operation>
</wsdl:portType>

@Bean
public Jaxb2Marshaller marshaller() {
  Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
  ...
  marshaller.setMtomEnabled(true);
  return marshaller;
}

@Bean
public Jaxb2Marshaller marshaller() {
  Jaxb2Marshaller marshaller = new Jaxb2Marshaller();
  marshaller.setContextPath("rst.sample.mtom.jaxb");
  marshaller.setMtomEnabled(true);
  return marshaller;
}

@Bean
@Override
public DefaultMethodEndpointAdapter defaultMethodEndpointAdapter() {
  List<MethodArgumentResolver> argumentResolvers =
  new ArrayList<MethodArgumentResolver>();
  argumentResolvers.add(methodProcessor());

  List<MethodReturnValueHandler> returnValueHandlers =
  new ArrayList<MethodReturnValueHandler>();
  returnValueHandlers.add(methodProcessor());

  DefaultMethodEndpointAdapter adapter = new DefaultMethodEndpointAdapter();
  adapter.setMethodArgumentResolvers(argumentResolvers);
  adapter.setMethodReturnValueHandlers(returnValueHandlers);

  return adapter;
}

@Bean
public MarshallingPayloadMethodProcessor methodProcessor() {
  return new MarshallingPayloadMethodProcessor(marshaller());
}

@Configuration
public class MultipartResolverConfig {

  @Bean
  public CommonsMultipartResolver multipartResolver() {
    return new CommonsMultipartResolver();
  }

  @Bean
  public CommonsMultipartResolver filterMultipartResolver() {
    final CommonsMultipartResolver resolver = new CommonsMultipartResolver();
    return resolver;
  }
}

enter size of document to upload, or just press enter to exit: 30

Storing document of size 30
2015-09-07 17:36:37.740 TRACE 11644 --- [main] o.s.ws.client.MessageTracing.received : Received response [------=_Part_2_8618207.1441640197738
Content-Type: application/xop+xml; charset=UTF-8; type="text/xml"

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"><SOAP-ENV:Header/><SOAP-ENV:Body><ns2:storeDocumentResponse xmlns:ns2="https://github.com/ralfstuckert/mtom"><ns2:success>true</ns2:success></ns2:storeDocumentResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>
------=_Part_2_8618207.1441640197738--] for request [------=_Part_1_12274722.1441640197737
Content-Type: application/xop+xml; charset=utf-8; type="text/xml"

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://schemas.xmlsoap.org/soap/envelope/"><SOAP-ENV:Header/><SOAP-ENV:Body><ns2:storeDocumentRequest xmlns:ns2="https://github.com/ralfstuckert/mtom"><ns2:document><ns2:name>30</ns2:name><ns2:author>Bibo</ns2:author><ns2:content><xop:Include xmlns:xop="http://www.w3.org/2004/08/xop/include" href="cid:3f9e1eef-fc65-4bda-bcee-c2764a3cbf3a%40github.com"/></ns2:content></ns2:document></ns2:storeDocumentRequest></SOAP-ENV:Body></SOAP-ENV:Envelope>
------=_Part_1_12274722.1441640197737
Content-Type: application/octet-stream
Content-ID: <3f9e1eef-fc65-4bda-bcee-c2764a3cbf3a@github.com>
Content-Transfer-Encoding: binary

&.}p R 4Ѿ    m  B  C T yK}>}
------=_Part_1_12274722.1441640197737--]

public class Document {

   @XmlElement(required = true)
   protected String name;

   @XmlElement(required = true)
   protected String author;

   @XmlElement(required = true)
   protected byte[] content;
...

<xs:complexType name="document">
  <xs:sequence>
    <xs:element name="name" type="xs:string" />
    <xs:element name="author" type="xs:string" />
    <xs:element name="content" type="xs:base64Binary" xmime:expectedContentTypes="application/octet-stream" />
  </xs:sequence>
</xs:complexType>

public class Document {
  ...
  @XmlElement(required = true)
  @XmlMimeType("application/octet-stream")
  protected DataHandler content;

public class DocumentsClient extends WebServiceGatewaySupport {

  public boolean storeDocument(int size) {
    Document document = new Document();
    document.setContent(getContentAsDataHandler(size));
    ...
  }

  private DataHandler getContentAsDataHandler(final int size) {
    InputStream input = getContentAsStream(size);
    DataSource source = new InputStreamDataSource(input, ...
    return new DataHandler(source);
  }

POST /ws/documents HTTP/1.1
...
Content-Type: Multipart/Related; start-info="text/xml"; type="application/xop+xml"; boundary="----=_Part_0_2494886.1441553075493"
Content-Length: 842

  public DocumentsClient() {
    setMessageSender(new ChunkedEncodingMessageSender());
  }
  ...

public class ChunkedEncodingMessageSender extends HttpUrlConnectionMessageSender {
  protected void prepareConnection(final HttpURLConnection connection) throws IOException {
    super.prepareConnection(connection);
    connection.setChunkedStreamingMode(-1);
  }
}

@SpringBootApplication
public class Application {

  public static void main(String[] args) {
    // needed for streaming, see https://java.net/jira/browse/SAAJ-31
    System.setProperty("saaj.use.mimepull", "true");

    SpringApplication.run(Application.class, args);
  }
}

enter size of document to upload, or just press enter to exit: 1000000000

Storing document of size 1000000000
success: true

<bindings>
  <basicHttpBinding>
    <binding name="...." messageEncoding="Mtom" transferMode="Streamed" >