xfire传入传出自定义类型和集合类型-webservice分析

1.xfire eclipse插件安装步骤，详细内容见：http://xfire.codehaus.org/Eclipse+Plugin
Overview
The XFire Eclipse plugin provides Eclipse support for XFire's WSDL->Code generator. It requires Eclipse 3.2 and Java 5.
Installing the Plugin

To install the Eclipse XFire plugin:
go to the Help menu, select "Software Updates" and then select "Find and Install."
Select "Search for new features to install" and click Next.
Select "Create New Remote Site" and enter "XFire" as the name and http://dist.codehaus.org/xfire/update/ as the eclipse update site.
Select OK.
Select Finish
Using the Plugin

The first step is to start the code generation wizard. Go to File->New->Other. Then select Code generation from WSDL document.

The plugin will then prompt you for the location of your WSDL, where to output the code, and also what package you would like the service in.

Once you're done you'll see the generated classes in your IDE!

2.基本思路为：
 1.使用eclipse ->new project ->MyEclipse ->J2EE Projects ->Web Service Project创建一个ws服务端工程，默认在web.xml中加入：

  <servlet>
    <servlet-name>XFireServlet</servlet-name>
    <servlet-class>org.codehaus.xfire.transport.http.XFireConfigurableServlet</servlet-class>
    <load-on-startup>0</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>XFireServlet</servlet-name>
    <url-pattern>/services/*</url-pattern>
  </servlet-mapping>

 
  同时在类路径下默认加入：XFire 1.1 Core Libraries
 2.ws服务端工程运行，请求services Url，如：
 http://127.0.0.1:8083/xfirelist5/services/HelloWorldService?wsdl，如果看到wsdl内容，表示ws服务工程成功，继续下一步.
 3.ws客户端工程根据xfire eclipse插件，Code generation from WSDL document，然后编写测试类开始测试，调用ws服务工程远程方法。

3.下面以一个具体的例子来说明：
 需求定义：
 服务端提供两个远程服务方法：
 第一个方法：考虑用户对象及该用户的friends List集合对象自定义类型传入传出情况，
 根据传入对象打印出该对象的信息：如编号id，用户名username，密码password，消息msg，friends List集合等，
 假设该用户提交的信息给服务端验证审核，审核完毕后，修改该用户的消息msg，同时新建friends List集合封装该对象返回。
 第二个方法：仅仅考虑该用户对象集合传入传出情况，不考虑该用户的friends List集合对象，
 假设有一批考生user List提交到服务器，服务器端循环输出，然后循环遍历修改该用户的消息msg，提示"考试通过"。

4.服务端主要代码：
 User.java (Model类)

 private int id;
 private String username;
 private String password;
 private String msg; //从服务端获取消息
 private List<User> friends=new ArrayList<User>();

 
 分别提供get~(),set~()方法.
 HelloWorldService.java (服务接口)

/**
  * xfire传入传出自定义类型示例
  * @param user
  * @return User Object
  */
 User helloWorldDetail(User user);
 /**
  * xfire传入传出集合类型示例
  * @param list
  * @return List<User>集合
  */
 List<User> listHelloWorld(List<User> list);

  

注意：必须写成List<User> 如果为List，在生成wsdl文件时会报错
org.springframework.beans.factory.BeanCreationException: Error creating bean with name 'HelloService' defined in class path resource [META-INF/xfire/services.xml]: Invocation of init method failed; nested exception is org.codehaus.xfire.XFireRuntimeException: Cannot create mapping for java.util.List, unspecified component type for return type of method HelloWorldList in interface org.simpledev.xfire.list.service.IHelloWorldService

  HelloWorldServiceImpl(服务接口实现类)

