应用CXF实现webservice发布+spring _Web前端

使用CXF实现webservice发布+spring

这是自己写的代码，只是为留个记录，仅供参考。

1，准备好相关jar包，不多说了。

2，使用myeclipse创建web项目，添加spring和cxf相关jar，在web.xml中配置spring和cxf.

	<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>
	
	<servlet>
	    <display-name>CXFServlet</display-name>
	    <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>/webservices/*</url-pattern>
	</servlet-mapping>

3，写webservice服务接口，使用Annotation进行标注

先了解各种类型的Annotation。

@WebService和@WebMethod是WSDL映射Annatotion。这些Annotation将描述Web Service的WSDL文档元素和Java源代码联系在一起。@SOAPBinding是一个绑定的annotation用来说明网络协议和格式。

1）、@WebService annotation的元素name,serviceName和targetNamespace成员用来描述wsdl:portType，wsdl:service，和targetNameSpace生成WebService中的WSDL文件。

2）、@SOAPBinding是一个用来描述SOAP格式和RPC的协议的绑定Annotation。

3）、@WebMethod Annotation的operationName成员描述了wsdl:operation，而且它的操作描述了WSDL文档中的SOAPAction头部。这是客户端必须要放入到SQAPHeader中的数值，SOAP 1.1中的一种约束。

4）、@WebParam Annotation的partName成员描述了WSDL文档中的wsdl:part。

5）、@WebResult Annotation的partName成员描述了wsdl:part用来返回WSDL文档的值。

package com.lekihuo.demo;

import java.util.List;

import javax.jws.WebMethod;
import javax.jws.WebParam;
import javax.jws.WebResult;
import javax.jws.WebService;

@WebService
public interface HelloWorld {
    @WebMethod(operationName = "SayHi")//opertionName默认是方法名
    @WebResult(name = "result")//返回值 不标注 默认为return
    String sayHi(@WebParam(name = "text") String text);//方法参数不标注，默认为arg0...

    @WebMethod(operationName = "SayHiToUser")
    @WebResult(name = "result")
    String sayHiToUser(@WebParam(name = "user") User user);

    @WebMethod(operationName = "SayHiToUserList")
    @WebResult(name = "results")
    String[] sayHiToUserList(@WebParam(name = "users") List<User> users);

    @WebMethod(operationName = "GetUser")
    @WebResult(name = "results")
    User getUser();
}

使用到了User类

package com.lekihuo.demo;

import java.io.Serializable;

import javax.activation.DataHandler;
import javax.xml.bind.annotation.XmlAccessType;
import javax.xml.bind.annotation.XmlAccessorType;
import javax.xml.bind.annotation.XmlMimeType;
import javax.xml.bind.annotation.XmlRootElement;
/**
 * MTOM (SOAP Message Transmission Optimization Mechanism) SOAP消息传输优化机制
 * @XmlRootElement(name="User")//使用JAXB注解告诉CXF如何处理XML和Java对象,默认使用类名小写
 * @XmlAccessorType(XmlAccessType.FIELD)//标注JAXB在进行java对象与XML之间的进行转换时只关注字段，
 *  而不关注属性(getXxx),否则会报出现两个imageData同名属性的错误
 * @XmlMimeType("application/octet-stream")//这里标注这是一个附件类型数据(二进制文件)
 * 
 */
@XmlRootElement(name="User")
@XmlAccessorType(XmlAccessType.FIELD)
public class User implements Serializable {
	
	private String name ;
	
	private int age;
	
	@XmlMimeType("application/octet-stream")
	private DataHandler imageData;//MTOM方式传输附件，必须使用 javax.activation.DataHandler类
	
	public User() {
		super();
	}
	public String getName() {
		return name;
	}
	public void setName(String name) {
		this.name = name;
	}
	public int getAge() {
		return age;
	}
	public void setAge(int age) {
		this.age = age;
	}
	public DataHandler getImageData() {
		return imageData;
	}
	public void setImageData(DataHandler imageData) {
		this.imageData = imageData;
	}
	
}

4.写webservice服务的实现类

package com.lekihuo.demo.server;

import javax.xml.ws.Endpoint;

import com.lekihuo.demo.HelloWorldImpl;

public class WebServiceApp {
	
