2. 程式人生 > >cxf 入門

cxf 入門

阿新 • • 發佈：2017-12-29
name tro 數據表示 tag tor 啟動 repos 客戶端 ppi

1 WebService 簡單描述

? 一言以蔽之：WebService是一種跨編程語言和跨操作系統平臺的遠程調用技術。常用的webservice框架 : cfx、jwx、XFire與Axis2，jwx也就是jax-ws，是java6提供的對webservice的一種實現。cxf框架則簡化了服務發布過程。Axis與XFire已隨著技術不斷的更替慢慢落幕，而目前也只有axis2和cxf官方有更新，Axis與XFire都已不再更新。

? XML+XSD , SOAP 和 WSDL 就是構成WebService平臺的三大技術。

1 XML+XSD

? XML 封裝數據 , 解決數據表示問題 , 因為與平臺和廠商無關 , 保證了通用性 ; XSD 解決數據類型問題 , 定義了 webService 所使用的數據的類型 , 保證了不同系統下數據通用的問題

2 SOAP

? soap協議 . WebService 是通過 http 協議發送請求和接收數據結果 , http 消息內容都有特定的消息頭和消息內容 . 而 SOAP 協議限定了這些消息頭和內容的格式. 簡單理解就是 , SOAP 約束了 WebService 的請求信息和響應信息應該長什麽樣 .

3 WSDL

? WSDL(Web Services Description Language) 服務描述語言 , WebService 作為一個服務 , 必須告訴調用者服務地址在哪?提供什麽服務?調用服務需要傳什麽參數?等 這些信息 , 就是通過 WSDL文件來描述的 .

? WSDL文件保存在Web服務器上，通過一個url地址就可以訪問到它。客戶端要調用一個WebService服務之前，要知道該服務的WSDL文件的地址。WebService服務提供商可以通過兩種方式來暴露它的WSDL文件地址：1.註冊到UDDI服務器，以便被人查找；2.直接告訴給客戶端調用者。

4 UDDI

? UDDI (Universal Description, Discovery, and Integration) 是一個主要針對Web服務供應商和使用者的新項目。在用戶能夠調用Web服務之前，必須確定這個服務內包含哪些商務方法，找到被調用的接口定義，還要在服務端來編制軟件，UDDI是一種根據描述文檔來引導系統查找相應服務的機制。UDDI利用SOAP消息機制（標準的XML/HTTP）來發布，編輯，瀏覽以及查找註冊信息。它采用XML格式來封裝各種不同類型的數據，並且發送到註冊中心或者由註冊中心來返回需要的數據。

2 WebService服務工作流程

技術分享圖片

? 註冊到 UUID服務器的 webservice

工作流程大致如下 :

  1. 服務提供者實現服務 , 並在服務註冊中心(UDDI)進行註冊

  2. 服務請求者向服務註冊中心請求特定服務(其實就是請求對應的 wsdl 文件)

  3. 服務註冊中心找到對應的服務後 , 將該服務的描述(wsdl)文件返回為請求者

  4. 請求者根據返回的 wsdl 文件 , 生成相應的 soap消息 , 發送給服務提供者

  5. 服務提供者根據 soap消息執行對應的服務 , 並將結果返回給請求者

3 使用 cxf 搭建一個 webService

? CXF : Apache CXF 的前身叫 Apache CeltiXfire，現在已經正式更名為 Apache CXF 了，簡稱為 CXF。CXF 繼承了 Celtix 和 XFire 兩大開源項目的精華。

? 搭建 webService的步驟大致如下:

  1. 創建一個接口聲明提供的服務方法

  2. 實現接口

  3. 搭建web服務器,並註冊 CXFServlet , 用於對外提供服務

  4. 註冊服務

  5. 啟動web服務器

1 maven 坐標

<!-- https://mvnrepository.com/artifact/org.apache.cxf/cxf-rt-frontend-jaxws -->
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-frontend-jaxws</artifactId>
    <version>3.0.1</version>
</dependency>
<!-- https://mvnrepository.com/artifact/org.apache.cxf/cxf-rt-transports-http -->
<dependency>
    <groupId>org.apache.cxf</groupId>
    <artifactId>cxf-rt-transports-http</artifactId>
    <version>3.0.1</version>
</dependency>
?
<!-- 服務以 war 包形式發布,並且和 spring 整合所以依賴了 springmvc-->
<dependency>
    <groupId>org.springframework</groupId>
    <artifactId>spring-webmvc</artifactId>
    <version>4.3.10.RELEASE</version>
</dependency>

2 配置web.xml

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns="http://xmlns.jcp.org/xml/ns/javaee"
         xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
         xsi:schemaLocation="http://xmlns.jcp.org/xml/ns/javaee http://xmlns.jcp.org/xml/ns/javaee/web-app_3_1.xsd"
         version="3.1">
