Axis2-03 WebService中传递复杂类型对象

 

在Axis2入门中我们使用WebService来传递简单类型的数据，但有时也需要传递更复杂的数据，这些数据可以被称为复合类型的数据。数组与类（接口）是比较常用的复合类型。在Axis2中可以直接使用将WebService方法的参数或返回值类型声明成数组或类（接口）。但要注意，在定义数组类型时只能使用一维数组，如果想传递多维数组，可以使用分隔符进行分隔，如下面的代码所示：

String[] strArray = new String[]{ "Java,C#,Android","中文,英文,日文", "东风,白杨,民兵" } ;

 上面的代码可以看作是一个3*3的二维数组。

        在传递类的对象实例时，除了直接将数组类型声明成相应的类或接口，也可以将对象实例进行序列化，也就是说，将一个对象实例转换成字节数组进行传递，然后接收方再进行反序列化，还原这个对象实例。

        下面的示例代码演示了如何传递数组与类（接口）类型的数据，并演示如何使用字节数组上传图像。本示例的客户端代码使用Java和C#编写。要完成这个例子需要如下几步：

 

一、实现服务器端代码

 

package com.iflytek.webservice;
import java.io.FileOutputStream;

import com.iflytek.data.DataForm;

/**
 * @author xdwang
 * 
 * @create Apr 19, 2013 10:08:36 AM
 * 
 * @email:[e-mail]
 * 
 * @description 服务器端代码
 * 
 */
public class ComplexTypeService {
	// 上传图像，imageByte参数表示上传图像文件的字节，
	// length参数表示图像文件的字节长度（该参数值可能小于imageByte的数组长度）
	public boolean uploadImageWithByte(byte[] imageByte, int length) {
		FileOutputStream fos = null;
		try {
			// 将上传的图像保存在D盘的test1.jpg文件中
			fos = new FileOutputStream("d:\\test1.png");
			// 开始写入图像文件的字节
			fos.write(imageByte, 0, length);
			fos.close();
		} catch (Exception e) {
			return false;
		} finally {
			if (fos != null) {
				try {
					fos.close();
				} catch (Exception e) {

				}
			}
		}
		return true;
	}

	// 返回一维字符串数组
	public String[] getArray() {
		String[] strArray = new String[] { "Java", "C#", "Android " };
		return strArray;
	}

	// 返回二维字符串数组
	public String[] getMDArray() {
		String[] strArray = new String[] { "Java,C#,Android", "中文,英文,日文",
				"东风,白杨,民兵" };
		return strArray;
	}

	// 返回DataForm类的对象实例
	public DataForm getDataForm() {
		return new DataForm();
	}

	// 将DataForm类的对象实例序列化，并返回序列化后的字节数组
	public byte[] getDataFormBytes() throws Exception {
		java.io.ByteArrayOutputStream baos = new java.io.ByteArrayOutputStream();
		java.io.ObjectOutputStream oos = new java.io.ObjectOutputStream(baos);
		oos.writeObject(new DataForm());
		return baos.toByteArray();
	}

}

 

 

二、实现DataForm类

package com.iflytek.data;

/**
 * @author xdwang
 * 
 * @create Apr 19, 2013 10:09:20 AM
 * 
 * @email:[e-mail]
 * 
 * @description DataForm是要返回的对象实例所对应的类
 * 
 */
public class DataForm implements java.io.Serializable {
	private String name = "xdwang";
	private int age = 24;

	public String getName() {
		return name;
	}

	public void setName(String name) {
		this.name = name;
	}

	public int getAge() {
		return age;
	}

	public void setAge(int age) {
		this.age = age;
	}
}

 

 

三、打包与部署服务

File—New—Other—Axis2 Wizards—Axis2 Service Archiver

Next输入Class文件路径注该处路径只写到bin一级不用到包一级。

Next选择Skip WSDLNext—Next—Next填写服务名与类名注：类名一定为全路径即包.类

Next指定输出文件的路径与名字Finish。

