cxf实现webservice简单案例

落日映苍穹つ 2022-04-13 14:59 520阅读 0赞

### 1.创建一个简单的maven工程，添加依赖 ###

<project xmlns="http://maven.apache.org/POM/4.0.0" xmlns:xsi="http://www.w3.org/2001/XMLSchema-instance" xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 http://maven.apache.org/xsd/maven-4.0.0.xsd">
      <modelVersion>4.0.0</modelVersion>
      <groupId>com.szcatic</groupId>
      <artifactId>cxf</artifactId>
      <version>0.0.1-SNAPSHOT</version>
      <packaging>war</packaging>
      <dependencies>
      	
    	<dependency>
    	    <groupId>org.springframework</groupId>
    	    <artifactId>spring-webmvc</artifactId>
    	    <version>5.1.3.RELEASE</version>
    	</dependency>
    	<dependency>
    	    <groupId>org.apache.cxf</groupId>
    	    <artifactId>cxf-rt-frontend-jaxws</artifactId>
    	    <version>3.2.7</version>
    	</dependency>
    	<dependency>
    	    <groupId>org.apache.cxf</groupId>
    	    <artifactId>cxf-rt-transports-http</artifactId>
    	    <version>3.2.7</version>
    	</dependency>
    	
    	<dependency>
    	    <groupId>org.apache.cxf</groupId>
    	    <artifactId>cxf-rt-transports-http-jetty</artifactId>
    	    <version>3.2.7</version>
    	</dependency>
      	
    	<dependency>
    	    <groupId>org.junit.jupiter</groupId>
    	    <artifactId>junit-jupiter-engine</artifactId>
    	    <version>5.3.2</version>
    	    <scope>test</scope>
    	</dependency>
    	<dependency>
    	    <groupId>org.junit.platform</groupId>
    	    <artifactId>junit-platform-runner</artifactId>
    	    <version>1.3.2</version>
    	    <scope>test</scope>
    	</dependency>
      </dependencies>
    </project>

### 2.分别编写服务接口 ###

**2.1 HelloService.java**

package com.szcatic.webservice.service;
    
    import javax.jws.WebParam;
    import javax.jws.WebService;
    
    /**
     * 使用@webService注解，来标识这是一个暴露的webservice
     * @author zsx
     *
     */
    @WebService
    public interface HelloService {
    	
    	String sayHello(@WebParam(name = "name") String message);
    }

**2.2 HiService.java**

package com.szcatic.webservice.service;
    
    import javax.jws.WebParam;
    import javax.jws.WebService;
    
    @WebService
    public interface HiService {
    	
    	String sayHi(@WebParam(name="name")String name);
    }

**2.3 UserService.java**

package com.szcatic.webservice.service;
    
    import javax.jws.WebParam;
    import javax.jws.WebService;
    
    @WebService
    public interface UserService {
    	
    	String getName(@WebParam(name = "name") String name);
    }

### 3.编写服务具体实现 ###

**3.1 HelloServiceImpl.java**

package com.szcatic.webservice.impl;
    
    import javax.jws.WebService;
    
    import com.szcatic.webservice.service.HelloService;
    
    
    /**
     * 通过endpoint属性值指明服务接口，在发布的时候要使用该值
     * @author zsx
     *
     */
    @WebService(endpointInterface="com.szcatic.webservice.service.HelloService",serviceName="helloWorld")
    public class HelloServiceImpl implements HelloService {
    	
    	public String sayHello(String name) {
    		System.out.println("执行sayHello方法");
    		return "Hello " + name;
    	}
    }

** 3.2 HiServiceImpl.java**

package com.szcatic.webservice.impl;
    
    import javax.jws.WebService;
    
    import com.szcatic.webservice.service.HiService;
    
    @WebService(endpointInterface="com.szcatic.webservice.service.HiService",serviceName="hiWorld")
    public class HiServiceImpl implements HiService{
    
    	@Override
    	public String sayHi(String name) {
    		System.out.println("执行sayHi方法");
    		return "Hi," + name;
    	}
    
    }

**3.3 UserServiceImpl.java**

