URI 链接

在 Reactive 堆栈中查看 equivalentspring-doc.cn

本节描述了 Spring Framework 中可用于 URI 的各种选项。spring-doc.cn

UriComponents

Spring MVC 和 Spring WebFluxspring-doc.cn

UriComponentsBuilder有助于使用变量从 URI 模板构建 URI，如下例所示：spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

UriComponents uriComponents = UriComponentsBuilder
		.fromUriString("https://example.com/hotels/{hotel}") (1)
		.queryParam("q", "{q}") (2)
		.encode() (3)
		.build(); (4)

URI uri = uriComponents.expand("Westin", "123").toUri(); (5)

1	具有 URI 模板的静态工厂方法。
2	添加或替换 URI 组件。
3	请求对 URI 模板和 URI 变量进行编码。
4	构建一个 .`UriComponents`
5	展开变量并获取 .`URI`

val uriComponents = UriComponentsBuilder
		.fromUriString("https://example.com/hotels/{hotel}") (1)
		.queryParam("q", "{q}") (2)
		.encode() (3)
		.build() (4)

val uri = uriComponents.expand("Westin", "123").toUri() (5)

1	具有 URI 模板的静态工厂方法。
2	添加或替换 URI 组件。
3	请求对 URI 模板和 URI 变量进行编码。
4	构建一个 .`UriComponents`
5	展开变量并获取 .`URI`

前面的示例可以合并为一个链，并用，如下例所示：buildAndExpandspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

URI uri = UriComponentsBuilder
		.fromUriString("https://example.com/hotels/{hotel}")
		.queryParam("q", "{q}")
		.encode()
		.buildAndExpand("Westin", "123")
		.toUri();

val uri = UriComponentsBuilder
		.fromUriString("https://example.com/hotels/{hotel}")
		.queryParam("q", "{q}")
		.encode()
		.buildAndExpand("Westin", "123")
		.toUri()

您可以通过直接转到 URI（这意味着编码）来进一步缩短它，如下例所示：spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

URI uri = UriComponentsBuilder
		.fromUriString("https://example.com/hotels/{hotel}")
		.queryParam("q", "{q}")
		.build("Westin", "123");

val uri = UriComponentsBuilder
		.fromUriString("https://example.com/hotels/{hotel}")
		.queryParam("q", "{q}")
		.build("Westin", "123")

您可以使用完整的 URI 模板进一步缩短它，如下例所示：spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

URI uri = UriComponentsBuilder
		.fromUriString("https://example.com/hotels/{hotel}?q={q}")
		.build("Westin", "123");

val uri = UriComponentsBuilder
		.fromUriString("https://example.com/hotels/{hotel}?q={q}")
		.build("Westin", "123")

Uri生成器

Spring MVC 和 Spring WebFluxspring-doc.cn

UriComponentsBuilder 实现 .您可以依次使用 .一起提供一种可插入的机制，以基于共享配置，例如基本 URL、编码首选项和其他详细信息。UriBuilderUriBuilderUriBuilderFactoryUriBuilderFactoryUriBuilderspring-doc.cn

您可以配置和来自定义 URI 的准备。是默认值实现 that uses internal，公开共享配置选项。RestTemplateWebClientUriBuilderFactoryDefaultUriBuilderFactoryUriBuilderFactoryUriComponentsBuilderspring-doc.cn

以下示例显示如何配置：RestTemplatespring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

// import org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode;

String baseUrl = "https://example.org";
DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory(baseUrl);
factory.setEncodingMode(EncodingMode.TEMPLATE_AND_VALUES);

RestTemplate restTemplate = new RestTemplate();
restTemplate.setUriTemplateHandler(factory);

// import org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode

val baseUrl = "https://example.org"
val factory = DefaultUriBuilderFactory(baseUrl)
factory.encodingMode = EncodingMode.TEMPLATE_AND_VALUES

val restTemplate = RestTemplate()
restTemplate.uriTemplateHandler = factory

以下示例配置了一个：WebClientspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

// import org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode;

String baseUrl = "https://example.org";
DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory(baseUrl);
factory.setEncodingMode(EncodingMode.TEMPLATE_AND_VALUES);

WebClient client = WebClient.builder().uriBuilderFactory(factory).build();

// import org.springframework.web.util.DefaultUriBuilderFactory.EncodingMode

val baseUrl = "https://example.org"
val factory = DefaultUriBuilderFactory(baseUrl)
factory.encodingMode = EncodingMode.TEMPLATE_AND_VALUES

val client = WebClient.builder().uriBuilderFactory(factory).build()

此外，您也可以直接使用。它类似于 using ，但它不是静态工厂方法，而是一个实际的实例，其中包含 configuration 和 preferences，如下例所示：DefaultUriBuilderFactoryUriComponentsBuilderspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

