クラス MappedInterceptor

java.lang.ObjectSE
org.springframework.web.servlet.handler.MappedInterceptor
実装されているすべてのインターフェース:
HandlerInterceptor
public final class MappedInterceptor extends ObjectSE implements HandlerInterceptor
HandlerInterceptor をラップし、URL パターンを使用して、指定されたリクエストに適用されるかどうかを判断します。

パターンマッチングは、PathMatcher または解析された PathPattern を使用して実行できます。構文はほぼ同じですが、後者の方が Web での使用に適しており、より効率的です。選択は、解決されたString lookupPath または解析されたRequestPath の存在によって決まります。これは、現在のリクエストに一致した HandlerMapping に依存します。

MappedInterceptor は、型 MappedInterceptor の Bean を検出し、それに直接登録されているインターセプターがこの型であるかどうかをチェックする AbstractHandlerMethodMapping のサブクラスによってサポートされます。

導入:
3.0
作成者:
Keith Donald, Rossen Stoyanchev, Brian Clozel

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

  • メソッドの詳細

    • getIncludePathPatterns

      public StringSE @Nullable [] getIncludePathPatterns()
      このインターセプタがマッピングされているインクルードパスパターンを取得します。
      導入:
      6.1
      関連事項:

    • getExcludePathPatterns

      public StringSE @Nullable [] getExcludePathPatterns()
      このインターセプタがマッピングされている除外パスパターンを取得します。
      導入:
      6.1
      関連事項:

    • getInterceptor

      public HandlerInterceptor getInterceptor()
      一致した場合に呼び出すターゲット HandlerInterceptor。

    • setPathMatcher

      @DeprecatedSE(since="7.0", forRemoval=true) public void setPathMatcher(PathMatcher pathMatcher)
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      PathMatcher および UrlPathHelper の使用は、Web モジュールでの実行時の使用では非推奨となり、代わりに PathPatternParser による解析パターンが推奨されます。
      URL パスを包含および除外パターンと照合するために使用するように PathMatcher を構成します。

      これは、カスタマイズされた AntPathMatcher またはカスタム PathMatcher が必要な場合にのみ使用する必要がある高度なプロパティです。

      デフォルトでは、これは AntPathMatcher です。

      注 : PathMatcher を設定すると、解析されたRequestPath が使用可能な場合でも、文字列パターンマッチングの使用が強制されます。

    • getPathMatcher

      @DeprecatedSE(since="7.0", forRemoval=true) public PathMatcher getPathMatcher()
      非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。
      PathMatcher および UrlPathHelper の使用は、Web モジュールでの実行時の使用では非推奨となり、代わりに PathPatternParser による解析パターンが推奨されます。
      構成された PathMatcher を取得します。

    • matches

      public boolean matches(jakarta.servlet.http.HttpServletRequest request)
      このインターセプターがリクエストにマップされているかどうかを確認します。

      リクエストマッピングパスは、外部で解決されている必要があります。クラスレベルの Javadoc も参照してください。

      パラメーター:
      request - 一致するリクエスト
      戻り値:
      インターセプターをリクエストに適用する必要がある場合は true 

    • preHandle

      public boolean preHandle(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, ObjectSE handler) throws ExceptionSE
      インターフェースからコピーされた説明: HandlerInterceptor
      ハンドラーの実行前のインターセプトポイント。HandlerMapping が適切なハンドラーオブジェクトを決定した後、HandlerAdapter がハンドラーを呼び出す前に呼び出されます。

      DispatcherServlet は、任意の数のインターセプターで構成される実行チェーンでハンドラーを処理し、ハンドラー自体を最後に処理します。このメソッドを使用すると、各インターセプターはチェーンの実行を中止することを決定でき、通常は HTTP エラーを送信するか、カスタムレスポンスを作成します。

      注意 : 非同期リクエスト処理には特別な考慮事項が適用されます。詳細については、AsyncHandlerInterceptor を参照してください。

      デフォルトの実装は true を返します。

      次で指定:
      インターフェース HandlerInterceptor の preHandle 
      パラメーター:
      request - 現在の HTTP リクエスト
      response - 現在の HTTP レスポンス
      handler - 型および / またはインスタンス評価のために、実行するために選択されたハンドラー
      戻り値:
      実行チェーンが次のインターセプターまたはハンドラー自体を続行する必要がある場合は、true。そうでない場合、DispatcherServlet は、このインターセプターがすでにレスポンス自体を処理していると想定します。
      例外:
      ExceptionSE - エラーの場合

    • postHandle

      public void postHandle(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, ObjectSE handler, @Nullable ModelAndView modelAndView) throws ExceptionSE
      インターフェースからコピーされた説明: HandlerInterceptor
      ハンドラーの実行が成功した後のインターセプトポイント。HandlerAdapter が実際にハンドラーを呼び出した後、DispatcherServlet がビューをレンダリングする前に呼び出されます。指定された ModelAndView を介して、追加のモデルオブジェクトをビューに公開できます。

      DispatcherServlet は、任意の数のインターセプターで構成される実行チェーンのハンドラーを処理します。ハンドラー自体は最後にあります。このメソッドを使用すると、各インターセプターは実行を後処理でき、実行チェーンの逆順で適用されます。

      注意 : 非同期リクエスト処理には特別な考慮事項が適用されます。詳細については、AsyncHandlerInterceptor を参照してください。

      デフォルトの実装は空です。

      次で指定:
      インターフェース HandlerInterceptor の postHandle 
      パラメーター:
      request - 現在の HTTP リクエスト
      response - 現在の HTTP レスポンス
      handler - 型やインスタンスの検査のために、非同期実行を開始したハンドラー（または HandlerMethod）
      modelAndView - ハンドラーが返した ModelAndView (null にすることもできます)
      例外:
      ExceptionSE - エラーの場合

    • afterCompletion

      public void afterCompletion(jakarta.servlet.http.HttpServletRequest request, jakarta.servlet.http.HttpServletResponse response, ObjectSE handler, @Nullable ExceptionSE ex) throws ExceptionSE
      インターフェースからコピーされた説明: HandlerInterceptor
      リクエスト処理の完了後、つまりビューのレンダリング後のコールバック。ハンドラー実行の結果で呼び出されるため、適切なリソースのクリーンアップが可能になります。

      メモ: このインターセプターの preHandle メソッドが正常に完了し、true を返した場合にのみ呼び出されます！

      postHandle メソッドと同様に、このメソッドはチェーンの各インターセプターで逆の順序で呼び出されるため、最初のインターセプターが最後に呼び出されます。

      注意 : 非同期リクエスト処理には特別な考慮事項が適用されます。詳細については、AsyncHandlerInterceptor を参照してください。

      デフォルトの実装は空です。

      次で指定:
      インターフェース HandlerInterceptor の afterCompletion 
      パラメーター:
      request - 現在の HTTP リクエスト
      response - 現在の HTTP レスポンス
      handler - 型やインスタンスの検査のために、非同期実行を開始したハンドラー（または HandlerMethod）
      ex - ハンドラーの実行時にスローされる例外（ある場合）。これには、例外リゾルバーを介して処理された例外は含まれません
      例外:
      ExceptionSE - エラーの場合