带有 MTOM 附件的 Spring-WS webservice

问题描述

我正在尝试创建一个简单的 Spring Web 服务，它在调用时会返回一个文件附件作为 SOAP 响应的一部分.Enpoint 类如下图所示:

I am trying to create a simple Spring webservice which when called returns a file attachment as part of the SOAP response. The Enpoint class is shown below:

最后是端点

@PayloadRoot(namespace="http://ws.mypackage.com", localPart="downloadMessageRequest")
    @ResponsePayload
    public JAXBElement<DownloadResponseType> invoke(@RequestPayload DownloadMessageRequest req) throws Exception  {

        DownloadResponseType response = new DownloadResponseType();
        DownloadResponseType.PayLoad payload = new DownloadResponseType.PayLoad();          

        javax.activation.DataHandler dataHandler = new javax.activation.DataHandler(new FileDataSource("c:\temp\maven-feather.png"));
        payload.setMessagePayLoad(dataHandler);
        response.setPayLoad(payload);

        return objectFactory.createDownloadMessageResponse(response);

    }

我希望响应包含文件作为附件，类似于以下响应:

I would like the response to include the file as an attachement similar to the following response:

Content-Type: multipart/related; boundary=MIMEBoundary4A7AE55984E7438034;
                         type="application/xop+xml"; start="<0.09BC7F4BE2E4D3EF1B@apache.org>";
                         start-info="text/xml; charset=utf-8"

--MIMEBoundary4A7AE55984E7438034
content-type: application/xop+xml; charset=utf-8; type="application/soap+xml;"
content-transfer-encoding: binary
content-id: <0.09BC7F4BE2E4D3EF1B@apache.org>

<?xml version='1.0' encoding='utf-8'?>
<soapenv:Envelope xmlns:soapenv="...."....>
  ........
         <xop:Include href="cid:1.A91D6D2E3D7AC4D580@apache.org" 
                        xmlns:xop="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112936384.jpg">
         </xop:Include>
  ........

</soapenv:Envelope>
--MIMEBoundary4A7AE55984E7438034
content-type: application/octet-stream
content-transfer-encoding: binary
content-id: <1.A91D6D2E3D7AC4D580@apache.org>

Binary Data.....
--MIMEBoundary4A7AE55984E7438034--

