49.2. 构建客户端目标


概述

创建初始 客户端 实例后,下一步是构建请求 URI。WebTarget 构建器类允许您配置 URI 的所有方面,包括 URI 路径和查询参数。

WebTarget builder 类

javax.ws.rs.client.WebTarget 构建器类提供 fluent API 的一部分,可让您为请求构建 REST URI。

创建客户端目标

要创建 WebTarget 实例,请在 javax.ws.rs.client.Client 实例上调用其中一个 目标 方法。例如:

// Java
import javax.ws.rs.client.WebTarget;
...
WebTarget base = client.target("http://example.org/bookstore/");

基本路径和路径片段

您可以使用 目标 方法指定所有 go 的完整路径;或者,您可以指定一个基本路径,然后使用 目标 方法和路径方法的组合添加 路径 片段。将基本路径与路径段结合使用的好处是,您可以轻松地重复使用基本路径 WebTarget 对象来对稍有不同的目标进行多次调用。例如:

// Java
import javax.ws.rs.client.WebTarget;
...
WebTarget base = client.target("http://example.org/bookstore/");
WebTarget headers     = base.path("bookheaders");
// Now make some invocations on the 'headers' target...
...
WebTarget collections = base.path("collections");
// Now make some invocations on the 'collections' target...
...

URI 模板参数

目标路径的语法也支持 URI 模板参数。也就是说,路径片段可以使用模板参数 {param} 来初始化,后者随后被解析为一个指定值。例如:

// Java
import javax.ws.rs.client.WebTarget;
import javax.ws.rs.core.Response;
...
WebTarget base = client.target("http://example.org/bookstore/");
WebTarget books = base.path("books").path("{id}");
...
Response resp = books.resolveTemplate("id", "123").request("application/xml").get();

其中 resolveTemplate 方法将路径段 {id} 替换为值 123

定义查询参数

查询参数可以附加到 URI 路径,其中查询参数的开头由单个 ? 字符标记。这个机制可让您使用语法设置一系列名称/值对: ?name1=value1&name2=value2&…​

WebTarget 实例允许您使用 queryParam 方法定义查询参数,如下所示:

// Java
WebTarget target = client.target("http://example.org/bookstore/")
                         .queryParam("userId","Agamemnon")
                         .queryParam("lang","gr");

定义列表参数

matrix 参数与查询参数稍相似,但不是广泛支持,并使用不同的语法。要在 WebTarget 实例上定义 matrix 参数,请调用 matrixParam (String, Object) 方法。

Red Hat logoGithubRedditYoutubeTwitter

学习

尝试、购买和销售

社区

关于红帽文档

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

让开源更具包容性

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

關於紅帽

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

© 2024 Red Hat, Inc.