利用CXF工具开发WebService接口

简单记录一下webservice接口开发以便供以后参考:

一、根据需求编写wsdl文件

WSDL的文件格式和语法我就不多说了,到网上百度一下,或者到W3CSchool去学习都可以,语法很简单,下面是我自己写的一个demo,仅供参考:
WSDL文件:

<?xml version='1.0' encoding='UTF-8'?>
<wsdl:definitions name="QueryUserInfoService"
    targetNamespace="http://hr.soa.csg.cn" xmlns:ns1="http://cxf.apache.org/bindings/xformat"
    xmlns:soap="http://schemas.xmlsoap.org/wsdl/soap/" xmlns:tns="http://hr.soa.csg.cn"
    xmlns:wsdl="http://schemas.xmlsoap.org/wsdl/" xmlns:xsd="http://www.w3.org/2001/XMLSchema">
    <wsdl:types>
        <xs:schema attributeFormDefault="unqualified"
            elementFormDefault="qualified" targetNamespace="http://hr.soa.csg.cn"
            xmlns:tns="http://hr.soa.csg.cn" xmlns:xs="http://www.w3.org/2001/XMLSchema">
            <xs:element name="queryUserInfoRequest" type="tns:QueryUserInfoRequest" />
            <xs:complexType name="QueryUserInfoRequest">
                <xs:sequence>
                    <xsd:element minOccurs="0" name="userId" type="xs:string" />
                </xs:sequence>
            </xs:complexType>
            <xs:element name="queryUserInfoResponse" type="tns:QueryUserInfoResponse" />
            <xs:complexType name="QueryUserInfoResponse">
                <xs:sequence>
                    <xs:element minOccurs="0" name="replyCode" type="xs:string" />
                    <xs:element maxOccurs="unbounded" minOccurs="0" name="user"
                        nillable="true" type="tns:User" />
                </xs:sequence>
            </xs:complexType>
            <xs:complexType name="User">
                <xs:sequence>
                    <xs:element name="userId" type="xs:string" />
                    <xs:element name="age" type="xs:string" />
                    <xs:element name="name" type="xs:string" />
                    <xs:element name="email" type="xs:string" />
                </xs:sequence>
            </xs:complexType>
        </xs:schema>
    </wsdl:types>
    <!--查询用户信息-->
    <wsdl:message name="queryUserInfoRequest">
        <wsdl:part name="queryUserInfoRequest" element="tns:queryUserInfoRequest" />
    </wsdl:message>
    <wsdl:message name="queryUserInfoResponse">
        <wsdl:part name="queryUserInfoResponse" element="tns:queryUserInfoResponse" />
    </wsdl:message>
    <wsdl:portType name="SOAServicePort">
        <wsdl:operation name="queryUserInfo">
            <wsdl:input message="tns:queryUserInfoRequest" />
            <wsdl:output message="tns:queryUserInfoResponse" />
        </wsdl:operation>
    </wsdl:portType>
    <wsdl:binding name="SOAServiceBinding" type="tns:SOAServicePort">
        <soap:binding style="document"
            transport="http://schemas.xmlsoap.org/soap/http" />
        <wsdl:operation name="queryUserInfo">
            <soap:operation style="document" soapAction="" />
            <wsdl:input>
                <soap:body use="literal" />
            </wsdl:input>
            <wsdl:output>
                <soap:body use="literal" />
            </wsdl:output>
        </wsdl:operation>
    </wsdl:binding>
    <wsdl:service name="QueryUserInfoService">
        <wsdl:port name="SOAService" binding="tns:SOAServiceBinding">
            <soap:address location="http://localhost:8080/service/queryUserInfoService" />
        </wsdl:port>
    </wsdl:service>
</wsdl:definitions>

二、利用CXF工具生成接口代码

1、下载cxf工具
下载地址:http://cxf.apache.org/download.html
(1)解压cxf工具,使用控制台(cmd)进入bin目录
2、使用wsdl2java工具生成客户端代码
(2)wsdl2java用法: wsdl2java -p com.client -d d:\client\src –all transferQueryEmpCode.wsdl
(注:-p后面的参数是生成代码所在的包名,-d后面的参数是生成代码存放的路径,-all后面的参数是wsdl文件所在的具体目录)
-p 指定其wsdl的命名空间,也就是要生成代码的包名:
-d 指定要产生代码所在目录
-client 生成客户端测试web service的代码
-server 生成服务器启动web service的代码
-impl 生成web service的实现代码
-ant 生成build.xml文件
-all 生成所有开始端点代码

利用CXF工具生成代码命令
生成的代码列表
把所有类中注解部分有红色标注的这一行代码删掉

三、接口代码测试

(1)运行服务端测试类,发布接口:

public class SOAServicePort_SOAService_Server{

