Spring整合ApacheCXF实现基于Restful风格的WebService(基于jaxrs)

1.服务端

1.1 创建web maven项目

在这里插入图片描述

1.2 添加依赖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>org.example</groupId>
	<artifactId>spring_jaxrs_server</artifactId>
	<packaging>war</packaging>
	<version>0.0.1-SNAPSHOT</version>
	<name>spring_jaxrs_server Maven Webapp</name>
	<url>http://maven.apache.org</url>
	<dependencies>
		<!-- https://mvnrepository.com/artifact/org.apache.cxf/cxf-rt-frontend-jaxrs -->
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-frontend-jaxrs</artifactId>
			<version>3.0.1</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-log4j12 -->
		<dependency>
			<groupId>org.slf4j</groupId>
			<artifactId>slf4j-log4j12</artifactId>
			<version>1.7.12</version>
			<scope>test</scope>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.apache.cxf/cxf-rt-rs-client -->
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-rs-client</artifactId>
			<version>3.0.1</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.apache.cxf/cxf-rt-rs-extension-providers -->
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-rs-extension-providers</artifactId>
			<version>3.0.1</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.codehaus.jettison/jettison -->
		<dependency>
			<groupId>org.codehaus.jettison</groupId>
			<artifactId>jettison</artifactId>
			<version>1.3.7</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context</artifactId>
			<version>4.2.4.RELEASE</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.springframework/spring-web -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-web</artifactId>
			<version>4.2.4.RELEASE</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/junit/junit -->
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.12</version>
			<scope>test</scope>
		</dependency>

	</dependencies>
	<build>
		<pluginManagement>
			<plugins>
				<!-- 编译插件 -->
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-compiler-plugin</artifactId>
					<version>3.2</version>
					<configuration>
						<source>1.8</source>
						<target>1.8</target>
						<showWarnings>true</showWarnings>
					</configuration>
				</plugin>
				<!-- 运行tomcat7方法:tomcat7:run -->
				<plugin>
					<groupId>org.apache.tomcat.maven</groupId>
					<artifactId>tomcat7-maven-plugin</artifactId>
					<version>2.2</version>
					<configuration>
						<!-- 指定端口 -->
						<port>8080</port>
						<!-- 请求路径 -->
						<path>/</path>
					</configuration>
				</plugin>
			</plugins>
		</pluginManagement>
	</build>
</project>

1.3 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>

	<!-- 1.cxfServlet配置 -->
	<servlet>
		<servlet-name>cxfServlet</servlet-name>
		<servlet-class>org.apache.cxf.transport.servlet.CXFServlet</servlet-class>
	</servlet>
	<servlet-mapping>
		<servlet-name>cxfServlet</servlet-name>
		<!-- 需要注意:这个路径是作为我们webService服务访问路径的其中一部分,另外一部分在spring的配置文件中进行配置的 -->
		<url-pattern>/ws/*</url-pattern>
	</servlet-mapping>

	<!-- 2.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>
</web-app>

1.4 服务实体类

package org.jaxrs.entity;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name = "Car")
public class Car {

	private Integer id;
	private String carName;
	private Double price;
	public Integer getId() {
		return id;
	}
	public void setId(Integer id) {
		this.id = id;
	}
	public String getCarName() {
		return carName;
	}
	public void setCarName(String carName) {
		this.carName = carName;
	}
	public Double getPrice() {
		return price;
	}
	public void setPrice(Double price) {
		this.price = price;
	}
	@Override
	public String toString() {
		return "Car [id=" + id + ", carName=" + carName + ", price=" + price + "]";
	}
	public Car(Integer id, String carName, Double price) {
		super();
		this.id = id;
		this.carName = carName;
		this.price = price;
	}
	public Car() {
		super();
	}
	
}

package org.jaxrs.entity;

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

import javax.xml.bind.annotation.XmlRootElement;

/**
 *	基于restful风格的webservice,客户端与服务端之间的通讯可以传递xml数据、json数据
 *	 @XmlRootElement 指定对象序列化为xml或json数据时根节点的名称
 *	xml:
 *		<User>
 *			<id></id>
 *			<username></username>
 *			<city></city>
 *		</User>
 *	json:
 *		{"User":{"id":100,"username":"张三","city":"广东"}}
 *
 */
