在RESTFul Web
Service一书中,介绍了使用
HTTP协议来实现
异步请求的一个轻量级
设计模式,叫做ASync Job Service。而RESTEasy很好地支持了这个模式,并提供了一个
例子说明
使用方法。本文对这种设计模式及其在RESTEasy下的使用方法做出说明。
ASync Job Service
一般情况下,当客户端对
服务端发起
HTTP请求后,服务端将会为客户端打开一个HTTP连接,然后处理客户端发来的请求,处理完成后将结果封装成HTTP Response转回客户端,从而完成一次HTTP请求。
上述过程中,服务端在进行业务处理时,服务器与客户端之间的连接会保持联系,直到服务器将HTTP请求处理结束。如果服务端业务处理时间较长,那么客户端在等待的时候将一直占用这个HTTP连接。而服务器的资源是有限的,可以同时处理的HTTP请求也有一定的上限,当服务器压力较大,接受请求数很多时,很多等待返回结果的客户端连接就会造成性能瓶颈。
因此,在RESTFul WebService一书中针对这种情况提出了两种轻量级的解决方案:
第一种叫做 Ony Way 模式。当用户访问服务器的某个URL地址时,服务器接受到客户端请求,并马上返回HTTP Response给客户端,然后再开始执行业务处理逻辑。与普通情况下的正常返回值 HTTP 200 OK 不同,服务器会返回给客户端 HTTP 202 ACCEPTED,告知客户端请求已收到。
这种模式的好处是客户端基本上不会占用服务器的连接数,缺点也是显而易见的,客户端并不能监控请求到底成功没有,也不能判定业务逻辑是否正常执行。不管服务器接受到请求后,是否成功处理了业务逻辑,客户端只会收到一个 HTTP 202 ACCEPTED的返回值,并没有其它的信息包含在内。
针对上述问题,RESTFul WebService这本书中在此基础上还提出了另一种异步请求模式,叫做 ASync 模式:针对第一种模式中,客户端无法获得请求的执行结果的情况,要求服务器在收到请求后,返回给用户HTTP 202 ACCEPTED的同时,在HTTP HEADER中封装一个Location的属性给用户。在这个Location属性当中,提供给客户端一个用于查看业务执行结果的URL地址。
如果客户端想查看请求的执行结果,便可以访问服务器服务返回的Location地址处获得结果。如果此时服务器仍未处理完毕,则还会立刻返回给客户端HTTP 202 Accepted。如果服务端处理完成了,便会把实际的请求结果返回给用户。
RESTEasy实现
RESTEasy实现了RESTFul WebService中所描述的上面这两种设计模式,并提供了一个例子来展示其用法,我们来简单看一下。首先是从RESTEasy的网站中获取源代码:
svn export https://resteasy.svn.sourceforge.net/svnroot/resteasy/branches/Branch_2_1_0/ resteasy
下载完成后,将RESTEasy源代码使用
Maven进行编译安装:
mvn -Dmaven.skip.test=true install
执行编译过程中,Maven会下载所依赖的库,需要不少的时间。完成后,我们便可以使用RESTEasy提供的异步调用HTTP请求的例子。这个例子位于刚刚签出的RESTEasy代码的examples/async-job-service中。
这个例子中定义了一个非常简单的WebService:
package org.jboss.resteasy.examples.asyncjob;
import javax.ws.rs.Consumes;
import javax.ws.rs.GET;
import javax.ws.rs.POST;
import javax.ws.rs.PUT;
import javax.ws.rs.Path;
import javax.ws.rs.Produces;
/**
* @author <a href="mailto:bill@burkecentral.com">Bill Burke</a>
* @version $Revision: 1 $
*/
@Path("/resource")
public class MyResource
{
private static int count = 0;
@POST
@Produces("text/plain")
@Consumes("text/plain")
public String post(String content) throws Exception
{
Thread.sleep(1000);
return content;
}
@GET
@Produces("text/plain")
public String get() throws InterruptedException
{
return Integer.toString(count);
}
@PUT
@Consumes("text/plain")
public void put(String content) throws Exception
{
System.out.println("IN PUT!!!!");
Thread.sleep(1000);
System.out.println("******* countdown complete ****");
count++;
}
}
如代码所示,例子中定义了一个计数器的WebService,映射到URL地址/resource上,提供POST,GET,PUT方法。
当使用POST方法访问/resources时,服务会把客户端提交的字串原封不动返回给用户;使用PUT方法访问时,将count计数器加1;使用GET方法调用则会获得计数器当前的值。
值得注意的是put和post方法里面的两段代码:
Thread.sleep(1000);
让服务端在收到请求后休眠一秒钟后继续运行,目的是为了展示出异步执行的效果。针对这个WebService,例子中提供了一个测试类AsyncJobTest.java。
可以看到这个类给出了两种模式的测试方法,分别是testOneway和testAsynch。
testOneway
testOneway调用/resources的put方法,并使用?oneway=true的参数,当RESTEasy收到oneway=true时,便知道要异步处理这个请求,并迅速返回给客户端一个 HTTP 202 ACCEPTED,然后再执行业务逻辑代码。上面看到,在put方法的服务端业务中,故意让这个
线程休眠1秒钟,因此通过这个测试便可以展示出请求是异步执行的,客户端并不需要等这一秒钟,而是直接得到了 HTTP 202 ACCEPTED的返回。
接下来的测试代码,让客户端得到服务器的返回后也休眠1.5秒钟,目的是等待服务器执行完put请求,将计数器加1,然后再通过get方法访问/resources,可以验证此时计数已经确实被加1了。
testAsynch
接下来是testAsynch方法。在这个测试方法中,首先向resource服务发起一个post请求,提交"content"字串。注意在这次提交中使用了?asynch=true的标记,向RESTEasy声明使用async模式。因此服务端收到请求后,除了马上返回一个 HTTP 202 ACCEPTED以外,还会将一个Location属性封装进HTTP Header中。接下来的测试代码读取Location中提供的URL,并马上访问这个地址。因为此时服务端的业务设计成休眠一秒,因此从这个地址中肯定还得不到业务返回结果,因此仍然会得到HTTP 202 ACCEPTED的响应。接下来客户端代码休眠了1.5秒,再次尝试访问Location给出的URL,此时应该得到了业务逻辑的正确返回,即"content"字串。
执行上述测试,可在这个例子的根目录下使用下述maven命令:
mvn integration-test
以上是对RESTEasy的轻量级HTTP异步请求模式的一个简单说明。在本文的下半部分,我将深入这个例子,动手做一些实验,加深对这两个模式的
理解。
参考书目:
http://www.amazon.com/Restful-Web-Services-Leonard-Richardson/dp/0596529260/ref=sr_1_1?ie=UTF8&qid=1298825300&sr=8-1
参考文档:
http://docs.jboss.org/resteasy/docs/1.1.GA/userguide/html/async_job_service.html