Java?WebService開(kāi)源框架CXF案例分析

本篇內(nèi)容介紹了“Java WebService開(kāi)源框架CXF案例分析”的有關(guān)知識(shí)，在實(shí)際案例的操作過(guò)程中，不少人都會(huì)遇到這樣的困境，接下來(lái)就讓小編帶領(lǐng)大家學(xué)習(xí)一下如何處理這些情況吧！希望大家仔細(xì)閱讀，能夠?qū)W有所成！

CXF簡(jiǎn)介

CXF是一個(gè)開(kāi)源的WebService框架。Apache CXF = Celtix + XFire，開(kāi)始叫 Apache CeltiXfire，后來(lái)更名為 Apache CXF 了，以下簡(jiǎn)稱為 CXF。CXF 繼承了 Celtix 和 XFire 兩大開(kāi)源項(xiàng)目的精華，提供了對(duì) JAX-WS 全面的支持，并且提供了多種 Binding 、DataBinding、Transport 以及各種 Format 的支持，并且可以根據(jù)實(shí)際項(xiàng)目的需要，采用代碼優(yōu)先（Code First）或者 WSDL 優(yōu)先（WSDL First）來(lái)輕松地實(shí)現(xiàn) Web Services 的發(fā)布和使用。

支持多種標(biāo)準(zhǔn)

• 支持 JAX-WS、 JAX-WSA、JSR-181 和 SAAJ；

• 支持 SOAP 1.1、1.2、WS-I BasicProfile、WS-Security、WS-Addressing、WS-RM 和 WS-Policy；

• 支持 WSDL 1.1 、2.0；

• 支持 MTOM；

它支持多種協(xié)議，比如：SOAP1.1,1,2、XML/HTTP、RESTful HTTP 或者 CORBA。CORBA（Common Object Request Broker Architecture公共對(duì)象請(qǐng)求代理體系結(jié)構(gòu),早期語(yǔ)言使用的WS。C,c++,C#）

Cxf是基于SOA總線結(jié)構(gòu)，依靠spring完成模塊的集成，實(shí)現(xiàn)SOA方式。

靈活的部署：可以運(yùn)行有Tomcat,Jboss,Jetty(內(nèi)置),weblogic上面。

CXF入門案例

我們還以昨天的天氣服務(wù)為案例來(lái)看一下CXF的開(kāi)發(fā)過(guò)程。

服務(wù)端的實(shí)現(xiàn)

1.創(chuàng)建一個(gè)空的java項(xiàng)目，創(chuàng)建一個(gè)lib目錄，將所有jar包放入lib目錄
  然后為工程引入jar包，選擇build path，然后Add JARS，只用選擇cxf-manifest.jar即可。

2.創(chuàng)建一個(gè)SEI接口，需要在接口上添加@WebService注解

@WebService
public interface WeatherInterface {
    public String queryWeather(String cityName);
}

3.創(chuàng)建SEI接口實(shí)現(xiàn)類 

public class WeatherInterfaceImpl implements WeatherInterface {

    public String queryWeather(String cityName) {
        if("河南".equals(cityName)) {
            return "熱爆炸";
        }else {
            return "冰雹";
        }
    }
}

4.發(fā)布服務(wù) 

public class WeatherServer {

    public static void main(String[] args) {
        //創(chuàng)建服務(wù)工廠Bean
        JaxWsServerFactoryBean jaxWsServerFactoryBean=new JaxWsServerFactoryBean();
        //設(shè)置服務(wù)接口
        jaxWsServerFactoryBean.setServiceClass(WeatherInterface.class);
        //設(shè)置服務(wù)實(shí)現(xiàn)類
        jaxWsServerFactoryBean.setServiceBean(new WeatherInterfaceImpl());
        //設(shè)置服務(wù)地址
        jaxWsServerFactoryBean.setAddress("http://127.0.0.1:12345/weather");
        //創(chuàng)建服務(wù)
        jaxWsServerFactoryBean.create();
    }

}

5.訪問(wèn)服務(wù)的wsdl文件地址，看服務(wù)是否發(fā)布成功
    http://127.0.0.1:12345/weather?wsdl