package com.szcatic.webservice.impl;
    
    import javax.jws.WebService;
    
    import com.szcatic.webservice.service.UserService;
    
    @WebService(endpointInterface="com.szcatic.webservice.service.UserService",serviceName="getName")
    public class UserServiceImpl implements UserService {
    
    	@Override
    	public String getName(String name) {
    		System.out.println("执行getName方法");
    		return name;
    	}
    
    }

### 4.编写服务发布测试类 ###

package com.szcatic.test;
    
    import javax.xml.ws.Endpoint;
    
    import org.apache.cxf.frontend.ServerFactoryBean;
    import org.apache.cxf.jaxws.JaxWsServerFactoryBean;
    
    import com.szcatic.webservice.impl.HelloServiceImpl;
    import com.szcatic.webservice.impl.HiServiceImpl;
    import com.szcatic.webservice.impl.UserServiceImpl;
    import com.szcatic.webservice.service.UserService;
    
    public class WebServicePublishTest {
    	
    	public static void testEndpoint() {
    		String address = "http://localhost:8088/helloWorld";
    		Endpoint.publish(address, new HelloServiceImpl());
    	}
    	
    	public static void testJaxWsServerFactoryBean() {
    		JaxWsServerFactoryBean bean = new JaxWsServerFactoryBean();
    		bean.setAddress("http://localhost:8088/hiWorld");// 服务的地址
    		bean.setServiceClass(HiServiceImpl.class);// 提供服务的类的类型
    		bean.setServiceBean(new HiServiceImpl());// 提供服务的实例
    		bean.create();// 发布服务 publish()…
    	}
    	
    	public static void testServerFactoryBean() {
    		ServerFactoryBean factory = new ServerFactoryBean();
    		factory.setAddress("http://localhost:8088/getName");
    		factory.setServiceClass(UserService.class);
    		factory.setServiceBean(new UserServiceImpl());
    		factory.create();
    	}
    	
    	public static void main(String[] args) {
    		System.out.println("web service start。。。");
    		testEndpoint();
    		testJaxWsServerFactoryBean();
    		testServerFactoryBean();
    		System.out.println("server ready...");
    	}
    }

### 5.执行服务测试类主程序 ###

**5.1 控制台输出内容如下：**

