【JAX-WS入门系列】第06章_使用MTOM处理二进制文件

完整版见https://jadyer.github.io/2013/05/31/jaxws-use-mtom-to-upload-file/

首先示例服务端代码

下面这个SEI，是以byte[]为参数的服务端接口类BinaryService.java

package com.jadyer.service;import javax.jws.WebParam;import javax.jws.WebService;@WebService(targetNamespace="http://blog.csdn.net/jadyer")public interface BinaryService {public void upload(@WebParam(name="uploadFile")byte[] file);}

下面这个SEI，是以DataHandler为参数的服务端接口类BinaryHandlerService.java

package com.jadyer.service;import javax.activation.DataHandler;import javax.jws.WebParam;import javax.jws.WebService;import javax.xml.bind.annotation.XmlMimeType;@WebService(targetNamespace="http://blog.csdn.net/jadyerHandler")public interface BinaryHandlerService {public void uploadUseHandler(@WebParam(name="uploadFile") @XmlMimeType("application/octet-stream") DataHandler file);}

接下来分别是两个SEI对应的SIB

package com.jadyer.service;import java.io.File;import java.io.IOException;import javax.jws.WebService;import javax.xml.ws.soap.MTOM;import org.apache.commons.io.FileUtils;@WebService(endpointInterface="com.jadyer.service.BinaryService", targetNamespace="http://blog.csdn.net/jadyer")@MTOMpublic class BinaryServiceImpl implements BinaryService {@Overridepublic void upload(byte[] file) {try {//FileUtils类引用自commons-io-2.4.jarFileUtils.writeByteArrayToFile(new File("D:/test.jpg"), file);} catch (IOException e) {e.printStackTrace();}}}

package com.jadyer.service;import java.io.File;import java.io.IOException;import javax.activation.DataHandler;import javax.jws.WebService;import javax.xml.ws.BindingType;import javax.xml.ws.soap.SOAPBinding;import org.apache.commons.io.FileUtils;@WebService(endpointInterface="com.jadyer.service.BinaryHandlerService",targetNamespace="http://blog.csdn.net/jadyerHandler")@BindingType(SOAPBinding.SOAP11HTTP_MTOM_BINDING)public class BinaryHandlerServiceImpl implements BinaryHandlerService {@Overridepublic void uploadUseHandler(DataHandler file) {try {//FileUtils类引用自commons-io-2.4.jarFileUtils.copyInputStreamToFile(file.getDataSource().getInputStream(), new File("D:/test2.jpg"));} catch (IOException e) {e.printStackTrace();}}}

最后是发布服务的ServerApp.java

package com.jadyer.server;import javax.xml.ws.Endpoint;import com.jadyer.service.BinaryHandlerService;import com.jadyer.service.BinaryHandlerServiceImpl;import com.jadyer.service.BinaryServiceImpl;/** * 使用MTOM处理二进制文件 * @see --------------------------------------------------------------------------------------------------- * @see 比较传统做法是:服务端公布的方法参数为byte[],客户端调用时直接传进去一个文件的byte[]即可 * @see 此时使用TcpMon监听报文会发现,字节数组在传送的过程中,都是在SOAPBody里面传送的,而且是一次性全部传送 * @see 那么问题就来了:如果传送的文件比较大,就有可能造成内存溢出 * @see 对此,有一种解决方案是使用MTOM机制传输文件 * @see --------------------------------------------------------------------------------------------------- * @see MTOM(Message Transmission Optimization Mechanism),翻译过来就是消息优化传输机制 * @see 使用了MTOM后,我们再使用tcpmon监听报文会发现,文件传输是通过附件(以流的形式)传送的,而不是通过SOAPBody * @see 这里有必要提一下:当使用Apache的TcpMon监听MTOM时,由于JAXWS版本问题,可能会报告下面的异常 * @see javax.xml.ws.WebServiceException: java.io.IOException: Error writing to server * @see 这时,我们可以使用GoogleCode上的tcpmon或者Eclipse提供的TCP/IP Monitor * @see 有关三者的描述,可参考我的博客http://blog.csdn.net/jadyer/article/details/8967447 * @see 好了,回归正题.关于MTOM,有两种实现方式,分别为传输byte[]和传输javax.activation.DataHandler * @see --------------------------------------------------------------------------------------------------- * @see MTOM实现之传输byte[] * @see 1)SEI中定义开放服务的方法参数为byte[] * @see 2)使用@MTOM注解SIB,表示打开MTOM传输功能 * @see 3)客户端调用时,为getServicePort()方法传入new MTOMFeature()参数,表示启用MTOM传输 * @see   如new BinaryServiceImplService().getBinaryServiceImplPort(new MTOMFeature()).upload(....) * @see --------------------------------------------------------------------------------------------------- * @see MTOM实现之传输javax.activation.DataHandler * @see 1)SEI中定义开放服务的方法参数为DataHandler,并为该参数增加注解@XmlMimeType("application/octet-stream") * @see 2)使用@BindingType(SOAPBinding.SOAP11HTTP_MTOM_BINDING)注解SIB * @see 3)客户端调用时使用(SOAPBinding)((BindingProvider)service).setMTOMEnabled(true)启用MTOM传输 * @see   BinaryHandlerService service = new BinaryHandlerServiceImplService().getBinaryHandlerServiceImplPort() * @see   BindingProvider bp = (BindingProvider)service * @see   SOAPBinding binding = (SOAPBinding)bp.getBinding() * @see   binding.setMTOMEnabled(true) * @see   service.uploadUseHandler(new DataHandler(new FileDataSource(new File("D:/玄玉.png")))); * @see --------------------------------------------------------------------------------------------------- * @see MTOM总结 * @see 其实在使用DataHandler时,第二步和第三步都可以使用<code>MTOM实现之传输byte[]</code>的第二,三步编写方式 * @see 即使用@MTOM和new MTOMFeature()来打开MTOM传输并启用之,也就是说这两种方式的区别就在于开放服务的方法参数不同 * @see 一个是upload(byte[] file),一个是upload(@XmlMimeType("application/octet-stream")DataHandler file) * @see --------------------------------------------------------------------------------------------------- * @create May 26, 2013 12:15:53 AM * @author 玄玉<http://blog.csdn.net/jadyer> */public class ServerApp {public static void main(String[] args) {Endpoint.publish("http://127.0.0.1:8086/upload", new BinaryServiceImpl());Endpoint.publish("http://127.0.0.1:8086/uploadHandler", new BinaryHandlerServiceImpl());}}

OK，服务端代码示例完毕，下面是客户端代码

客户端只有一个演示调用服务的类ClientApp.java

注意：具体客户端代码是由wsimport生成的，详见http://blog.csdn.net/jadyer/article/details/8692108

package com.jadyer.client;import java.io.File;import java.io.IOException;import java.net.URL;import javax.activation.DataHandler;import javax.activation.FileDataSource;import javax.xml.namespace.QName;import javax.xml.ws.BindingProvider;import javax.xml.ws.soap.SOAPBinding;import net.csdn.blog.jadyerhandler.BinaryHandlerService;import net.csdn.blog.jadyerhandler.BinaryHandlerServiceImplService;/** * wsimport -d D:/Download/ -keep -verbose http://127.0.0.1:8086/upload?wsdl * @create May 26, 2013 1:47:40 AM * @author 玄玉<http://blog.csdn.net/jadyer> */public class ClientApp {public static void main(String[] args) throws IOException {//URL url = new URL("http://127.0.0.1:8086/upload?wsdl");//QName qname = new QName("http://blog.csdn.net/jadyer", "BinaryServiceImplService");//byte[] uploadFile = FileUtils.readFileToByteArray(new File("D:/玄玉.png"));////普通的传文件//new BinaryServiceImplService(url, qname).getBinaryServiceImplPort().upload(uploadFile);////MTOM方式//new BinaryServiceImplService(url, qname).getBinaryServiceImplPort(new MTOMFeature()).upload(uploadFile);URL urlHandler = new URL("http://127.0.0.1:8086/uploadHandler?wsdl");QName qnameHandler = new QName("http://blog.csdn.net/jadyerHandler", "BinaryHandlerServiceImplService");BinaryHandlerService service = new BinaryHandlerServiceImplService(urlHandler, qnameHandler).getBinaryHandlerServiceImplPort();BindingProvider bp = (BindingProvider)service;SOAPBinding binding = (SOAPBinding)bp.getBinding();binding.setMTOMEnabled(true);service.uploadUseHandler(new DataHandler(new FileDataSource(new File("D:/玄玉.png"))));}}