泽西岛的RESTful Web服务

我已经讨论了有关体系结构注意事项<< link >>的早期文章，以成为可在我的系统/机器上使用的分布式环境上的RESTful系统。本文我们将讨论如何基于REST体系结构考虑来构建Web服务。本教程说明了如何使用Tomcat 6，Eclipse和Jersey JAX-RS（JSR 311）参考实现在Java中开发RESTful Web服务。

简而言之，RESTful Web服务是使用HTTP on REST原理的机器之间的通信，该通信具有以下要点：

每个资源代表唯一的URI，以通过HTTP协议进行通信
HTTP方法支持的每个资源操作（POST，GET，PUT和DELETE）
JSON，XML和各种MIME类型（例如图像，字节流等）支持的请求和响应。

JAX-RS

JAX-RS是基于注释的API，用于在Java中基于HTTP实现RESTful Web服务。本质上，类和方法用信息注释，这些信息使运行时可以将它们公开为资源。在考虑到URI，请求和接受的内容类型以及HTTP方法的情况下，实现JAX-RS的运行时在HTTP协议和Java类之间进行中介。

Jersey框架实现了JSR-RS（JSR-311）参考API。除了Jersey之外，还有其他各种实现，例如Retlet，JBOSS RESTeasy，Apache CXF等。

球衣：

泽西岛包含以下主要部分：

核心服务器：要基于注释构建RESTful Web服务，请包含诸如jersey-core.jar，jersey-server.jar，jsr311-api.jar，asm.jar之类的关键库。
核心客户端：Jersey客户端API可帮助您轻松与REST服务进行通信，包括libabry ersey-client.jar
JAXB支持：（在高级示例中使用）jaxb-impl.jar，jaxb-api.jar，activation.jar，stax-api.jar，wstx-asl.jar
JSON支持：（在高级示例中使用）jersey-json.jar

集成：Jersey还提供了可以轻松与Spring，Guice，Apache Abdera等集成的库。

获取工具

软件	下载
Java JDK-6	http://www.oracle.com/
Eclipse –印度	http://www.eclipse.org/
Tomcat的Apache -6	http://tomcat.apache.org/
H2-数据库	http://www.h2database.com/

注意：您可以在此处下载完整的演示应用程序，包括H2和Jersey库<link>

使用Jersey的RESTful Web服务实现

我们将为用户管理构建一个小型应用程序，以对用户进行CRUD操作。然后，我们将使用列用户名和密码创建一个小的User表，并使用Jersey注释对Web服务使用POJO类公开操作进行CRUD操作。

在开始RESTful Web服务开发之前，以下是设计注意事项。

资源：具有用户名和密码属性的用户
资源类： UsersResource.java
URI： http：// localhost：8080 / UserManagement / users
表示形式： XML

应用程序开发文件夹结构

我们的应用程序的目录结构如下所示：

以下是所需的应用程序库列表：

应用配置：

在开始开发之前，我们需要将Jersey servlet添加到web.xml中，以将整个请求定向到jersey，以进行资源标识和操作过程（POST，GET，PUT和DELETE）。

包含jersey servlet之后，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" xmlns:web="http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" xsi:schemaLocation="http://java.sun.com/xml/ns/javaee http://java.sun.com/xml/ns/javaee/web-app_2_5.xsd" id="WebApp_ID" version="2.5"><display-name>UserManagement</display-name><servlet><servlet-name>Jersey REST Service</servlet-name><servlet-class>com.sun.jersey.spi.container.servlet.ServletContainer</servlet-class><init-param><param-name>com.sun.jersey.config.property.packages</param-name><param-value>resource.com.users.java</param-value></init-param><load-on-startup>1</load-on-startup></servlet><servlet-mapping><servlet-name>Jersey REST Service</servlet-name><url-pattern>/*</url-pattern></servlet-mapping>
</web-app>

资源资源

资源是指可通过网络寻址和操纵的任何东西。 Jersey资源是带有@Path注释的纯Java对象（POJO），将由HTTP方法POST，GET，PUT和DELETE进行操纵。资源还具有子资源。在示例应用程序Users Users的UsersResource中，Java bean是Resources。用户是具有属性名称和密码的简单POJO

