クラス RequestMappingHandlerMapping

方法の詳細

• setPathPrefixes

  public void setPathPrefixes(MapSE<StringSE, PredicateSE<ClassSE<?>>> prefixes)

  コントローラーメソッドに適用するパスプレフィックスを構成します。

  プレフィックスは、コントローラー型がマップ内の対応する Predicate と一致するすべての @RequestMapping メソッドおよび @HttpExchange メソッドのマッピングを強化するために使用されます。入力マップの順序が予測可能であると仮定して、最初に一致する述語の接頭辞が使用されます。

  HandlerTypePredicate を使用してコントローラーをグループ化することを検討してください。

  パラメーター:

  prefixes - キーとしてパス接頭辞を持つマップ

  導入:

  5.1

• getPathPrefixes

  public MapSE<StringSE, PredicateSE<ClassSE<?>>> getPathPrefixes()

  構成されたパスは、読み取り専用の、おそらく空のマップとしてプレフィックスします。

  導入:

  5.1

• setContentNegotiationManager

  public void setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)

  リクエストされたメディア型を判別するために使用する ContentNegotiationManager を設定します。設定されていない場合、デフォルトのコンストラクターが使用されます。

• getContentNegotiationManager

  public ContentNegotiationManager getContentNegotiationManager()

  設定された ContentNegotiationManager を返します。

• setEmbeddedValueResolver

  public void setEmbeddedValueResolver(StringValueResolver resolver)

  インターフェースからコピーされた説明: EmbeddedValueResolverAware

  StringValueResolver を設定して、埋め込まれた定義値の解決に使用します。

  次で指定:

  インターフェース EmbeddedValueResolverAware 内の setEmbeddedValueResolver 

• afterPropertiesSet

  public void afterPropertiesSet()

  クラスからコピーされた説明: AbstractHandlerMethodMapping

  初期化時にハンドラーメソッドを検出します。

  次で指定:

  インターフェース InitializingBean 内の afterPropertiesSet 

  オーバーライド:

  クラス AbstractHandlerMethodMapping<RequestMappingInfo> の afterPropertiesSet 

  関連事項:

  • AbstractHandlerMethodMapping.initHandlerMethods()

• getBuilderConfiguration

  public RequestMappingInfo.BuilderConfiguration getBuilderConfiguration()

  この HandlerMapping の内部構成を反映し、RequestMappingInfo.Builder.options(RequestMappingInfo.BuilderConfiguration) の設定に使用できる RequestMappingInfo.BuilderConfiguration を取得します。

  これは、registerHandlerMethod(Object, Method, RequestMappingInfo) を介したリクエストマッピングのプログラムによる登録に役立ちます。

  戻り値:

  内部状態を反映するビルダー構成

  導入:

  5.3.14

• isHandler

  protected boolean isHandler(ClassSE<?> beanType)

  指定された型がハンドラーメソッドを持つハンドラーかどうか。

  ハンドラーが型レベルの @Controller アノテーションを持つことを期待します。

  次で指定:

  クラス AbstractHandlerMethodMapping<RequestMappingInfo> の isHandler 

  パラメーター:

  beanType - チェックされている Bean の型

  戻り値:

  これがハンドラー型の場合は "true"、そうでない場合は "false"。

• getMappingForMethod

  protected @Nullable RequestMappingInfo getMappingForMethod(MethodSE method, ClassSE<?> handlerType)

  型レベルおよびメソッドレベルの @RequestMapping および @HttpExchange アノテーションを使用して RequestMappingInfo を作成します。

  CGLIB プロキシクラスの場合、メソッドの可視性に基づいて追加の検証が実行されます。

  • プライベートメソッドはオーバーライドできないため、ハンドラーメソッドとして使用することはできません。
  • 異なるパッケージのパッケージプライベートメソッドにはアクセスできないため、パブリックまたは protected メソッドに変更する必要があります。

  次で指定:

  クラス AbstractHandlerMethodMapping<RequestMappingInfo> の getMappingForMethod 

  パラメーター:

  method - マッピングを提供する方法

  handlerType - ハンドラー型、場合によってはメソッドの宣言クラスのサブ型

  戻り値:

  作成された RequestMappingInfo、またはメソッドに @RequestMapping または @HttpExchange アノテーションがない場合は null 

  関連事項:

  • getCustomMethodCondition(Method)
  • getCustomTypeCondition(Class)

