webservice restful一个小例子

时间：2023-01-28 11:58:32

需求
公司有一个产品，包括前台WEB界面和多个后台服务，各个服务都需要在前面界面中进行配置和控
制，以调整服务的行为。以前，配置文件都存放在数据库中，界面上修改配置后入库，并发送消息（Socket）通知特定的服务重新加载配置。这样有些问题，
一方面自己维护Socket带来很多麻烦，二来数据库重建的时候，需要备份/恢复这些配置数据。

所以，我们想把配置文件局部化到各个服务（比如用本地文件存储），然后在界面上修改的时候，实时向服务请求当前配置数据（XML格式），修改完毕后，再直接发给服务进行更新和存储。而在通信方式上，我们希望各个服务提供Web Service接口来实现配置的检索和更新。

但Web Service通常需要在Web Container（比如，tomcat, jboss）中实现，而我们不想把所有的服务都跑在tomcat里，于是想找到一种更加轻量级的方式。

今天偶然看到JSR311，进而发现在Java后台服务中内嵌grizzly（基于NIO的实现）和Jersey（Sun的JSR311参考实现）
来提供Restful Web
Service能力，是非常方便的。个人认为这种方式适用于后台Java程序的控制、配置和监视，其作用有些类似于JMX，但比实现JMX要简单的多
（JSR311基于POJO）。

背景知识
Representational state transfer (REST) Web Service：
它
是Roy Fielding博士在2000年他的博士论文中提出来的一种软件架构风格。在目前三种主流的Web
Service实现方案中，因为REST与SOAP和XML-RPC相比显的更加简洁，因此越来越多的Web
Service开始采用REST风格设计和实现。

参考资料：http://en.wikipedia.org/wiki/Representational_State_Transfer

Jersey：
它是Sun对JSR311的官方参考实现，而JSR311是java中实现Restful Web
Service的API规范（JSR311: JAX-RS: The Java API for RESTful Web
Services）。JSR311有一个重要目标：使用注解（annotation）把POJO暴露成Web Service，这样就比较轻量级。

参考资料：https://jsr311.dev.java.net/nonav/releases/1.0/spec/index.html

Grizzly：
Grizzly于2004年诞生在GlassFish中，开始目的是要建构一个HTTP
Web服务器，用来代替Tomcat的Coyote连接器和Sun WebServ
er6.1。后来，Grizzly成为一种应用程序框架，专门解决编写成千上万用户访问服务器时候产生的各种问题。使用JAVA
NIO作为基础，并隐藏其编程的复杂性。在本例中，我们将其用作内嵌的Servlet Container。

参考资料：https://grizzly.dev.java.net/

准备工作
首先，下载grizzly和jersey。其中，grizzly的下载地址为：http://download.java.net/maven/2/com/sun/grizzly/grizzly-servlet-webserver/1.9.18a/grizzly-servlet-webserver-1.9.18a.jar，jersey的下载地址为：http://download.java.net/maven/2/com/sun/jersey/jersey-archive/1.1.2-ea/jersey-archive-1.1.2-ea.zip

在Eclipse中建一个Java工程，名为jsr331，然后把下载的jersey-archive-1.1.2-ea.zip解压，将
jersey-archive-1.1.2-ea/contribs、jersey-archive-1.1.2-ea/lib两个目录下的jar包，连
同下载的grizzly-http-webserver-1.9.18a.jar都拷贝到jsr331工程下的lib目录，并加入到该工程的Build
Path。（实测中，发现还需要引入一个包，下载地址：http://repository.jboss.org/maven2/org/jvnet
/mimepull/1.2/mimepull-1.2.jar）

编写最简单的服务
JSR331把准备提供Web Service的类称为Resource class。Resource class是一个普通类（POJO），但是按照规范要求增加了特定的注解（annotation）。我们首先实现最简单的hello world服务。

在jinxfei.test.jsr311.service下，建立HelloService类，内容如下：

  1. package jinxfei.test.jsr311.service;  
  2.   
  3. import javax.ws.rs.GET;  
  4. import javax.ws.rs.Path;  
  5. import javax.ws.rs.Produces;  
  6.   
  7. @Path("/hello")  
  8. public class HelloService {  
  9.     @GET   
  10.     @Produces("text/plain")  
  11.     public String helloWorld(){  
  12.         return "Hello world!";  
  13.     }     
  14. }  

