API
类/注解 | 描述 |
---|---|
@XmlRootElement | 指定对象序列化为xml或json数据时根节点的名称 |
@Path | 在接口上表示访问当前服务接口对应的路径 |
@Produces | 表示服务器支持的返回的数据格式类型。值为*/*,支持任意类型 |
@POST | 表示处理的请求类型,post对应的是insert新增操作 |
@PUT | 表示处理的请求类型,put对应的是update更新操作 |
@GET | 表示处理的请求类型,get对应的是query查询操作 |
@DELETE | 表示处理的请求类型,delete对应的是delete删除操作 |
@Consumes | 表示服务器支持的请求的数据格式类型 |
@PathParam | restful风格路径变量 |
1.服务端
1.1创建简单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/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion>
<groupId>org.example</groupId>
<artifactId>jaxrs_server</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.apache.cxf/cxf-rt-transports-http-jetty -->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http-jetty</artifactId>
<version>3.0.1</version>
<scope>test</scope>
</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/junit/junit -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</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>
</plugins>
</pluginManagement>
</build>
</project>
1.3实体类
package com.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 com.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.4 服务接口、实现类
package com.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 com.jaxrs.entity.User;
/**
* @Path 在接口上表示访问当前服务接口对应的路径
*
*
* */
@Path("/userService")
//@Produces 值为*/*,支持任意类型,表示服务器支持的返回的数据格式类型
@Produces("*/*")
public interface UserServiceI {
/**
* @Path 表示访问当前服务接口方法对应的路径。【.../userService/user】
* @POST 表示处理的请求类型,post对应的是insert新增操作
* @PUT 表示处理的请求类型,put对应的是update更新操作
* @GET 表示处理的请求类型,get对应的是query查询操作
* @DELETE 表示处理的请求类型,delete对应的是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 com.jaxrs.service.impl;
import java.util.ArrayList;
import java.util.List;
import com.jaxrs.entity.Car;
import com.jaxrs.entity.User;
import com.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.5添加日志配置文件log4j.properties
log4j.rootCategory=info,CONSOLE,LOGFILE
log4j.logger.org.apache.axis.enterprise=FATAL,CONSOLE
log4j.appender.CONSOLE=org.apache.log4j.ConsoleAppender
log4j.appender.CONSOLE.layout=org.apache.log4j.PatternLayout
log4j.appender.CONSOLE.layout.ConversionPattern=%d{ISO8601}%-6r[%15.15t\%-5p %30.30c %x - %m\n
log4j.appender.LOGFILE=org.apache.log4j.FileAppender
log4j.appender.LOGFILE.File=d:\axis.log
log4j.appender.LOGFILE.Append=true
log4j.appender.LOGFILE.layout=org.apache.log4j.PatternLayout
1.6发布服务
package com.jaxrs.test;
import org.apache.cxf.interceptor.LoggingInInterceptor;
import org.apache.cxf.interceptor.LoggingOutInterceptor;
import org.apache.cxf.jaxrs.JAXRSServerFactoryBean;
import com.jaxrs.service.impl.UserServiceImpl;
public class Server {
public static void main(String[] args) {
//创建发布服务的工厂
JAXRSServerFactoryBean factoryBean = new JAXRSServerFactoryBean();
//设置服务地址
factoryBean.setAddress("http://localhost:8001/ws/");
//设置服务类
factoryBean.setServiceBean(new UserServiceImpl());
//添加日志输入输出拦截器
factoryBean.getInInterceptors().add(new LoggingInInterceptor());
factoryBean.getOutInterceptors().add(new LoggingOutInterceptor());
//发布服务
factoryBean.create();
System.out.println("发布服务成功");
}
}
1.7运行控制台日志
2021-11-20 14:39:31,4850 [ mainINFO apache.cxf.endpoint.ServerImpl - Setting the server's publish address to be http://localhost:8001/ws/
2021-11-20 14:39:31,612127 [ mainINFO rg.eclipse.jetty.server.Server - jetty-8.1.15.v20140411
2021-11-20 14:39:32,285800 [ mainINFO jetty.server.AbstractConnector - Started SelectChannelConnector@localhost:8001
发布服务成功
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>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.apache.cxf/cxf-rt-transports-http-jetty -->
<dependency>
<groupId>org.apache.cxf</groupId>
<artifactId>cxf-rt-transports-http-jetty</artifactId>
<version>3.0.1</version>
<scope>test</scope>
</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/junit/junit -->
<dependency>
<groupId>junit</groupId>
<artifactId>junit</artifactId>
<version>4.10</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>
</plugins>
</pluginManagement>
</build>
</project>
2.3实体类
package com.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 com.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.3写无返回junit,远程访问服务端
2.3.1 无返回-测试代码
package com.jaxrs.test;
import javax.ws.rs.core.MediaType;
import org.apache.cxf.jaxrs.client.WebClient;
import org.junit.Test;
import com.jaxrs.entity.User;
public class Client {
@Test
public void testSave() {
User user = new User(100,"王五","横沥",null);
//通过WebClient对象远程调用服务端
WebClient.create("http://localhost:8001/ws/userService/user")
.type(MediaType.APPLICATION_JSON) //默认请求的数据格式为xml,指定请求的数据格式为json
.post(user);
}
}
2.3.2 无返回-控制台日志输出
客户端
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.
服务端
2021-11-20 14:39:31,4850 [ mainINFO apache.cxf.endpoint.ServerImpl - Setting the server's publish address to be http://localhost:8001/ws/
2021-11-20 14:39:31,612127 [ mainINFO rg.eclipse.jetty.server.Server - jetty-8.1.15.v20140411
2021-11-20 14:39:32,285800 [ mainINFO jetty.server.AbstractConnector - Started SelectChannelConnector@localhost:8001
发布服务成功
2021-11-20 14:48:33,864542379[tp1413246829-16INFO terceptor.LoggingInInterceptor - Inbound Message
----------------------------
ID: 1
Address: http://localhost:8001/ws/userService/user
Encoding: ISO-8859-1
Http-Method: POST
Content-Type: application/json
Headers: {Accept=[*/*], Cache-Control=[no-cache], connection=[keep-alive], Content-Length=[55], content-type=[application/json], Host=[localhost:8001], Pragma=[no-cache], User-Agent=[Apache CXF 3.0.1]}
Payload: {"User":{"city":"横沥","id":100,"username":"王五"}}
--------------------------------------
save user:User [id=100, username=王五, city=横沥, cars=[]]
2021-11-20 14:48:34,021542536[tp1413246829-16INFO erceptor.LoggingOutInterceptor - Outbound Message
---------------------------
ID: 1
Response-Code: 204
Content-Type:
Headers: {Date=[Sat, 20 Nov 2021 06:48:34 GMT], Content-Length=[0]}
--------------------------------------
可以看出是post请求,请求的类型为application/json,PayLoad为json格式传输请求参数
2.4写有返回junit,远程访问服务端
2.4.1 有返回单对象-测试代码
package com.jaxrs.test;
import java.util.List;
import javax.ws.rs.core.MediaType;
import org.apache.cxf.jaxrs.client.WebClient;
import org.junit.Test;
import com.jaxrs.entity.User;
public class Client {
@Test
public void testGet() {
// 通过WebClient对象远程调用服务端
User user = WebClient.create("http://localhost:8001/ws/userService/user/1")
.accept(MediaType.APPLICATION_JSON) // 默认响应的数据格式为xml,指定响应的数据格式为json
.get(User.class);// get(class)返回类型
System.out.println(user);
}
2.4.2 有返回单对象-控制台打印
客户端
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.
User [id=1, username=张三, city=东莞, cars=[]]
服务端
2021-11-20 15:01:03,1981291713[tp1413246829-15INFO terceptor.LoggingInInterceptor - Inbound Message
----------------------------
ID: 2
Address: http://localhost:8001/ws/userService/user
Encoding: ISO-8859-1
Http-Method: POST
Content-Type: application/xml
Headers: {Accept=[*/*], Cache-Control=[no-cache], connection=[keep-alive], Content-Length=[126], content-type=[application/xml], Host=[localhost:8001], Pragma=[no-cache], User-Agent=[Apache CXF 3.0.1]}
Payload: <?xml version="1.0" encoding="UTF-8" standalone="yes"?><User><city>横沥</city><id>100</id><username>王五</username></User>
--------------------------------------
save user:User [id=100, username=王五, city=横沥, cars=[]]
2021-11-20 15:01:03,2421291757[tp1413246829-15INFO erceptor.LoggingOutInterceptor - Outbound Message
---------------------------
ID: 2
Response-Code: 204
Content-Type:
Headers: {Date=[Sat, 20 Nov 2021 07:01:03 GMT], Content-Length=[0]}
--------------------------------------
2021-11-20 15:06:04,2281592743[tp1413246829-16INFO terceptor.LoggingInInterceptor - Inbound Message
----------------------------
ID: 3
Address: http://localhost:8001/ws/userService/user/1
Http-Method: GET
Content-Type: */*
Headers: {Accept=[application/json], Cache-Control=[no-cache], connection=[keep-alive], content-type=[*/*], Host=[localhost:8001], Pragma=[no-cache], User-Agent=[Apache CXF 3.0.1]}
--------------------------------------
2021-11-20 15:06:04,2431592758[tp1413246829-16INFO erceptor.LoggingOutInterceptor - Outbound Message
---------------------------
ID: 3
Response-Code: 200
Content-Type: application/json
Headers: {Content-Type=[application/json], Date=[Sat, 20 Nov 2021 07:06:04 GMT]}
Payload: {"User":{"city":"东莞","id":1,"username":"张三"}}
--------------------------------------
2.4.3 有返回集合对象-测试代码
package com.jaxrs.test;
import java.util.List;
import javax.ws.rs.core.MediaType;
import org.apache.cxf.jaxrs.client.WebClient;
import org.junit.Test;
import com.jaxrs.entity.User;
public class Client {
@Test
public void testGetAll() {
// 通过WebClient对象远程调用服务端
List<User> user = (List<User>) WebClient.create("http://localhost:8001/ws/userService/user")
.accept(MediaType.APPLICATION_JSON) // 默认响应的数据格式为xml,指定响应的数据格式为json
.getCollection(User.class);// get(class)返回类型
System.out.println(user);
}
}
2.4.4 有返回集合对象-控制台打印
客户端
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.
[User [id=1, username=张三, city=东莞, cars=[Car [id=101, carName=保时捷, price=1.0E12], Car [id=102, carName=宝马, price=4000000.0]]], User [id=2, username=李四, city=上海, cars=[]]]
服务端
2021-11-20 15:12:34,7691983284[tp1413246829-20INFO terceptor.LoggingInInterceptor - Inbound Message
----------------------------
ID: 6
Address: http://localhost:8001/ws/userService/user
Http-Method: GET
Content-Type: */*
Headers: {Accept=[application/json], Cache-Control=[no-cache], connection=[keep-alive], content-type=[*/*], Host=[localhost:8001], Pragma=[no-cache], User-Agent=[Apache CXF 3.0.1]}
--------------------------------------
2021-11-20 15:12:34,7721983287[tp1413246829-20INFO erceptor.LoggingOutInterceptor - Outbound Message
---------------------------
ID: 6
Response-Code: 200
Content-Type: application/json
Headers: {Content-Type=[application/json], Date=[Sat, 20 Nov 2021 07:12:34 GMT]}
Payload: {"User":[{"cars":[{"carName":"保时捷","id":101,"price":1.0E12},{"carName":"宝马","id":102,"price":4000000}],"city":"东莞","id":1,"username":"张三"},{"city":"上海","id":2,"username":"李四"}]}
--------------------------------------