cxf处理java bean及List、Map类型

      项目中经常是处理复合类型比如集合List、Map，下面就cxf处理复合类型进行讲解。

具体例子如下：

   这里实例是客户端传一个JavaBean，服务器端返回集合类型；

 一、  接口返回List处理：

    在原来的项目实例（cxf开发webService服务端口）基础上，我们先创建一个实体类User:

/**
 * 
 */
package com.hik.entity;

/**
 * @ClassName: User
 * @Description: 用户实体类
 * @author jed
 * @date 2017年7月30日下午2:44:41
 *
 */
public class User {

    private Integer id; // 编号
    private String userName; //用户名
    private String password; //密码
    
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getUserName() {
        return userName;
    }
    public void setUserName(String userName) {
        this.userName = userName;
    }
    public String getPassword() {
        return password;
    }
    public void setPassword(String password) {
        this.password = password;
    }
    
    
}

再创建一个Role实体类：

/**
 * 
 */
package com.hik.entity;

/**
 * @ClassName: Role
 * @Description: TODO
 * @author jed
 * @date 2017年7月30日下午2:46:45
 *
 */
public class Role {

    private Integer id; //编号
    private String roleName; //角色名称
    
    public Role() {
        super();
    }

    public Role(Integer id, String roleName) {
        super();
        this.id = id;
        this.roleName = roleName;
    }
    
    public Integer getId() {
        return id;
    }
    public void setId(Integer id) {
        this.id = id;
    }
    public String getRoleName() {
        return roleName;
    }
    public void setRoleName(String roleName) {
        this.roleName = roleName;
    }
    
    
}

然后HelloWorld再加一个接口方法getRoleByUser，通过用户查找角色：

/**
 * 
 */
package com.hik.webservice;

import java.util.List;

import javax.jws.WebService;

import com.hik.entity.Role;
import com.hik.entity.User;

/**
 * @ClassName: HelloWorld
 * @Description: TODO
 * @author jed
 * @date 2017年7月30日上午10:20:35
 *
 */
@WebService
public interface HelloWorld {

    public String say(String str);
    
    public List<Role> getRoleByUser(User user);
}

然后HelloWorld接口实现类 HelloWorldImpl写下新增的方法的具体实现，我们这里写死，模拟下即可：

/**
 * 
 */
package com.hik.webservice.impl;

import java.util.ArrayList;
import java.util.List;

import javax.jws.WebService;

import com.hik.entity.Role;
import com.hik.entity.User;
import com.hik.webservice.HelloWorld;

/**
 * @ClassName: HelloWorldImpl
 * @Description: TODO
 * @author jed
 * @date 2017年7月30日上午10:24:46
 *
 */
@WebService
public class HelloWorldImpl implements HelloWorld{

    public String say(String str) {
        return "hello "+str;
    }

    public List<Role> getRoleByUser(User user) {
        List<Role> roleList = new ArrayList<Role>();
        if(user!=null){
            if(user.getUserName().equals("jack") && user.getPassword().equals("123456")){
                roleList.add(new Role(1, "技术总监"));
                roleList.add(new Role(2, "产品经理"));
            }else if(user.getUserName().equals("lili") && user.getPassword().equals("123456")){
                roleList.add(new Role(3, "程序员"));
            }
            return roleList;
        }else{
            return null;
        }
                
    }

}

服务端其他地方不用动；再重新发布下webService接口。

下面我们来处理下客户端，和前面讲的一样。我们用wsdl2java工具重新生成代码（参考cxf开发webService客户端及调用服务端的理解 ）

我们改下Client类：

/**
 * 
 */
package com.hik.webservice;

import java.util.List;

/**
 * @ClassName: Client
 * @Description: TODO
 * @author jed
 * @date 2017年7月30日下午1:58:36
 *
 */
public class Client {

