Java EE 6 Web Services:JAX-RS 1.1 提供了基于注解的 REST 支持

  • Srini Penchikala
  • 张龙

2010 年 2 月 14 日

话题:Java语言 & 开发

JavaEE 6 规范提供了 Java API for RESTful Web Services(JAX-RS)支持,提供了基于 POJO 的框架以构建轻量级的 Web Services,该框架符合 REST(Representational State Transfer)风格的软件架构。JAX-RS 1.1 隶属于JSR 311,其所提供的几个注解可用于将 Java 类的方法公开为 Web 资源。

JAX-RS 会自动进行 Java 类与 MIME 媒体类型之间的转换。比如说,如果通过注解“@Produces(MediaType.TEXT_PLAIN)”标记某个类方法,JAX-RS 则会将该 Java 类型转换为“text/plain”MIME 类型,这代表了普通文本,同时通过 HTTP 响应将该类型的内容发送给客户端。

Java EE 6 包含了 JAX-RS 的最新版,即 JAX-RS 1.1,该版本充分利用了 Java EE 6 的新特性,而Jersey则是 JAX-RS 规范开源的参考实现,Jersey 1.1.5 实现了 JAX-RS 1.1。

注解增加了一些额外的说明信息,可以标识资源并辅助处理 HTTP 请求。JAX-RS 所支持的一些注解列举如下:

Path:该注解为资源指定了一个相对路径。@Path所标识的 URI 路径用于资源类或是类方法处理请求所用。

GET@GET所注解的方法用于处理 HTTP GET 请求。当客户端向代表某个 Web 资源的 URI 直接发送 HTTP GET 请求时,JAX-RS 运行时会调用被 @GET 所注解的方法来处理该 GET 请求。

POST@POST所注解的方法用于处理 HTTP POST 请求。

Produces:该注解用于标识 MIME 媒体类型,这样资源中的方法就会生成该类型的内容并返回给客户端。

Consumes@Consumes注解用于标识 MIME 媒体类型,这表示了资源中的方法可以接受客户端所请求的类型。与 @Produces 注解一样,如果在类上指定了 @Consumes 注解,该注解就会应用到类中的所有方法;如果在某个方法上指定了 @Consumes 注解,那么它会覆盖类上所指定的 @Consumes 注解。

JAX-RS 还提供了其他一些方便的特性,比如基于参数的注解可以获得请求中的信息,@QueryParam, 就是这样一种注解,它可以从请求 URL 的查询字符串中获得查询参数。其他基于参数的注解还有@MatrixParam,它可以从 URL 路径的 segment 部分获取信息;@HeaderParam可以从 HTTP 头中获得信息,而@CookieParam则可以从 cookie 相关的 HTTP 头中获得 cookie 信息。

还有不少辅助类和接口简化了 Java 中 RESTful Web Services 的构建和使用,列举如下:

  • MediaType类可用于获取 MIME 媒体类型。该类的实例是不可变的。
  • UriInfo是个接口,可以获取应用和请求的 URI 信息。
  • UriBuilder能够获取 URI 模板信息,它可以从 URI 的各个组成部分来构建 URI。
  • Response是个抽象类,代表了 HTTP 响应。在应用向运行时提供元数据时,它定义了返回实例与运行时之间的契约。应用中的类可以直接继承 Response 类,也可以使用其静态方法来通过 ResponseBuilder 创建实例。
  • Response.ResponseBuilder用于构建 Response 对象,使用了 Builder 模式。

来自 JBoss 的RESTEasy框架也实现了 JAX-RS 规范。Apache 开源的服务框架CXF也在2.3 版中提供了对 JAX-RS 1.1 的支持。

查看英文原文:Java EE 6 Web Services: JAX-RS 1.1 Provides Annotation Based REST Support

Java语言 & 开发