49.2. 构建客户端目标
概述
在创建初始 客户端
实例后,下一步是构建请求 URI。WebTarget
构建器类可让您配置 URI 的所有方面,包括 URI 路径和查询参数。
WebTarget 构建器类
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/");
基本路径和路径片段
您可以使用 目标
方法指定整个路径;或者,您可以指定基本路径,然后使用 target
方法和路径方法的组合添加 路径
片段。将基本路径与路径段相结合的优点是,您可以轻松地重新使用基本路径 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");
定义列表参数
列表参数类似于查询参数,但并不像广泛支持,使用不同的语法。要在 WebTarget
实例上定义列表参数,请调用 list Param (String, Object)
方法。