    public static void main(String[] args) {
        HelloWorldService service = new HelloWorldService();
        HelloWorld helloWorld = service.getHelloWorldPort(); //代理
        //System.out.println(helloWorld.say("你好！"));
        User user = new User();
        user.setUserName("lili");
        user.setPassword("123456"); 
        List<Role> roleList = helloWorld.getRoleByUser(user);
        for(Role role : roleList){
            System.out.println(role.getId()+" , "+role.getRoleName());
        }
    }
}

运行截图：

二、接口返回Map处理

      map类型比较特殊，由其数据结构而决定。XmlAdapter类源码也有说明：

 因此，需要写一个适配器来做转换，使用注解annotation注解 。该适配器类需实现抽象类XmlAdapter的两个转换方法。

 代码例子如下：

  如增加接口：获取所有用用户以及对应的每个用户所有角色信息；

服务器端：

HelloWorld接口加方法：

/**
     * 
     * @MethodName: getRoles
     * @Description: 获取所有用户及对应角色
     * @author jed
     * @date 2017年8月4日下午10:36:59
     * @param @return    
     * @return Map<String,List<Role>>    返回类型
     * @return
     *
     */
    @XmlJavaTypeAdapter(MapAdapter.class)
    public Map<String, List<Role>> getRoles();

 HelloWorldImpl实现类加方法实现：

public Map<String, List<Role>> getRoles() {
        Map<String, List<Role>> map = new HashMap<String, List<Role>>();
        List<Role> roleList1 = new ArrayList<Role>();
        roleList1.add(new Role(1, "技术总监"));
        roleList1.add(new Role(2, "产品经理"));
        map.put("admin", roleList1);
        List<Role> roleList2 = new ArrayList<Role>();
        roleList2.add(new Role(3, "程序员"));
        map.put("jack", roleList2);
        return map;
    }

然后我们启动Server类：发现报错：

 报错显示不支持该类型，解决方案，可以使用适配器，把cxf不能接受的类型通过适配器，转能接受的类型。

      我们使用@XmlJavaTypeAdapter注解，加在接口定义上，完整接口代码如下：

/**
 * 
 */
package com.hik.webservice;

import java.util.List;
import java.util.Map;

import javax.jws.WebService;
import javax.xml.bind.annotation.adapters.XmlJavaTypeAdapter;

import com.hik.adapter.MapAdapter;
import com.hik.entity.Role;
import com.hik.entity.User;

/**
 * @ClassName: HelloWorld
 * @Description: TODO
 * @author jed
 * @date 2017年7月30日上午10:20:35
 *
 */
@WebService
public interface HelloWorld {

    public String say(String str);
    
    /**
     * 
     * @MethodName: getRoleByUser
     * @Description: 获取用户角色 
     * @author jed
     * @date 2017年8月4日下午10:37:30
     * @param @param user
     * @param @return    
     * @return List<Role>    返回类型
     * @param user
     * @return
     *
     */
    public List<Role> getRoleByUser(User user);
    
    /**
     * 
     * @MethodName: getRoles
     * @Description: 获取所有用户及对应角色
     * @author jed
     * @date 2017年8月4日下午10:36:59
     * @param @return    
     * @return Map<String,List<Role>>    返回类型
     * @return
     *
     */
    @XmlJavaTypeAdapter(MapAdapter.class)
    public Map<String, List<Role>> getRoles();
}

这里参数需要一个实现了XmlAdapter类的适配器类；

这里的话XmlAdapter要加两个参数，XmlAdapter<ValueType,BoundType> 

ValueType是cxf能接收的类型，这里我用了数组；

BoundType是cxf不能接受的类型，也就是我例子里的需求的Map类型；

/**
 * 
 */
package com.hik.adapter;

import java.util.HashMap;
import java.util.List;
import java.util.Map;

import javax.xml.bind.annotation.adapters.XmlAdapter;

import com.hik.entity.Role;

/**
 * @ClassName: MapAdapter
 * @Description: Map适配器
 * @author jed
 * @date 2017年8月4日下午10:56:41
 *
 */