?
    <context-param>
        <param-name>contextConfigLocation</param-name>
        <param-value>classpath*:applicationContext.xml</param-value>
    </context-param>
?
    <listener>
        <listener-class>
            org.springframework.web.context.ContextLoaderListener
        </listener-class>
    </listener>
    
    <!--cxf 服務的入口-->
    <servlet>
        <servlet-name>cxf</servlet-name>
        <servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
    </servlet>
    <servlet-mapping>
        <servlet-name>cxf</servlet-name>
        <url-pattern>/webservice/*</url-pattern>
    </servlet-mapping>
</web-app>

3 創建服務接口和實現類

? HelloWorld.java

package com.fmi110.cxf.service;
import javax.jws.WebParam;
import javax.jws.WebService;
/**
 * 一定要添加 @WebService 註解 !!!
 */
@WebService
public interface HelloWorld {
    String sayHi(@WebParam(name="msg") String msg);
?
}

ps:

@WebService 註解一定要有!!!否則報錯

@WebParam(name="msg") 不是必須的 , 加了以後生成的wsdl文件中對參數 msg 的描述會用"msg" 表示 , 否則使用 "arg0" 表述

? HelloWorldImpl.java

package com.fmi110.cxf.service.impl;
import com.fmi110.cxf.service.HelloWorld;
?
public class HelloWorldImpl implements HelloWorld{
    @Override
    public String sayHi(String msg) {
        System.out.println("sayHi() 被調用...");
        return "sayHi : "+msg;
    }
}

4 spring配置文件 applicationContext.xml

? 因為在web.xml 中已經通過 <param-value>classpath*:applicationContext.xml</param-value> 指定配置文件位置 , 所以文件放在 src/main/resource 目錄下(maven工程 , 非maven工程放在 src 目錄下即可)

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:jaxws="http://cxf.apache.org/jaxws"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context-4.2.xsd
       http://cxf.apache.org/jaxws
       http://cxf.apache.org/schemas/jaxws.xsd">
?
?
    <!--開啟註解掃描聲明-->
    <context:component-scan base-package="com.fmi110"/>
?
    <!--聲明服務方式1-->
    <bean id="hello" class="com.fmi110.cxf.service.impl.HelloWorldImpl"/>
    <jaxws:server address="/helloworld">
        <jaxws:serviceBean>
            <ref bean="hello"/>
        </jaxws:serviceBean>
    </jaxws:server>
?
    <!--聲明服務方式2-->
    <!--
        <jaxws:endpoint id="helloWorld" implementor="com.fmi110.cxf.service.impl.HelloWorldImpl" address="/helloworld"/>
    -->
?
</beans>

? 如上提供了兩種註冊服務的方式 , <jaxws:server/> 和 <jaxws:endpoint/> 實現效果是等價的 , <jaxws:server/> 來源於 JAXWS 的API , 而 <jaxws:endpoint/> 來自 Xfire 的API , 選用哪個都可以...

? 這裏需要註意的是 <jaxws:server address="/helloworld"> 中的 address 屬性指定了服務的訪問地址時 /helloworld , 則在瀏覽器中輸入的地址應該是 ${request.ContextPath}/helloworld

? jaxws 標簽的詳細配置請參考 : jax-ws-configuration

5 啟動服務並訪問

? 配置好後,啟動tomcat並部署應用 , 此時在瀏覽器輸入地址 : http://localhost:8080/cxf/webservice/helloworld?wsdl

可看到如下內容 :

技術分享圖片

? 這就說明我們的服務註冊成功了...

4 創建一個客戶端

? webService 是用來實現遠程調用的 , 所以這裏我們重新建一個java工程 , 遠程調用服務

1 使用 wsimport 命令生成接口文件

? 在一個空文件夾下 , 打開cmd 窗口 , 輸入如下命令 :

wsimport  -s  .   http://localhost:8080/cxf/webservice/helloworld?wsdl

技術分享圖片

此時會生成一堆文件 , 這裏我們只需要生成的 HelloWorld.java 這個接口文件就可以了 , 文件內容如下 :

package com.fmi110.cxf.service;
?
import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;
import javax.xml.bind.annotation.XmlSeeAlso;
import javax.xml.ws.RequestWrapper;
import javax.xml.ws.ResponseWrapper;
?
 (name = "HelloWorld", targetNamespace = "http://service.cxf.fmi110.com/")