UsersResource.java
@Path("/users")
public class UsersResource implements IUsersResource{
@Context
UriInfo uriInfo;
@GET
@Produces ("application/xml")
public List<User> getUsersAll() {
List<User> als=null;
try {
als= UserService.getInstance().getUserAll();
} catch (ClassNotFoundException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
return als;
}@POST
@Consumes ("application/xml")
@Produces ("application/xml")
public User createUser(User user){
URI uri = uriInfo.getAbsolutePathBuilder().path(user.getUserName()).build();
Response res=Response.created(uri).build();
try {
UserService.getInstance().CreateUser(user);
} catch (ClassNotFoundException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (SQLException e) {
// TODO Auto-generated catch block
e.printStackTrace();
}
return user;
}@Path("/user/{username}")
@GET
@Produces ("application/xml")public List<User> getUser(@PathParam("username") String username) {
List<User> asl=null;
try {
asl= UserService.getInstance().getUser(username);
} catch (ClassNotFoundException e) {
// TODO Auto-generated catch block
e.printStackTrace();
} catch (SQLException e) {
e.printStackTrace();
}
return asl;
}

以下是对JAX-RS注释的简要说明

@Path：与根路径结合的路径提供URI来标识资源。例如，在给定的示例URI中将为http：// localhost：8080 / UserManagement / users
@Path（“ / user / {username}”）：我们也可以在方法上使用子路径来公开子资源，此示例URI将为http：// localhost：8080 / UserManagement / users / user / john
@Context：上下文用于注入上下文对象，例如Request，Response，UriInfo，ServletContext等。
@PathParam：此批注与@Path一起使用，并与GET，POST，PUT和DELETE结合使用。其他可用的注释是@ FormParam，@ QueryParam等。
@Produces（“ application / xml”）：支持多种MIME类型的响应。在这种情况下，application / xml将是默认的MIME类型。
@Consumes（“ application / xml”）：输入请求有效负载将以xml格式发送。
@GET：由GET，POST，PUT和DELET方法之一操纵的资源通过HTTP标头传递

JAXB – Java POJO XML绑定

泽西岛支持JAXB，实习生将POJO转换为XML，反之亦然。为了使POJO具备支持XML的资格，我们必须声明@XmlRootElement注释，如下所示：

不要忘记在转换过程中根据需要添加空的构造函数。

@XmlRootElement
public class User {
private String userName;
private String userPasswd;
public User(String userName, String userPasswd) {
this.userName = userName;
this.userPasswd = userPasswd;
}
public User() {
super();
}
public String getUserName() {
return userName;
}
public void setUserName(String userName) {
this.userName = userName;
}
public String getUserPasswd() {
return userPasswd;
}
public void setUserPasswd(String userPasswd) {
this.userPasswd = userPasswd;
}
}

我们将在H2数据库的User表中创建执行CRUD操作的服务类。

UserService.javapublic class UserService{
public static UserService userService = new UserService();
public static final String GET_USER="SELECT * FROM USER";
public static final String INSERT_USER="Insert into user ";
public List<User> getUserAll() throws ClassNotFoundException, SQLException {
List<User> ls = new ArrayList();
ls=DataServiceHelper.getInstance().executeQuery(GET_USER);
return ls;
}public List<User> getUser(String name) throws ClassNotFoundException, SQLException{
String SQL_WHERE_CAS=" where name='"+name+"'";
List<User> als=DataServiceHelper.getInstance().executeQuery(GET_USER+SQL_WHERE_CAS);
return als;
}public void CreateUser(User user) throws SQLException, ClassNotFoundException {
String SQL_WHERE_CASE=" VALUES('" + user.getUserName() + "','" + user.getUserPasswd() + "')";
DataServiceHelper.getInstance().executeUpdateQuery(INSERT_USER+SQL_WHERE_CASE);
}
public static UserService getInstance() {
return userService;
}
}

助手类

我们必须创建更多的类来与DB（在本例中为H2）进行交互并执行CRUD操作。

DaraServiceHelper.javapublic class DataServiceHelper {
public static DataServiceHelper dataServiceHelper = null;
private Connection con = null;
DataSource dataSource = null;
InitialContext initialContext = null;
public static final String DB_URL = "jdbc:h2:tcp://localhost/~/test";
public static final String DRIVER_NAME = "org.h2.Driver";
/*** This method is used to create an object for the given DAO class name.
*/public Connection getConnection() throws ClassNotFoundException,
SQLException {
Class.forName(DRIVER_NAME);
con = DriverManager.getConnection(DB_URL, "sa", "");
return con;
}public void closeConnection() throws SQLException {
if (isConnectionOpen()) {
con.close();
con = null;
}
}
public boolean isConnectionOpen() {
return (con != null);
}public static DataServiceHelper getInstance() {
if (dataServiceHelper == null) {
dataServiceHelper = new DataServiceHelper();
}
return dataServiceHelper;
}public void executeUpdateQuery(String query) throws SQLException,
ClassNotFoundException {
Connection con = getConnection();
Statement stmt = con.createStatement();
stmt.execute(query);
closeConnection();
}public List<User> executeQuery(String query) throws ClassNotFoundException,
SQLException {
Connection con = getConnection();
Statement stmt = con.createStatement();
ResultSet rs = stmt.executeQuery(query);
List<User> als = convertPojoList(rs);
closeConnection();
return als;
}private List<User> convertPojoList(ResultSet rs) throws SQLException {
List<User> asl = new ArrayList<User>();
while (rs.next()) {
User user = new User(rs.getString("name"), rs.getString("password"));
asl.add(user);
}
return asl;
}public static void main(String[] args) throws ClassNotFoundException,
SQLException {
String query = "Select * from user where name='nitin'";
List<User> als = DataServiceHelper.getInstance().executeQuery(query);
System.out.println("List==>" + als);
}
}

注意：为简单起见，我将所有代码都包含在一个类中

泽西岛客户测试

泽西岛提供客户端来测试RESTful Web服务，它有助于与服务器进行通信并测试服务。该库是一个通用实现，可以与任何基于HTTP / HTTPS的Web服务配合使用。

public class UserResourceSample {
public static final String USER_URI="http://localhost:8080/UserManagement/users";
public String testGetUsersAll() {
ClientConfig config = new DefaultClientConfig();
Client client = Client.create(config);
WebResource resource = client.resource(ForumConstant.USER_URI);
ClientResponse response = resource.type(MediaType.APPLICATION_XML).get(
ClientResponse.class);
String en = response.getEntity(String.class);
return en;
}public String testGetUsers() {
ClientConfig config = new DefaultClientConfig();
Client client = Client.create(config);
WebResource resource = client.resource(ForumConstant.USER_URI);
ClientResponse response = resource.type(MediaType.APPLICATION_XML).get(
ClientResponse.class);
String en = response.getEntity(String.class);
return en;
}public User testCreateUser() {
User user = new User("John", "john@");
Client client = Client.create();
WebResource r = client.resource(ForumConstant.USER_URI);
ClientResponse response = r.accept(MediaType.APPLICATION_XML).post(
ClientResponse.class, user);
return user;
}
}

使用浏览器运行

在Eclipse中运行Web应用程序，并在以下位置测试REST服务的可用性： http：// localhost：8080 / UserManagement / users＆＃8221;。您应该看到用户项目的XML表示形式：

对于子资源：

注意：在运行应用程序之前，请不要忘记运行H2数据库并将记录插入到User表中

结论：

此示例讨论了Apache Tomcat与Jersey的基本用法。我们将在以后讨论一些JAX-RS的高级用法。您也可以将完整的代码下载到此链接下面的<>

资源：

http://en.wikipedia.org/wiki/Representational_state_transfer
https://jersey.java.net/

参考： Tech My Talk博客上来自JCG合作伙伴 Nitin Kumar的新泽西RESTful Web服务。

翻译自: https://www.javacodegeeks.com/2013/07/restful-webservices-with-jersey.html