發(fā)布SOAP1.2的服務(wù)端

SOAP分為1.1版本和1.2版本。JDK1.6并不支持1.2，我們可以通過(guò)CXF來(lái)發(fā)布SOAP1.2的服務(wù)端。
只需要在接口上添加注解 @BindingType(SOAPBinding.SOAP12HTTP_BINDING)。然后重新發(fā)布服務(wù)即可

import javax.jws.WebService;
import javax.xml.ws.BindingType;
import javax.xml.ws.soap.SOAPBinding;

@WebService
@BindingType(SOAPBinding.SOAP12HTTP_BINDING)
public interface WeatherInterface {
    public String queryWeather(String cityName);
}

客戶端的實(shí)現(xiàn)

Wsdl2java命令是CXF提供的生成客戶端的工具，他和wsimport類似，可以根據(jù)WSDL生成客戶端代碼 

Wsdl2java常用參數(shù)：
-d，指定輸出目錄
-p，指定包名，如果不指定該參數(shù)，默認(rèn)包名是WSDL的命名空間的倒序 

Wsdl2java支持SOAP1.1和SOAP1.2

1.我們先創(chuàng)建一個(gè)客戶端項(xiàng)目，然后引入jar包，和上面一樣，使用Add JARS選擇cxf-manifest.jar即可

  然后使用工具生成客戶端

  wsdl2java -p com.cad.cxf -d . http://127.0.0.1:12345/weather?wsdl

2.創(chuàng)建客戶端 

public class WeatherClient {

    public static void main(String[] args) {
        JaxWsProxyFactoryBean jaxWsProxyFactoryBean=new JaxWsProxyFactoryBean();
        //設(shè)置服務(wù)接口
        jaxWsProxyFactoryBean.setServiceClass(WeatherInterface.class); 
        //設(shè)置服務(wù)地址
        jaxWsProxyFactoryBean.setAddress("http://127.0.0.1:12345/weather");
        //獲取服務(wù)接口實(shí)例
        WeatherInterface weatherInterface=(WeatherInterface) jaxWsProxyFactoryBean.create();
        //調(diào)用方法
        String message=weatherInterface.queryWeather("河南");
        System.out.println(message);
    }

}

CXF+Spring整合發(fā)布SOAP模式的服務(wù)

服務(wù)端的實(shí)現(xiàn)

1.創(chuàng)建WEB項(xiàng)目，導(dǎo)入jar包

2.創(chuàng)建SEI接口 

@WebService
@BindingType(SOAPBinding.SOAP12HTTP_BINDING)
public interface WeatherInterface {
    public String queryWeather(String cityName);
}

3.創(chuàng)建SEI實(shí)現(xiàn)類 
public class WeatherInterfaceImpl implements WeatherInterface {

    public String queryWeather(String cityName) {
        if("河南".equals(cityName)) {
            return "熱爆炸";
        }else {
            return "冰雹";
        }
    }
}

4.配置spring配置文件，applicationContext.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:jaxws="http://cxf.apache.org/jaxws"
    xmlns:jaxrs="http://cxf.apache.org/jaxrs" xmlns:cxf="http://cxf.apache.org/core"
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
                            http://www.springframework.org/schema/beans/spring-beans.xsd
                            http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd
                            http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
                            http://cxf.apache.org/core http://cxf.apache.org/schemas/core.xsd">

<!--jaxws:server發(fā)布SOAP協(xié)議的服務(wù) ，對(duì)JaxWsServerFactoryBean類封裝-->
<!--serviceClass屬性是服務(wù)接口，address代表地址，因?yàn)槲覀兪莣eb服務(wù)，不需要輸入ip。serviceBean是服務(wù)實(shí)現(xiàn)類-->
<jaxws:server serviceClass="com.cad.cxf.WeatherInterface" address="/weather">
    <jaxws:serviceBean>
        <ref bean="weatherInterfaceImpl"/>
    </jaxws:serviceBean>
</jaxws:server>
<bean name="weatherInterfaceImpl" class="com.cad.cxf.WeatherInterfaceImpl"></bean>
</beans>