String baseUrl = "https://example.com";
DefaultUriBuilderFactory uriBuilderFactory = new DefaultUriBuilderFactory(baseUrl);

URI uri = uriBuilderFactory.uriString("/hotels/{hotel}")
		.queryParam("q", "{q}")
		.build("Westin", "123");

val baseUrl = "https://example.com"
val uriBuilderFactory = DefaultUriBuilderFactory(baseUrl)

val uri = uriBuilderFactory.uriString("/hotels/{hotel}")
		.queryParam("q", "{q}")
		.build("Westin", "123")

URI 解析

Spring MVC 和 Spring WebFluxspring-doc.cn

UriComponentsBuilder支持两种 URI 解析器类型：spring-doc.cn

RFC 解析器 — 此解析器类型要求 URI 字符串符合 RFC 3986 语法，并将偏离语法的行为视为非法。spring-doc.cn
WhatWG 解析器 — 此解析器基于 WhatWG URL Living 标准中的 URL 解析算法。它提供宽松的处理各种意外输入的情况。浏览器实现此 API 是为了处理宽容地用户键入的 URL。有关更多详细信息，请参阅 URL Living Standard 和 URL 解析测试用例。spring-doc.cn

默认情况下，，，并使用 RFC 解析器类型，期望应用程序提供符合 RFC 语法的 URL 模板。更改，您可以在任何客户端上自定义。RestClientWebClientRestTemplateUriBuilderFactoryspring-doc.cn

应用程序和框架可以进一步依赖它们自己的需求解析用户提供的 URL，以便检查和可能验证的 URI 组件例如 scheme、host、port、path 和 query。此类组件可以决定使用 WhatWG 解析器类型，以便更宽松地处理 URL，并与浏览器解析 URI，以防重定向到输入 URL 或它包含在响应浏览器。UriComponentsBuilderspring-doc.cn

URI 编码

Spring MVC 和 Spring WebFluxspring-doc.cn

UriComponentsBuilder在两个级别公开编码选项：spring-doc.cn

UriComponentsBuilder#encode（）中：首先对 URI 模板进行预编码，然后在展开时对 URI 变量进行严格编码。spring-doc.cn
UriComponents#encode（）中：在 URI 变量展开后对 URI 组件进行编码。spring-doc.cn

这两个选项都用转义的八位字节替换非 ASCII 字符和非法字符。但是，第一个选项还会替换 URI 变量中出现的具有保留含义的字符。spring-doc.cn

请考虑 “;”，它在 path 中是合法的，但具有保留的含义。第一个选项将 “;” 在 URI 变量中带有 “%3B”，但在 URI 模板中没有。相比之下，第二个选项永远不会替换 “;”，因为它是路径中的合法字符。

在大多数情况下，第一个选项可能会给出预期的结果，因为它将 URI 变量作为不透明数据进行完全编码，而第二个选项在 URI 变量确实有意包含保留字符。第二个选项也很有用当根本不扩展 URI 变量时，因为这也将编码任何顺便说一句，看起来像一个 URI 变量。spring-doc.cn

以下示例使用第一个选项：spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

URI uri = UriComponentsBuilder.fromPath("/hotel list/{city}")
		.queryParam("q", "{q}")
		.encode()
		.buildAndExpand("New York", "foo+bar")
		.toUri();

// Result is "/hotel%20list/New%20York?q=foo%2Bbar"

val uri = UriComponentsBuilder.fromPath("/hotel list/{city}")
		.queryParam("q", "{q}")
		.encode()
		.buildAndExpand("New York", "foo+bar")
		.toUri()

// Result is "/hotel%20list/New%20York?q=foo%2Bbar"

您可以通过直接转到 URI（这意味着编码）来缩短前面的示例，如下例所示：spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

URI uri = UriComponentsBuilder.fromPath("/hotel list/{city}")
		.queryParam("q", "{q}")
		.build("New York", "foo+bar");

val uri = UriComponentsBuilder.fromPath("/hotel list/{city}")
		.queryParam("q", "{q}")
		.build("New York", "foo+bar")

您可以使用完整的 URI 模板进一步缩短它，如下例所示：spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

URI uri = UriComponentsBuilder.fromUriString("/hotel list/{city}?q={q}")
		.build("New York", "foo+bar");

val uri = UriComponentsBuilder.fromUriString("/hotel list/{city}?q={q}")
		.build("New York", "foo+bar")

和扩展和编码 URI 模板在内部通过策略。两者都可以使用自定义策略如下例所示：WebClientRestTemplateUriBuilderFactoryspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

String baseUrl = "https://example.com";
DefaultUriBuilderFactory factory = new DefaultUriBuilderFactory(baseUrl)
factory.setEncodingMode(EncodingMode.TEMPLATE_AND_VALUES);