	public static void main(String[] args) {//使用自带jetty容器发布webservice
		System.out.println("Web Service Start !");
		HelloWorldImpl implementor = new HelloWorldImpl();
		String address = "http://localhost:8082/HelloWorld";
		Endpoint.publish(address,implementor);//发布服务
		System.out.println("Web Service started !");
	}

}

运行该代码后，可在浏览器正常访问 http://localhost:8082/HelloWorld?wsdl

2)整合到spring发布
在Spring的配置文件中，需要对服务进行配置：
在applicationContext.xml(Spring的配置文件)中需要引入CXF的XML Scheam 配置文件和cxf的资源文件

<?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"
       xsi:schemaLocation="
	        http://www.springframework.org/schema/beans
	        http://www.springframework.org/schema/beans/spring-beans-2.0.xsd
	        http://cxf.apache.org/jaxws 
	        http://cxf.apache.org/schemas/jaxws.xsd">

    <import resource="classpath:META-INF/cxf/cxf.xml" />
    <import resource="classpath:META-INF/cxf/cxf-extension-soap.xml" />
    <import resource="classpath:META-INF/cxf/cxf-servlet.xml" />

    <!-- 发布服务  -->
    <bean id="hello" class="com.lekihuo.demo.HelloWorldImpl" />
    <jaxws:endpoint id="helloWorld" implementor="#hello"
        address="/HelloWorld">
    </jaxws:endpoint>

    <!-- 另一种写法 是 
        <jaxws:endpoint    id="helloWorld"   implementor="demo.spring.HelloWorldImpl"     address="/HelloWorld" /> 
        建议不要用这种方法 ，如果实现类有的属性要通过spring依赖注入的话，这种方法只是简单的new个实现类，他的属性没有通过spring依赖注入给注入值 
        
        所有综合考虑   建议使用上面的写法！ 
    -->

    <!-- 方式一：实现客户端 对象创建 
    <bean id="client" class="com.lekihuo.demo.HelloWorld"
        factory-bean="clientFactory" factory-method="create" />
    <bean id="clientFactory"
        class="org.apache.cxf.jaxws.JaxWsProxyFactoryBean">
        <property name="serviceClass"
            value="com.lekihuo.demo.HelloWorld" />
        <property name="address"
            value="http://localhost:8088/testcxf/webservices/HelloWorld" />
</bean>
-->
</beans>

配置后，部署到tomcat服务器，启动后访问 http://ip:port/appname/cxfservlet_url_pattern/address?wsdl

其中/cxfservlet_url_pattern 就是指在web.xml中配置CXFServlet的url-pattern中/*前面的部分，

而/address就是刚上面配置的jaxws:endpoint中的address值。

我的访问地址就是 http://localhost:8088/testcxf/webservices/HelloWorld?wsdl

6.写webservice客户端访问服务

package com.lekihuo.demo.client;

import java.util.ArrayList;
import java.util.List;

import org.apache.cxf.jaxws.JaxWsProxyFactoryBean;
import org.springframework.context.ApplicationContext;
import org.springframework.context.support.ClassPathXmlApplicationContext;

import com.lekihuo.demo.HelloWorld;
import com.lekihuo.demo.User;

public class WebServiceClient {
	public static void main(String[] args) {
		System.out.println("Hello World Client ");
		JaxWsProxyFactoryBean jwpf = new JaxWsProxyFactoryBean();//代理工厂Bean
		jwpf.setServiceClass(HelloWorld.class);
		jwpf.setAddress("http://localhost:8082/HelloWorld");//这里要和正确访问的wsdl地址一致 
		//http://localhost:8088/testcxf/webservices/HelloWorld
		HelloWorld hw = (HelloWorld)jwpf.create();
		User user = new User();
		user.setName("Tony");
		user.setAge(25);
		
		System.out.println(hw.sayHiToUser(user));
        //=============两种方式都一样的============
//		ApplicationContext  context = new ClassPathXmlApplicationContext(
//                new String[]{ "applicationContext.xml" });
//
//		HelloWorld client = (HelloWorld) context.getBean("client");//注意检查address是否跟wsdl一致
//		User user1 = new User();
//		user1.setName("Tony");
//		User user2 = new User();
//		user2.setName("freeman");
//		List<User> userList = new ArrayList<User>();
//		userList.add(user1);
//		userList.add(user2);
//		String[] res = client.sayHiToUserList(userList);
//		System.out.println(res[0]);
//		System.out.println(res[1]);
	}

}

1 楼 phpxiaoxin 2010-12-23

很好。谢谢