    protected SOAServicePort_SOAService_Server() throws Exception {
        System.out.println("Starting Server");
        Object implementor = new SOAServicePortImpl();
        //接口发布地址
        String address = "http://127.0.0.1:8080/service/queryUserInfoService";
        Endpoint.publish(address, implementor);
    }
    
    public static void main(String args[]) throws Exception { 
        new SOAServicePort_SOAService_Server();
        System.out.println("Server ready..."); 
        
        Thread.sleep(5 * 60 * 1000); 
        System.out.println("Server exiting");
        System.exit(0);
    }
}

(2)在浏览器输入发布地址拼上?wsdl,截图如下:

看到的基本上就是和我们写的wsdl文件内容是一致的

(3)简单实现一下服务端的实现类

public class SOAServicePortImpl implements SOAServicePort {

    private static final Logger LOG = Logger.getLogger(SOAServicePortImpl.class.getName());

    /* (non-Javadoc)
     * @see com.user.server.SOAServicePort#queryUserInfo(com.user.server.QueryUserInfoRequest  queryUserInfoRequest )*
     */
    public com.user.server.QueryUserInfoResponse queryUserInfo(QueryUserInfoRequest queryUserInfoRequest) { 
        LOG.info("Executing operation queryUserInfo");
        System.out.println(queryUserInfoRequest.getUserId());
        try {
            //简单实现一下服务端,返回给调用者的数据
            com.user.server.QueryUserInfoResponse _return = new QueryUserInfoResponse();
            _return.setReplyCode("200");
            User u = new User();
            u.setAge("11");
            u.setEmail("xxx@126.com");
            u.setName("TestUser");
            u.setUserId("10086");
            _return.getUser().add(u);
            return _return;
        } catch (Exception ex) {
            ex.printStackTrace();
            throw new RuntimeException(ex);
        }
    }

}

(4)客户端测试类,简单封装以下请求参数

public final class SOAServicePort_SOAService_Client {

    private static final QName SERVICE_NAME = new QName("http://hr.soa.csg.cn", "QueryUserInfoService");

    private SOAServicePort_SOAService_Client() {
    }

    public static void main(String args[]) throws Exception {
        //需要将WSDL_LOCATION修改为我们发布的地址:http://127.0.0.1:8080/service/queryUserInfoService?wsdl
        URL wsdlURL = QueryUserInfoService.WSDL_LOCATION;
        if (args.length > 0) { 
            File wsdlFile = new File(args[0]);
            try {
                if (wsdlFile.exists()) {
                    wsdlURL = wsdlFile.toURI().toURL();
                } else {
                    wsdlURL = new URL(args[0]);
                }
            } catch (MalformedURLException e) {
                e.printStackTrace();
            }
        }
      
        QueryUserInfoService ss = new QueryUserInfoService(wsdlURL, SERVICE_NAME);
        SOAServicePort port = ss.getSOAService();  
        
        {
        System.out.println("Invoking queryUserInfo...");
        //简单封装请求参数
        com.user.server.QueryUserInfoRequest _queryUserInfo_queryUserInfoRequest = new QueryUserInfoRequest();
        _queryUserInfo_queryUserInfoRequest.setUserId("10086");
        //下面这一句代码就是调用服务端接口的代码
        com.user.server.QueryUserInfoResponse _queryUserInfo__return = port.queryUserInfo(_queryUserInfo_queryUserInfoRequest);
        System.out.println("queryUserInfo.result=" + _queryUserInfo__return.getReplyCode());
        System.out.println(_queryUserInfo__return.getUser().get(0).toString());


        }

        System.exit(0);
    }

}

(5)测试结果截图

服务端启动及接收到客户端请求时打印显示
客户端发送请求后得到服务端返回的数据打印显示

(6)以上只是简单的测试,还未涉及到cxf集成spring发布接口

四、其他注意事项