// Customize the RestTemplate..
RestTemplate restTemplate = new RestTemplate();
restTemplate.setUriTemplateHandler(factory);

// Customize the WebClient..
WebClient client = WebClient.builder().uriBuilderFactory(factory).build();

val baseUrl = "https://example.com"
val factory = DefaultUriBuilderFactory(baseUrl).apply {
	encodingMode = EncodingMode.TEMPLATE_AND_VALUES
}

// Customize the RestTemplate..
val restTemplate = RestTemplate().apply {
	uriTemplateHandler = factory
}

// Customize the WebClient..
val client = WebClient.builder().uriBuilderFactory(factory).build()

该实现在内部使用展开并编码 URI 模板。作为工厂，它提供了一个配置位置编码方法，基于以下编码模式之一：DefaultUriBuilderFactoryUriComponentsBuilderspring-doc.cn

TEMPLATE_AND_VALUES：使用，对应于前面列表中的第一个选项，用于预编码 URI 模板并在扩大。UriComponentsBuilder#encode()spring-doc.cn
VALUES_ONLY：不对 URI 模板进行编码，而是应用严格编码到 URI 变量中，然后再将它们扩展到模板。UriUtils#encodeUriVariablesspring-doc.cn
URI_COMPONENT：使用对应于前面列表中的第二个选项的，以在 URI 变量展开后对 URI 组件值进行编码。UriComponents#encode()spring-doc.cn
NONE：不应用编码。spring-doc.cn

设置为 historical 原因和向后兼容性。依赖于默认值 in ，该 URL 已从 in 更改 5.0.x 复制到 5.1 中。RestTemplateEncodingMode.URI_COMPONENTWebClientDefaultUriBuilderFactoryEncodingMode.URI_COMPONENTEncodingMode.TEMPLATE_AND_VALUESspring-doc.cn

相对 Servlet 请求

您可以使用它来创建相对于当前请求的 URI。如下例所示：ServletUriComponentsBuilderspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

HttpServletRequest request = ...

// Re-uses scheme, host, port, path, and query string...

URI uri = ServletUriComponentsBuilder.fromRequest(request)
		.replaceQueryParam("accountId", "{id}")
		.build("123");

val request: HttpServletRequest = ...

// Re-uses scheme, host, port, path, and query string...

val uri = ServletUriComponentsBuilder.fromRequest(request)
		.replaceQueryParam("accountId", "{id}")
		.build("123")

您可以创建相对于上下文路径的 URI，如下例所示：spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

HttpServletRequest request = ...

// Re-uses scheme, host, port, and context path...

URI uri = ServletUriComponentsBuilder.fromContextPath(request)
		.path("/accounts")
		.build()
		.toUri();

val request: HttpServletRequest = ...

// Re-uses scheme, host, port, and context path...

val uri = ServletUriComponentsBuilder.fromContextPath(request)
		.path("/accounts")
		.build()
		.toUri()

