类 ServletUriComponentsBuilder

构造器详细资料

• 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.

  Note: This method extracts values from "Forwarded" and "X-Forwarded-*" headers if found. See class-level docs.

  As of 4.3.15, this method replaces the contextPath with the value of "X-Forwarded-Prefix" rather than prepending, thus aligning with ForwardedHeaderFilter.

• 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).

  Note: This method extracts values from "Forwarded" and "X-Forwarded-*" headers if found. See class-level docs.

  As of 4.3.15, this method replaces the contextPath with the value of "X-Forwarded-Prefix" rather than prepending, thus aligning with ForwardedHeaderFilter.

• fromRequestUri

  public static ServletUriComponentsBuilder fromRequestUri​(HttpServletRequest request)

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

  Note: This method extracts values from "Forwarded" and "X-Forwarded-*" headers if found. See class-level docs.

  As of 4.3.15, this method replaces the contextPath with the value of "X-Forwarded-Prefix" rather than prepending, thus aligning with ForwardedHeaderFilter.

• fromRequest

  public static ServletUriComponentsBuilder fromRequest​(HttpServletRequest request)

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

  Note: This method extracts values from "Forwarded" and "X-Forwarded-*" headers if found. See class-level docs.

  As of 4.3.15, this method replaces the contextPath with the value of "X-Forwarded-Prefix" rather than prepending, thus aligning with ForwardedHeaderFilter.

• fromCurrentContextPath

  public static ServletUriComponentsBuilder fromCurrentContextPath()

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

  Note: This method extracts values from "Forwarded" and "X-Forwarded-*" headers if found. See class-level docs.

  As of 4.3.15, this method replaces the contextPath with the value of "X-Forwarded-Prefix" rather than prepending, thus aligning with ForwardedHeaderFilter.

• fromCurrentServletMapping

  public static ServletUriComponentsBuilder fromCurrentServletMapping()

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

  Note: This method extracts values from "Forwarded" and "X-Forwarded-*" headers if found. See class-level docs.

  As of 4.3.15, this method replaces the contextPath with the value of "X-Forwarded-Prefix" rather than prepending, thus aligning with ForwardedHeaderFilter.

• fromCurrentRequestUri

  public static ServletUriComponentsBuilder fromCurrentRequestUri()

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

  Note: This method extracts values from "Forwarded" and "X-Forwarded-*" headers if found. See class-level docs.

  As of 4.3.15, this method replaces the contextPath with the value of "X-Forwarded-Prefix" rather than prepending, thus aligning with ForwardedHeaderFilter.

• fromCurrentRequest

  public static ServletUriComponentsBuilder fromCurrentRequest()

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

  Note: This method extracts values from "Forwarded" and "X-Forwarded-*" headers if found. See class-level docs.

  As of 4.3.15, this method replaces the contextPath with the value of "X-Forwarded-Prefix" rather than prepending, thus aligning with ForwardedHeaderFilter.

• getCurrentRequest

  protected static HttpServletRequest getCurrentRequest()

  Obtain current request through RequestContextHolder.

• removePathExtension

  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.com/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.com/rest/books/6/pages/1.json", result);
   

  返回:

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

  从以下版本开始:

  4.0

• cloneBuilder

  public ServletUriComponentsBuilder cloneBuilder()

  从类复制的说明: UriComponentsBuilder
  Clone this UriComponentsBuilder.

  覆盖:

  cloneBuilder 在类中 UriComponentsBuilder

  返回:

  the cloned UriComponentsBuilder object