1.引言
在真实的项目中WebService和web项目的整合尤其重要,在此篇可以主要介绍一下CXF框架如何与Web程序整合,首先介绍一下我们将要实现的功能:
解释:
- 将
Person,PersonService,PersonServiceImpl
发布为rest类型的服务 - 将
User,UserService,UserServiceImpl
发布为soap类型的服务 - 配置Web服务允许跨域
2.CXF与Web程序的整合
2.1 POM.xml文件
<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/maven-v4_0_0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>web</groupId>
<artifactId>cxf</artifactId>
<packaging>war</packaging>
<version>1.0-SNAPSHOT</version>
<name>cxf Maven Webapp</name>
<url>http://maven.apache.org</url>
<properties>
<project.build.sourceEncoding>UTF-8</project.build.sourceEncoding>
<cxf.version>3.1.9</cxf.version>
<jackson.version>1.9.13</jackson.version>
<spring.version>4.0.5.RELEASE</spring.version>
</properties>
<dependencies>
<!-- Spring -->
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-context</artifactId>
<version>${spring.version}</version>
</dependency>
<dependency>
<groupId>org.springframework</groupId>
<artifactId>spring-web</artifactId>
<version>${spring.version}</version>
</dependency>
<!--cxf所需要的jar包-->
<!--cxf-rt-frontend-jaxws 对soap服务的支持-->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-jaxws</artifactId>
<version>${cxf.version}</version>
</dependency>
<!--cxf-rt-frontend-jaxrs 对rest服务的支持-->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-frontend-jaxrs</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>
<!-- 用于rest服务序列化对象-->
<dependency>
<groupId>org.codehaus.jackson</groupId>
<artifactId>jackson-jaxrs</artifactId>
<version>${jackson.version}</version>
</dependency>
<!--用于跨域的jar包-->
<dependency>
<groupId>com.thetransactioncompany</groupId>
<artifactId>java-property-utils</artifactId>
<version>1.9</version>
</dependency>
<dependency>
<groupId>com.thetransactioncompany</groupId>
<artifactId>cors-filter</artifactId>
<version>1.7</version>
</dependency>
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.9</version>
<scope>test</scope>
</dependency>
</dependencies>
<build>
<finalName>cxf</finalName>
</build>
</project>
2.2 web.xml文件
<!DOCTYPE web-app PUBLIC
"-//Sun Microsystems, Inc.//DTD Web Application 2.3//EN"
"http://java.sun.com/dtd/web-app_2_3.dtd" >
<web-app>
<display-name>Archetype Created Web Application</display-name>
<filter>
<filter-name>CORS</filter-name>
<filter-class>com.thetransactioncompany.cors.CORSFilter</filter-class>
<init-param>
<param-name>cors.allowOrigin</param-name>
<param-value>*</param-value>
</init-param>
<init-param>
<param-name>cors.supportedMethods</param-name>
<param-value>GET, POST, HEAD, PUT, DELETE</param-value>
</init-param>
<init-param>
<param-name>cors.supportedHeaders</param-name>
<param-value>Accept, Origin, X-Requested-With, Content-Type, Last-Modified</param-value>
</init-param>
<init-param>
<param-name>cors.exposedHeaders</param-name>
<param-value>Set-Cookie</param-value>
</init-param>
<init-param>
<param-name>cors.supportsCredentials</param-name>
<param-value>true</param-value>
</init-param>
</filter>
<filter-mapping>
<filter-name>CORS</filter-name>
<!--允许跨域的路径,这里只允许我们发布的Web服务跨域-->
<url-pattern>/ws/*</url-pattern>
</filter-mapping>
<servlet>
<servlet-name>cxf</servlet-name>
<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
<init-param>
<param-name>config-location</param-name>
<param-value>classpath:cxf.xml</param-value>
</init-param>
</servlet>
<!--web服务的地址-->
<servlet-mapping>
<servlet-name>cxf</servlet-name>
<url-pattern>/ws/*</url-pattern>
</servlet-mapping>
</web-app>
2.3 SOAP服务的接口,类,实体类
- 实体类
package com.skd.domain;
public class User {
private String username;
private String password;
public String getUsername() {
return username;
}
public void setUsername(String username) {
this.username = username;
}
public String getPassword() {
return password;
}
public void setPassword(String password) {
this.password = password;
}
}
- 接口
package com.skd.service;
import com.skd.domain.User;
import javax.jws.WebService;
@WebService
public interface UserService {
public User getUser(String name);
}
- 接口实现类
package com.skd.service.impl;
import com.skd.domain.User;
import com.skd.service.UserService;
public class UserServiceImpl implements UserService{
public User getUser(String name) {
User u=new User();
u.setUsername(name);
u.setPassword("123456");
return u;
}
}
2.4 rest服务的实体类,接口,接口的实现类
- 实体类(注意要实现接口Serializable)
package com.skd.domain;
import java.io.Serializable;
public class Person implements Serializable{
private String name;
private int age;
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;
}
}
- 接口
package com.skd.service;
import com.skd.domain.Person;
import javax.jws.WebService;
import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;
import javax.ws.rs.core.MediaType;
import java.util.List;
@Produces( {MediaType.APPLICATION_JSON })
public interface PersonService {
@GET
@Path("/person/{name}")
public Person getPerson(@PathParam("name") String name);
@GET
@Path("/persons")
public List<Person> getPersons();
}
- 接口的实现类
package com.skd.service.impl;
import com.skd.domain.Person;
import com.skd.service.PersonService;
import java.util.ArrayList;
import java.util.List;
/**
* Created by wpx on 2016/12/31.
*/
public class PersonServiceImpl implements PersonService{
public Person getPerson(String name) {
Person p=new Person();
p.setName(name);
p.setAge(100);
return p;
}
public List<Person> getPersons() {
List<Person> persons=new ArrayList<Person>();
Person p1=new Person();
p1.setName("wpx");
p1.setAge(100);
persons.add(p1);
Person p2=new Person();
p2.setName("zlr");
p2.setAge(100);
persons.add(p2);
return persons;
}
}
2.5 CXF的配置文件(cxf.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:soap="http://cxf.apache.org/bindings/soap" xmlns:jaxrs="http://cxf.apache.org/jaxrs"
xsi:schemaLocation="http://www.springframework.org/schema/beans
http://www.springframework.org/schema/beans/spring-beans.xsd
http://cxf.apache.org/bindings/soap
http://cxf.apache.org/schemas/configuration/soap.xsd
http://cxf.apache.org/jaxws
http://cxf.apache.org/schemas/jaxws.xsd
http://cxf.apache.org/jaxrs
http://cxf.apache.org/schemas/jaxrs.xsd
">
<!--
id:当前服务的唯一标识 address:当前服务对应的请求url serviceClass:接口类型
-->
<jaxws:server id="soapuser" address="/user"
serviceClass="com.skd.service.UserService">
<jaxws:serviceBean>
<bean class="com.skd.service.impl.UserServiceImpl" />
</jaxws:serviceBean>
<jaxws:inInterceptors>
<bean class="org.apache.cxf.interceptor.LoggingInInterceptor"></bean>
</jaxws:inInterceptors>
</jaxws:server>
<!-- 发布一个Restful方式的WebService服务 -->
<bean id="personServiceImpl" class="com.skd.service.impl.PersonServiceImpl"></bean>
<jaxrs:server id="personService" address="/p">
<jaxrs:serviceBeans>
<ref bean="personServiceImpl" />
</jaxrs:serviceBeans>
<!--提供序列化为json数据的实现类-->
<jaxrs:providers>
<bean class="org.codehaus.jackson.jaxrs.JacksonJsonProvider"></bean>
</jaxrs:providers>
<jaxrs:inInterceptors>
<bean class="org.apache.cxf.interceptor.LoggingInInterceptor"></bean>
</jaxrs:inInterceptors>
<jaxrs:outInterceptors>
<bean class="org.apache.cxf.interceptor.LoggingOutInterceptor"></bean>
</jaxrs:outInterceptors>
</jaxrs:server>
</beans>
2.6验证是否成功
查看网址http://localhost:8080/ws如果出现下图,便发布成功了。
3代码下载
代码的下载地址为:CXF和Web程序的整合