@XmlRootElement(name = "User")
public class User {
	
	private Integer id;
	private String username;
	private String city;
	
	private List<Car> cars = new ArrayList<Car>();

	
	public User() {
		super();
	}

	public User(Integer id, String username, String city, List<Car> cars) {
		super();
		this.id = id;
		this.username = username;
		this.city = city;
		this.cars = cars;
	}

	public Integer getId() {
		return id;
	}

	public void setId(Integer id) {
		this.id = id;
	}

	public String getUsername() {
		return username;
	}

	public void setUsername(String username) {
		this.username = username;
	}

	public String getCity() {
		return city;
	}

	public void setCity(String city) {
		this.city = city;
	}

	public List<Car> getCars() {
		return cars;
	}

	public void setCars(List<Car> cars) {
		this.cars = cars;
	}

	@Override
	public String toString() {
		return "User [id=" + id + ", username=" + username + ", city=" + city + ", cars=" + cars + "]";
	}
	
}

1.5 服务接口、实现

package org.jaxrs.service;

import java.util.List;

import javax.ws.rs.Consumes;
import javax.ws.rs.DELETE;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;
import javax.ws.rs.Produces;

import org.jaxrs.entity.User;


//@Path 在接口上表示访问当前服务接口对应的路径
//@Produces 值为*/*,支持任意类型,表示服务器支持的返回的数据格式类型
@Path("/userService")
@Produces("*/*")
public interface UserServiceI {
	
	/**
	 *	 @Path 表示访问当前服务接口方法对应的路径。【.../userService/user】
	 *	 @POST 表示处理的请求类型,post对应的是insert新增操作
	 *	 @PUT  表示处理的请求类型,put对应的是update更新操作
	 *	 @GET  表示处理的请求类型,put对应的是query查询操作
	 *	 @DELETE  表示处理的请求类型,put对应的是delete删除操作
	 *	 @Consumes 表示服务器支持的请求的数据格式类型
	 */
	@POST
	@Path("/user")
	@Consumes({"application/xml","application/json"})
	public void saveUser(User user);
	
	@PUT
	@Path("/user")
	@Consumes({"application/xml","application/json"})
	public void updateUser(User user);
	
	@GET
	@Path("/user")
	@Produces({"application/xml","application/json"})
	public List<User> findAllUsers();
	
	@GET
	@Path("/user/{id}")
	@Consumes("application/xml")
	@Produces({"application/xml","application/json"})
	public User findUserById(@PathParam("id") Integer id);
	
	@DELETE
	@Path("/user/{id}")
	@Consumes({"application/xml","application/json"})
	public void deleteUser(@PathParam("id") Integer id);

}

package org.jaxrs.service.impl;

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

import org.jaxrs.entity.Car;
import org.jaxrs.entity.User;
import org.jaxrs.service.UserServiceI;


public class UserServiceImpl implements UserServiceI{

	@Override
	public void saveUser(User user) {
		System.out.println("save user:" + user);
	}

	@Override
	public void updateUser(User user) {
		System.out.println("update user:"+user);
	}

	@Override
	public List<User> findAllUsers() {
		//张三所拥有的汽车集合
		List<Car> cars = new ArrayList<Car>();
		Car car1 = new Car(101,"保时捷",1000000000000d);
		Car car2 = new Car(102,"宝马",4000000d);
		cars.add(car1);
		cars.add(car2);
		
		List<User> users =new ArrayList<User>();
		User user1 = new User(1,"张三","东莞",cars);
		
		User user2 = new User(2,"李四","上海",null);
		
		users.add(user1);
		users.add(user2);
		return users;
	}

	@Override
	public User findUserById(Integer id) {
		if (id == 1) {
			User user = new User(1,"张三","东莞",null);
			return user;
		}
		return null;
	}

	@Override
	public void deleteUser(Integer id) {
		System.out.println("delete user id:"+id);
	}

}