/**
  * 考虑用户对象及该用户对象friends集合对象
  */
 public User helloWorldDetail(User user) {
  System.out.println("HelloWorldServiceImpl.helloWorldDetail()");
  //================自定义类型传入 begin================
  System.out.println("客户端传递过来的User对象信息：");
  int id = user.getId();
  String username = user.getUsername();
  String password = user.getPassword();
  String msg = user.getMsg();
  System.out.println("id:"+id);
  System.out.println("username:"+username);
  System.out.println("password:"+password);
  System.out.println("msg:"+msg);
  List<User> friends = user.getFriends();
  User friend;
  for (int i = 0; i < friends.size(); i++) {
   friend=friends.get(i);
   System.out.println("朋友的编号："+friend.getId()+"用户名："+friend.getUsername()+"密码："+friend.getPassword()+"消息："+friend.getMsg()+"");
  }
  //================自定义类型传入 end================
  //服务器端确认用户业务逻辑代码
  //... 
  //服务器端处理完毕后，返回一个User Object
  //================自定义类型传出 begin================
  User temp = user;
  temp.setMsg("恭喜你，你的编号是："+id+"用户名是："+username+"密码是："+password+"已经被服务器端确认!");
  User friend1 = new User(101,"樱木花道","ymhd","我是新朋友樱木花道");
  User friend2 = new User(102,"流川 枫","lcf","我是新朋友流川 枫");
  User friend3 = new User(103,"三井 寿","sjs","我是新朋友三井 寿");
  User friend4 = new User(104,"宫城良田","gclt","我是新朋友宫城良田");
  User friend5 = new User(105,"赤木刚宪","ymhd","我是新朋友赤木刚宪");
  List<User> newfriends = new ArrayList<User>();
  newfriends.add(friend1);
  newfriends.add(friend2);
  newfriends.add(friend3);
  newfriends.add(friend4);
  newfriends.add(friend5);
  temp.setFriends(newfriends);
  //================自定义类型传出 end================
  return temp;
 }

 /**
  * 不考虑friends集合情况
  */
 public List<User> listHelloWorld(List<User> list) {
  System.out.println("HelloWorldServiceImpl.listHelloWorld()");
  //用户信息批量确认
  User user;
  int id;
  String username;
  String password;
  String msg;
  //================集合类型传入 begin================
  for (int i = 0; i < list.size(); i++) {
   user = list.get(i);
   id = user.getId();
   username = user.getUsername();
   password = user.getPassword();
   msg = user.getMsg();
   System.out.println("===id为"+id+"信息读取显示开始===");
   System.out.println("username:"+username);
   System.out.println("password:"+password);
   System.out.println("msg:"+msg);
  }
  //================集合类型传入 end================
  
  //================集合类型传出 begin================
  List<User> temp = new ArrayList<User>();
  for (int i = 0; i < list.size(); i++) {
   user = list.get(i);
   id = user.getId();
   user.setMsg("恭喜你，编号"+id+"为已经通过考试了");
   temp.add(user);
  }
  //================集合类型传出 end================
  return temp;
 }

  

Web Service Project创建后，services.xml代码默认如下：
<beans xmlns="http://xfire.codehaus.org/config/1.0">
  ...配置
</beans>

org.springframework.beans.factory.BeanDefinitionStoreException: Error registering bean with name '' defined in class path resource [META-INF/xfire/services.xml]: Bean class [list] not found; nested exception is java.lang.ClassNotFoundException: list
java.lang.ClassNotFoundException: list
去掉：xmlns="http://xfire.codehaus.org/config/1.0" <beans>...配置</beans>

services.xml文件完整：
 

<beans>
 <!-- 使用Spring方式配置 -->
 <bean name="HelloService" class="org.codehaus.xfire.spring.ServiceBean">
  <property name="serviceBean" ref="echo" />
  <property name="serviceClass" value="org.simpledev.xfire.list.HelloWorldService" />
  <property name="inHandlers">
   <list>
    <ref bean="addressingHandler" />
   </list>
  </property>
 </bean>
 <bean id="echo" class="org.simpledev.xfire.list.HelloWorldServiceImpl" />
 <bean id="addressingHandler" class="org.codehaus.xfire.addressing.AddressingInHandler" />
</beans>

 

