クラス ServletRequestPathUtils

java.lang.ObjectSE
org.springframework.web.util.ServletRequestPathUtils
public abstract class ServletRequestPathUtils extends ObjectSE
リクエストマッピングの目的でルックアップパスの準備とアクセスを支援するユーティリティクラス。これは、parsed patterns の使用が有効になっている場合のパスの解析済み RequestPath 表現、またはそれ以外の場合は PathMatcher で使用するための文字列パスの場合があります。
導入:
5.3
作成者:
Rossen Stoyanchev, Stephane Nicoll

  • フィールドの詳細

    • PATH_ATTRIBUTE

      public static final StringSE PATH_ATTRIBUTE
      解析された RequestPath を保持するサーブレットリクエスト属性の名前。

  • コンストラクターの詳細

    • ServletRequestPathUtils

      public ServletRequestPathUtils()

  • メソッドの詳細

    • parse

      public static RequestPath parse(jakarta.servlet.http.HttpServletRequest request)
      requestURI を RequestPath に解析します。

      返される RequestPath には、公開される pathWithinApplication から省略された contextPath と servletPath プレフィックスの両方が含まれます。

      導入:
      6.2.12

    • parseAndCache

      public static RequestPath parseAndCache(jakarta.servlet.http.HttpServletRequest request)
      parse(HttpServletRequest) のバリアントで、解析されたパスをリクエスト属性 PATH_ATTRIBUTE にも保存します。

    • getParsedRequestPath

      public static RequestPath getParsedRequestPath(jakarta.servlet.ServletRequest request)
      解析およびキャッシュされた RequestPath の previously を返します。
      例外:
      IllegalArgumentExceptionSE - 見つからない場合

    • setParsedRequestPath

      public static void setParsedRequestPath(@Nullable RequestPath requestPath, jakarta.servlet.ServletRequest request)
      キャッシュされ、解析された RequestPath を指定された値に設定します。
      パラメーター:
      requestPath - 設定する値、または null の場合はキャッシュ値がクリアされます。
      request - 現在のリクエスト
      導入:
      5.3.3

    • hasParsedRequestPath

      public static boolean hasParsedRequestPath(jakarta.servlet.ServletRequest request)
      解析およびキャッシュされた RequestPath の previously を確認します。

    • clearParsedRequestPath

      public static void clearParsedRequestPath(jakarta.servlet.ServletRequest request)
      解析およびキャッシュされた RequestPath を保持する previously を保持するリクエスト属性 PATH_ATTRIBUTE を削除します。

    • getCachedPath

      public static ObjectSE getCachedPath(jakarta.servlet.ServletRequest request)
      pre-resolved 文字列 lookupPath または pre-parsed RequestPath のいずれかを返します。

      Spring MVC では、少なくとも 1 つの HandlerMapping が解析済みの PathPatterns を有効にしている場合、DispatcherServlet は RequestPath を解析してキャッシュしますが、これは ServletRequestPathFilter でさらに早く実行することもできます。HandlerMapping が PathMatcher との文字列パターンマッチングを使用するその他のケースでは、文字列 lookupPath は各 HandlerMapping で個別に解決されます。

      パラメーター:
      request - 現在のリクエスト
      戻り値:
      文字列 lookupPath または RequestPath
      例外:
      IllegalArgumentExceptionSE - どちらも利用できない場合

    • getCachedPathValue

      public static StringSE getCachedPathValue(jakarta.servlet.ServletRequest request)
      リクエストマッピングのパスを文字列として返す getCachedPath(ServletRequest) のバリアント。

      キャッシュされたパスが pre-parsed RequestPath の場合、返される文字列パス値はエンコードされ、パスパラメーターが削除されます。

      キャッシュされたパスが pre-resolved 文字列 lookupPath の場合、返される文字列パス値は、解決された UrlPathHelper の構成方法によって異なります。

      パラメーター:
      request - 現在のリクエスト
      戻り値:
      文字列としての完全なリクエストマッピングパス

    • hasCachedPath

      public static boolean hasCachedPath(jakarta.servlet.ServletRequest request)
      以前の resolved 文字列 lookupPath または以前の parsed 文字列 RequestPath を確認します。
      パラメーター:
      request - 現在のリクエスト
      戻り値:
      事前に解決されたパスまたは事前に解析されたパスが使用可能かどうか

    • getServletPathPrefix

      public static @Nullable StringSE getServletPathPrefix(jakarta.servlet.http.HttpServletRequest request)
      サーブレットがパスプレフィックスによってマップされているかどうかを確認し、マップされている場合はそのパスプレフィックスを返します。
      パラメーター:
      request - 現在のリクエスト
      戻り値:
      プレフィックス、またはサーブレットがプレフィックスによってマップされていない場合は null 
      導入:
      6.2.3