• getCustomTypeCondition

  protected @Nullable RequestCondition<?> getCustomTypeCondition(ClassSE<?> handlerType)

  カスタム型レベルのリクエスト条件を指定します。カスタム RequestCondition は、カスタムリクエスト条件を組み合わせて比較できるように、このメソッドへのすべての呼び出しから同じ条件型が返される限り、どの型でもかまいません。

  カスタム条件型用に AbstractRequestCondition を継承し、CompositeRequestCondition を使用して複数のカスタム条件を提供することを検討してください。

  パラメーター:

  handlerType - 条件を作成するハンドラー型

  戻り値:

  条件、または null

• getCustomMethodCondition

  protected @Nullable RequestCondition<?> getCustomMethodCondition(MethodSE method)

  カスタムのメソッドレベルのリクエスト条件を指定します。カスタム RequestCondition は、カスタムリクエスト条件を組み合わせて比較できるように、このメソッドへのすべての呼び出しから同じ条件型が返される限り、どの型でもかまいません。

  カスタム条件型用に AbstractRequestCondition を継承し、CompositeRequestCondition を使用して複数のカスタム条件を提供することを検討してください。

  パラメーター:

  method - 条件を作成するハンドラーメソッド

  戻り値:

  条件、または null

• createRequestMappingInfo

  protected RequestMappingInfo createRequestMappingInfo(RequestMapping requestMapping, @Nullable RequestCondition<?> customCondition)

  提供された @RequestMapping アノテーション、メタアノテーション、またはアノテーション階層内でアノテーション属性をマージした合成結果から RequestMappingInfo を作成します。

• createRequestMappingInfo

  protected RequestMappingInfo createRequestMappingInfo(HttpExchange httpExchange, @Nullable RequestCondition<?> customCondition)

  提供された @HttpExchange アノテーション、メタアノテーション、またはアノテーション階層内でアノテーション属性をマージした合成結果から RequestMappingInfo を作成します。

  導入:

  6.1

• resolveEmbeddedValuesInPatterns

  protected StringSE[] resolveEmbeddedValuesInPatterns(StringSE[] patterns)

  指定されたパターンの配列のプレースホルダー値を解決します。

  戻り値:

  更新されたパターンを持つ新しい配列

• registerMapping

  public void registerMapping(RequestMappingInfo mapping, ObjectSE handler, MethodSE method)

  クラスからコピーされた説明: AbstractHandlerMethodMapping

  指定されたマッピングを登録します。

  このメソッドは、初期化が完了した後、実行時に呼び出すことができます。

  オーバーライド:

  クラス AbstractHandlerMethodMapping<RequestMappingInfo> の registerMapping 

  パラメーター:

  mapping - ハンドラーメソッドのマッピング

  handler - ハンドラー

  method - メソッド

• registerHandlerMethod

  protected void registerHandlerMethod(ObjectSE handler, MethodSE method, RequestMappingInfo mapping)

  ハンドラーメソッドとその一意のマッピングを登録します。検出された各ハンドラーメソッドに対して起動時に呼び出されます。

  注意 : RequestMappingInfo を作成するには、getBuilderConfiguration() を使用し、この HandlerMapping の構成方法と一致するように RequestMappingInfo.Builder.options(RequestMappingInfo.BuilderConfiguration) のオプションを設定してください。これは、たとえば、PathPattern または PathMatcher ベースのマッチングを確実に使用するために重要です。

  オーバーライド:

  クラス AbstractHandlerMethodMapping<RequestMappingInfo> の registerHandlerMethod 

  パラメーター:

  handler - ハンドラーまたはハンドラーインスタンスの Bean 名

  method - 登録する方法

  mapping - ハンドラーメソッドに関連付けられたマッピング条件

• match

  @DeprecatedSE(since="7.0", forRemoval=true) public @Nullable RequestMatchResult match(jakarta.servlet.http.HttpServletRequest request, StringSE pattern)

  非推奨、削除予定: この API 要素は、将来のバージョンで削除される可能性があります。

  インターフェースからコピーされた説明: MatchableHandlerMapping

  リクエストが指定されたパターンに一致するかどうかを判別します。MatchableHandlerMapping.getPatternParser() が null を返す場合、このメソッドを使用します。これは、HandlerMapping が文字列パターンマッチングを使用していることを意味します。

  次で指定:

  インターフェース MatchableHandlerMapping 内の match 

  パラメーター:

  request - 現在のリクエスト

  pattern - マッチングするパターン

  戻り値:

  リクエストマッチングの結果、または存在しない場合は null 

• initCorsConfiguration

  protected @Nullable CorsConfiguration initCorsConfiguration(ObjectSE handler, MethodSE method, RequestMappingInfo mappingInfo)

  クラスからコピーされた説明: AbstractHandlerMethodMapping

  マッピングの CORS 設定を抽出して返します。

  オーバーライド:

  クラス AbstractHandlerMethodMapping<RequestMappingInfo> の initCorsConfiguration