Jersey+Spring+Hibernate搭建的一个简单Web Service

之前学习了REST风格的Web Service的基本知识，又了解了JAX-RS这个用于开发REST风格的Web Service的官方标准以及

Jersey这个实现。下面就自己写了一个利用Jersey，Spring和Hibernate搭建起来的RESTful的Web Service，实现一个简单的Book类

信息的CRUD。

工具：MyEclipse 10、 Tomcat6

框架：Jersey、Hibernate、Spring

1、首先在MyEclipse下创建一个Maven工程，创建最基本的依赖

<dependencies>
		<dependency>
			<groupId>junit</groupId>
			<artifactId>junit</artifactId>
			<version>3.8.1</version>
			<scope>test</scope>
		</dependency>
		<!-- servlet -->
		<dependency>
			<groupId>javax.servlet</groupId>
			<artifactId>servlet-api</artifactId>
			<version>2.5</version>
			<scope>provided</scope>
		</dependency>
		<!-- https://mvnrepository.com/artifact/javax.ws.rs/jsr311-api -->
		<dependency>
			<groupId>javax.ws.rs</groupId>
			<artifactId>jsr311-api</artifactId>
			<version>1.1.1</version>
		</dependency>
		<!-- hibernate -->
		<dependency>
			<groupId>org.hibernate</groupId>
			<artifactId>hibernate-core</artifactId>
			<version>4.3.11.Final</version>
		</dependency>
		<!-- spring -->
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-core</artifactId>
			<version>4.2.5.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-aop</artifactId>
			<version>4.2.5.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-aspects</artifactId>
			<version>4.2.5.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-beans</artifactId>
			<version>4.2.5.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context</artifactId>
			<version>4.2.5.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-context-support</artifactId>
			<version>4.2.5.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-expression</artifactId>
			<version>4.2.5.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-instrument</artifactId>
			<version>4.2.5.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-tx</artifactId>
			<version>4.2.5.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-jdbc</artifactId>
			<version>4.2.5.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-orm</artifactId>
			<version>4.2.5.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-web</artifactId>
			<version>4.2.5.RELEASE</version>
		</dependency>
		<dependency>
			<groupId>org.springframework</groupId>
			<artifactId>spring-test</artifactId>
			<version>4.2.5.RELEASE</version>
			<scope>test</scope>
		</dependency>
		<!-- commons-dbcp -->
		<dependency>
			<groupId>commons-dbcp</groupId>
			<artifactId>commons-dbcp</artifactId>
			<version>1.4</version>
		</dependency>
		<!-- mysql驱动 -->
		<dependency>
			<groupId>mysql</groupId>
			<artifactId>mysql-connector-java</artifactId>
			<version>5.1.6</version>
			<scope>runtime</scope>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.glassfish.jersey.core/jersey-server -->
		<dependency>
			<groupId>org.glassfish.jersey.core</groupId>
			<artifactId>jersey-server</artifactId>
			<version>2.23</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.glassfish.jersey.containers/jersey-container-servlet -->
		<dependency>
			<groupId>org.glassfish.jersey.containers</groupId>
			<artifactId>jersey-container-servlet</artifactId>
			<version>2.23</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.glassfish.jersey.media/jersey-media-json-jackson -->
		<dependency>
			<groupId>org.glassfish.jersey.media</groupId>
			<artifactId>jersey-media-json-jackson</artifactId>
			<version>2.23</version>
		</dependency>
		<!-- https://mvnrepository.com/artifact/org.glassfish.jersey.ext/jersey-spring3 -->
		<dependency>
			<groupId>org.glassfish.jersey.ext</groupId>
			<artifactId>jersey-spring3</artifactId>
			<version>2.23</version>
		</dependency>

	</dependencies>

2、创建web.xml