代码中的注解（annotation）决定了程序发布成Web Service后的行为和特性。其中，HelloService类前面的@PATH，表明该Service的URL路径，这种类名前面带@PATH注解的类被称为Root Resource Class，因为他们决定了访问Service时URI中的第一级路径；@GET表示访问该服务使用HTTP GET方法；@Produces规定该服务返回结果的类型，这里的”text/plain”表名返回纯文本。

发布服务
实现服务类后，我们要启动一个内嵌的grizzly servlet
container，并把HelloService发布到该Container中，这样就能通过HTTP协议访问该服务。Jersey提供了两种发布方
式，标准的做法需要在web.xml中做配置，所以比较适用于部署在独立的Web Container下的应用，本文不做深入介绍，可参见：http://docs.sun.com/app/docs/doc/820-4867/6nga7f5o4?l=en&a=view。本例与grizzly整合，所以使用grizzly的工具类，通过代码进行部署配置。

在jinxfei.test.jsr311包下创建ServiceDeployer类，内容如下：

  1. package jinxfei.test.jsr311;  
  2.   
  3. import java.io.IOException;  
  4. import java.net.URI;  
  5. import java.util.HashMap;  
  6. import java.util.Map;  
  7. import javax.ws.rs.core.UriBuilder;  
  8. import com.sun.grizzly.http.SelectorThread;  
  9. import com.sun.jersey.api.container.grizzly.GrizzlyWebContainerFactory;  
  10.   
  11. public class ServiceDeployer {  
  12.       
  13.     public static void main(String[] args) throws IOException {  
  14.         URI ServerURI=UriBuilder.fromUri("http://localhost/").port(9876).build();  
  15.         startServer(ServerURI);  
  16.         System.out.println("服务已启动，请访问："+ServerURI);  
  17.     }      
  18.       
  19.     protected static SelectorThread startServer(URI serverURI) throws IOException {  
  20.         final Map<String, String> initParams = new HashMap<String, String>();  
  21.         initParams.put("com.sun.jersey.config.property.packages","jinxfei.test.jsr311.service");  
  22.         System.out.println("Grizzly 启动中...");  
  23.         SelectorThread threadSelector = GrizzlyWebContainerFactory.create(serverURI, initParams);       
  24.         return threadSelector;  
  25.     }      
  26. }  

代
码很简单，其中：initParams.put("com.sun.jersey.config.property.packages" ,
"jinxfei.test.jsr311.service");
这一行的第二个参数表明服务实现类所在的包名，系统会自动搜索做了注解的类并将其发布成服务。

在Eclipse中运行该类，控制台上打印“服务已启动”字样，表示系统启动成功，打开浏览器，输入：http://localhost:9876/hello，即可看到效果，如下图所示：

webservice restful一个小例子

让功能再强一点点
接下来，我们要让服务能够接受参数，并根据参数打印不同的信息，最简单的就是回显（Echo）。为了实现这一功能，我们给HelloService类增加一个方法：

  1. @POST @Path("echo")
  2. @Consumes("application/x-www-form-urlencoded")
  3. public String echo(@FormParam("msg") String message){
  4. return "Are you saying:"+message;
  5. }

@POST表明该方法要用HTTP Post来访问，@Path表明访问该方法的相对路径是echo，@Consumes表明该方法处理HTTP Post请求中何种类型的数据。该方法参数中的注解@FormParam("msg")说明后面的“String message”参数取自表单提交数据中的msg。

由于该方法需要Post访问，且需要通过表单提交数据，所以我们创建一个test.htm，在其中写一个简单的Form：

  1. <form action="http://localhost:9876/hello/echo" method="post">
  2. <input type="text" name="msg">
  3. <input type="submit" value="submit">
  4. </form>

重启ServiceDeployer，然后在浏览器中打开test.htm，表单中输入任意信息：
webservice restful一个小例子

然后点提交按钮，可以看到如下信息：
webservice restful一个小例子

这说明HelloService已经提取了表单参数，并回显给用户。

相关文章