前言：
从今天开始，我们将学习如何使用Webservice进行二进制附件的传输，这一课题将分成两个部分：
l 第一部分实现Client上传一个附件到服务端，服务端接收Client传过来的二进制附件后保存至本地。
第二部分实现Client上传一个Java复杂类型，该复杂类型中有一个字段叫myPhoto，为一个jpg/gif附件，服务端接受该上传的复杂类型，并把其中的二进制字段中的图片保存至本地。
以下是我们要存取的图片（搞笑一下啊）
目标:
1． 客户端用Webservice上传一个二进制文件，服务端收到客户端request后把二进制附件读出，保存至本地
一、编写Server端
1.1 制作Service端
| package ctsjavacoe.ws.fromjava; import javax.jws.WebMethod; import javax.jws.WebService; import javax.xml.ws.Holder; import java.io.*; @WebService public class MTOMSimple { @WebMethod public void echoData(Holder<byte[]> data) { OutputStream os = null; ByteArrayInputStream bin = null; try { bin = new ByteArrayInputStream(data.value); if (data.value != null) os = new FileOutputStream("D:/upload/jaxwsupload/echoData.jpg"); byte[] bytes = new byte[1024]; int c; while ((c = bin.read(bytes)) != -1) { os.write(bytes, 0, c); } os.close(); } catch (Exception e) { e.printStackTrace(); } finally { try { if (os != null) { os.close(); os = null; } } catch (Exception e) { } try { if (bin != null) { bin.close(); bin = null; } } catch (Exception e) { } } } } |
该Service有一个方法：
public void echoData(Holder<byte[]> data)；
该方法中接收一个参数，该参数叫“Holder”，该方法在接受到客户端的上传请求后会从Holder类型的参数中导出以byte[]为类型的二进制流，然后写入Server端的D:\upload\jaxwsupload目录下，并且存成一个叫echoData.jpg文件。
1.2 javax.xml.ws.Holder的解释
在java中方法调用“以值调用（call by value）”，即是通过原始值的复制传递的（是使用的变量的复制，而不是原始值）。
如果形参是对象引用，此时形参引用改变了对象的域，或者调用了改变对象状态的方法，那么对于持有该对象引用的其他代码而言，该对象改变了。
也就是说，IN参数是Java因有的参数，而OUT、INOUT参数不是Java固有的。
而JAX-WS2.0是支持OUT、INOUT参数的。
Holder就提供了一个措施，为不可变的对象引用提供一个可变的包装，在java中支持引用传递。这样就使Java可以与支持INOUT、OUT参数的编程语言写的web service进行通信。
1.3 编译
此处的Webservice Server端生成的全部详细过程请参见“第一天”教程中的描述。
1. 用wsgen来编译生成相关的java文件，wsdl文件与xsd文件；
2. 将编译时输出至wssrc目录的文件拷贝至src目录；
3. 修改WebContent\WEB-INF目录下的sun-jaxws.xml文件，加入：
| <endpoint name='MTOMSimple' implementation='ctsjavacoe.ws.fromjava.MTOMSimple' url-pattern='/MTOMSimpleService' /> |
4．修改WebContent\WEB-INF目录下的web.xml加入：
| <servlet> <servlet-name>MTOMSimple</servlet-name> <servlet-class>com.sun.xml.ws.transport.http.servlet.WSServlet</servlet-class> <load-on-startup>2</load-on-startup> </servlet> <servlet-mapping> <servlet-name>MTOMSimple</servlet-name> <url-pattern>/MTOMSimpleService</url-pattern> </servlet-mapping> |
5. 将JaxWSProject的WebContent目录下的文件拷贝至tomcat的webapps\JaxWSSample
目录下，并选择全部覆盖；
6．重启Tomcat；
7．打开一个IE浏览器，输入：
http://localhost:9090/JaxWSSample/MTOMSimpleService?wsdl ，这时应该可以看到正确的输出二、编写Client端
2.1 编译前的准备
此处的Webservice Client端生成的全部详细过程请参见“第一天”教程中的描述。
1. 把Server端生成的wsdl与xsd拷贝至client工程的wsdl目录下
2. 由于我们继续使用polling方式来书写异步的客户端调用，因此我们还需要打开binding.xml文件，更改一下：
| <?xml version="1.0" encoding="UTF-8"?> <bindings xmlns:xsd="http://www.w3.org/2001/XMLSchema" xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" wsdlLocation="wsdl/MTOMSimpleService.wsdl" xmlns="http://java.sun.com/xml/ns/jaxws"> <bindings node="wsdl:definitions"> <enableAsyncMapping>true</enableAsyncMapping> </bindings> </bindings> |
3. 使用wsimport命令来生成client端调用时所需要的“句柄”
4. 把生成的句柄中的MTOMSimpleService.java这个文件打开，编辑它，将里面两处Url url=……的地方改成你的Server端实际的Webservice的wsdl地址，而默认它是指向一个本地的wsdl文件的路径
2.2 书写Test客户端调用Webservice的Server端
| package ctsjavacoe.ws.fromjava;
import com.sun.xml.ws.developer.JAXWSProperties;
import javax.xml.ws.BindingProvider; import javax.xml.ws.Holder; import javax.xml.ws.soap.SOAPBinding; import javax.xml.ws.soap.MTOMFeature; import javax.xml.transform.stream.StreamSource; import javax.activation.DataHandler; import java.io.File; import java.io.InputStream; import java.io.FileInputStream; import java.awt.*; import java.util.Arrays; public class MTOMSimplePollingClient { public static void testEcho(MTOMSimple port) throws Exception { byte[] bytes = AttachmentHelper.getImageBytes(getImage("carrier.jpg"), "image/jpeg"); Holder<byte[]> image = new Holder<byte[]>(bytes); port.echoData(image); if (image.value != null) System.out.println("SOAP 1.1 testEcho() PASSED!"); else System.out.println("SOAP 1.1 testEcho() FAILED!"); } private static String getDataDir () { return "d:/"; } private static Image getImage(String imageName) throws Exception { String location = getDataDir() + imageName; System.out.println("image location=====>"+location); return javax.imageio.ImageIO.read(new File(location)); }
public static void main(String[] args) { try { MTOMSimple port = new MTOMSimpleService() .getMTOMSimplePort(new MTOMFeature()); if (port == null) { System.out.println("TEST FAILURE: Couldnt get port!"); System.exit(-1); }
// test echo testEcho(port); } catch (Exception ex) { System.out.println("SOAP 1.1 MtomApp FAILED!"); ex.printStackTrace(); }
}
} |
核心代码片段：
| byte[] bytes = AttachmentHelper.getImageBytes(getImage("carrier.jpg"), "image/jpeg"); Holder<byte[]> image = new Holder<byte[]>(bytes); port.echoData(image); if (image.value != null) System.out.println("SOAP 1.1 testEcho() PASSED!"); else System.out.println("SOAP 1.1 testEcho() FAILED!"); |
请注意这边的port.echoData…if…else…的用法。
在《1.2 javax.xml.ws.Holder的解释》中提到过，“Holder就提供了一个措施，为不可变的对象引用提供一个可变的包装，在java中支持引用传递”。
因此，当客户端调用完Service的echoData(Holder)后， 再去判断这个image是否为null，此时，如果Service端调用成功，它会把这个image回传给客户端（引用传递），如果调用失败，它会返回一个null值给客户端。
因此我们判断这个image是否为null即可知道Service端是否成功执行且没抛出任何异常。
AttachmentHelper是一个用于处理二进制图片文件的“工具类”，大家也可以根据这个类的设计思想写自己的处理相关二进制文件的“工具类”，该类的代码如下：
| package ctsjavacoe.ws.fromjava; import com.sun.xml.ws.util.ASCIIUtility; import javax.xml.transform.stream.StreamSource; import javax.imageio.ImageWriter; import javax.imageio.ImageIO; import javax.imageio.stream.ImageOutputStream; import java.awt.*; import java.awt.image.BufferedImage; import java.awt.image.ImageObserver; import java.awt.image.PixelGrabber; import java.io.IOException; import java.io.InputStream; import java.io.ByteArrayOutputStream; import java.util.ArrayList; import java.util.Arrays; import java.util.Iterator;
public class AttachmentHelper { public static boolean compareStreamSource (StreamSource src1, StreamSource src2) throws Exception { if (src1 == null || src2 == null) { System.out.println ("compareStreamSource - src1 or src2 null!"); return false; } InputStream is1 = src1.getInputStream (); InputStream is2 = src2.getInputStream (); if ((is1 == null) || (is2 == null)) { System.out.println ("InputStream of - src1 or src2 null!"); return false; } return Arrays.equals (ASCIIUtility.getBytes (is1), ASCIIUtility.getBytes (is2)); } public static byte[] getImageBytes(Image image, String type) throws IOException { ByteArrayOutputStream baos = new ByteArrayOutputStream(); BufferedImage bufImage = convertToBufferedImage(image); ImageWriter writer = null; Iterator i = ImageIO.getImageWritersByMIMEType(type); if (i.hasNext()) { writer = (ImageWriter)i.next(); } if (writer != null) { ImageOutputStream stream = null; stream = ImageIO.createImageOutputStream(baos); writer.setOutput(stream); writer.write(bufImage); stream.close(); return baos.toByteArray(); } return null; } private static BufferedImage convertToBufferedImage (Image image) throws IOException { if (image instanceof BufferedImage) { return (BufferedImage)image;
} else { MediaTracker tracker = new MediaTracker (null/*not sure how this is used*/); tracker.addImage (image, 0); try { tracker.waitForAll (); } catch (InterruptedException e) { throw new IOException (e.getMessage ()); } BufferedImage bufImage = new BufferedImage ( image.getWidth (null), image.getHeight (null), BufferedImage.TYPE_INT_RGB);
Graphics g = bufImage.createGraphics (); g.drawImage (image, 0, 0, null); return bufImage; } } public static boolean compareImages (Image image1, Image image2) throws IOException { if (image1 == null || image2 == null) return false; boolean matched = false; Rectangle rect = new Rectangle (0, 0, convertToBufferedImage (image1) .getWidth (), convertToBufferedImage (image1) .getHeight ()); Iterator iter1 = handlePixels (image1, rect); Iterator iter2 = handlePixels (image2, rect); while (iter1.hasNext () && iter2.hasNext ()) { Pixel pixel = (Pixel) iter1.next (); if (pixel.equals ((Pixel) iter2.next ())) { matched = true; } else { matched = false; } } if (matched) return true; return false; } private static Iterator handlePixels (Image img, Rectangle rect) { int x = rect.x; int y = rect.y; int w = rect.width; int h = rect.height;
int[] pixels = new int[w * h]; PixelGrabber pg = new PixelGrabber (img, x, y, w, h, pixels, 0, w); try { pg.grabPixels (); } catch (InterruptedException e) { System.err.println ("interrupted waiting for pixels!"); return null; } if ((pg.getStatus () & ImageObserver.ABORT) != 0) { System.err.println ("image fetch aborted or errored"); return null; } ArrayList tmpList = new ArrayList (); for (int j = 0; j < h; j++) { for (int i = 0; i < w; i++) { tmpList.add (handleSinglePixel (x + i, y + j, pixels[j * w + i])); } } return tmpList.iterator (); } private static Pixel handleSinglePixel (int x, int y, int pixel) { int alpha = (pixel >> 24) & 0xff; int red = (pixel >> 16) & 0xff; int green = (pixel >> 8) & 0xff; int blue = (pixel) & 0xff; return new Pixel (alpha, red, green, blue); } private static class Pixel { private int a; private int r; private int g; private int b; Pixel (int a, int r, int g, int b) { this.a = a; this.r = r; this.g = g; this.b = b; } protected boolean equals (Pixel p) { if (p.a == a && p.r == r && p.g == g && p.b == b) return true; return false; } } } |
ü 在d:盘下建立目录D:\upload\jaxwsupload
运行该客户端，得到如下输出：
在得到上述PASSED!的输出信息后，我们就可以查看一下我们的D:\upload\jaxwsupload目录：
可以看到，图片已经通过服务端的Webservice生成至相应的目录，并改名叫echoData.jpg文件了。
三、解说MTOM
MTOM 是一种机制，用来以原始字节形式传输包含 SOAP 消息的较大二进制附件，从而使所传输的消息较小。
提到MTOM消息优化传输机制，通常的实验结果是使用MTOM传输数据会提高大约33%的性能。 消息传输优化机制(MTOM) 标准允许将消息中包含的大型数据元素外部化，并将其作为无任何特殊编码的二进制数据随消息一起传送。MTOM消息会打包为多部分/相关 MIME 序列，放在SOAP 消息中一起传送。
MTOM 全称Message Transmission Optimization Mechanism，即消息传输优化机制。它提出的模型适用于大量数据的交互情况。针对Base64编码情况带来的开销提出的解决方案。当数据量小的时候，SOAP依然使用XML进行消息的传递。
但是在大量数据情况下，如果数据依然进行Base64编码,会带来33%的额外开销，这样的情况对于大量数据交换的情况是无法容忍的。MTOM 就是针对SOAP 消息传输的基础上提出的改进办法。对于大量数据的传递，不会进行进行Base64编码，而是直接以附件的二进制原始数据的形式封装在SOAP消息的MIME 部分，进行传输。SOAP 消息通过指向随其发送的 MIME 部分来引用二进制内容，另外包括SOAP基本的XML 数据，这些还是Base64编码。因为此模型与简单邮件协议SMTP 模型基本一致。
MTOM通过简化大量数据的编码过程，从而提高数据的处理效率。因为SOAP消息等必要的信息，MTOM 也有一些必要的开销。MTOM仅在二进制数据元素的大小超过大约 1 KB 时，才能体现出其优势
四、结束第四天
通过今天的学习，我们知道了如何使用javax.xml.ws.Holder结合jaxws的MTOM特性来通过client端给server端上传附件。
在第五天的教程中，将展示更强大的Java复杂类型混合二进制文件，实现真正意义上的“附件绑定上传”功能。