我尝试遵循 spring-ws 示例中的文档和示例代码，但由于某种原因，我得到的输出总是这样(即 base64 数据不是附件.

I have tried to follow the documentation and the sample code in the spring-ws samples and for some reason the output i am getting is always this (i.e. the base64 data is not an attachement.

HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Accept: text/xml, text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
SOAPAction: ""
Content-Type: text/xml;charset=utf-8
Content-Length: 4750
Date: Tue, 03 Jul 2012 17:05:21 GMT

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112922478.jpg"><SOAP-ENV:Header/><SOAP-ENV:Body><ns2:downloadMessageResponse xmlns:ns2="http://ws.mypackage.com"><ns2:payLoad><ns2:messagePayLoad>....iVBORw0KGgoAAAANSUhEUgAAAFoAAAAeCyAAAAAElFTkSuQmCC....</ns2:messagePayLoad></ns2:payLoad></ns2:downloadMessageResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>

如您所见，有效负载不是附件.以下是我如何配置我的应用程序:

As you can see, the payload is not an attachment. Here is how i have configured my application:

web.xml

<context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>
        /WEB-INF/app-config.xml
        </param-value>
    </context-param>

    <listener>
        <listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    </listener>

    <servlet>
        <servlet-name>webservice</servlet-name>
        <servlet-class>org.springframework.ws.transport.http.MessageDispatcherServlet</servlet-class>
        <init-param>
            <param-name>contextConfigLocation</param-name>
            <param-value>/WEB-INF/ws-config.xml</param-value>
        </init-param>
    </servlet>

ws-config.xml

<beans xmlns="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112922651.jpg"
    xmlns:xsi="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112923416.jpg"
    xmlns:ws="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112923890.jpg"
    xmlns:context="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112924431.jpg"
    xsi:schemaLocation="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112923890.jpg 
    http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112923890.jpg/web-services-2.0.xsd
        http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112922651.jpg 
        http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112922651.jpg/spring-beans.xsd
        http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112924431.jpg 
        http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112924431.jpg/spring-context-3.0.xsd">

    <context:component-scan base-package="com.mypackage"/>

    <ws:annotation-driven/>


    <ws:dynamic-wsdl id="serviceDefinition" portTypeName="myService"
                     locationUri="http://localhost:8080/springWsTest/webservice">
        <ws:xsd location="/WEB-INF/schemas/downloadMessageRequest.xsd"/>
    </ws:dynamic-wsdl>

    <bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
        <property name="contextPath" value="com.mypackage.ws"/>
        <property name="mtomEnabled" value="true"/>
    </bean> 
</beans>

下载MessageRequest.xsd 架构文件

downloadMessageRequest.xsd schema file

<?xml version="1.0" encoding="UTF-8"?>
<xs:schema xmlns:xs="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112929259.jpg" 
xmlns:m="http://ws.mypackage.com" 
xmlns:xmime="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112929744.jpg" elementFormDefault="qualified"
targetNamespace="http://ws.mypackage.com" 
attributeFormDefault="unqualified"> 

    <xs:element name="downloadMessageRequest">
        <xs:complexType/>
    </xs:element>

    <xs:element name="downloadMessageResponse" type="m:downloadResponseType" />

    <xs:complexType name="downloadResponseType">
            <xs:sequence>
                <xs:element name="requestName" type="xs:string"/>
                <xs:element name="payLoad">
                    <xs:complexType>
                        <xs:sequence>
                            <xs:element name="messagePayLoad" type="xs:base64Binary" xmime:expectedContentTypes="application/octet-stream"/>
                        </xs:sequence>
                    </xs:complexType>
                </xs:element>
            </xs:sequence>
     </xs:complexType>


     <xs:element name="localDTMRequest">
        <xs:complexType/>
    </xs:element>

    <xs:element name="localDTMResponse">
        <xs:complexType>        
            <xs:sequence>
                <xs:element name="localDTM" type="xs:dateTime"/>
            </xs:sequence>          
        </xs:complexType>
    </xs:element>


</xs:schema>

文件确实被转换为 base64binary.JAXB 类已正确生成.端点工作，但它不包括文件作为附件.即使我设置了 mtomEnabled=true，它也将其作为 XML 标记的一部分.

The file does get converted to base64binary. The JAXB clases are generated correctly. The Endpoint works but it is not including the file as an attachement. It is including it as part of the XML tag even though i have set mtomEnabled=true.

我错过了什么?

推荐答案

终于设法让它工作了.配置与我在原始帖子中的配置或多或少相同.我不得不更新配置文件.这是我的配置文件现在的样子.

Finally managed to get it to work. The configuration is more or less the same as what i had in my original post. I had to update the configuration file. Here is how my configuration file looks like now.

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112922651.jpg"
    xmlns:xsi="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112923416.jpg" xmlns:ws="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112923890.jpg"
    xmlns:context="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112924431.jpg"
    xsi:schemaLocation="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112923890.jpg http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112923890.jpg/web-services-2.0.xsd
        http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112922651.jpg http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112922651.jpg/spring-beans.xsd
        http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112924431.jpg http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112924431.jpg/spring-context-3.0.xsd">

    <context:component-scan base-package="com.mypackage.ws" />

    <ws:annotation-driven />

    <ws:dynamic-wsdl id="serviceDefinition"
        portTypeName="Msm" locationUri="http://localhost:8080/MyWebService/webservice">
        <ws:xsd location="/WEB-INF/schemas/schema.xsd" />
    </ws:dynamic-wsdl>

    <bean id="messageReceiver"
        class="org.springframework.ws.soap.server.SoapMessageDispatcher">
        <property name="endpointAdapters">
            <list>
                <ref bean="defaultMethodEndpointAdapter" />
            </list>
        </property>
    </bean>

    <bean id="defaultMethodEndpointAdapter"
        class="org.springframework.ws.server.endpoint.adapter.DefaultMethodEndpointAdapter">
        <property name="methodArgumentResolvers">
            <list>
                <!-- Be careful here! You might need to add more processors if you do 
                    more than webservices! -->
                <ref bean="marshallingPayloadMethodProcessor" />
            </list>
        </property>
        <property name="methodReturnValueHandlers">
            <list>
                <ref bean="marshallingPayloadMethodProcessor" />
            </list>
        </property>
    </bean>

    <bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
        <property name="contextPath" value="com.mypackage.ws" />
        <property name="mtomEnabled" value="true" />
    </bean>

    <bean id="marshallingPayloadMethodProcessor"
        class="org.springframework.ws.server.endpoint.adapter.method.MarshallingPayloadMethodProcessor">
        <constructor-arg ref="marshaller" />
        <constructor-arg ref="marshaller" />
    </bean>
</beans>

我添加的更改基于我在这篇文章中阅读的内容 - blog.hpxn.net/2012/06/

The changes i added were based on what i read on this article - blog.hpxn.net/2012/06/

这是一个以 MTOM 格式返回附件的示例(基于 spring 示例).我刚试了一下，响应如下:

Here is an example (based on the spring samples) that returns the attachment in MTOM format. I just tried it and the response is shown below:

   HTTP/1.1 200 OK
Server: Apache-Coyote/1.1
Accept: text/xml, text/html, image/gif, image/jpeg, *; q=.2, */*; q=.2
SOAPAction: ""
Content-Type: Multipart/Related; start-info="text/xml"; type="application/xop+xml"; boundary="----=_Part_0_17910623.1342789122256"
Transfer-Encoding: chunked
Date: Fri, 20 Jul 2012 12:58:42 GMT

------=_Part_0_17910623.1342789122256
Content-Type: application/xop+xml; charset=utf-8; type="text/xml"

<SOAP-ENV:Envelope xmlns:SOAP-ENV="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112922478.jpg"><SOAP-ENV:Header/><SOAP-ENV:Body><ns2:LoadImageResponse xmlns:ns2="http://www.springframework.org/spring-ws/samples/mtom"><ns2:name>?</ns2:name><ns2:image><xop:Include xmlns:xop="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112936384.jpg" href="cid:f1c3ef65-a519-4bba-9b92-9acffc0c14f7%40www.springframework.org"/></ns2:image></ns2:LoadImageResponse></SOAP-ENV:Body></SOAP-ENV:Envelope>
------=_Part_0_17910623.1342789122256
Content-Type: image/png
Content-ID: <f1c3ef65-a519-4bba-9b92-9acffc0c14f7@www.springframework.org>
Content-Transfer-Encoding: binary

‰PNG

请注意，我没有配置任何 Axiom 工厂.下面列出了必要的文件:

Note that i have not configured any Axiom factories. The necessary files are listed below:

schema.xsd

<?xml version="1.0" encoding="UTF-8"?>
<schema xmlns="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112929259.jpg" targetNamespace="http://www.springframework.org/spring-ws/samples/mtom"
        xmlns:tns="http://www.springframework.org/spring-ws/samples/mtom"
        xmlns:xmime="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112929744.jpg" elementFormDefault="qualified">

    <element name="StoreImageRequest" type="tns:Image"/>

    <element name="LoadImageRequest" type="string"/>

    <element name="LoadImageResponse" type="tns:Image"/>

    <complexType name="Image">
        <sequence>
            <element name="name" type="string"/>
            <element name="image" type="base64Binary" xmime:expectedContentTypes="image/png"/>
        </sequence>
    </complexType>

</schema>

spring-ws-servlet.xml

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112922651.jpg" xmlns:xsi="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112923416.jpg"
       xsi:schemaLocation="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112922651.jpg http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112922651.jpg/spring-beans-2.0.xsd">

    <bean id="imageRepository" class="org.springframework.ws.samples.mtom.service.StubImageRepository"/>

    <bean class="org.springframework.ws.samples.mtom.ws.ImageRepositoryEndpoint">
        <constructor-arg ref="imageRepository"/>
    </bean>

    <bean class="org.springframework.ws.server.endpoint.mapping.PayloadRootAnnotationMethodEndpointMapping"/>

    <bean class="org.springframework.ws.server.endpoint.adapter.GenericMarshallingMethodEndpointAdapter">
        <constructor-arg ref="marshaller"/>
    </bean>

    <bean id="marshaller" class="org.springframework.oxm.jaxb.Jaxb2Marshaller">
        <property name="contextPath" value="org.springframework.ws.samples.mtom.schema"/>
        <property name="mtomEnabled" value="true"/>
    </bean>

    <bean id="mtom" class="org.springframework.ws.wsdl.wsdl11.DefaultWsdl11Definition">
        <property name="schema" ref="schema"/>
        <property name="portTypeName" value="ImageRepository"/>
        <property name="locationUri" value="http://localhost:8080/mtom-server/"/>
    </bean>

    <bean id="schema" class="org.springframework.xml.xsd.SimpleXsdSchema">
        <property name="xsd" value="/WEB-INF/schema.xsd"/>
    </bean>

</beans>

web.xml

<web-app xmlns="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112941435.jpg" xmlns:xsi="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112923416.jpg"
         xsi:schemaLocation="http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112941435.jpg http://www.51sjk.com/Upload/Articles/1/0/337/337437_20221117112941435.jpg/web-app_2_4.xsd"
         version="2.4">

    <display-name>MyCompany HR Holiday Service</display-name>

    <servlet>
        <servlet-name>spring-ws</servlet-name>
        <servlet-class>org.springframework.ws.transport.http.MessageDispatcherServlet</servlet-class>
    </servlet>

    <servlet-mapping>
        <servlet-name>spring-ws</servlet-name>
        <url-pattern>/*</url-pattern>
    </servlet-mapping>

</web-app>

要获得作为 SAAJ 附件而不是 MTOM 附件返回的响应，我必须按照此线程中的描述手动配置 SAAj 工厂如何在 Spring-WS 中向响应负载添加附件?

To get the response returned as a SAAJ attachment rather than an MTOM attachment, i have to manually configure the SAAj factories as described in this thread How do I add an attachment to a response payload in Spring-WS?