1、生成的接口代码出现响应报文缺少命名空间前缀问题:
解决办法:
(1)在生成的ObjectFactory.java类中修改一下代码:
@XmlElementDecl(namespace = "http://test.cxf.com", name = "queryEmployeeCodeResponse")中的namespace置为空(即是@XmlElementDecl(namespace = "", name = "queryEmployeeCodeResponse")
(2)在生成的package-info.java类的注解中增加一下代码:
原来的注解(@javax.xml.bind.annotation.XmlSchema(namespace = "http://hr.soa.csg.cn")
增加后的注解:
@javax.xml.bind.annotation.XmlSchema(namespace = "http://hr.soa.csg.cn", elementFormDefault = javax.xml.bind.annotation.XmlNsForm.QUALIFIED)

最后编辑于
©著作权归作者所有,转载或内容合作请联系作者
  • 序言:七十年代末,一起剥皮案震惊了整个滨河市,随后出现的几起案子,更是在滨河造成了极大的恐慌,老刑警刘岩,带你破解...
    沈念sama阅读 212,686评论 6 492
  • 序言:滨河连续发生了三起死亡事件,死亡现场离奇诡异,居然都是意外死亡,警方通过查阅死者的电脑和手机,发现死者居然都...
    沈念sama阅读 90,668评论 3 385
  • 文/潘晓璐 我一进店门,熙熙楼的掌柜王于贵愁眉苦脸地迎上来,“玉大人,你说我怎么就摊上这事。” “怎么了?”我有些...
    开封第一讲书人阅读 158,160评论 0 348
  • 文/不坏的土叔 我叫张陵,是天一观的道长。 经常有香客问我,道长,这世上最难降的妖魔是什么? 我笑而不...
    开封第一讲书人阅读 56,736评论 1 284
  • 正文 为了忘掉前任,我火速办了婚礼,结果婚礼上,老公的妹妹穿的比我还像新娘。我一直安慰自己,他们只是感情好,可当我...
    茶点故事阅读 65,847评论 6 386
  • 文/花漫 我一把揭开白布。 她就那样静静地躺着,像睡着了一般。 火红的嫁衣衬着肌肤如雪。 梳的纹丝不乱的头发上,一...
    开封第一讲书人阅读 50,043评论 1 291
  • 那天,我揣着相机与录音,去河边找鬼。 笑死,一个胖子当着我的面吹牛,可吹牛的内容都是我干的。 我是一名探鬼主播,决...
    沈念sama阅读 39,129评论 3 410
  • 文/苍兰香墨 我猛地睁开眼,长吁一口气:“原来是场噩梦啊……” “哼!你这毒妇竟也来了?” 一声冷哼从身侧响起,我...
    开封第一讲书人阅读 37,872评论 0 268
  • 序言:老挝万荣一对情侣失踪,失踪者是张志新(化名)和其女友刘颖,没想到半个月后,有当地人在树林里发现了一具尸体,经...
    沈念sama阅读 44,318评论 1 303
  • 正文 独居荒郊野岭守林人离奇死亡,尸身上长有42处带血的脓包…… 初始之章·张勋 以下内容为张勋视角 年9月15日...
    茶点故事阅读 36,645评论 2 327
  • 正文 我和宋清朗相恋三年,在试婚纱的时候发现自己被绿了。 大学时的朋友给我发了我未婚夫和他白月光在一起吃饭的照片。...
    茶点故事阅读 38,777评论 1 341
  • 序言:一个原本活蹦乱跳的男人离奇死亡,死状恐怖,灵堂内的尸体忽然破棺而出,到底是诈尸还是另有隐情,我是刑警宁泽,带...
    沈念sama阅读 34,470评论 4 333
  • 正文 年R本政府宣布,位于F岛的核电站,受9级特大地震影响,放射性物质发生泄漏。R本人自食恶果不足惜,却给世界环境...
    茶点故事阅读 40,126评论 3 317
  • 文/蒙蒙 一、第九天 我趴在偏房一处隐蔽的房顶上张望。 院中可真热闹,春花似锦、人声如沸。这庄子的主人今日做“春日...
    开封第一讲书人阅读 30,861评论 0 21
  • 文/苍兰香墨 我抬头看了看天上的太阳。三九已至,却和暖如春,着一层夹袄步出监牢的瞬间,已是汗流浃背。 一阵脚步声响...
    开封第一讲书人阅读 32,095评论 1 267
  • 我被黑心中介骗来泰国打工, 没想到刚下飞机就差点儿被人妖公主榨干…… 1. 我叫王不留,地道东北人。 一个月前我还...
    沈念sama阅读 46,589评论 2 362
  • 正文 我出身青楼,却偏偏与公主长得像,于是被迫代替她去往敌国和亲。 传闻我的和亲对象是个残疾皇子,可洞房花烛夜当晚...
    茶点故事阅读 43,687评论 2 351

推荐阅读更多精彩内容

  • Spring Cloud为开发人员提供了快速构建分布式系统中一些常见模式的工具(例如配置管理,服务发现,断路器,智...
    卡卡罗2017阅读 134,637评论 18 139
  • 一. Java基础部分.................................................
    wy_sure阅读 3,806评论 0 11
  • Spring Boot 参考指南 介绍 转载自:https://www.gitbook.com/book/qbgb...
    毛宇鹏阅读 46,778评论 6 342
  • 勇氣,用來表達自己的立場想法或用來努力突破眼前的困境。 帶不帶種?世界給你某些教導,非要你一起做,才叫做帶種:說謊...
    YNC再寫一篇阅读 150评论 0 0
  • 首先,我不是专业的影评人,全部观点都是源自个人对影片内容的理解;其次,所有内容均为原创,手工码字。如果觉得有用或与...
    _Akon_Wang阅读 879评论 1 1