跳转到主内容
趣航编程网 - 趣学编程,启航技术之路!

深入了解JAVA Jersey框架

Java Jersey的详情概述Jersey是一个RESTFUL请求服务JAVA框架,与常规的JAVA编程使用的struts框架类似,它主要用于处理业务逻辑层。

与springmvc 的区别:1. jersey同样提供DI,是由glassfish hk2实现,也就是说,如果想单独使用jersey一套,需要另外学习Bean容器;

2. MVC出发点即是WEB,但jersey出发点确实RESTFull,体现点在与接口的设计方面,

如MVC返回复杂结构需要使用ModelAndView,而jersey仅仅需要返回一个流或者文件句柄;

3. jersey提供一种子资源的概念,这也是RESTFull中提倡所有url都是资源;

4. jersey直接提供application.wadl资源url说明;

5. MVC提供Session等状态管理,jersey没有,这个源自RESTFull设计无状态化;

6. Response方法支持更好返回结果,方便的返回Status,包括200,303,401,403;

7. 提供超级特别方便的方式访问RESTFull;

jersey

1.X的版本是sun公司提供的独立的jar包,在2.X版本中,已经将jersey融合到JavaSE中,在javax.ws.rs.*包中。

与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是JAX-RS(JSR311)开源参考实现用于构建 RESTful Web service,它包含三个部分:核心服务器(Core Server) :通过提供JSR 311中标准化的注释和API标准化,可以用直观的方式开发RESTful Web服务。

核心客户端(Core Client) :Jersey客户端API能够帮助开发者与RESTful服务轻松通信;

集成(Integration) :Jersey还提供可以轻松继承Spring、Guice、Apache Abdera的库。

在本次开发中使用Jersey2.0,并且仅使用了核心服务器。

设置Jersey环境Mavenorg.glassfish.jersey.containersjersey-container-servlet-core2.0

javax.xml.wsjaxws-api2.1

org.codehaus.jacksonjackson-core-asl1.9.12org.codehaus.jacksonjackson-mapper-asl1.9.12org.codehaus.jacksonjackson-jaxrs1.9.12引入Jar文件方式

从Jersey开发包中将以下库复制的WEB-INF下的库目录:1  服务器:jersey-server.jar 、jersey-container-servlet-core.jar、jersey-container-servlet.jar、javax.ws.rs-api-2.0.jar 2  客户端:jersey-client.jar 3  common:jersey-common.jar 4  json支持:在Jersey2.0中需要使用 Jackson1.9 才能支持json。

Hello World以下将展示一个Hello World第一步: 编写一个名为HelloResource的资源,它接受Http Get请求并响应“Hello Jersey”

@Path("/hello") public class HelloResource {@GET@Produces(MediaType.TEXT_PLAIN) public String sayHello() {return "Hello Jersey";}}第二步: 编写JAX-RS applicationpublic class APIApplication extends ResourceConfig {public APIApplication() {//加载Resource register(HelloResource.class);

//注册数据转换器register(JacksonJsonProvider.class);

// Logging.

register(LoggingFilter.class);}}第三步: 在web.xml文件中定义servelt调度程序,目的是将所有REST请求发送到Jersey容器。除了声明Jersey Servlet外,还需定义一个初始化参数,指定JAX-RS application。

JerseyServletorg.glassfish.jersey.servlet.ServletContainerjavax.ws.rs.Applicationcn.com.mink.resource.APIApplication