您可以创建相对于 Servlet 的 URI（例如、如下例所示：/main/*spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

HttpServletRequest request = ...

// Re-uses scheme, host, port, context path, and Servlet mapping prefix...

URI uri = ServletUriComponentsBuilder.fromServletMapping(request)
		.path("/accounts")
		.build()
		.toUri();

val request: HttpServletRequest = ...

// Re-uses scheme, host, port, context path, and Servlet mapping prefix...

val uri = ServletUriComponentsBuilder.fromServletMapping(request)
		.path("/accounts")
		.build()
		.toUri()

从 5.1 开始，忽略和标头中的信息，这些标头指定客户端发起的地址。考虑使用 ForwardedHeaderFilter 来提取和使用或丢弃这样的标头。ServletUriComponentsBuilderForwardedX-Forwarded-*

控制器链接

Spring MVC 提供了一种机制来准备指向控制器方法的链接。例如以下 MVC 控制器允许创建链接：spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

@Controller
@RequestMapping("/hotels/{hotel}")
public class BookingController {

	@GetMapping("/bookings/{booking}")
	public ModelAndView getBooking(@PathVariable Long booking) {
		// ...
	}
}

@Controller
@RequestMapping("/hotels/{hotel}")
class BookingController {

	@GetMapping("/bookings/{booking}")
	fun getBooking(@PathVariable booking: Long): ModelAndView {
		// ...
	}
}

您可以通过按名称引用方法来准备链接，如下例所示：spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

UriComponents uriComponents = MvcUriComponentsBuilder
	.fromMethodName(BookingController.class, "getBooking", 21).buildAndExpand(42);

URI uri = uriComponents.encode().toUri();

val uriComponents = MvcUriComponentsBuilder
	.fromMethodName(BookingController::class.java, "getBooking", 21).buildAndExpand(42)

val uri = uriComponents.encode().toUri()

在前面的示例中，我们提供了实际的方法参数值（在本例中为 long 值：）用作路径变量并插入到 URL 中。此外，我们还提供 value ，，填充任何剩余的 URI 变量，例如继承的变量从类型级请求映射。如果该方法有更多的参数，我们可以为 URL 不需要参数。通常，只有 and 参数与构造 URL 相关。2142hotel@PathVariable@RequestParamspring-doc.cn

还有其他使用 .例如，您可以使用一种技术类似于通过代理进行模拟测试，以避免通过名称引用控制器方法，如下例所示（该示例假定 static import 的）：MvcUriComponentsBuilderMvcUriComponentsBuilder.onspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

UriComponents uriComponents = MvcUriComponentsBuilder
	.fromMethodCall(on(BookingController.class).getBooking(21)).buildAndExpand(42);

URI uri = uriComponents.encode().toUri();

val uriComponents = MvcUriComponentsBuilder
	.fromMethodCall(on(BookingController::class.java).getBooking(21)).buildAndExpand(42)

val uri = uriComponents.encode().toUri()

控制器方法签名在设计上受到限制，而它们应该可用于使用创建链接。除了需要适当的参数签名之外，返回类型存在技术限制（即生成运行时代理），因此返回类型不能为 .特别视图名称的通用返回类型在此处不起作用。你应该使用甚至 plain （带有返回值）。fromMethodCallfinalStringModelAndViewObjectString

前面的示例在中使用了中的静态方法。在内部，他们依赖于 on 从方案、host、port、当前请求的 context path 和 servlet path 的 servlet 路径。这在大多数情况下效果很好。但是，有时，它可能不够。例如，您可能位于请求（例如准备链接的批处理），或者可能需要插入路径前缀（例如已从请求路径中删除的区域设置前缀，需要重新插入到链接中）。MvcUriComponentsBuilderServletUriComponentsBuilderspring-doc.cn

对于此类情况，您可以使用接受 a 的 static 重载方法来使用基 URL。或者，您也可以使用基 URL 创建实例，然后使用基于实例的方法。例如，以下列表用途：fromXxxUriComponentsBuilderMvcUriComponentsBuilderwithXxxwithMethodCallspring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

UriComponentsBuilder base = ServletUriComponentsBuilder.fromCurrentContextPath().path("/en");
MvcUriComponentsBuilder builder = MvcUriComponentsBuilder.relativeTo(base);
builder.withMethodCall(on(BookingController.class).getBooking(21)).buildAndExpand(42);

URI uri = uriComponents.encode().toUri();

val base = ServletUriComponentsBuilder.fromCurrentContextPath().path("/en")
val builder = MvcUriComponentsBuilder.relativeTo(base)
builder.withMethodCall(on(BookingController::class.java).getBooking(21)).buildAndExpand(42)

val uri = uriComponents.encode().toUri()

从 5.1 开始，忽略和标头中的信息，这些标头指定客户端发起的地址。考虑使用 ForwardedHeaderFilter 来提取和使用或丢弃这样的标头。MvcUriComponentsBuilderForwardedX-Forwarded-*

视图中的链接

在 Thymeleaf、FreeMarker 或 JSP 等视图中，您可以构建指向带注释的控制器的链接通过引用每个请求映射的隐式或显式分配的名称。spring-doc.cn

请考虑以下示例：spring-doc.cn

Javaspring-doc.cn
Kotlinspring-doc.cn

@RequestMapping("/people/{id}/addresses")
public class PersonAddressController {

	@RequestMapping("/{country}")
	public HttpEntity<PersonAddress> getAddress(@PathVariable String country) { ... }
}

@RequestMapping("/people/{id}/addresses")
class PersonAddressController {

	@RequestMapping("/{country}")
	fun getAddress(@PathVariable country: String): HttpEntity<PersonAddress> { ... }
}

给定前面的控制器，您可以从 JSP 准备一个链接，如下所示：spring-doc.cn

<%@ taglib uri="http://www.springframework.org/tags" prefix="s" %>
...
<a href="${s:mvcUrl('PAC#getAddress').arg(0,'US').buildAndExpand('123')}">Get Address</a>

前面的示例依赖于 Spring 标记库中声明的函数（即 META-INF/spring.tld），但定义自己的函数或准备其他模板技术类似。mvcUrlspring-doc.cn

这是它的工作原理。启动时，每个 each 都分配了一个默认名称通过其默认实现使用类和方法名称的大写字母（例如，method in 变为 “TC#getThing”）。如果存在名称冲突，则可以使用分配显式名称或实现自己的 .@RequestMappingHandlerMethodMappingNamingStrategygetThingThingController@RequestMapping(name="..")HandlerMethodMappingNamingStrategyspring-doc.cn