程序包 cn.taketoday.web.servlet.support

类 ServletUriComponentsBuilder

java.lang.Object

cn.taketoday.web.util.UriComponentsBuilder

cn.taketoday.web.servlet.support.ServletUriComponentsBuilder

所有已实现的接口:

UriBuilder, Cloneable

public class ServletUriComponentsBuilder
extends UriComponentsBuilder

UriComponentsBuilder with additional static factory methods to create links based on the current HttpServletRequest.

Note: methods in this class do not extract "Forwarded" and "X-Forwarded-*" headers that specify the client-originated address. Please, use ForwardedHeaderFilter, or similar from the underlying server, to extract and use such headers, or to discard them.

从以下版本开始:

4.0 2022/4/7 21:30

作者:

Rossen Stoyanchev, Harry Yang

字段概要

字段

修饰符和类型	字段	说明
private String	originalPath

构造器概要

构造器

限定符	构造器	说明
protected	ServletUriComponentsBuilder()	Default constructor.
protected	ServletUriComponentsBuilder(ServletUriComponentsBuilder other)	Create a deep copy of the given ServletUriComponentsBuilder.

方法概要

修饰符和类型	方法	说明
ServletUriComponentsBuilder	cloneBuilder()	Clone this UriComponentsBuilder.
static ServletUriComponentsBuilder	fromContextPath(HttpServletRequest request)	Prepare a builder from the host, port, scheme, and context path of the given HttpServletRequest.
static ServletUriComponentsBuilder	fromCurrentContextPath()	Same as fromContextPath(HttpServletRequest) except the request is obtained through RequestContextHolder.
static ServletUriComponentsBuilder	fromCurrentRequest()	Same as fromRequest(HttpServletRequest) except the request is obtained through RequestContextHolder.
static ServletUriComponentsBuilder	fromCurrentRequestUri()	Same as fromRequestUri(HttpServletRequest) except the request is obtained through RequestContextHolder.
static ServletUriComponentsBuilder	fromCurrentServletMapping()	Same as fromServletMapping(HttpServletRequest) except the request is obtained through RequestContextHolder.
static ServletUriComponentsBuilder	fromRequest(HttpServletRequest request)	Prepare a builder by copying the scheme, host, port, path, and query string of an HttpServletRequest.
static ServletUriComponentsBuilder	fromRequestUri(HttpServletRequest request)	Prepare a builder from the host, port, scheme, and path (but not the query) of the HttpServletRequest.
static ServletUriComponentsBuilder	fromServletMapping(HttpServletRequest request)	Prepare a builder from the host, port, scheme, context path, and servlet mapping of the given HttpServletRequest.
protected static HttpServletRequest	getCurrentRequest()	Obtain current request through RequestContextHolder.
private static ServletUriComponentsBuilder	initFromRequest(HttpServletRequest request)	Initialize a builder with a scheme, host,and port (but not path and query).
private void	initPath(String path)
String	removePathExtension()	Remove any path extension from the requestURI.

从类继承的方法 cn.taketoday.web.util.UriComponentsBuilder

build, build, build, build, buildAndExpand, buildAndExpand, clone, encode, encode, fragment, fromHttpRequest, fromHttpUrl, fromOriginHeader, fromPath, fromUri, fromUriString, host, newInstance, path, pathSegment, port, port, query, queryParam, queryParam, queryParamIfPresent, queryParams, replacePath, replaceQuery, replaceQueryParam, replaceQueryParam, replaceQueryParams, scheme, schemeSpecificPart, toUriString, uri, uriComponents, uriVariables, userInfo

从类继承的方法 java.lang.Object

equals, finalize, getClass, hashCode, notify, notifyAll, toString, wait, wait, wait

字段详细资料

originalPath

@Nullable
private String originalPath

构造器详细资料

ServletUriComponentsBuilder

protected ServletUriComponentsBuilder()

Default constructor. Protected to prevent direct instantiation.

另请参阅:

• fromContextPath(HttpServletRequest)
• fromServletMapping(HttpServletRequest)
• fromRequest(HttpServletRequest)
• fromCurrentContextPath()
• fromCurrentServletMapping()
• fromCurrentRequest()

ServletUriComponentsBuilder

protected ServletUriComponentsBuilder(ServletUriComponentsBuilder other)

Create a deep copy of the given ServletUriComponentsBuilder.

参数:

other - the other builder to copy from

方法详细资料

fromContextPath

public static ServletUriComponentsBuilder fromContextPath(HttpServletRequest request)

Prepare a builder from the host, port, scheme, and context path of the given HttpServletRequest.

fromServletMapping

public static ServletUriComponentsBuilder fromServletMapping(HttpServletRequest request)

Prepare a builder from the host, port, scheme, context path, and servlet mapping of the given HttpServletRequest.

If the servlet is mapped by name, e.g. "/main/*", the path will end with "/main". If the servlet is mapped otherwise, e.g. "/" or "*.do", the result will be the same as if calling fromContextPath(HttpServletRequest).

fromRequestUri

public static ServletUriComponentsBuilder fromRequestUri(HttpServletRequest request)

Prepare a builder from the host, port, scheme, and path (but not the query) of the HttpServletRequest.

fromRequest

public static ServletUriComponentsBuilder fromRequest(HttpServletRequest request)

Prepare a builder by copying the scheme, host, port, path, and query string of an HttpServletRequest.

initFromRequest

private static ServletUriComponentsBuilder initFromRequest(HttpServletRequest request)

Initialize a builder with a scheme, host,and port (but not path and query).

fromCurrentContextPath

public static ServletUriComponentsBuilder fromCurrentContextPath()

Same as fromContextPath(HttpServletRequest) except the request is obtained through RequestContextHolder.

fromCurrentServletMapping

public static ServletUriComponentsBuilder fromCurrentServletMapping()

Same as fromServletMapping(HttpServletRequest) except the request is obtained through RequestContextHolder.

fromCurrentRequestUri

public static ServletUriComponentsBuilder fromCurrentRequestUri()

Same as fromRequestUri(HttpServletRequest) except the request is obtained through RequestContextHolder.

fromCurrentRequest

public static ServletUriComponentsBuilder fromCurrentRequest()

Same as fromRequest(HttpServletRequest) except the request is obtained through RequestContextHolder.

getCurrentRequest

protected static HttpServletRequest getCurrentRequest()

Obtain current request through RequestContextHolder.

initPath

private void initPath(String path)

removePathExtension

@Nullable
public String removePathExtension()

Remove any path extension from the requestURI. This method must be invoked before any calls to UriComponentsBuilder.path(String) or UriComponentsBuilder.pathSegment(String...).

 GET http://www.foo.example/rest/books/6.json

 ServletUriComponentsBuilder builder = ServletUriComponentsBuilder.fromRequestUri(this.request);
 String ext = builder.removePathExtension();
 String uri = builder.path("/pages/1.{ext}").buildAndExpand(ext).toUriString();
 assertEquals("http://www.foo.example/rest/books/6/pages/1.json", result);
 

返回:

the removed path extension for possible re-use, or null

cloneBuilder

public ServletUriComponentsBuilder cloneBuilder()

从类复制的说明: UriComponentsBuilder

Clone this UriComponentsBuilder.

覆盖:

cloneBuilder 在类中 UriComponentsBuilder

返回:

the cloned UriComponentsBuilder object