1.6 Spring整合CXF配置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:cxf="http://cxf.apache.org/core"
    xmlns:jaxws="http://cxf.apache.org/jaxws"
    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/core
        http://cxf.apache.org/schemas/core.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
        ">
        
        <!--这里发布服务  -->
        <!-- spring整合cxf发布基于restful风格的服务,关键点:
        	1.服务地址
        	2.服务类
        	服务完整访问地址:http://localhost:8080/spring_jaxrs_service/ws/...
         -->
         
         <jaxrs:server address="/userService">
         	<jaxrs:serviceBeans>
         		<bean class="org.jaxrs.service.impl.UserServiceImpl"></bean>
         	</jaxrs:serviceBeans>
         </jaxrs:server>

</beans>


1.7 发布服务

在这里插入图片描述

在这里插入图片描述

这里一定要设置jdk版本,因为pom.xml设置了maven编译版本为1.8,如果不是jdk1.8,会报错不匹配

控制台没有报错即发布成功

2.客户端

2.1 创建简单maven项目

在这里插入图片描述

2.2 添加依赖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/xsd/maven-4.0.0.xsd">
  <modelVersion>4.0.0</modelVersion>
  <groupId>org.example</groupId>
  <artifactId>spring_jaxrs_client</artifactId>
  <version>0.0.1-SNAPSHOT</version>
  
  <dependencies>
		<!-- https://mvnrepository.com/artifact/org.apache.cxf/cxf-rt-frontend-jaxrs -->
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-frontend-jaxrs</artifactId>
			<version>3.0.1</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.slf4j/slf4j-log4j12 -->
		<dependency>
			<groupId>org.slf4j</groupId>
			<artifactId>slf4j-log4j12</artifactId>
			<version>1.7.12</version>
			<scope>test</scope>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.apache.cxf/cxf-rt-rs-client -->
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-rs-client</artifactId>
			<version>3.0.1</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.apache.cxf/cxf-rt-rs-extension-providers -->
		<dependency>
			<groupId>org.apache.cxf</groupId>
			<artifactId>cxf-rt-rs-extension-providers</artifactId>
			<version>3.0.1</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.codehaus.jettison/jettison -->
		<dependency>
			<groupId>org.codehaus.jettison</groupId>
			<artifactId>jettison</artifactId>
			<version>1.3.7</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.springframework/spring-context -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context</artifactId>
			<version>4.2.4.RELEASE</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.springframework/spring-web -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-web</artifactId>
			<version>4.2.4.RELEASE</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/junit/junit -->
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>4.12</version>
			<scope>test</scope>
		</dependency>

	</dependencies>
	<build>
		<pluginManagement>
			<plugins>
				<!-- 编译插件 -->
				<plugin>
					<groupId>org.apache.maven.plugins</groupId>
					<artifactId>maven-compiler-plugin</artifactId>
					<version>3.2</version>
					<configuration>
						<source>1.8</source>
						<target>1.8</target>
						<showWarnings>true</showWarnings>
					</configuration>
				</plugin>
				<!-- 运行tomcat7方法:tomcat7:run -->
				<plugin>
					<groupId>org.apache.tomcat.maven</groupId>
					<artifactId>tomcat7-maven-plugin</artifactId>
					<version>2.2</version>
					<configuration>
						<!-- 指定端口 -->
						<port>8080</port>
						<!-- 请求路径 -->
						<path>/</path>
					</configuration>
				</plugin>
			</plugins>
		</pluginManagement>
	</build>
</project>

2.3 实体类

package org.jaxrs.entity;

import javax.xml.bind.annotation.XmlRootElement;

@XmlRootElement(name = "Car")
public class Car {

	private Integer id;
	private String carName;
	private Double price;
	public Integer getId() {
		return id;
	}
	public void setId(Integer id) {
		this.id = id;
	}
	public String getCarName() {
		return carName;
	}
	public void setCarName(String carName) {
		this.carName = carName;
	}
	public Double getPrice() {
		return price;
	}
	public void setPrice(Double price) {
		this.price = price;
	}
	@Override
	public String toString() {
		return "Car [id=" + id + ", carName=" + carName + ", price=" + price + "]";
	}
	public Car(Integer id, String carName, Double price) {
		super();
		this.id = id;
		this.carName = carName;
		this.price = price;
	}
	public Car() {
		super();
	}
	
}

package org.jaxrs.entity;

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

import javax.xml.bind.annotation.XmlRootElement;