到此，一个服务的arr文件已经生成，将此文件移至之前部署的axis2。即apache-tomcat\webapps\axis2\WEB-INF\services下重启tomcat。

 

四、调用服务

1、  生成客户端stub代码

File—New—Other—Axis2 Wizards—Axis2 Code Generator步骤如下

 Next默认选择Generate Java source code from a WSDL file根据WSDL生成webservice客户端的java代码

Next输入WSDL路径

Next—Next指定生成的代码放置的工程可以选择当前工作空间中已有的工程下图中Client即是之前已经在当前工作空间中创建的Java Project

这时，项目中会多几个类

右击项目—Build Path—Configure Build Path—Libraries—Add External JARs添加之前解压的axis2-1.6.2由axis2-1.6.2-bin.zip解压而来文件夹下lib文件夹中所有的JAR文件

 

编写调用代码 TestWB.java

package com.iflytek.test;

import java.io.InputStream;
import java.text.MessageFormat;

import javax.activation.DataHandler;
import javax.activation.FileDataSource;

import com.iflytek.data.xsd.DataForm;
import com.iflytek.webservice.EclipseAxisWB;
import com.iflytek.webservice.EclipseAxisWBStub;
import com.iflytek.webservice.GetArray;
import com.iflytek.webservice.GetArrayResponse;
import com.iflytek.webservice.GetDataForm;
import com.iflytek.webservice.GetDataFormBytes;
import com.iflytek.webservice.GetDataFormBytesResponse;
import com.iflytek.webservice.GetDataFormResponse;
import com.iflytek.webservice.GetMDArray;
import com.iflytek.webservice.GetMDArrayResponse;
import com.iflytek.webservice.UploadImageWithByte;
import com.iflytek.webservice.UploadImageWithByteResponse;

/**
 * @author xdwang
 * 
 * @create Apr 19, 2013 2:26:30 PM
 * 
 * @email:[e-mail]
 * 
 * @description 调用
 * 
 */
public class TestWB {

	public static void main(String args[]) throws Exception {
		// 创建客户端对象
		EclipseAxisWB axis2WB = new EclipseAxisWBStub();

		// **************1、文件上传*****************
		java.io.File file = new java.io.File("F:\\2.jpg");
		// 将图像文件的内容读取buffer数组中
		int length = (int) file.length();
		// new一个调用uploadImageWithByte方法需要的参数UploadImageWithByte并且设置length和ImageByte
		UploadImageWithByte uploadImageWithByteArgs = new UploadImageWithByte();
		uploadImageWithByteArgs.setLength(length);
		DataHandler dataHandler = new DataHandler(new FileDataSource(
				"F:\\2.jpg"));
		uploadImageWithByteArgs.setImageByte(dataHandler);
		// 调用web服务
		UploadImageWithByteResponse uploadImageWithByteResponse = axis2WB
				.uploadImageWithByte(uploadImageWithByteArgs);
		// 拿到返回结果
		System.out.println(uploadImageWithByteResponse.get_return());

		// **************2、返回一维字符串数组*****************
		GetArray getArrayArgs = new GetArray();
		GetArrayResponse getArrayResponse = axis2WB.getArray(getArrayArgs);
		String[] strArray = getArrayResponse.get_return();
		for (String s : strArray) {
			System.out.print(s + "\t");
		}
		System.out.println();
		// **************3、返回二维字符串数组*****************
		GetMDArray getMDArrayArgs = new GetMDArray();
		GetMDArrayResponse getMDArrayResponse = axis2WB
				.getMDArray(getMDArrayArgs);
		String[] strMDArray = getMDArrayResponse.get_return();
		for (String s : strMDArray) {
			String[] array = s.split(",");
			for (String ss : array)
				System.out.print("<" + ss + "> ");
			System.out.println();
		}

		// **************4、返回DataForm类的对象实例*****************
		GetDataForm getDataFormArgs = new GetDataForm();
		GetDataFormResponse getDataFormResponse = axis2WB
				.getDataForm(getDataFormArgs);
		DataForm dataForm = getDataFormResponse.get_return();
		System.out.println(MessageFormat.format("姓名：{0}，年龄：{1}",
				dataForm.getName(), dataForm.getAge()));

		// **************5、返回序列化后的字节数组*****************
		GetDataFormBytes getDataFormBytesArgs = new GetDataFormBytes();
		GetDataFormBytesResponse getDataFormBytesResponse = axis2WB
				.getDataFormBytes(getDataFormBytesArgs);
		DataHandler dataFormBytes = getDataFormBytesResponse.get_return();
		InputStream inputStream = dataFormBytes.getInputStream();
		java.io.ObjectInputStream ois = new java.io.ObjectInputStream(
				inputStream);

		com.iflytek.data.DataForm dataFrom = (com.iflytek.data.DataForm) ois
				.readObject();
		System.out.println(MessageFormat.format("姓名：{0}，年龄：{1}",
				dataFrom.getName(), dataFrom.getAge()));

	}
}

 运行结果：

