前言:
在第四天时了解了用jaxws如何去传输一个二进制文件,今天我们将讲述用Client上传一个Java复杂类型,该复杂类型中有一个字段叫myPhoto,为一个jpg/gif附件,服务端接受该上传的复杂类型,并把其中的二进制字段中的图片保存至本地。
对于我们来说,传输诸如下面这样一种的数据结构更符合企业级webservice的应用。
客户ID: |
XXXX |
客户名: |
XXXX |
客户靓照: |
|
目标:
1. 客户端用Webservice上传一个带有二进制附件的java复杂类型,服务端收到客户端request后把java复杂类型读出,并把该复杂类型中的二进制附件(字段)读出后,以jpg格式保存至本地
一、编写Server端
1.1 制作Service端接口
package ctsjavacoe.ws.fromjava; import javax.jws.WebParam; import javax.jws.WebService; import javax.jws.soap.SOAPBinding; import javax.xml.ws.soap.MTOM; import ctsjavacoe.ws.fromjava.bean.*; @WebService(name="MTOMCustomer") @SOAPBinding(style = SOAPBinding.Style.RPC) @MTOM public interface MTOMCustomer { public void uploadCustomerByName(@WebParam(name = "customer")Customer customer); } |
于前四天的教程有所不同,这次我们先来制作一个Interface,代码如上所示。
@MTOM注解用于开启MTOM功能。
@WebService注解中的name属性标注在接口类上,可以指定wsdl中接口名称,也就是生成的客户端代码中接口类的名字。
@SOAPBinding(style = SOAPBinding.Style.RPC)指定SOAP消息样式,有两个枚举值:SOAPBinding.Style.DOCUMENT(默认)和 SOAPBinding.Style.RPC,可以对比这两种方式生成的wsdl会有所不同,而且生成的客户端代码也会有所不同。
该接口有一个抽象方法需要实现:
public void uploadCustomerByName();
注意该方法中的参数为一个@WebParam。
这与其它的Webservice的@WebMethod所注释的方法有所区别,因为这个parameter不为一个java object,而是注释成了@WebParam,来一起看一下概念:
Ø @WebParam 注释:
用于定制从单个参数至 Web Service 消息部件和 XML 元素的映射。
将此注释应用于客户机或服务器服务端点接口(SEI)上的方法,或者应用于 JavaBeans 端点的服务器端点实现类。
由@WebParam注释的方法不会产生相应的如“GetPersonResponse.java”,”GetPerson.java”这样的服务端代码。
Ø @WebMethod 注释:
表示作为一项 Web Service 操作的方法。
将此注释应用于客户机或服务器服务端点接口(SEI)上的方法,或者应用于 JavaBeans 端点的服务器端点实现类。
仅支持在使用 @WebService 注释来注释的类上使用 @WebMethod 注释。
有了接口我们来写实现吧。
1.2 实现MTOMCustomer接口
package ctsjavacoe.ws.fromjava;
import java.io.File; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.Date; import java.util.Set; import javax.activation.DataHandler; import javax.activation.FileDataSource; import javax.annotation.Resource; import javax.jws.WebService; import javax.xml.ws.WebServiceContext; import javax.xml.ws.handler.MessageContext; import ctsjavacoe.ws.fromjava.bean.Customer;
@WebService(serviceName = "MTOMCustomerService", portName = "MTOMCustomerServicePort", targetNamespace = "http://fromjava.ws.ctsjavacoe/", endpointInter face = "ctsjavacoe.ws.fromjava.MTOMCustomer")
public class MTOMCustomerImpl implements MTOMCustomer { @Override public void uploadCustomerByName(Customer customer) { InputStream is = null; OutputStream os = null; try { System.out.println("customer====" + customer.getId() + " " + customer.getName()); System.out.println("generate jpg......"); is = customer.getMyPhoto().getInputStream(); os = new FileOutputStream("D:/upload/jaxwsupload/customer.jpg"); byte[] bytes = new byte[1024]; int c; while ((c = is.read(bytes)) != -1) { os.write(bytes, 0, c); } } catch (Exception e) { e.printStackTrace(); } finally { try { if (os != null) { os.close(); os = null; } } catch (Exception e) { } try { if (is != null) { is.close(); is = null; } } catch (Exception e) { } } } } |
该实现类实现了接受一个来自于客户端的带有Customer数据结构的变量的Webservice请求。
服务端得到Customer类型的变量,将其内容显示在后台的console上,并且把Customer变量中的myPhoto以二进制图片格式存到:D:/upload/jaxwsupload/customer.jpg.
1.3 制作ctsjavacoe.ws.fromjava.bean.Customer
package ctsjavacoe.ws.fromjava.bean; import javax.activation.DataHandler; import javax.xml.bind.annotation.XmlAccessType; import javax.xml.bind.annotation.XmlAccessorType; import javax.xml.bind.annotation.XmlMimeType; import javax.xml.bind.annotation.XmlRootElement; @XmlRootElement(name = "Customer") @XmlAccessorType(XmlAccessType.FIELD) public class Customer { private long id; private String name; @XmlMimeType("application/octet-stream") private DataHandler myPhoto; //getter and setter ...... } |
MTOM 方式中要传输的附件必须使用javax.activation.DataHandler类,还要注意必须在类上使用@XmlAccessorType(FIELD)注解,标注JAXB 在进行JAVA 对象与XML 之间进行转换时只关注字段,而不关注属性(getXXX()方法),否则发布Web 服务时会报出现了两个imageData 属性的错误,原因未知,可能是BUG。
然后使用@XmlMimeType 注解标注这是一个附件类型的数据,这里我们标注imageData 是一个二进制文件,当然你也可以使用具体的MIME类型,譬如:image/jpg、image/gif 等,但要考虑到客户端是否支持。
1.4编译
此处的Webservice Server端生成的全部详细过程请参见“第一天”教程中的描述。
1. 用wsgen来编译生成相关的java文件,wsdl文件与xsd文件;
2. 这个例子将不会在server端工程的wssrc目录中生成任何类,为什么:请看@WebMethod
与@WebParam的解释。
3. 修改WebContent\WEB-INF目录下的sun-jaxws.xml文件,加入:
<endpoint name=' MTOMCustomer ' implementation='ctsjavacoe.ws.fromjava.MTOMCustomer' url-pattern='/MTOMCustomerService' /> |
4.修改WebContent\WEB-INF目录下的web.xml加入:
<servlet> <servlet-name>MTOMCustomer</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> MTOMCustomer </servlet-name> <url-pattern>/ MTOMCustomerService </url-pattern> </servlet-mapping> |
5. 将JaxWSProject的WebContent目录下的文件拷贝至tomcat的webapps\JaxWSSample
目录下,并选择全部覆盖;
6.重启Tomcat;
7.打开一个IE浏览器,输入:
http://localhost:9090/JaxWSSample/MTOMCustomerService?wsdl,你应该可以看到正确的输出
二、编写Client端
2.1 编译前的准备
此处的Webservice Client端生成的全部详细过程请参见“第一天”教程中的描述。
1. 把Server端生成的wsdl与xsd拷贝至client工程的wsdl目录下
2. 此处我们不用也不能用polling方式来书写异步的客户端调用,因为服务端的方法为带@WebParam注释,因此此处我们使用SOAP客户端调用来做这个客户端的例子。因此我们也不需要修改binding.xml文件了。
(服务端也可不用@WebParam来注释方法,而使用一般的Java类型,此时会生成相应的服务端的Response代码以及生成可供客户端异步调用的代码,这个练习就留给大家自己去做了)
3. 使用wsimport命令来生成client端调用时所需要的“句柄”4. 把生成的句柄中的MTOMCustomerService.java这个文件打开,编辑它,将里面两处Url url=……的地方改成你的Server端实际的Webservice的wsdl地址,而默认它是指向一个本地的wsdl文件的路径
2.2 书写Test客户端调用Webservice的Server端
package ctsjavacoe.ws.fromjava; import ctsjavacoe.ws.fromjava.bean.*; import java.io.FileOutputStream; import java.io.IOException; import java.io.InputStream; import java.io.OutputStream; import java.net.MalformedURLException; import java.net.URL; import java.text.ParseException; import java.text.SimpleDateFormat; import java.util.GregorianCalendar; import javax.activation.DataHandler; import javax.activation.DataSource; import javax.activation.FileDataSource; import javax.xml.datatype.DatatypeConfigurationException; import javax.xml.datatype.DatatypeFactory; import javax.xml.namespace.QName; public class MTOMCustomerClient { public static void main(String[] args) { // TODO Auto-generated method stub Customer customer = new Customer(); String endPoint = "http://localhost:9090/JaxWSSample/MTOMCustomerService?wsdl"; try { QName qName = new QName("http://fromjava.ws.ctsjavacoe/", "MTOMCustomerService"); MTOMCustomerService customerService = new MTOMCustomerService( new URL(endPoint), qName); MTOMCustomer customerPort = customerService .getMTOMCustomerServicePort(); customer.setId(101); customer.setName("mk"); customer.setMyPhoto(new DataHandler(new FileDataSource( "D:/upload/wsphoto.jpg"))); customerPort.uploadCustomerByName(customer); } catch (Exception e) { e.printStackTrace(); } } } |
注意:
customer.setMyPhoto(newDataHandler(new FileDataSource(
"D:/upload/wsphoto.jpg")));
的用法。
ü 在d:\upload\目录下放一个wsphoto.jpg文件
ü 在d:盘下建立目录D:\upload\jaxwsupload
运行该客户端,客户端没有任何输出信息,我们来看我们的Tomcat的后台console输出:
再来看D:\upload\jaxwsupload目录,多了一个customer.jpg的文件。
四、结束jaxws的5天教程
通过这5天的课程,基本可以掌握使用jaxws编制Webservice,可以应付一般的中小型工程了。
Webservice其实一点不神秘,就是一个Service层,无非是一些协议和规范需要掌握。
对于大型复杂系统尚有几个Topic需要去解决:
ü WSSecurity
ü WSTransaction
ü XML加密
这些会在日后的高级课程中一一放出。
五、附录
5.1 wsgen
Usage:wsgen [options] < SEI> 主要选项:
l -d指定生成的class文件的位置。
l -s指定生成的Javasource文件的位置。
l -r指定生成的resources文件的位置。如WSDL、XSD 的位置。
l -wsdl,-servicename,-portname 三个参数指定生成的 WSDL 文件中的 service 和 port 的名称。 注意:这里的SEI是一个 endpoint implementation class,而不是一个接口。必须先写好一个endpoint的实现类,该类中用@WebService声明好WebService,再将它编译成class文件,才能提供给wsgen使用。
5.2 wsimport
Usage:wsimport [options] <WSDL_URI> 主要选项:
l -d指定生成的 class 文件的位置。
l -s指定生成的 Javasource 文件的位置。
l -wsdllocation指定生成的Java source中@WebService.WSDLLocation和 @WebServiceClient. wsdllocation的值