jersey实现web service接口+客户端调用

jersey实现web service接口+客户端调用

jersey百度百科：

         Jersey是一个RESTFUL请求服务JAVA框架，与常规的JAVA编程使用的struts框架类似，它主要用于处理业务逻辑层。与Struts类似，它同样可以和hibernate,spring框架整合。

由于Struts2+hibernate+spring整合在市场的占有率太高，所以很少一部分人去关注Jersey。所以网上有关于Jersey的介绍很少。但是它确实是一个非常不错的框架。对于请求式服务，对于GET,DELETE请求，你甚至只需要给出一个URI即可完成操作。

         举个简单的例子：如果你想获得服务器数据库中的所有数据；那么你可以在浏览器或者利用Ajax的GET方法，将路径设置好；例如：localhost:8080/Student(项目名称)/studentinfo(项目服务总体前缀)/student(处理student对象的签注)/getStudentInfo(最后前缀)。这样就可以获取所有学生信息。你可以选择GET获取的数据的返回类型：JSON,XML,TEXT_HTML(String)..获取之后，你可以通过JS将这些数据塞到html或者jsp页面上。

Jersey开发web service框架：

一、参考资源：

         1.http://www.importnew.com/7336.html

         2.http://jersey.dev.java.net/

         3.http://www.tuicool.com/articles/67vyIbv

         4.http://redhacker.iteye.com/blog/1923226

         5.http://blog.csdn.net/zztfj/article/details/7608991

二、框架下载：

         Jersey官网：https://jersey.java.net/

Jersey官网下载地址：

http://repo1.maven.org/maven2/org/glassfish/jersey/bundles/jaxrs-ri/2.16/jaxrs-ri-2.16.zip

         Jersey官网API下载：（下载来的是jar，解压查看）

         http://download.oracle.com/otn-pub/jcp/jaxrs-2_0_rev_A-mrel-spec/javax.ws.rs-api-javadoc.jar?AuthParam=1426144064_2ad2e7a67fbe37ee3bb9a7e73832128b

         云盘下载：参考文档最后提供的路径

三、webservice开发实例

         使用jersey开发前先了解下Rest，关于REST介绍这里有参考博客：

         http://redhacker.iteye.com/blog/1923226

         然后，知道了一些概念上的定义，就可以具体使用jersey，自己做了jerseyDemo来简单说名jersey的使用。另外，jersey1.X的版本是sun公司提供的独立的jar包，在2.X版本中，已经将jersey融合到JavaSE中，在javax.ws.rs.*包中，在后面的web配置中有些区别。

 

以下开发环境及工具：

                   1.window764为Pc机

                   2.Tomcat7.0 window  64位版本

             3.Eclipse 3.7 window 64位版本

                   4.火狐浏览器36.0.1版本

                   5.jaxrs-ri-2.16版本

 

1.下载jaxrs-ri-2.16压缩包解压，新建一个web项目，将下载解压的jaxrs里的全部jar包导入项目中

2.在src中创建要发布的实体类，例如：

package com.jersey.service;
import javax.ws.rs.Consumes;
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;
@Path("HelloWorld")
public class HelloWorld {
	@GET
	//这里如果是Post请求，在浏览器中直接使用路径检测接口就会报405错误：不允许访问该方法，因为浏览器路径访问是属于Get请求
	@Path("/sayHello/{name}")
	@Consumes({MediaType.APPLICATION_XML, MediaType.APPLICATION_JSON})
	@Produces(MediaType.APPLICATION_JSON)
	public String sayHello(@PathParam("name")String name){
		return "Hello "+name;
	}
}

其中：

@Path，标注资源类或者方法的相对路径 　　

@GET，@PUT，@POST，@DELETE，标注方法是HTTP请求的类型。 　　

@Produces，标注返回的MIME媒体类型 　　

@Consumes，标注可接受请求的MIME媒体类型

@PathParam，@QueryParam，@HeaderParam，@CookieParam，@MatrixParam，@FormParam,分别标注方法的参数来自于HTTP请求的不同位置，例如@PathParam来自于URL的路径，@QueryParam来自于URL的查询参数，@HeaderParam来自于HTTP请求的头信息，@CookieParam来自于HTTP请求的Cookie。

网上资源对jersey常用注解解释：