true
Java	C#	Android 	
<Java> <C#> <Android> 
<中文> <英文> <日文> 
<东风> <白杨> <民兵> 
姓名：xdwang，年龄：24
姓名：xdwang，年龄：24

 

WebService类中包含byte[]类型参数的方法在wsdl2java生成的stub类中对应的数据类型不再是byte[]类型，而是javax.activation.DataHandler。DataHandler类是专门用来映射WebService二进制类型的。

在WebService类中除了可以使用byte[]作为传输二进制的数据类型外，也可以使用javax.activation.DataHandler作为数据类型。不管是使用byte[]，还是使用javax.activation.DataHandler作为WebService方法的数据类型，使用wsdl2java命令生成的stub类中相应方法的类型都是javax.activation.DataHandler。而象使用.net、delphi生成的stub类的相应方法类型都是byte[]。这是由于javax.activation.DataHandler类是Java特有的，对于其他语言和技术来说，并不认识javax.activation.DataHandler类，因此，也只有使用最原始的byte[]了。

 

采用RPC方式则：

发布WebService，同上篇说的一样

由于本示例的WebService类使用了一个Java类（DataForm类），因此，在发布WebService之前，需要先将DataForm.class文件复制到<Tomcat安装目录>\webapps\axis2\WEB-INF\classes\data目录中，然后将ComplexTypeService.class文件复制到<Tomcat安装目录>\webapps\axis2\WEB-INF\pojo目录中，最后启动Tomcat（如果Tomcat已经启动，由于增加了一个DataForm类，因此，需要重新启动Tomcat）。

 

ComplexTypeRPCClient.java

 

package com.iflytek.test;

import javax.xml.namespace.QName;

import org.apache.axis2.addressing.EndpointReference;
import org.apache.axis2.client.Options;
import org.apache.axis2.rpc.client.RPCServiceClient;

import com.iflytek.data.DataForm;

/**
 * @author xdwang
 * 
 * @create Apr 19, 2013 4:56:30 PM
 * 
 * @email:[e-mail]
 * 
 * @description RPC的调用方式
 * 
 */