@XmlSeeAlso({
    // 這個類文件用不到,刪掉了,所以這裏也註釋掉    
    // ObjectFactory.class
})
public interface HelloWorld {
?
    @WebMethod
    @WebResult(targetNamespace = "")
    @RequestWrapper(localName = "sayHi", targetNamespace = "http://service.cxf.fmi110.com/", className = "com.fmi110.cxf.service.SayHi")
    @ResponseWrapper(localName = "sayHiResponse", targetNamespace = "http://service.cxf.fmi110.com/", className = "com.fmi110.cxf.service.SayHiResponse")
    public String sayHi(
        @WebParam(name = "msg", targetNamespace = "")
        String msg);
?
}

註意 :

  1. 接口上的註解 @XmlSeeAlso 可以刪除,不影響

  2. 接口上的註解 @WebService , name 屬性可以隨便寫不影響 , targetNamespace 屬性不能修改 , 否則服務找不到,程序報錯

2 新建一個 java 工程作為客戶端

? 這裏還是使用maven工具來構建工程,需要導入的依賴跟搭建服務端的一致,這裏不在寫了 , 項目結構如下圖 :

技術分享圖片

? 這裏接口文件 HelloWorld.java 放在了 com.fmi110.cxf.service 包下 , 只是為了與服務端接口的定義保持一致 , 事實上放在哪個包下都可以 , 因為 cxf 生成代理類對象時 是通過接口文件裏的內容描述(class字節碼) 生成 , 所在包不影響.

3 註冊客戶端

? 在spring配置文件 client-beans.xml 裏註冊客戶端

<?xml version="1.0" encoding="UTF-8"?>
<beans xmlns="http://www.springframework.org/schema/beans"
       xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance"
       xmlns:context="http://www.springframework.org/schema/context"
       xmlns:jaxws="http://cxf.apache.org/jaxws"
       xsi:schemaLocation="
       http://www.springframework.org/schema/beans
       http://www.springframework.org/schema/beans/spring-beans-4.2.xsd
       http://www.springframework.org/schema/context
       http://www.springframework.org/schema/context/spring-context-4.2.xsd
       http://cxf.apache.org/jaxws
       http://cxf.apache.org/schemas/jaxws.xsd">
?
?
    <!--聲明客戶端-->
    <jaxws:client id="client" serviceClass="com.fmi110.cxf.service.HelloWorld"
                  address="http://localhost:8080/cxf/webservice/helloworld"/>
</beans>

  1. serviceClass 的值是項目中 HelloWorld 類的全限定名

  2. address 地址必須寫正確 , 否則調用不了服務 , 該地址時服務端暴露的服務的地址

4 編寫測試代碼

import com.fmi110.cxf.service.HelloWorld;
import org.springframework.context.support.ClassPathXmlApplicationContext;
?
/**
 * Created by huangyunning on 2017/12/20.
 */
public class HelloClient {
?
    public static void main(String args[]) throws Exception {
?
        ApplicationContext context = new ClassPathXmlApplicationContext("client-beans.xml");
?
        HelloWorld client = (HelloWorld)context.getBean("client");
?
        String response = client.sayHi("Joe");
        System.out.println("Response: " + response);
?
        System.exit(0);
    }
}

5 cxf 支持的參數

? cxf 定義的接口方法參數和返回值類型可以是基本數據類型 , java 對象 或這 List 集合 , 如果要使用 Map 集合或者 接口 , 則需要註冊XmlAdapter 進行轉換

cxf 入門

相關推薦

WebService概述和CXF入門小程序

定義 clas zhang 目的 配置 service組件 ott code 方式 一. 什麽是WedService? WebService不是框架, 甚至不是一種技術, 而是一種跨平臺,跨語言的規範, WebService的出現是為了解決這種需求場景: 不同平臺,

CXF 入門：創建一個基於WS-Security標準的安全驗證(CXF回調函數使用)

urn star cti say struct stc lba features ear 註意：以下客戶端調用代碼中獲取服務端ws實例，都是通過CXF 入門: 遠程接口調用方式實現 以下是服務端配置 ===================================

cxf 入門

name tro 數據表示 tag tor 啟動 repos 客戶端 ppi 1 WebService 簡單描述 ? 一言以蔽之：WebService是一種跨編程語言和跨操作系統平臺的遠程調用技術。常用的webservice框架 : cfx、jwx、XFire與Axis2，

CXF入門教程（5） -- webService非同步呼叫模式

除了教程（3）中介紹的常見的同步呼叫模式，CXF還支援如下兩種形式的非同步呼叫模式： 輪詢方法（Polling approach） - 這種情況下呼叫遠端方法，我們可以呼叫一個特殊的方法；該方法沒有輸出引數，但是返回一個 javax.xml.ws.Respon

CXF入門教程（4） -- 設定上下文連線屬性