Annotation	作用	说明
@GET	查询请求	相当于数据库的查询数据操作
@POST	插入请求	相当于数据库的插入数据操作
@PUT	更新请求	相当于数据库的更新数据操作
@DELETE	删除请求	相当于数据的删除数据操作
@Path	uri路径	定义资源的访问路径，client通过这个路径访问资源。比如：@Path("user")
@Produces	指定返回MIME格式	资源按照那种数据格式返回，可取的值有：MediaType.APPLICATION_XXX。比如： @Produces(MediaType.APPLICATION_XML)
@Consumes	接受指定的MIME格式	只有符合这个参数设置的请求再能访问到这个资源。比如 @Consumes("application/x-www-form-urlencoded")
@PathParam	uri路径参数	写在方法的参数中，获得请求路径参数。比如 ：@PathParam("username")  String userName
@QueryParam	uri路径请求参数	写在方法的参数中，获得请求路径附带的参数。比如： @QueryParam("desc")  String desc
@DefaultValue	设置@QueryParam参数的默认值	如果@QueryParam没有接收到值，就使用默认值。比如：@DefaultValue("description") @QueryParam("desc") String desc
@FormParam	form传递的参数	接受form传递过来的参数。比如： @FormParam("name")  String userName
@BeanParam	通过Bena的形式传递参数	接受client传递的bean类型的参数，同时这个bean可以在属性上配置@FormParam用以解决client的属性名称和bean的属性名称不一致的问题。比如： @BeanParam  User user
@Context	获得一些系统环境信息	通过@Context可以获得以下信息：UriInfo、ServletConfig、ServletContext、HttpServletRequest、HttpServletResponse和HttpHeaders等
@XmlRootElement	将bean转换为xml	如果要讲bean以xml或json的格式返回，必须要这个注解。比如： @XmlRootElement public class User｛...｝
@XmlElements
@XmlElement

3.编写资源加载器，将各种资源加载进来，暴露给client。

         有两种加载资源的方式，一种是使用自己的资源加载器去加载资源，需要给出自己资源加载器的位置。另一种是使用默认的资源加载器加载，需要给出资源所在的package。个人主张第一种，写一个自己的资源加载器去加载想要加载的资源，这样感觉可控性强一点，可以加载业务资源以外，还可以加载日子和其他的需要一些工具资源等等。或者package下的某个资源不想被暴露，就不要加载进来就可以了。

资源加载器类：

package com.jersey.service;
import org.glassfish.jersey.server.ResourceConfig;
public class MyServiceRegister extends ResourceConfig {
	public MyServiceRegister() {
        //需要加载的资源放进来
		register(HelloWorld.class);
	}
}

4.在web.xml中添加配置，引入jersey，同时配置资源加载器

<servlet>
    <servlet-name>jersey-servlet</servlet-name>
    <servlet-class>
		org.glassfish.jersey.servlet.ServletContainer
	</servlet-class>
	<!-- 配置自己的资源加载类去加载资源 -->
	<init-param>
		<param-name>javax.ws.rs.Application</param-name>
		<param-value>com.jersey.service.MyServiceRegister</param-value>
	</init-param>
    <load-on-startup>1</load-on-startup>
  </servlet>
  <servlet-mapping>
    <servlet-name>jersey-servlet</servlet-name>
    <url-pattern>/rest/*</url-pattern>
  </servlet-mapping>

注意：jersey 1.x版本的jersey主拦截器是：com.sun.jersey.spi.container.servlet.ServletContainer

         jersey 2.x版本主拦截器是：org.glassfish.jersey.servlet.ServletContainer

根据你jersey引入框架的不同来配置<servlet-class></servlet-class>

5.运行项目，在浏览器中输入访问地址：

http://localhost:8080/MyJersey/rest/HelloWorld/sayHello/admin

你也可以访问：http://localhost:8080/MyJersey/rest/application.wadl  得到wadl的接口说明文档。

注意：这里浏览器路径访问的到的前提是该接口中配置为Get请求

最后项目的分布：

四、客户端调用webservice接口

         1.新建一个项目，导入jaxrs里的全部jar包(可将上个Project里的的jar全部导入，避免漏包)

         2.然后在src下新建一个客户端测试类，调用web service接口

package com.jersey.client;

import javax.ws.rs.client.Client;
import javax.ws.rs.client.ClientBuilder;
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.client.Invocation.Builder;
import javax.ws.rs.core.MediaType;

public class TestClient {

	public static void main(String[] args) {
		String url = "http://192.168.1.134:8080/MyJersey/rest";
		Client client = ClientBuilder.newClient();
		WebTarget webTarget = client.target(url).path("HelloWorld").path("sayHello/admin");
		Builder builder = webTarget.request(MediaType.APPLICATION_JSON);
		String result = builder.get(String.class);
		System.out.println(result);
	}
}

这里builder.get()里面的参数根据接口方法响应数据类型决定。同时注意的是，这里的调用是jersey 2.x的调用语句，在jersey 1.x中调用原理没变，但是一些类名有所改变，下面附上网上查到的jersey 1.x的调用客户端的代码：(没有测试过)

package com.jersey.client;

import com.sun.jersey .api.client.Client;
import com.sun.jersey .api.client.WebResource;
public class TestClient {

	public static void main(String[] args) {
		String url = "http://192.168.1.134:8080/MyJersey/rest";
		Client client = Client.create();
		WebResource webResource = c.resource(url);
		String result = webResource.get(String.class);
		System.out.println(result);
	}
}

3.运行该方法，控制台打印：Helloadmin

最后项目分布：

全部完成，最后献上途中使用的到的Jersey框架及项目实例的资源下载路径：

http://pan.baidu.com/s/1c0s8a44