public class MapAdapter extends XmlAdapter<MyRole[], Map<String, List<Role>>>{

    /**
     * 适配转换  MyRole[] -> Map<String, List<Role>>
     */
    @Override
    public Map<String, List<Role>> unmarshal(MyRole[] v) throws Exception {
        Map<String, List<Role>> map = new HashMap<String, List<Role>>();
        for(int i=0;i<v.length;i++){
            MyRole r = v[i];
            map.put(r.getKey(), r.getValue());
        }
        return map;
    }

     /**
     * 适配转换  Map<String, List<Role>> -> MyRole[]
     */
    @Override
    public MyRole[] marshal(Map<String, List<Role>> v) throws Exception {
        MyRole[] roles = new MyRole[v.size()];
        int i=0;
        for(String key : v.keySet()){
            roles[i] = new MyRole();
            roles[i].setKey(key);
            roles[i].setValue(v.get(key));
            i++;
        }
        
        return roles;
    }

}

还有一个MyRole自定义类型，key:value。我们搞成两个属性，具体实现如下：

/**
 * 
 */
package com.hik.adapter;

import java.util.List;

import com.hik.entity.Role;

/**
 * @ClassName: MyRole
 * @Description: 自定义实体 cxf能接受
 * @author jed
 * @date 2017年8月4日下午11:01:23
 *
 */
public class MyRole {

    private String key;
    private List<Role> value;
    
    public String getKey() {
        return key;
    }
    public void setKey(String key) {
        this.key = key;
    }
    public List<Role> getValue() {
        return value;
    }
    public void setValue(List<Role> value) {
        this.value = value;
    }
    
    
}

OK  好了。我们运行Server类，发布webservice接口：

发布成功。然后就到了webservice客户端，我们用wsdl2java工具生成下最新代码

我们修改下Client类：

/**
 * 
 */
package com.hik.webservice;

import java.util.List;

/**
 * @ClassName: Client
 * @Description: TODO
 * @author jed
 * @date 2017年7月30日下午1:58:36
 *
 */
public class Client {

    public static void main(String[] args) {
        HelloWorldService service = new HelloWorldService();
        HelloWorld helloWorld = service.getHelloWorldPort(); //代理
        //System.out.println(helloWorld.say("你好！"));
        /*User user = new User();
        user.setUserName("lili");
        user.setPassword("123456"); 
        List<Role> roleList = helloWorld.getRoleByUser(user);
        for(Role role : roleList){
            System.out.println(role.getId()+" , "+role.getRoleName());
        }*/
        MyRoleArray array = helloWorld.getRoles();
        List<MyRole> roleList = array.item;
        for(int i=0;i<roleList.size();i++){
            MyRole mr = roleList.get(i);
            System.out.println(mr.key+":");
            for(Role r: mr.getValue()){
                System.out.println(r.getId()+","+r.getRoleName()+" ");
            }
            System.out.println();
        }
    }
}

运行结果：

    总结： webService处理过程如下：

1、webservice服务器端开发webservice接口，然后发布webservice；

2、通过一个Url调用webservice接口，发布的url是 http://192.168.0.102/helloWorld，则我们请求的url就是 http://192.168.0.102/helloWorld?wsdl  

3、请求成功，返回一大串xml标记。这一大串xml即使wsdl。   wsdl （Web Services Description Language） 也就是Web Service描述语言，描述服务器端定义的webservice接口的相关信息。

4、wsdl描述可看到发布的方法。如：wsdl:types就是定义了一些变量，wsdl:message相当于定义方法，wsdl:portType相当与调用与返回。

5、客户端通过这个url请求，获得wsdl规范的xml文档片段信息，需用到SOAP（Simple Object Access Protocol）即简单对象访问协议，我们通过这个协议，来实现客户端，服务器端消息交互，SOAP使用XML消息调用远程方法；

     当然交互的媒介就是xml，具体交互内容根据wsdl文档描述来。