<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>
		<servlet-name>rest</servlet-name>
		<servlet-class>org.glassfish.jersey.servlet.ServletContainer
		</servlet-class>
		<!-- 加载application -->
		<init-param>
			<param-name>javax.ws.rs.Application</param-name>
			<param-value>cn.wqy.BookResourceConfig</param-value>
		</init-param>
		<load-on-startup>1</load-on-startup>
	</servlet>
	<servlet-mapping>
		<servlet-name>rest</servlet-name>
		<url-pattern>/rest/*</url-pattern>
	</servlet-mapping>

首先context-param中的键值对定义了spring框架的配置文件的定位。listener定义了spring框架中定义的bean随着web容器启动而被

创建。之后配置了一个servlet，采用的类是org.glassfish.jersey.servlet.ServletContainer，这个类相当于是对客户端发来的请求做了

一个拦截，/rest/*的请求会被视作请求资源的请求。同时他还有一个启动参数，设置了Application类的实现，这个类是要我们自己写

的，在其中定位或者说注册了Resource类的具体定位。

3、配置applicationContext.xml和jdbc.properties

配置spring的相关配置文件。

applicationContext.xml：

<!-- 配置使用注解，仅仅配置这一项的话还是需要在XML文件中进行bean配置 -->
	<context:annotation-config />
	<!-- 让容器到指定包目录下寻找需要被当做组件的类 ，其中包含了context:annotation-config的功能，因此有scan时可以省略上一条-->
	<context:component-scan base-package="cn.wqy" />
	<!-- 事务管理******************************************************************************************** -->
	<tx:annotation-driven transaction-manager="txManager"/>
	<bean id="txManager"
		class="org.springframework.orm.hibernate4.HibernateTransactionManager">
		<property name="sessionFactory" ref="sessionFactory" />
	</bean>
	<!-- 创建数据源***************************************************************************************** -->
	<context:property-placeholder location="classpath:jdbc.properties" /><!-- 
		classpath表示src目录下的properties文件 -->
	<bean id="myDataSource" class="org.apache.commons.dbcp.BasicDataSource"
		destroy-method="close">
		<property name="driverClassName" value="${jdbc.driverClassName}" />
		<property name="url" value="${jdbc.url}" />
		<property name="username" value="${jdbc.username}" />
		<property name="password" value="${jdbc.password}" />
	</bean>
	<!-- 创建SessionFactory，并注入数据源********************************************************************* -->
	<bean id="sessionFactory"
		class="org.springframework.orm.hibernate4.LocalSessionFactoryBean">
		<property name="DataSource" ref="myDataSource" />
		<property name="annotatedClasses">
			<list>
				<value>cn.wqy.model.Book</value>
			</list>
		</property>

		<property name="hibernateProperties">
			<props>
				<prop key="hibernate.dialect">org.hibernate.dialect.MySQLDialect</prop>
				<prop key="hibernate.show_sql">true</prop>
				<prop key="hibernate.format_sql">true</prop>
			</props>
		</property>

	</bean>
	<!-- 创建hibernateTemplate********************************************************************************** -->
	<bean id="hibernateTemplate" class="org.springframework.orm.hibernate4.HibernateTemplate">
		<property name="sessionFactory" ref="sessionFactory"></property>
	</bean>

4、创建Resource类

package cn.wqy.resource;

import javax.annotation.Resource;
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 org.springframework.stereotype.Component;

import cn.wqy.model.Book;
import cn.wqy.service.BookService;

@Path("books")
@Component
public class BookResource {
	private BookService bookService;

	public BookService getBookService() {
		return bookService;
	}

	@Resource
	public void setBookService(BookService bookService) {
		this.bookService = bookService;
	}

	@GET
	@Path("/test1")
	@Produces(MediaType.APPLICATION_JSON)
	public Book getUserJSON() {
		Book book = new Book();
		book.setId(4);
		book.setBookName("wqy");
		book.setPublisher("yyq");
		return book;
	}
	
	@GET
	@Path("/test2")
	@Produces(MediaType.APPLICATION_XML)
	public Book getUserXML() {
		Book book = new Book();
		book.setId(4);
		book.setBookName("wqy");
		book.setPublisher("yyq");
		return book;
	}

	@GET
	@Path("{id:[0-9]*}")
	@Produces({ MediaType.APPLICATION_JSON, MediaType.APPLICATION_XML })
	public Book getBooks(@PathParam("id") final int id) {
		final Book book = this.bookService.getById(id);
		return book;	
	}
}

5、创建service、dao、model类

这些都是很基础的创建，在此就不再赘述。

6、创建Application类，注册服务

package cn.wqy;

import org.glassfish.jersey.server.ResourceConfig;

//import javax.ws.rs.ApplicationPath;
//@ApplicationPath("/webapi/*")
public class BookResourceConfig extends ResourceConfig {
	public BookResourceConfig() {
		// TODO Auto-generated constructor stub
		packages("cn.wqy.resource");
	}
}

其中可以通过@ApplicationPath注解定义入口，并且其中通过packages方法配置了Resource资源类的定位。

7、创建jsp以及js文件

为了实现访问RESTful类型的url，在这里用jquery的ajax方法发送url请求。

<!DOCTYPE html>
<html>
<head>
<meta charset="utf-8">
<style type="text/css">
body {
	font: 12px/20px arial, sans-serif;
}
</style>
<script src="webjars/jquery/3.1.0/jquery-3.1.0.js"></script>
<script src="js/rest.js"></script>
</head>

<body>
 <div id="resultDiv" style="border: 1px solid green;">测试结果</div>
 <h3>1 查询全部(没有分页功能)</h3>
 <input id="getButton3" type="button" value="GetAll" onclick="getAllBook();" />
 
 <h3>2 主键查询(query)</h3>
 <input type="text" id="queryUrl" name="queryUrl" value="/book?id=1" style="width: 200px" />
 <input id="getButton1" type="button" value="Get By Query" onclick="getBookByQuery();" />
 
 <h3>3 主键查询(path)</h3>
 <input type="text" id="pathUrl" name="pathUrl" value="/1" style="width: 200px" />
 <input id="getButton2" type="button" value="Get By Path" onclick="getBookByPath();" />
 
 <h3>4 更新</h3>
 <div>
  <p>
   book Id: <input type="text" id="bookId0" name="bookId0" />
   book name: <input type="text" id="bookName0" name="bookName0" />
   publisher: <input type="text" id="publisher0" name="publisher0" />
  </p>
  <p>
   data format:
   <input id="jsonRadio0" type="radio" name="updateRadio" value="application/json" checked="checked"/>json
   <input id="xmlRadio0" type="radio"  name="updateRadio" value="application/xml"/>xml
  </p>
   <input id="putButton" type="button" value="Update" onclick="putBook();" />
 </div>
 
 <h3>5 删除</h3>
  <div>
  <input type="text" id="delUrl" name="delUrl" value="/1" style="width: 200px" />
   <input id="deleteButton" type="button" value="Delete" onclick="deleteBook();" />
 </div>
 
 <h3>6 新增</h3>
 <div>
  <p>
   book name: <input type="text" id="bookName" name="bookName" />
   publisher: <input type="text" id="publisher" name="publisher" />
  </p>
  
  <p>
   data format:
   <input id="jsonRadio" type="radio" name="saveRadio" value="application/json" checked="checked"/>json
   <input id="xmlRadio" type="radio"  name="saveRadio" value="application/xml"/>xml
  </p>
  <input id="createButton" type="button" value="Create" onclick="postBook();" />
 </div>
</body>
</html>

js文件：

var bookRestUrl = 'http://localhost:8080/restfulService/rest/books';
function rest(restUrl, httpMethod, param, contenttype, datatype, callback) {
	jQuery('#resultDiv').html("Loading...");
	var request = jQuery.ajax({type : httpMethod, url : restUrl, data : param, contentType : contenttype, dataType : datatype});
	request.done(function(data) {
		try {
			if (data === null || data === undefined) {
				jQuery('#resultDiv').html("No result from server");
			} else {
				alert(JSON.stringify(data));
				callback(data);
			}
		} catch (e) {
			jQuery('#resultDiv').html(e);
		}
	});
	request.fail(function(textStatus, errorThrown) {
		jQuery('#resultDiv').html(errorThrown + " status=" + textStatus.status);
	});
}
/*GET*/
function getAllBook() {
	rest(bookRestUrl, 'GET', null, null, 'json', renderGetAll);
}
function getBookByQuery() {
	var url = $("#queryUrl").val();
	rest(bookRestUrl + url, 'GET', null, null, 'json', renderQueryGet);
}
function getBookByPath() {
	var url = $("#pathUrl").val();
	rest(bookRestUrl + url, 'GET', null, null, 'json', renderPathGet);
}
/*PUT*/
function putBook() {
	var contentType = $("input[name='updateRadio']:checked").val();
	var putData;
	var idValue = $("#bookId0").val();
	var nameValue = $("#bookName0").val();
	var publisherValue = $("#publisher0").val();
	if (contentType === "application/xml") {
		putData = "<book";
		if (nameValue !== "") {
			putData += " bookName='" + nameValue + "'";
		}
		if (publisherValue !== "") {
			putData += " publisher='" + publisherValue + "'";
		}
		putData += "/>";
	} else {
		var book = new Object();
		if (nameValue !== "") {
			book.bookName = nameValue;
		}
		if (publisherValue !== "") {
			book.publisher = publisherValue;
		}
		putData = JSON.stringify(book);
	}
	rest(bookRestUrl + "/" + idValue, 'PUT', putData, contentType, 'json', renderPut);
}
/*POST*/
function postBook() {
	var contentType = $("input[name='saveRadio']:checked").val();
	var postData;
	var nameValue = $("#bookName").val();
	var publisherValue = $("#publisher").val();
	if (contentType === "application/xml") {
		postData = "<book bookName='" + nameValue + "'/>";
	} else {
		postData = JSON.stringify({bookName : nameValue, publisher : publisherValue});
	}
	rest(bookRestUrl, 'POST', postData, contentType, 'json', renderPut);
};
/*DELETE*/
function deleteBook() {
	var url = $("#delUrl").val();
	rest(bookRestUrl + url, 'DELETE', null, null, 'text', renderDelete);
}
/*Render DOM*/
function renderGetAll(data) {
	var books = data.bookList.book;
	var result = "";
	for ( var i = 0; i < books.length; i++) {
		result += books[i].bookId + "-" + books[i].bookName + "-" + books[i].publisher + "<br/>";
	}
	$('#resultDiv').html(result);
}
function renderQueryGet(data) {
	$('#resultDiv').html("query result: " + data.bookId + "-" + data.bookName + "-" + data.publisher);
}
function renderPathGet(data) {
	$('#resultDiv').html("path result: " + data.id + "-" + data.bookName + "-" + data.publisher);
}
function renderPut(data) {
	$('#resultDiv').html("DONE! id=" + data.bookId);
}
function renderDelete(data) {
	$('#resultDiv').html(data);
}

至此，这个服务的基本框架已经搭好了，并且实现了基本的一个根据id查找书本信息的get功能。启动服务器：

初始状态局部图：

查询有结果后的图：

查询无结果后的图：