RESTLET开发实例(一)基于JAX-RS的REST服务

RESTLET开发实例（一）基于JAX-RS的REST服务RESTLET介绍Restlet项目为“建立REST概念与Java类之间的映射”提供了一个轻量级而全面的框架。它可用于实现任何种类的REST式系统，而不仅仅是REST式Web服务。Restlet项目受到ServletAPI、JSP（JavaServerPages）、HttpURLConnection及Struts等Web开发技术的影响。该项目的主要目标是：在提供同等功能的同时，尽量遵守RoyFielding博士论文中所阐述的REST的目标。它的另一个主要目标是：提出一个既适于客户端应用又适于服务端的应用的、统一的Web视图。Restlet的思想是：HTTP客户端与HTTP服务器之间的差别，对架构来说无所谓。一个软件应可以既充当Web客户端又充当Web服务器，而无须采用两套完全不同的APIs。准备工作1、Restlet提供了多个版本:JavaSE、JavaEE、android、GoogleAppEngine、GoogleWebToolkit、Android。这里我们下载jee版本。restlet-jee-2.0.6.zip下载地址：、restlet-jee-2.0.6.zip解压到硬盘，这里以%RESTLET_HOME%表示为解压的文件目录。一、基于JAX-RS的REST服务JAX-RS(JSR-311)是一种JavaAPI，可使JavaRestful服务的开发变得迅速而轻松。这个API提供了一种基于注释的模型来描述分布式资源。注释被用来提供资源的位置、资源的表示和可移植的（pluggable）数据绑定架构。在本文中，学习如何使用JAX-RS在JavaEE环境内实现RESTful服务架构的潜能。1、新建javawebprojectRestService工程2、%RESTLET_HOME%\lib复制到\RestService\WebRoot\WEB-INF\lib下，并加入工程引用。为了测试方便可以将全部的lib包加入进去。实际上面，你可以根据实际需要只复制相应的包进去即可。下面的图片是我加入的相关的jar包：org.restlet.jar这个是必须的，如果是用于JAX-RS发布rest的话，还需要这几个包：javax.ws.rs.jarjavax.xml.bind.jarorg.json.jarorg.restlet.ext.jaxrs.jarorg.restlet.ext.json.jarorg.restlet.ext.servlet.jar3、创建Student实体类，用于返回数据。Student使用JAXB绑定技术，自动解析为xml返回给客户端或浏览器。JAXB是一套自动映射XML和Java实例的开发接口和工具。JAXB使XML更加方便的编译一个XMLSCHEMA到一个或若干个JAVACLASS。可以从使用JAXB进行数据绑定获得详细介绍。@XmlRootElement(name=”Student”)publicclassStudent{privateintid;privateStringname;privateintsex;privateintclsId;privateintage;publicintgetId(){returnid;}publicvoidsetId(intid){this.id=id;}publicStringgetName(){returnname;}publicvoidsetName(Stringname){this.name=name;}publicintgetSex(){returnsex;}publicvoidsetSex(intsex){this.sex=sex;}publicintgetClsId(){returnclsId;}publicvoidsetClsId(intclsId){this.clsId=clsId;}publicintgetAge(){returnage;}publicvoidsetAge(intage){this.age=age;}}4、Restlet架构主要是Application和Resource的概念。程序上可以定义多个Resource，一个Application可以管理多个Resource。创建应用类：StudentApplication继承了抽象类：javax.ws.rs.core.Application，并重载getClasses()方法。代码如下：SetClass?rrcs=newHashSetClass?();rrcs.add(StudentResource.class);绑定了StudentResource。有多个资源可以在这里绑定。你可以有Course等其他更多资源，相应的可以定义为：CourseResource及Course,然后加入rrcs.add(CourseResource.class)。创建资源类：StudentResource管理Student实体类@Path(“student”)publicclassStudentResource{@GET@Path(“{id}/xml”)@Produces(“application/xml”)publicStudentgetStudentXml(@PathParam(“id”)intid){returnResourceHelper.getDefaultStudent();}}其中：@Path(“student”)执行了uri路径，student路径进来的都会调用StudentResource来处理。@GET说明了http的方法是get方法。@Path(“{id}/xml”)每个方法前都有对应path，用来申明对应uri路径。@Produces(“application/xml”)指定返回的数据格式为xml。@PathParam(“id”)intid接受传递进来的id值，其中id为{id}定义的占位符要一致。和上面类似，我们可以定义返回json格式方法，如下@GET@Path(“{id}/json”)@Produces(“application/json”)publicStudentgetStudentJson(@PathParam(“id”)intid){returnResourceHelper.findStudent(id);}其中：@Produces(“application/json”)指定返回的数据格式为json。5、定义了相应的Resource和Application后，还要创建运行环境。RESTlet架构为了更好的支持JAX-RS规范，定了JaxRsApplication类来初始化基于JAX-RS的WebService运行环境。创建运行类：RestJaxRsApplication继承了类：org.restlet.ext.jaxrs.JaxRsApplication。构造方法代码如下：publicRestJaxRsApplication(Contextcontext){super(context);this.add(newStudentApplication());}将StudentApplication加入了运行环境中，如果有多个Application可以在此绑定。二、发布和部署restlet服务1、将Restlet服务部署到Tomcat容器中web.xml加入如下代码：context-paramparam-nameorg.restlet.application/param-nameparam-valuews.app.RestJaxRsApplication/param-value/context-paramservletservlet-nameRestletServlet/servlet-nameservlet-classorg.restlet.ext.servlet.ServerServlet/servlet-class/servletservlet-mappingservlet-nameRestletServlet/servlet-nameurl-pattern/*/url-pattern/servlet-mapping启动tomcat没报错的话，说明你配置正常。2、将Restlet服务当做单独的Java程序进行部署创建类RestJaxRsServer，代码如下：publicstaticvoidmain(String[]args)throwsException{Componentcomponent=newComponent();component.getServers().add(Protocol.HTTP,8085);component.getDefaultHost().attach(newRestJaxRsApplication(null));component.start();}该类中创建一个新的HttpServer，添加监听端口8085。将RestJaxRsApplication加入到HttpServer中。运行该代码，下图说明你启动成功。三、测试Restlet服务1、浏览器模式访问xml数据访问json数据提示下载数据，下载后打开数据内容为{“name”:”Steven”,”id”:1,”age”:0,”sex”:1,”clsId”:201001}如果是独立部署的话，直接访问：即可。2、Restlet自带了客户端测试代码，目前提供了jee、webkit、android等版本,调用rest服务，非常方便。新建Client类，代码如下：//publicstaticStringurl=”“;publicstaticStringurl=”“;publicstaticvoidtestXml(){ClientResourceclient=newClientResource(url+”student/1/xml”);try{System.out.println(client.get().getText());}catch(ResourceExceptione){//TODOAuto-generatedcatchblocke.printStackTrace();}catch(IOExceptione){//TODOAuto-generatedcatchblocke.printStackTrace();}}publicstaticvoidtestJson(){ClientResourceclient=newClientResource(url+”student/1/json”);try{System.out.println(client.get().getText());}catch(ResourceExceptione){//TODOAuto-generatedcatchblocke.printStackTrace();}catch(IOExceptione){//TODOAuto-generatedcatchblocke.printStackTrace();}}通过junit测试代码分别输出：四、实现对Rest服务的PUT,POST,DELETE方法。到现在我们已经完成一个基本的Rest搭建，并且实现了GET方法。REST定义了4个基本方法：