1JerseyServlet/services/*在命令终端中输入以下命令,将会看到“Hello Jersey”。

curl http://host:port/services/hello或者在浏览器中输入以下URL,将会看到“Hello Jersey”

http://host:port/services/hello使用资源Root Resource And Sub-Resource资源是组成RESTful服务的关键部分,可以使用HTTP方法(如:GET、POST、PUT和DELETE)操作资源。在JAX-RX中,资源通过POJO实现,使用 @Path 注释组成其标识符。资源可以有子资源,父资源是资源集合,子资源是成员资源。

在以下样例代码中,Resources是"/services" URI组成是集合资源,UserResource是“/services/user” URI组成的成员资源;@Path("/services") public class Resources {

@Path("/user") public UserResource getUserResource() {...

}

@Path("/book") public BookResource getBookResource() {...

}}UserResource是“/user” URI组成的集合资源,getUser是“/user/{username}” URI组成的资源方法@Path("/user") public class UserResource {@GET@Path("{username"})@Produces("application/json") public User getUser(@PathParam("username") String userName) {...

}}HTTP Methods HTTP方法映射到资源的CRUD(创建、读取、更新和删除)操作,基本模式如下:HTTP GET :读取/列出/检索单个或资源集合。

HTTP POST :新建资源。

HTTP PUT :更新现有资源或资源集合。

HTTP DELETE :删除资源或资源集合。

@Produces@Produces 注释用来指定将要返回给client端的数据标识类型(MIME)。@Produces 可以作为class注释,也可以作为方法注释,方法的 @Produces 注释将会覆盖class的注释。

1  指定一个MIME类型@Produces("application/json") 2  指定多个MIME类型@Produces({"application/json","application/xml"})@Consumes@Consumes 与 @Produces 相反,用来指定可以接受client发送过来的MIME类型,同样可以用于class或者method,也可以指定多个MIME类型,一般用于 @PUT ,@POST 。

参数(Parameter Annotations)

Parameter Annotations用于获取client发送的数据。本文只介绍常用的注解,更多详见 Jersey用户手册@PathParam使用 @PathParam 可以获取URI中指定规则的参数,比如:@GET@Path("{username"})@Produces(MediaType.APPLICATION_JSON) public User getUser(@PathParam("username") String userName) {...

}当浏览器请求 http://localhost/user/jack 时,userName值为jack。

@QueryParam@QueryParam 用于获取GET请求中的查询参数,如:@GET@Path("/user")@Produces("text/plain") public User getUser(@QueryParam("name") String name,@QueryParam("age") int age) {...

}当浏览器请求 http://host:port/user?name=rose&age=25 时,name值为rose,age值为25。如果需要为参数设置默认值,可以使用 @DefaultValue ,如:@GET@Path("/user")@Produces("text/plain") public User getUser(@QueryParam("name") String name,@DefaultValue("26") @QueryParam("age") int age) {...

}当浏览器请求 http://host:port/user?name=rose 时,name值为rose,age值为26。

@FormParam@FormParam ,顾名思义,从POST请求的表单参数中获取数据。如:@POST@Consumes("application/x-www-form-urlencoded") public void post(@FormParam("name") String name) {// Store the message}@BeanParam当请求参数很多时,比如客户端提交一个修改用户的PUT请求,请求中包含很多项用户信息。这时可以用 @BeanParam 。

@POST@Consumes("application/x-www-form-urlencoded") public void update(@BeanParam User user) {// Store the user data}User Bean定义如下:@XmlRootElement(name = "user") public class User {@PathParam("userName) private String userName;

@FormParam("name") private String name;

@FormParam("telephone") private String telephone;

@FormParam("email") private String email;

public String getUserName() {return userName;}

public void setUserName(String userName) {this.userName = userName;}...

}使用Map在一个大型的server中,因为参数的多变,参数结构的调整都会因为以上几种方式而遇到问题,这时可以考虑使用 @Context 注释,并获取UriInfo实例,如下:@GET public String get(@Context UriInfo ui) {MultivaluedMap queryParams = ui.getQueryParameters();MultivaluedMap pathParams = ui.getPathParameters();}同样还可以通过 @Context 注释获取 ServletConfig 、 ServletContext 、HttpServletRequest 、 HttpServletResponse 和 HttpHeaders 等,如下:@Path("/") public class Resource {

@Context HttpServletRequest req;

@Context ServletConfig servletConfig;

@Context ServletContext servletContext;

@GET public String get(@Context HttpHeaders hh) {MultivaluedMap headerParams = hh.getRequestHeaders();Map pathParams = hh.getCookies();}}Jersey返回Json和Xml JAX-RS支持使用JAXB(Java API for XML Binding)将JavaBean绑定到XML或JSON,反之亦然。JavaBean必须使用 @XmlRootElement 标注,没有@XmlElement 注释的字段将包含一个名称与之相同的XML元素,如下:@XmlRootElement public class OptionResult {@XmlElement(name = "code") private String result;

private String errorMsg;

public String getResult() {return result;}

public void setResult(String result) {this.result = result;}

public String getErrorMsg() {return errorMsg;}

public void setErrorMsg(String errorMsg) {this.errorMsg = errorMsg;}}

然后在REST服务中使用:

@Path("/user") public class UserResource {@POST@Produces("application/json") public OptionResult create(@BeanParam User user) {...

}}最后,要注册数据转换器,该转换器会自动将JavaBean转换为json数据:public class APIApplication extends ResourceConfig {public APIApplication() {//加载Model register(OptionResult.class);

//加载与OptionResult同一个packge的Model//packages(OptionResult.class.getPackage().getName());

//加载Resource register(UserResource.class);

//注册数据转换器register(JacksonJsonProvider.class);

// Logging.

register(LoggingFilter.class);}}说明 :返回XML数据的原理相同,仅仅是数据转换器不同,只需要在APIApplication中同时注册XML数据转换器即可,详见 Jersey用户手册问题总结Ajax请求(POST、PUT和DELETE)无法将数据提交到Jersey容器问题阐述在短信平台的开发中,数据的CRUD全部使用Ajax技术完成,因此必须使用POST、PUT和DELETE请求。此三种请求的content-type均为“application/x-www-form-urlencoded”,使用UTF-8编码会变成“application/x-www-form-urlencoded; UTF-8”。在使用Firefox的tamperdata扩展调试程序的过程中发现,当content-type为“application/x-www-form-urlencoded”时,Jersey容器能够通过 @FormParam 注解获取到提交的数据,而content-type为“application/x-www-form-urlencoded; UTF-8”时便获取不到。

解决方案最终我使用Java Filter和Jersey RequestFilter解决了问题。首先在Java Filter中使用UTF8将Request中的数据编码,然后在Jersey RequestFilter中将request对象中的content-type修改为“application/x-www-form-urlencoded”。如:public void doFilter(ServletRequest request, ServletResponse response, FilterChain chain) throws IOException, ServletException {HttpServletRequest req = (HttpServletRequest)request;req.setCharacterEncoding("UTF-8");}

public class RequestFilter implements ContainerRequestFilter {@Override public void filter(ContainerRequestContext context) throws IOException {String headerString = context.getHeaderString("content-type");if (headerString != null) {//如果content-type以"application/x-www-form-urlencoded"开头,则处理if (headerString.startsWith(MediaType.APPLICATION_FORM_URLENCODED)) context.getHeaders().putSingle("content-type", MediaType.APPLICATION_FORM_URLENCODED);}}}最后在web.xml中注册Java Filter(要注册在Jersey容器之前),在APIApplication中注册Jersey RequestFilter,如下:public class APIApplication extends ResourceConfig {public APIApplication() {register(RequestFilter.class);}}说明 :在修复此问题后,在Github的Jersey源代码仓库中看到已经有人发现并修复了此问题,在下个Jersey正式版本中应该不会再出现这样的问题,详见 此Discussion以上就是深入了解JAVA Jersey的详细内容,更多关于JAVA Jersey的资料请关注脚本之家其它相关文章!

您可能感兴趣的文章:Java通过jersey实现客户端图片上传示例java Jersey框架初体验基于Java中两种jersey文件上传方式使用CXF和Jersey框架来进行Java的WebService编程基于JAVA中Jersey处理Http协议中的Multipart的详解

相关文章