5.配置web.xml 

<?xml version="1.0" encoding="UTF-8"?>
<web-app xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xmlns="http://java.sun.com/xml/ns/javaee" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5">
  <display-name>CXFSpringDemo</display-name>

  //配置Tomcat啟動(dòng)時(shí)加載Spring配置文件 
  <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>
    <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>/ws/*</url-pattern>
  </servlet-mapping>


  <welcome-file-list>
    <welcome-file>index.html</welcome-file>
    <welcome-file>index.htm</welcome-file>
    <welcome-file>index.jsp</welcome-file>
    <welcome-file>default.html</welcome-file>
    <welcome-file>default.htm</welcome-file>
    <welcome-file>default.jsp</welcome-file>
  </welcome-file-list>
</web-app>

6.部署到Tomcat下，發(fā)布服務(wù)，并訪問(wèn) 

http://localhost:8080/CXFSpringDemo/ws/weather?wsdl

客戶端的實(shí)現(xiàn)

1.創(chuàng)建項(xiàng)目，導(dǎo)入jar包，生成客戶端 

wsdl2java -p com.cad.cxf -d . http://localhost:8080/CXFSpringDemo/ws/weather?wsdl

2.配置Spring文件  

<?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:jaxws="http://cxf.apache.org/jaxws"
    xmlns:jaxrs="http://cxf.apache.org/jaxrs" xmlns:cxf="http://cxf.apache.org/core"
    xsi:schemaLocation="http://www.springframework.org/schema/beans 
                            http://www.springframework.org/schema/beans/spring-beans.xsd
                            http://cxf.apache.org/jaxrs http://cxf.apache.org/schemas/jaxrs.xsd
                            http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd
                            http://cxf.apache.org/core http://cxf.apache.org/schemas/core.xsd">
    <!-- <jaxws:client實(shí)現(xiàn)客戶端 ，對(duì)JaxWsProxyFactoryBean類封裝-->   
    <!-- address是服務(wù)地址，servicelass是服務(wù)接口，返回服務(wù)實(shí)現(xiàn)類-->   
    <jaxws:client id="weatherClient" address="http://localhost:8080/CXFSpringDemo/ws/weather" serviceClass="com.cad.cxf.WeatherInterface"/>
</beans>

3.通過(guò)Spring容器獲取服務(wù)實(shí)現(xiàn)類，調(diào)用方法 

public class WeatherClient {

    public static void main(String[] args) {
        ApplicationContext context = new ClassPathXmlApplicationContext("classpath:applicationContext.xml");
        WeatherInterface  weatherInterface = (WeatherInterface) context.getBean("weatherClient");
        String message=weatherInterface.queryWeather("河南");
        System.out.println(message);
    }

}

CXF發(fā)布REST模式的服務(wù)

REST即表述性狀態(tài)傳遞（英文：Representational State Transfer，簡(jiǎn)稱REST），是一種軟件架構(gòu)風(fēng)格。

因?yàn)镽EST模式的Web服務(wù)與復(fù)雜的SOAP和XML-RPC對(duì)比來(lái)講明顯的更加簡(jiǎn)潔，越來(lái)越多的web服務(wù)開(kāi)始采用REST風(fēng)格設(shè)計(jì)和實(shí)現(xiàn)rest服務(wù)采用HTTP 做傳輸協(xié)議，REST 對(duì)于HTTP 的利用實(shí)現(xiàn)精確的資源定位。

例如：
非rest方式：http://ip:port/queryUser.action?userType=student&id=001 

Rest方式：http://ip:port/user/student/query/001

1.創(chuàng)建一個(gè)項(xiàng)目，導(dǎo)入CXF jar包

2.創(chuàng)建一個(gè)實(shí)體類 Student   
@XmlRootElement(name="student")可以實(shí)現(xiàn)XML和對(duì)象之間的轉(zhuǎn)換，name屬性指定根元素

@XmlRootElement(name="student")
public class Student {
    private int id;
    private String name;
    private Date birthday;
    public int getId() {
        return id;
    }
    public void setId(int id) {
        this.id = id;
    }
    public String getName() {
        return name;
    }
    public void setName(String name) {
        this.name = name;
    }
    public Date getBirthday() {
        return birthday;
    }
    public void setBirthday(Date birthday) {
        this.birthday = birthday;
    }

}

3.創(chuàng)建SEI接口 

@WebService
//@Path("/student")就是指定訪問(wèn)該接口的路徑
@Path("/Student")
public interface StudentInterface {
        //指定請(qǐng)求方式，如果服務(wù)端發(fā)布的時(shí)候指定的是GET（POST），那么客戶端訪問(wèn)時(shí)必須使用GET（POST
        @GET
        //指定服務(wù)數(shù)據(jù)類型，可以是XML，json等數(shù)據(jù)類型
        @Produces(MediaType.APPLICATION_XML)
        //@Path("/query/{id}")指定該方法的路徑，“{id}”指參數(shù)，多個(gè)參數(shù)，以“/”隔開(kāi)，放到“{}”中
        @Path("/query/{id}")
        public Student queryStudent(@PathParam("id")int id);

        @GET
        @Produces(MediaType.APPLICATION_XML)
        @Path("/queryList/{name}")
        public List<Student> queryList(@PathParam("name")String name);
}

4.創(chuàng)建SEI實(shí)現(xiàn)類 

public class StudentInterfaceImpl implements StudentInterface {
    @Override
    public Student queryStudent(int id) {
        Student s=new Student();
        s.setId(666);
        s.setName("張三");
        s.setBirthday(new Date());
        return s;
    }

    @Override
    public List<Student> queryList(String name) {
        Student s=new Student();
        s.setId(666);
        s.setName("張三");
        s.setBirthday(new Date());

        Student s2=new Student();
        s2.setId(888);
        s2.setName("李四");
        s2.setBirthday(new Date());

        List<Student> l=new ArrayList<Student>();
        l.add(s);
        l.add(s2);
        return l;
    }

}

5.發(fā)布服務(wù) 

public class StudentServer {

    public static void main(String[] args) {
        JAXRSServerFactoryBean jaxrsServerFactoryBean=new JAXRSServerFactoryBean();
        //設(shè)置服務(wù)實(shí)現(xiàn)類
        jaxrsServerFactoryBean.setServiceBean(new StudentInterfaceImpl());
        //設(shè)置資源類，如果有多個(gè)資源類，可以以“,”隔開(kāi)，例如Student.class StudentInterface.class都是資源類，但是StudentInterfaceImpl里面已經(jīng)包含了Student.class StudentInterface.class，所以不用重復(fù)指定
        jaxrsServerFactoryBean.setResourceClasses(StudentInterfaceImpl.class); 

        //設(shè)置服務(wù)地址
        jaxrsServerFactoryBean.setAddress("http://127.0.0.1:12345/Class");
        //發(fā)布服務(wù)
        jaxrsServerFactoryBean.create();

    }

}

6.測(cè)試服務(wù) 

訪問(wèn)query方法 
    http://127.0.0.1:12345/Class/Student/query/001

訪問(wèn)queryList方法 
    http://127.0.0.1:12345/Class/Student/queryList/xxx

如果服務(wù)端發(fā)布時(shí)指定請(qǐng)求方式是GET（POST），客戶端必須使用GET（POST）訪問(wèn)服務(wù)端，否則會(huì)報(bào)異常。
如果在同一方法上同時(shí)指定XML和JSON媒體類型，在GET請(qǐng)求下，默認(rèn)返回XML，在POST請(qǐng)求下，默認(rèn)返回JSON

CXF+Spring整合發(fā)布REST模式的服務(wù)

綜合案例：手機(jī)歸屬地查詢

“Java WebService開(kāi)源框架CXF案例分析”的內(nèi)容就介紹到這里了，感謝大家的閱讀。如果想了解更多行業(yè)相關(guān)的知識(shí)可以關(guān)注億速云網(wǎng)站，小編將為大家輸出更多高質(zhì)量的實(shí)用文章！