web service start。。。
    十二月 12, 2018 10:52:30 上午 org.apache.cxf.wsdl.service.factory.ReflectionServiceFactoryBean buildServiceFromClass
    信息: Creating Service {http://impl.webservice.szcatic.com/}helloWorld from class com.szcatic.webservice.service.HelloService
    十二月 12, 2018 10:52:31 上午 org.apache.cxf.endpoint.ServerImpl initDestination
    信息: Setting the server's publish address to be http://localhost:8088/helloWorld
    SLF4J: Failed to load class "org.slf4j.impl.StaticLoggerBinder".
    SLF4J: Defaulting to no-operation (NOP) logger implementation
    SLF4J: See http://www.slf4j.org/codes.html#StaticLoggerBinder for further details.
    十二月 12, 2018 10:52:32 上午 org.apache.cxf.wsdl.service.factory.ReflectionServiceFactoryBean buildServiceFromClass
    信息: Creating Service {http://impl.webservice.szcatic.com/}hiWorld from class com.szcatic.webservice.service.HiService
    十二月 12, 2018 10:52:32 上午 org.apache.cxf.endpoint.ServerImpl initDestination
    信息: Setting the server's publish address to be http://localhost:8088/hiWorld
    十二月 12, 2018 10:52:32 上午 org.apache.cxf.wsdl.service.factory.ReflectionServiceFactoryBean checkServiceClassAnnotations
    警告: A JAX-WS Annotation was found on com.szcatic.webservice.service.UserService while using the Simple frontend.  For better results, use the JAX-WS frontend.
    十二月 12, 2018 10:52:32 上午 org.apache.cxf.wsdl.service.factory.ReflectionServiceFactoryBean buildServiceFromClass
    信息: Creating Service {http://service.webservice.szcatic.com/}UserService from class com.szcatic.webservice.service.UserService
    十二月 12, 2018 10:52:32 上午 org.apache.cxf.endpoint.ServerImpl initDestination
    信息: Setting the server's publish address to be http://localhost:8088/getName
    server ready...

5.3 查看发布的服务[http://localhost:8088/getName?wsdl][http_localhost_8088_getName_wsdl]

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pzeDE4MjczMTE3MDAz_size_16_color_FFFFFF_t_70][]

**从上面可以看出发布服务成功**

### 6.编写客户端测试类 ###

package com.szcatic.test;
    
    import org.apache.cxf.endpoint.Client;
    import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;
    import org.apache.cxf.jaxws.endpoint.dynamic.JaxWsDynamicClientFactory;
    import org.junit.jupiter.api.Test;
    
    import com.szcatic.webservice.service.HelloService;
    import com.szcatic.webservice.service.HiService;
    
    public class WebServiceClientTest {
    	
    	@Test
    	void testHello() {
    		JaxWsProxyFactoryBean factoryBean = new JaxWsProxyFactoryBean();
    		factoryBean.setServiceClass(HelloService.class);
    		factoryBean.setAddress("http://localhost:8088/helloWorld");
    		HelloService hello = (HelloService) factoryBean.create();
    		System.out.println(hello.sayHello("zhangsan"));
    	}
    	
    	@Test
    	void testHi() {
    		JaxWsProxyFactoryBean factoryBean = new JaxWsProxyFactoryBean();
    		factoryBean.setServiceClass(HiService.class);
    		factoryBean.setAddress("http://localhost:8088/hiWorld");
    		HiService hi = (HiService) factoryBean.create();
    		System.out.println(hi.sayHi("zhangsan"));
    	}
    	
    	@Test
    	void testGetName() {
    		try{
    			JaxWsDynamicClientFactory jdcf = JaxWsDynamicClientFactory.newInstance();
    			Client client = jdcf.createClient("http://localhost:8088/getName?wsdl");
    			Object[] objects = client.invoke("getName", "zhangsan");
    			// 输出调用结果
    			System.out.println(objects[0].toString());
    		}catch (Exception e) {
    			e.printStackTrace();
    		}
    
    	}
    	
    }

### 7.分别执行测试方法 ###

**7.1 testHello()，控制台输出结果**

十二月 12, 2018 11:04:19 上午 org.apache.cxf.wsdl.service.factory.ReflectionServiceFactoryBean buildServiceFromClass
    信息: Creating Service {http://service.webservice.szcatic.com/}HelloServiceService from class com.szcatic.webservice.service.HelloService
    Hello zhangsan

**7.2  testHi()，控制台输出结果**

十二月 12, 2018 11:06:03 上午 org.apache.cxf.wsdl.service.factory.ReflectionServiceFactoryBean buildServiceFromClass
    信息: Creating Service {http://service.webservice.szcatic.com/}HiServiceService from class com.szcatic.webservice.service.HiService
    Hi,zhangsan

**7.3 testGetName()，控制台输出结果**

zhangsan

**从上面结果可以看出客户端调用服务成功**

### **8.通过tomcat发布服务** ###

**8.1 在资源文件夹src/main/resources目录下建立webservice.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:aop="http://www.springframework.org/schema/aop"
    	xmlns:context="http://www.springframework.org/schema/context"
    	xmlns:mvc="http://www.springframework.org/schema/mvc"
    	xmlns:tx="http://www.springframework.org/schema/tx"
    	xmlns:jaxws="http://cxf.apache.org/jaxws"
    	xsi:schemaLocation="http://www.springframework.org/schema/beans
    	   http://www.springframework.org/schema/beans/spring-beans-4.1.xsd
    	   http://www.springframework.org/schema/aop
    	   http://www.springframework.org/schema/aop/spring-aop-4.1.xsd
    	   http://www.springframework.org/schema/context
    	   http://www.springframework.org/schema/context/spring-context-4.1.xsd
    	   http://www.springframework.org/schema/mvc
    	   http://www.springframework.org/schema/mvc/spring-mvc-4.1.xsd
    	   http://www.springframework.org/schema/tx
    	   http://www.springframework.org/schema/tx/spring-tx-4.1.xsd
    	   http://cxf.apache.org/jaxws http://cxf.apache.org/schemas/jaxws.xsd">
    	
    	<import resource="classpath*:META-INF/cxf/cxf.xml" />
    
    	
    	<jaxws:endpoint id="helloWorld"
    		implementor="com.szcatic.webservice.impl.HelloServiceImpl"
    		address="/helloWorld" />
    
    	
    	<jaxws:server address="/hiWorld"
    		serviceClass="com.szcatic.webservice.impl.HiServiceImpl" />
    	<bean id="userServiceImpl" class="com.szcatic.webservice.impl.UserServiceImpl" />
    	
    	<jaxws:server id="getName" address="/getName">
    		<jaxws:serviceBean>
    			<ref bean="userServiceImpl"/>
    		</jaxws:serviceBean>
    	</jaxws:server>
    </beans>

**8.2 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"
    	version="2.5">
    	<display-name>cxf</display-name>
    	
    	<listener>
    		<listener-class>org.springframework.web.context.ContextLoaderListener</listener-class>
    	</listener>
    	<context-param>
    		<param-name>contextConfigLocation</param-name>
    		<param-value>classpath:webservice.xml</param-value>
    	</context-param>
    	<servlet>
    		<servlet-name>CXFServlet</servlet-name>
    		<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
    		<load-on-startup>1</load-on-startup>
    	</servlet>
    	<servlet-mapping>
    		<servlet-name>CXFServlet</servlet-name>
    		<url-pattern>/webservice/*</url-pattern>
    	</servlet-mapping>
    </web-app>

8.3 打开浏览器，分别输入如下网址

**[8.3.1 http://localhost:8088/cxf/webservice/helloWorld?wsdl 显示如下][8.3.1 http_localhost_8088_cxf_webservice_helloWorld_wsdl]**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pzeDE4MjczMTE3MDAz_size_16_color_FFFFFF_t_70 1][]

**8.3.2 [http://localhost:8088/cxf/webservice/hiWorld?wsdl][http_localhost_8088_cxf_webservice_hiWorld_wsdl]**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pzeDE4MjczMTE3MDAz_size_16_color_FFFFFF_t_70 2][]

**8.3.3 [http://localhost:8088/cxf/webservice/getName?wsdl][http_localhost_8088_cxf_webservice_getName_wsdl]**

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pzeDE4MjczMTE3MDAz_size_16_color_FFFFFF_t_70 3][]

**从上面结果可以看出tomcat发布webservice服务成功**

### 9. 项目目录结构如下 ###

![watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pzeDE4MjczMTE3MDAz_size_16_color_FFFFFF_t_70 4][]

[http_localhost_8088_getName_wsdl]: http://localhost:8088/getName?wsdl
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pzeDE4MjczMTE3MDAz_size_16_color_FFFFFF_t_70]: /images/20220413/72985f153c094df1ac415cd3d647f681.png
[8.3.1 http_localhost_8088_cxf_webservice_helloWorld_wsdl]: http://localhost:8088/cxf/webservice/helloWorld?wsdl
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pzeDE4MjczMTE3MDAz_size_16_color_FFFFFF_t_70 1]: /images/20220413/b190cd1faeac4649b89704bead15ad86.png
[http_localhost_8088_cxf_webservice_hiWorld_wsdl]: http://localhost:8088/cxf/webservice/hiWorld?wsdl
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pzeDE4MjczMTE3MDAz_size_16_color_FFFFFF_t_70 2]: /images/20220413/9eb1da67d8ad452d9638af1811604a5e.png
[http_localhost_8088_cxf_webservice_getName_wsdl]: http://localhost:8088/cxf/webservice/getName?wsdl
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pzeDE4MjczMTE3MDAz_size_16_color_FFFFFF_t_70 3]: /images/20220413/490e74fcfe134d2d8e73e4c4c641645d.png
[watermark_type_ZmFuZ3poZW5naGVpdGk_shadow_10_text_aHR0cHM6Ly9ibG9nLmNzZG4ubmV0L3pzeDE4MjczMTE3MDAz_size_16_color_FFFFFF_t_70 4]: /images/20220413/950348e285ae409e9b824b76da124550.png