第 46 章 创建资源


摘要

在 RESTful Web 服务中,所有请求都由资源来处理。JAX-RS API 将资源实施为 Java 类。资源类是一个 Java 类,它标上一个或多个 JAX-RS 注释。使用 JAX-RS 实施的 RESTful Web 服务核心是根资源类。根资源类是指向服务公开的资源树的入口点。它可以处理所有请求,也可以提供对处理请求的子资源的访问权限。

46.1. 简介

概述

使用 JAX-RS API 实施的 RESTful Web 服务以 Java 类实施的资源形式提供响应。资源类 是一种类,使用 JAX-RS 注释来实施资源。对于大多数 RESTful Web 服务,需要访问一组资源。资源类的注释提供资源 URI 以及每个操作处理的 HTTP 动词等信息。

资源类型

JAX-RS API 允许您创建两种基本资源类型:

  • 第 46.3 节 “根资源类” 是服务的资源树的入口点。它通过 @Path 注释来解码,以定义服务中资源的 base URI。
  • 第 46.5 节 “使用子资源” 可通过 root 资源访问。它们通过利用 @Path 注释进行解码的方法来实施。子资源的 @Path 注释定义了相对于根资源的基本 URI 的 URI。

示例

例 46.1 “简单资源类” 显示简单的资源类。

例 46.1. 简单资源类

package demo.jaxrs.server;

import javax.ws.rs.GET;
import javax.ws.rs.Path;
import javax.ws.rs.PathParam;

@Path("/customerservice")
public class CustomerService
{
  public CustomerService()
  {
  }

  @GET
  public Customer getCustomer(@QueryParam("id") String id)
  {
    ...
  }

  ...
}

两项组成一个资源类 例 46.1 “简单资源类” 中定义的类:

@Path 注释指定资源的 base URI。

@GET 注释指定方法为资源实施 HTTP GET 方法。

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

通过我们的产品和服务,以及可以信赖的内容,帮助红帽用户创新并实现他们的目标。

让开源更具包容性

红帽致力于替换我们的代码、文档和 Web 属性中存在问题的语言。欲了解更多详情,请参阅红帽博客.

關於紅帽

我们提供强化的解决方案,使企业能够更轻松地跨平台和环境(从核心数据中心到网络边缘)工作。

© 2024 Red Hat, Inc.