5.客户端主要代码：(注意：根据wsdl生成代码后，还需要httpclient.jar支持)

 public static void main(String[] args) {
  HelloWorldServiceClient client = new HelloWorldServiceClient();
  HelloWorldServicePortType service = client.getHelloWorldServiceHttpPort();
  
  System.out.println("########### 方法1 ###########");
  //QName参考: User.java
     User user = new User();
//     JAXBElement<Integer> id = new JAXBElement<Integer>(new
//             QName("http://list.xfire.simpledev.org", "id"),Integer.class,1);
     JAXBElement<String> username = new JAXBElement<String>(new
             QName("http://list.xfire.simpledev.org", "username"),String.class,"simpledev");
     JAXBElement<String> password = new JAXBElement<String>(new
             QName("http://list.xfire.simpledev.org", "password"),String.class,"123456");
     JAXBElement<String> msg = new JAXBElement<String>(new
             QName("http://list.xfire.simpledev.org", "msg"),String.class,"客户端编号为1的发出请求");
     //======添加对象friends集合 begin======
     ArrayOfUser temp = new ArrayOfUser();
      User friend1 = new User();
      JAXBElement<String> f_username1 = new JAXBElement<String>(new
              QName("http://list.xfire.simpledev.org", "username"),String.class,"许文强");
      JAXBElement<String> f_password1 = new JAXBElement<String>(new
              QName("http://list.xfire.simpledev.org", "password"),String.class,"xwq");
      JAXBElement<String> f_msg1 = new JAXBElement<String>(new
              QName("http://list.xfire.simpledev.org", "msg"),String.class,"上海滩-强哥");
      friend1.setId(11);
      friend1.setUsername(f_username1);
      friend1.setPassword(f_password1);
      friend1.setMsg(f_msg1);
      User friend2 = new User();
      JAXBElement<String> f_username2 = new JAXBElement<String>(new
              QName("http://list.xfire.simpledev.org", "username"),String.class,"丁力");
      JAXBElement<String> f_password2 = new JAXBElement<String>(new
              QName("http://list.xfire.simpledev.org", "password"),String.class,"dl");
      JAXBElement<String> f_msg2 = new JAXBElement<String>(new
              QName("http://list.xfire.simpledev.org", "msg"),String.class,"上海滩-阿力");
      friend2.setId(12);
      friend2.setUsername(f_username2);
      friend2.setPassword(f_password2);
      friend2.setMsg(f_msg2);      
     temp.getUser().add(friend1);
     temp.getUser().add(friend2);
     //======添加对象friends集合 end======
     JAXBElement<ArrayOfUser> friends = new JAXBElement<ArrayOfUser>(new
             QName("http://list.xfire.simpledev.org", "friends"),ArrayOfUser.class,temp);
     //封装User Object
     user.setId(1);
     user.setUsername(username);
     user.setPassword(password);
     user.setMsg(msg);
     user.setFriends(friends);
     //请求方法，返回User Object
     User tempUser = service.helloWorldDetail(user);
     System.out.println("===下面是从服务器端获取的详细信息===");
     System.out.println(tempUser.getId());
     System.out.println(tempUser.getUsername().getValue());
     System.out.println(tempUser.getPassword().getValue());
     System.out.println(tempUser.getMsg().getValue());
     JAXBElement<ArrayOfUser> f = tempUser.getFriends(); //获取新朋友，list
     ArrayOfUser f2 = f.getValue();
     List f3 = f2.getUser();
     for (int i = 0; i < f3.size(); i++) {
   User u = (User)f3.get(i);
   System.out.println(u.getId());
   System.out.println(u.getUsername().getValue());
   System.out.println(u.getPassword().getValue());
   System.out.println(u.getMsg().getValue());
  }
     System.out.println("--------------------------------");
  
     System.out.println("########### 方法2 ###########");
     ArrayOfUser a = new ArrayOfUser();
     User u1 = new User();
     JAXBElement<String> u_username1 = new JAXBElement<String>(new
             QName("http://list.xfire.simpledev.org", "username"),String.class,"本田透");
     JAXBElement<String> u_password1 = new JAXBElement<String>(new
             QName("http://list.xfire.simpledev.org", "password"),String.class,"111111");
     JAXBElement<String> u_msg1 = new JAXBElement<String>(new
             QName("http://list.xfire.simpledev.org", "msg"),String.class,"序号1：查询考试是否通过？");
     u1.setId(1);
     u1.setUsername(u_username1);
     u1.setPassword(u_password1);
     u1.setMsg(u_msg1);
     User u2 = new User();
     JAXBElement<String> u_username2 = new JAXBElement<String>(new
             QName("http://list.xfire.simpledev.org", "username"),String.class,"纪纱");
     JAXBElement<String> u_password2 = new JAXBElement<String>(new
             QName("http://list.xfire.simpledev.org", "password"),String.class,"222222");
     JAXBElement<String> u_msg2 = new JAXBElement<String>(new
             QName("http://list.xfire.simpledev.org", "msg"),String.class,"序号2：查询考试是否通过？");
     u2.setId(2);
     u2.setUsername(u_username2);
     u2.setPassword(u_password2);
     u2.setMsg(u_msg2);   
     a.getUser().add(u1);
     a.getUser().add(u2);
  ArrayOfUser list = service.listHelloWorld(a);
  List ls = list.getUser();
  for (int i = 0; i < ls.size(); i++) {
   User u = (User)ls.get(i);
   System.out.println(u.getId());
   System.out.println(u.getUsername().getValue());
   System.out.println(u.getPassword().getValue());
   System.out.println(u.getMsg().getValue());
  }
 }

 

6.打印信息如下：
 客户端打印信息如下：
 ########### 方法1 ###########
===下面是从服务器端获取的详细信息===
1
simpledev
123456
恭喜你，你的编号是：1用户名是：simpledev密码是：123456已经被服务器端确认!
101
樱木花道
ymhd
我是新朋友樱木花道
102
流川 枫
lcf
我是新朋友流川 枫
103
三井 寿
sjs
我是新朋友三井 寿
104
宫城良田
gclt
我是新朋友宫城良田
105
赤木刚宪
ymhd
我是新朋友赤木刚宪
--------------------------------
########### 方法2 ###########
1
本田透
111111
恭喜你，编号1为已经通过考试了
2
纪纱
222222
恭喜你，编号2为已经通过考试了

 

服务端打印信息如下：
 HelloWorldServiceImpl.helloWorldDetail()
客户端传递过来的User对象信息：
id:1
username:simpledev
password:123456
msg:客户端编号为1的发出请求
朋友的编号：11用户名：许文强密码：xwq消息：上海滩-强哥
朋友的编号：12用户名：丁力密码：dl消息：上海滩-阿力
HelloWorldServiceImpl.listHelloWorld()
===id为1信息读取显示开始===
username:本田透
password:111111
msg:序号1：查询考试是否通过？
===id为2信息读取显示开始===
username:纪纱
password:222222
msg:序号2：查询考试是否通过？