1.CXF简介
CXF是Apache项目下的一个开源框架,继承了CelTix和XFile两个开源项目的精华,并提供了对JAX-WS的全面支持,是一个非常优秀的WebService框架。
1)CXF支持的协议:SOAP1.1/1.2,REST。CXF是一个开源的webservice框架,提供很多完善功能,可以实现快速开发!
3)CXF支持数据格式:XML,JSON(仅在REST方式下支持)
4)并可以与Spring进行快速无缝的整合
5)灵活的部署:可以运行有Tomcat, Jboss, Jetty(内置), IBMWS, BeaWS上面。
2.CXF下载和配置
2.1.CXF下载
下载:http://cxf.apache.org/download.html
直接解压到某个盘下就可以使用。
2.2.CXF本地配置
- CXF_HOME
- PATH
Path = %JAVA_HOME%\bin;%CXF_HOME%\bin; - CLASSPATH
- 验证:
2.CXF发布WebService
2.1.服务端程序
(1)创建一个maven普通工程。如果是maven项目导入依赖
<!-- 集中定义依赖版本号 -->
<properties>
<junit.version>4.12</junit.version>
<cxf.version>3.2.6</cxf.version>
</properties>
<dependencies>
<!-- 单元测试 -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>${junit.version}</version>
<scope>test</scope>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-core</artifactId>
<version>${cxf.version}</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-jaxws</artifactId>
<version>${cxf.version}</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http</artifactId>
<version>${cxf.version}</version>
</dependency>
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http-jetty</artifactId>
<version>${cxf.version}</version>
</dependency>
</dependencies>
(2)创建SEI接口,要加入@WebService接口
备注:@BindingType(SOAPBinding.SOAP12HTTP_BINDING)表示发布SOAP1.2的服务端
@WebService
@BindingType(SOAPBinding.SOAP12HTTP_BINDING)
public interface WeatherInterface {
public String queryWeather(String cityName);
}
(3)创建SEI接口实现类
public class WeatherInterfaceImpl implements WeatherInterface {
@Override
public String queryWeather(String cityName) {
if ("成都".equals(cityName)) {
return "冷且霾";
} else {
return "暖且晴";
}
}
}
(4)发布服务(使用JaxWsServerFactoryBean发布)
public class WeatherServer {
// 用JaxWsServerFactoryBean发布服务,设置3个参数,1.服务接口;2.服务实现类;3.服务地址;
public static void main(String[] args) {
JaxWsServerFactoryBean factoryBean = new JaxWsServerFactoryBean();
// 设置服务接口
factoryBean.setServiceClass(WeatherInterface.class);
// 设置服务实现类
factoryBean.setServiceBean(new WeatherInterfaceImpl());
// 设置服务地址
factoryBean.setAddress("http://127.0.0.1:8888/weather");
// 发布
factoryBean.create();
System.out.println("服务发布成功...");
}
}
附录:
服务器端发布的类
ServerFactoryBean
JaxWsServerFactoryBean(建议使用)
2个对象,都可以发布服务端,但是我们建议使用JaxWsServerFactoryBean,因为它生成的wsdl文件更加规范。
服务器端的拦截器:
// 输入拦截器
factoryBean.getInInterceptors().add(new LoggingInInterceptor());
// 输出拦截器
factoryBean.getOutInterceptors().add(new LoggingOutInterceptor());
目的是用来输出响应的头部信息,可以看到soap协议的格式(http请求+Xml数据)
例如:
SOAP协议:HTTP+XML
Soap1.2:
----------------------------
ID: 1
Address: http://127.0.0.1:8888/weather
Encoding: UTF-8
Http-Method: POST
Content-Type: text/xml; charset=UTF-8
Headers: {Accept=[*/*], Cache-Control=[no-cache], connection=[keep-alive], Content-Length=[202], content-type=[text/xml; charset=UTF-8], Host=[127.0.0.1:8888], Pragma=[no-cache], SOAPAction=[""], User-Agent=[Apache-CXF/3.2.6]}
Payload: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns2:queryWeather xmlns:ns2="http://demo.weather.com/"><arg0>成都</arg0></ns2:queryWeather></soap:Body></soap:Envelope>
--------------------------------------
十月 06, 2018 11:07:22 上午 org.apache.cxf.services.WeatherInterfaceService.WeatherInterfacePort.WeatherInterface
信息: Outbound Message
---------------------------
ID: 1
Response-Code: 200
Encoding: UTF-8
Content-Type: text/xml
Headers: {}
Payload: <soap:Envelope xmlns:soap="http://schemas.xmlsoap.org/soap/envelope/"><soap:Body><ns2:queryWeatherResponse xmlns:ns2="http://demo.weather.com/"><return>冷且霾</return></ns2:queryWeatherResponse></soap:Body></soap:Envelope>
--------------------------------------
(5)测试服务是否发布成功,阅读使用说明书.直接访问即可。
2.2.客户端程序
(1)生成客户端代码
-
wsdl2java命令是CXF提供的生成客户端的工具,他和wsimport类似,可以根据WSDL生成客户端代码
-
wsdl2java常用参数:
-d,指定输出目录
-p,指定包名,如果不指定该参数,默认包名是WSDL的命名空间的倒序 -
wsdl2java支持SOAP1.1和SOAP1.2
完整示例:
wsdl2java -p com.weather.client -d . http://127.0.0.1:8888/weather?wsdl
//根据指定说明书地址生成客户端代码 -p指定生成的包名 -d .表示输出到当前目录
(2)使用说明书,使用生成代码调用服务端
//使用JaxWsProxyFactoryBean调用服务端,设置2个参数,1.设置服务接口;
public class WeatherClient {
public static void main(String[] args) {
JaxWsProxyFactoryBean factoryBean = new JaxWsProxyFactoryBean();
// 设置服务接口
factoryBean.setServiceClass(WeatherInterface.class);
// 设置服务地址
factoryBean.setAddress("http://127.0.0.1:8888/weather");
// 获取服务接口实例
WeatherInterface weatherInterface = factoryBean
.create(WeatherInterface.class);
// 调用查询方法
String string = weatherInterface.queryWeather("成都");
System.out.println(string);
}
}