我們可以使用 JAX-WS 上下文來自定義客戶端代理的屬性。特別地，上下文可以用來修改連線屬性以及通過協議頭髮送資料。例如，我們可以用上下文新增一個SOAP頭，請求訊息和響應訊息都可以新增。客戶端支援下列型別的上下文： Request context（請求上下文） - 在客戶端

apache CXF入門

下載：官網：cxf.apache.org     Apache CXF = Celtix + Xfire     支援多種協議：         SOAP1.1,1.2         XML/HTTP         CORBA（Common Object Request

WebService - CXF入門 攔截器

  什麼是攔截器？？ 就是在客服端訪問服務端的時候，在期間新增攔截器完成一些額外的功能。而CXF已經提供了一些日誌攔截器，可以直接使用。 新增自帶攔截器 - 日誌攔截器 LoggingInInterceptor – 資訊輸入時的攔截器 - 請求

WebService - CXF入門 簡單的服務端和客戶端

CXF Apache CXF = Celtix + XFire，開始叫 Apache CeltiXfire，後來更名為 Apache CXF 了，以下簡稱為 CXF。CXF 繼承了 Celtix 和 XFire 兩大開源專案的精華，提供了對 JAX-WS 

【WebService框架-CXF】——CXF入門例項

這篇文章主要介紹如何編寫WebService的服務端和客戶端 準備工作 下載apache-cxf-2.4.0的jar包 將bin目錄配置到環境變數中，如：E:\Workspaces\MyEclipse 10\CXF\apa

Webservice與CXF框架快速入門

strong put 1.0 reat jdk AI NPU button RM 1. Webservice Webservice是一套遠程調用技術規範 遠程調用RPC, 實現了系統與系統進程間的遠程通信.java領域有很多可實現遠程通訊的技術，如：RMI(Socket +

WebService入門 - CXF與Spring整合 （maven專案）

可參考CXF官網-使用Spring編寫服務文件：http://cxf.apache.org/docs/writing-a-service-with-spring.html 1.新增依賴 <!-- spring與cxf 整合webservice 所需 -->

WebService的CXF框架與Spring的整合釋出服務入門

1、建立WEB專案，將CXF與SPRING的包引入專案（在下載的CXF的lib包裡，裡面已經整合好了，直接引入進去就行了） 2、建立介面 package com.ckinghan.cxf.server.service; import javax.jws

WebService之CXF框架入門小程式

其實CXF的服務建立及釋出相當簡單，建立方法如下： 安裝JDK1.7或以上(注意要設定環境變數，javac命令必須可用) 下載CXF,建議去官網下。 將下載 的CXF解壓，並配置環境變數（與JDK的環境變數配置差不多，配置完成後，需要wsdl2java -h

使用apach cxf+spring+tomcat搭建提供json格式的對外介面入門Demo

apache cxf是一款可提供webservice服務的輕量級框架。主要格式有xml和json。下面就以apache cxf和spring以及tomcat框架為基礎，搭建一個簡單的對外提供json格式的介面服務。 下面就開始快樂的學習之旅吧！ 由於apache cxf是基

Webservice的cxf開發_入門(jdk1.7)

一、部署cxf+ant環境 下載以後解壓，目錄結構如下 配置環境變數: ANT_HOME=D:\PATH\apache-ant-1.8.4 CXF_HOME=D:\PATH\apache-cxf

《ES6標準入門》29~48Page 字符串拓展 正則拓展

har 字節 其中 logs 屬性表 regex fff 不能 包含 1.字符串的拓展 ES3允許使用類似\u0061這樣的形式來表示字符，其中的數字是Unicode-8編碼。 但如果超出\uffff的字符，必須使用雙字節的形式表達，例如 \uD842\uDFB7。 在ES

Android開發入門的正確姿勢,你get到了嗎？

開源 如何 com 正常 它的 接收 應用 切換 角度 在進行Android開發之前，我們先了解一下Android的生態圈現狀。Android系統是開源的，任何手機廠商和開發者都有權限去修改系統源代碼，定制專屬的系統。 這就產生了一個問題，不同手機廠商之間的ROM可能無法安

nodejs+mysql入門實例（增）

ava value query 連接 var ssa func add blog var userAddSql = ‘INSERT INTO userinfo(id,username,pwd) VALUES(0,?,?)‘; var userAddSql_Params

nodejs+mysql入門實例（改）

end cheng console req name create brush script *** //連接數據庫 var mysql = require(‘mysql‘); var connection = mysql.createConnection({ h

AngularJS入門學習筆記一

rect directive 技術分享 attr 兩個 ava 內容 module 大括號 首先聲明： 本博客源自於學習：跟我學AngularJs:AngularJs入門及第一個實例。通過學習，我自己的一些學習筆記。 1.AngularJS的一些基本特性 （1）使用雙大括號