public class ComplexTypeRPCClient {
	public static void main(String[] args) throws Exception {
		RPCServiceClient serviceClient = new RPCServiceClient();
		Options options = serviceClient.getOptions();
		EndpointReference targetEPR = new EndpointReference(
				"http://localhost:8080/axis2/services/EclipseAxisWB");
		options.setTo(targetEPR);
		
		// **************1、文件上传*****************
		// 打开图像文件，确定图像文件的大小
		java.io.File file = new java.io.File("F:\\2.jpg");
		java.io.FileInputStream fis = new java.io.FileInputStream(
				"F:\\2.jpg");
		// 创建保存要上传的图像文件内容的字节数组
		byte[] buffer = new byte[(int) file.length()];
		// 将图像文件的内容读取buffer数组中
		int n = fis.read(buffer);
		System.out.println("文件长度：" + file.length());
		Object[] opAddEntryArgs = new Object[] { buffer, n };
		Class[] classes = new Class[] { Boolean.class };
		QName opAddEntry = new QName("http://webservice.iflytek.com",
				"uploadImageWithByte");
		fis.close();
		// 开始上传图像文件，并输出uploadImageWithByte方法的返回传
		System.out.println(serviceClient.invokeBlocking(opAddEntry,
				opAddEntryArgs, classes)[0]);

		// **************2、返回一维字符串数组*****************
		opAddEntry = new QName("http://webservice.iflytek.com", "getArray");
		String[] strArray = (String[]) serviceClient.invokeBlocking(opAddEntry,
				new Object[] {}, new Class[] { String[].class })[0];
		for (String s : strArray)
			System.out.print(s + "  ");
		System.out.println();

		// **************3、返回二维字符串数组*****************
		opAddEntry = new QName("http://webservice.iflytek.com", "getMDArray");
		strArray = (String[]) serviceClient.invokeBlocking(opAddEntry,
				new Object[] {}, new Class[] { String[].class })[0];
		for (String s : strArray) {
			String[] array = s.split(",");
			for (String ss : array)
				System.out.print("<" + ss + "> ");
			System.out.println();
		}
		System.out.println();

		// **************4、返回DataForm类的对象实例*****************
		opAddEntry = new QName("http://webservice.iflytek.com", "getDataForm");
		DataForm df = (DataForm) serviceClient.invokeBlocking(opAddEntry,
				new Object[] {}, new Class[] { DataForm.class })[0];
		System.out.println(df.getAge());
		
		// **************5、返回序列化后的字节数组*****************
		opAddEntry = new QName("http://webservice.iflytek.com", "getDataFormBytes");
		buffer = (byte[]) serviceClient.invokeBlocking(opAddEntry,
				new Object[] {}, new Class[] { byte[].class })[0];
		java.io.ObjectInputStream ois = new java.io.ObjectInputStream(
				new java.io.ByteArrayInputStream(buffer));
		df = (DataForm) ois.readObject();
		System.out.println(df.getName());
	}

}

 运行结果：

文件长度：11900628
true
Java  C#  Android   
<Java> <C#> <Android> 
<中文> <英文> <日文> 
<东风> <白杨> <民兵> 
24
xdwang

 

使用C#编写调用WebService的客户端代码

假设引用WebService时的引用名为complexType，则下面的代码调用了uploadImageWithByte方法来上传图像文件。在Visual Studio引用WebService时，uploadImageWithByte方法多了两个out参数，在使用时要注意。

 

complexType.ComplexTypeService cts = new WSC.complexType.ComplexTypeService();
System.IO.FileStream fs = new System.IO.FileStream(@"f:\images.jpg", System.IO.FileMode.Open);
byte[] buffer = new byte[fs.Length];
fs.Read(buffer, 0, (int)fs.Length);
bool r;
bool rs;
cts.uploadImageWithByte( buffer, (int)fs.Length, true, out r, out rs);

 

在获得二维数组时，可以将数据加载到DataGridView或其他类似的控件中，代码如下：

 

String[] strArray = cts.getMDArray();
for (int i = 0; i < strArray.Length; i++)
{
    //  用正则表达式将带分隔符的字符串转换成String数组
    String[] columns = strArray[i].Split(',');
    //  如果DataGridView的表头不存在，向DataGridView控件添加三个带表头的列
    if (dataGridView1.Columns.Count == 0)
        for (int j = 0; j < columns.Length; j++)
            dataGridView1.Columns.Add("column" + (j + 1).ToString(), "列" + (j + 1).ToString());
    //  添加行
    dataGridView1.Rows.Add(1);
    for(int j = 0; j < columns.Length; j++)
    {
        dataGridView1.Rows[i].Cells[j].Value = columns[j];                       
    }                
}

 

要注意的是，由于.net和java序列化和反序列化的差异，通过序列化的方式传递对象实例只使用于客户端与服务端为同一种语言或技术的情况，如客户端和服务端都使用Java来编写。