/**
 *	基于restful风格的webservice,客户端与服务端之间的通讯可以传递xml数据、json数据
 *	 @XmlRootElement 指定对象序列化为xml或json数据时根节点的名称
 *	xml:
 *		<User>
 *			<id></id>
 *			<username></username>
 *			<city></city>
 *		</User>
 *	json:
 *		{"User":{"id":100,"username":"张三","city":"广东"}}
 *
 */
@XmlRootElement(name = "User")
public class User {
	
	private Integer id;
	private String username;
	private String city;
	
	private List<Car> cars = new ArrayList<Car>();

	
	public User() {
		super();
	}

	public User(Integer id, String username, String city, List<Car> cars) {
		super();
		this.id = id;
		this.username = username;
		this.city = city;
		this.cars = cars;
	}

	public Integer getId() {
		return id;
	}

	public void setId(Integer id) {
		this.id = id;
	}

	public String getUsername() {
		return username;
	}

	public void setUsername(String username) {
		this.username = username;
	}

	public String getCity() {
		return city;
	}

	public void setCity(String city) {
		this.city = city;
	}

	public List<Car> getCars() {
		return cars;
	}

	public void setCars(List<Car> cars) {
		this.cars = cars;
	}

	@Override
	public String toString() {
		return "User [id=" + id + ", username=" + username + ", city=" + city + ", cars=" + cars + "]";
	}
	
}

2.4 测试不返回

package org.jaxrs.test;

import java.util.List;

import javax.ws.rs.core.MediaType;

import org.apache.cxf.jaxrs.client.WebClient;
import org.jaxrs.entity.User;
import org.junit.Test;


public class Client {

	@Test
	public void testSave() {
		User user = new User(100, "王五", "横沥", null);

		// 通过WebClient对象远程调用服务端
		WebClient.create("http://localhost:8080/ws/userService/userService/user").type(MediaType.APPLICATION_JSON) // 默认请求的数据格式为xml,指定请求的数据格式为json
				.post(user);
	}

2.4.1 控制台打印

客户端

log4j:WARN No appenders could be found for logger (org.apache.cxf.common.logging.LogUtils).
log4j:WARN Please initialize the log4j system properly.
log4j:WARN See http://logging.apache.org/log4j/1.2/faq.html#noconfig for more info.

服务端

save user:User [id=100, username=王五, city=横沥, cars=[]]

2.5 测试返回单对象

	@Test
	public void testGet() {
		// 通过WebClient对象远程调用服务端
		User user = WebClient.create("http://localhost:8080/ws/userService/userService/user/1")
				.accept(MediaType.APPLICATION_JSON) // 默认响应的数据格式为xml,指定响应的数据格式为json
				.get(User.class);// get(class)返回类型
		System.out.println(user);
	}
2.5.1 控制台打印

客户端
在这里插入图片描述

服务端

2.6 测试返回集合对象

	@Test
	public void testGetAll() {
		// 通过WebClient对象远程调用服务端
		List<User> user = (List<User>) WebClient.create("http://localhost:8080/ws/userService/userService/user")
				.accept(MediaType.APPLICATION_JSON) // 默认响应的数据格式为xml,指定响应的数据格式为json
				.getCollection(User.class);// get(class)返回类型
		System.out.println(user);
	}
2.6.1 控制台打印

客户端
在这里插入图片描述

服务端

  • 0
    点赞
  • 1
    收藏
    觉得还不错? 一键收藏
  • 0
    评论

“相关推荐”对你有帮助么?

  • 非常没帮助
  • 没帮助
  • 一般
  • 有帮助
  • 非常有帮助
提交
评论
添加红包

请填写红包祝福语或标题

红包个数最小为10个

红包金额最低5元

当前余额3.43前往充值 >
需支付:10.00
成就一亿技术人!
领取后你会自动成为博主和红包主的粉丝 规则
hope_wisdom
发出的红包
实付
使用余额支付
点击重新获取
扫码支付
钱包余额 0

抵扣说明:

1.余额是钱包充值的虚拟货币,按照1:1的比例进行支付金额的抵扣。
2.余额无法直接购买下载,可以购买VIP、付费专栏及课程。

余额充值