AbstractHandlerMethodMapping (Spring Framework API)

java.lang.ObjectSE
- org.springframework.context.support.ApplicationObjectSupport
- - org.springframework.web.context.support.WebApplicationObjectSupport
  - - org.springframework.web.servlet.handler.AbstractHandlerMapping
    - - org.springframework.web.servlet.handler.AbstractHandlerMethodMapping<T>

型パラメーター:
T - ハンドラーメソッドを受信リクエストに一致させるために必要な条件を含む HandlerMethod のマッピング。
実装されたすべてのインターフェース:
Aware, BeanNameAware, InitializingBean, ApplicationContextAware, Ordered, ServletContextAware, HandlerMapping
既知の直属サブクラス
RequestMappingInfoHandlerMapping
```
public abstract class AbstractHandlerMethodMapping<T>
extends AbstractHandlerMapping
implements InitializingBean
```
リクエストと HandlerMethod の間のマッピングを定義する HandlerMapping 実装の抽象基本クラス。
登録された各ハンドラーメソッドについて、マッピング型 <T> の詳細を定義するサブクラスで一意のマッピングが維持されます。
導入:
3.1
作成者:
Arjen Poutsma, Rossen Stoyanchev, Juergen Hoeller, Sam Brannen

フィールドサマリー
- クラス org.springframework.web.servlet.handler.AbstractHandlerMapping から継承されたフィールド
  mappingsLogger
- クラス org.springframework.context.support.ApplicationObjectSupport から継承されたフィールド
  logger
- インターフェース org.springframework.web.servlet.HandlerMapping から継承されたフィールド
  BEST_MATCHING_HANDLER_ATTRIBUTE, BEST_MATCHING_PATTERN_ATTRIBUTE, INTROSPECT_TYPE_LEVEL_MAPPING, LOOKUP_PATH, MATRIX_VARIABLES_ATTRIBUTE, PATH_WITHIN_HANDLER_MAPPING_ATTRIBUTE, PRODUCIBLE_MEDIA_TYPES_ATTRIBUTE, URI_TEMPLATE_VARIABLES_ATTRIBUTE
- インターフェース org.springframework.core.Ordered から継承されたフィールド
  HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

コンストラクターのサマリー
コンストラクター
コンストラクターと説明
AbstractHandlerMethodMapping()

コンストラクター
コンストラクターと説明
`AbstractHandlerMethodMapping()`

メソッドのサマリー

すべてのメソッドインスタンスメソッド抽象メソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` 初期化時にハンドラーメソッドを検出します。
`protected HandlerMethod`	`createHandlerMethod(ObjectSE handler, MethodSE method)` HandlerMethod インスタンスを作成します。
`protected void`	`detectHandlerMethods(ObjectSE handler)` 指定されたハンドラー Bean でハンドラーメソッドを探します。
`protected StringSE[]`	`getCandidateBeanNames()` アプリケーションコンテキストで候補 Bean の名前を決定します。
`protected CorsConfiguration`	`getCorsConfiguration(ObjectSE handler, HttpServletRequestEE request)` 指定されたハンドラーの CORS 構成を取得します。
`protected SetSE<StringSE>`	`getDirectPaths(T mapping)` パターンではないリクエストマッピングパスを返します。
`protected HandlerMethod`	`getHandlerInternal(HttpServletRequestEE request)` 指定されたリクエストのハンドラーメソッドを検索します。
`MapSE<T, HandlerMethod>`	`getHandlerMethods()` すべてのマッピングと HandlerMethod を含む（読み取り専用）マップを返します。
`ListSE<HandlerMethod>`	`getHandlerMethodsForMappingName(StringSE mappingName)` 指定されたマッピング名のハンドラーメソッドを返します。
`protected abstract ComparatorSE<T>`	`getMappingComparator(HttpServletRequestEE request)` 一致するマッピングをソートするためのコンパレーターを返します。
`protected abstract T`	`getMappingForMethod(MethodSE method, ClassSE<?> handlerType)` ハンドラーメソッドのマッピングを提供します。
`protected SetSE<StringSE>`	`getMappingPathPatterns(T mapping)` 使用すべきではありません。 5.3 以降、代わりに `getDirectPaths(Object)` を介して非パターンマッピングを提供する
`protected abstract T`	`getMatchingMapping(T mapping, HttpServletRequestEE request)` マッピングが現在のリクエストに一致するかどうかを確認し、現在のリクエストに関連する条件を含む（潜在的に新しい）マッピングを返します。
`HandlerMethodMappingNamingStrategy<T>`	`getNamingStrategy()` 構成された命名戦略または `null` を返します。
`protected void`	`handleMatch(T mapping, StringSE lookupPath, HttpServletRequestEE request)` 一致するマッピングが見つかったときに呼び出されます。
`protected HandlerMethod`	`handleNoMatch(SetSE<T> mappings, StringSE lookupPath, HttpServletRequestEE request)` 一致するマッピングが見つからないときに呼び出されます。
`protected void`	`handlerMethodsInitialized(MapSE<T, HandlerMethod> handlerMethods)` すべてのハンドラーメソッドが検出された後に呼び出されます。
`protected boolean`	`hasCorsConfigurationSource(ObjectSE handler)` このハンドラーに `CorsConfigurationSource` がある場合、`true` を返します。
`protected CorsConfiguration`	`initCorsConfiguration(ObjectSE handler, MethodSE method, T mapping)` マッピングの CORS 設定を抽出して返します。
`protected void`	`initHandlerMethods()` ApplicationContext で Bean をスキャンし、ハンドラーメソッドを検出して登録します。
`protected abstract boolean`	`isHandler(ClassSE<?> beanType)` 指定された型がハンドラーメソッドを持つハンドラーかどうか。
`protected HandlerMethod`	`lookupHandlerMethod(StringSE lookupPath, HttpServletRequestEE request)` 現在のリクエストに最適なハンドラーメソッドを検索します。
`protected void`	`processCandidateBean(StringSE beanName)` 指定された候補 Bean の型を判別し、ハンドラー型として識別された場合は `detectHandlerMethods(java.lang.Object)` を呼び出します。
`protected void`	`registerHandlerMethod(ObjectSE handler, MethodSE method, T mapping)` ハンドラーメソッドとその一意のマッピングを登録します。
`void`	`registerMapping(T mapping, ObjectSE handler, MethodSE method)` 指定されたマッピングを登録します。
`void`	`setDetectHandlerMethodsInAncestorContexts(boolean detectHandlerMethodsInAncestorContexts)` 祖先 ApplicationContexts の Bean でハンドラーメソッドを検出するかどうか。
`void`	`setHandlerMethodMappingNamingStrategy(HandlerMethodMappingNamingStrategy<T> namingStrategy)` マップされたすべてのハンドラーメソッドにデフォルト名を割り当てるために使用する命名戦略を構成します。
`void`	`setPatternParser(PathPatternParser patternParser)` `AntPathMatcher` との文字列パターンマッチングの代わりに、事前に解析された `PathPattern` の使用を有効にします。
`void`	`unregisterMapping(T mapping)` 指定されたマッピングを登録解除します。

クラス org.springframework.web.servlet.handler.AbstractHandlerMapping から継承されたメソッド
adaptInterceptor, detectMappedInterceptors, extendInterceptors, formatMappingName, getAdaptedInterceptors, getCorsConfigurationSource, getCorsHandlerExecutionChain, getCorsProcessor, getDefaultHandler, getHandler, getHandlerExecutionChain, getMappedInterceptors, getOrder, getPathMatcher, getPatternParser, getUrlPathHelper, initApplicationContext, initInterceptors, initLookupPath, setAlwaysUseFullPath, setBeanName, setCorsConfigurations, setCorsConfigurationSource, setCorsProcessor, setDefaultHandler, setInterceptors, setOrder, setPathMatcher, setRemoveSemicolonContent, setUrlDecode, setUrlPathHelper, usesPathPatterns

クラス org.springframework.web.context.support.WebApplicationObjectSupport から継承されたメソッド
getServletContext, getTempDir, getWebApplicationContext, initApplicationContext, initServletContext, isContextRequired, setServletContext

クラス org.springframework.context.support.ApplicationObjectSupport から継承されたメソッド
getApplicationContext, getMessageSourceAccessor, obtainApplicationContext, requiredContextClass, setApplicationContext

クラス java.lang.ObjectSE から継承されたメソッド
cloneSE, equalsSE, finalizeSE, getClassSE, hashCodeSE, notifySE, notifyAllSE, toStringSE, waitSE, waitSE, waitSE

- コンストラクターの詳細
  - AbstractHandlerMethodMapping
```
public AbstractHandlerMethodMapping()
```
- メソッドの詳細
  - setPatternParser
```
public void setPatternParser(PathPatternParser patternParser)
```
    クラスからコピーされた説明: AbstractHandlerMapping
    AntPathMatcher との文字列パターンマッチングの代わりに、事前に解析された PathPattern の使用を有効にします。構文はほぼ同じですが、PathPattern 構文は Web アプリケーション向けに調整されており、その実装はより効率的です。
    このプロパティは、これが設定されている場合は事実上無視される次の他のプロパティと相互に排他的です。
    - AbstractHandlerMapping.setAlwaysUseFullPath(boolean) -- PathPatterns は常にフルパスを使用し、デコードされて部分的に正規化されているため requestURIEE と比較できない servletPath/pathInfo を無視します。
    - AbstractHandlerMapping.setRemoveSemicolonContent(boolean) -- PathPatterns は、パスマッチングの目的で常にセミコロンの内容を無視しますが、パスパラメーターは @MatrixVariable を介してコントローラーで使用できます。
    - AbstractHandlerMapping.setUrlDecode(boolean) -- PathPatterns は、一度に 1 つのデコードされたパスセグメントに一致し、デコードされた予約文字が原因で課題を引き起こす可能性のある完全なデコードされたパスを必要としません。
    - AbstractHandlerMapping.setUrlPathHelper(org.springframework.web.util.UrlPathHelper) -- リクエストパスは、DispatcherServlet または ServletRequestPathUtils を使用する ServletRequestPathFilter によってグローバルに事前解析され、再利用のためにリクエスト属性に保存されます。
    - AbstractHandlerMapping.setPathMatcher(org.springframework.util.PathMatcher) -- パターンは PathPatterns に解析され、PathMatcher との文字列照合の代わりに使用されます。
    デフォルトでは、これは設定されていません。
    オーバーライド:
    クラス AbstractHandlerMapping の setPatternParser
    パラメーター:
    patternParser - 使用するパーサー
  - setDetectHandlerMethodsInAncestorContexts
```
public void setDetectHandlerMethodsInAncestorContexts(boolean detectHandlerMethodsInAncestorContexts)
```
    祖先 ApplicationContexts の Bean でハンドラーメソッドを検出するかどうか。
    デフォルトは「false」: 現在の ApplicationContext の Bean のみが考慮されます。つまり、この HandlerMapping 自体が定義されているコンテキスト（通常、現在の DispatcherServlet のコンテキスト）のみが考慮されます。
    このフラグをオンにして、祖先コンテキスト（通常は Spring ルート WebApplicationContext）のハンドラー Bean も検出します。
    関連事項:
    getCandidateBeanNames()
  - setHandlerMethodMappingNamingStrategy
```
public void setHandlerMethodMappingNamingStrategy(HandlerMethodMappingNamingStrategy<T> namingStrategy)
```
    マップされたすべてのハンドラーメソッドにデフォルト名を割り当てるために使用する命名戦略を構成します。
    デフォルトの命名戦略は、クラス名の大文字に基づいて "#" が続き、次にメソッド名が続きます。メソッド getFoo を持つ TestController というクラスの "TC#getFoo"。
  - getNamingStrategy
```
@Nullable
public HandlerMethodMappingNamingStrategy<T> getNamingStrategy()
```
    構成された命名戦略または null を返します。
  - getHandlerMethods
```
public MapSE<T,HandlerMethod> getHandlerMethods()
```
    すべてのマッピングと HandlerMethod を含む（読み取り専用）マップを返します。
  - getHandlerMethodsForMappingName
```
@Nullable
public ListSE<HandlerMethod> getHandlerMethodsForMappingName(StringSE mappingName)
```
    指定されたマッピング名のハンドラーメソッドを返します。
    パラメーター:
    mappingName - マッピング名
    戻り値:
    一致する HandlerMethod または null のリスト。返されたリストは変更されることはなく、反復しても安全です。
    関連事項:
    setHandlerMethodMappingNamingStrategy(org.springframework.web.servlet.handler.HandlerMethodMappingNamingStrategy<T>)
  - registerMapping
```
public void registerMapping(T mapping,
                            ObjectSE handler,
                            MethodSE method)
```
    指定されたマッピングを登録します。
    このメソッドは、初期化が完了した後、実行時に呼び出すことができます。
    パラメーター:
    mapping - ハンドラーメソッドのマッピング
    handler - ハンドラー
    method - メソッド
  - unregisterMapping
```
public void unregisterMapping(T mapping)
```
    指定されたマッピングを登録解除します。
    このメソッドは、初期化が完了した後、実行時に呼び出すことができます。
    パラメーター:
    mapping - 登録解除するマッピング
  - afterPropertiesSet
```
public void afterPropertiesSet()
```
    初期化時にハンドラーメソッドを検出します。
    次で指定:
    インターフェース InitializingBean の afterPropertiesSet
    関連事項:
    initHandlerMethods()
  - initHandlerMethods
```
protected void initHandlerMethods()
```
    ApplicationContext で Bean をスキャンし、ハンドラーメソッドを検出して登録します。
    関連事項:
    getCandidateBeanNames(), processCandidateBean(java.lang.String), handlerMethodsInitialized(java.util.Map<T, org.springframework.web.method.HandlerMethod>)
  - getCandidateBeanNames
```
protected StringSE[] getCandidateBeanNames()
```
    アプリケーションコンテキストで候補 Bean の名前を決定します。
    導入:
    5.1
    関連事項:
    setDetectHandlerMethodsInAncestorContexts(boolean), BeanFactoryUtils.beanNamesForTypeIncludingAncestors(org.springframework.beans.factory.ListableBeanFactory, org.springframework.core.ResolvableType)
  - processCandidateBean
```
protected void processCandidateBean(StringSE beanName)
```
    指定された候補 Bean の型を判別し、ハンドラー型として識別された場合は detectHandlerMethods(java.lang.Object) を呼び出します。
    この実装は、BeanFactory.getType(java.lang.String) をチェックし、Bean 名で detectHandlerMethods(java.lang.Object) を呼び出すことにより、Bean の作成を回避します。
    パラメーター:
    beanName - 候補者 Bean の名前
    導入:
    5.1
    関連事項:
    isHandler(java.lang.Class<?>), detectHandlerMethods(java.lang.Object)
  - detectHandlerMethods
```
protected void detectHandlerMethods(ObjectSE handler)
```
    指定されたハンドラー Bean でハンドラーメソッドを探します。
    パラメーター:
    handler - Bean 名または実際のハンドラーインスタンス
    関連事項:
    getMappingForMethod(java.lang.reflect.Method, java.lang.Class<?>)
  - registerHandlerMethod
```
protected void registerHandlerMethod(ObjectSE handler,
                                     MethodSE method,
                                     T mapping)
```
    ハンドラーメソッドとその一意のマッピングを登録します。検出された各ハンドラーメソッドに対して起動時に呼び出されます。
    パラメーター:
    handler - ハンドラーまたはハンドラーインスタンスの Bean 名
    method - 登録する方法
    mapping - ハンドラーメソッドに関連付けられたマッピング条件
    例外:
    IllegalStateExceptionSE - 別のメソッドが同じマッピングですでに登録されている場合
  - createHandlerMethod
```
protected HandlerMethod createHandlerMethod(ObjectSE handler,
                                            MethodSE method)
```
    HandlerMethod インスタンスを作成します。
    パラメーター:
    handler - Bean 名または実際のハンドラーインスタンス
    method - ターゲットメソッド
    戻り値:
    作成された HandlerMethod
  - initCorsConfiguration
```
@Nullable
protected CorsConfiguration initCorsConfiguration(ObjectSE handler,
                                                            MethodSE method,
                                                            T mapping)
```
    マッピングの CORS 設定を抽出して返します。
  - handlerMethodsInitialized
```
protected void handlerMethodsInitialized(MapSE<T,HandlerMethod> handlerMethods)
```
    すべてのハンドラーメソッドが検出された後に呼び出されます。
    パラメーター:
    handlerMethods - ハンドラーメソッドとマッピングを含む読み取り専用マップ。
  - getHandlerInternal
```
@Nullable
protected HandlerMethod getHandlerInternal(HttpServletRequestEE request)
                                              throws ExceptionSE
```
    指定されたリクエストのハンドラーメソッドを検索します。
    次で指定:
    クラス AbstractHandlerMapping の getHandlerInternal
    パラメーター:
    request - 現在の HTTP リクエスト
    戻り値:
    対応するハンドラーインスタンス。見つからない場合は null
    例外:
    ExceptionSE - 内部エラーがある場合
  - lookupHandlerMethod
```
@Nullable
protected HandlerMethod lookupHandlerMethod(StringSE lookupPath,
                                                      HttpServletRequestEE request)
                                               throws ExceptionSE
```
    現在のリクエストに最も一致するハンドラーメソッドを検索します。複数の一致が見つかった場合、最適な一致が選択されます。
    パラメーター:
    lookupPath - 現在のサーブレットマッピング内のマッピングルックアップパス
    request - 現在のリクエスト
    戻り値:
    最適なハンドラーメソッド、または一致しない場合は null
    例外:
    ExceptionSE
    関連事項:
    handleMatch(Object, String, HttpServletRequest), handleNoMatch(Set, String, HttpServletRequest)
  - handleMatch
```
protected void handleMatch(T mapping,
                           StringSE lookupPath,
                           HttpServletRequestEE request)
```
    一致するマッピングが見つかったときに呼び出されます。
    パラメーター:
    mapping - 一致するマッピング
    lookupPath - 現在のサーブレットマッピング内のマッピングルックアップパス
    request - 現在のリクエスト
  - handleNoMatch
```
@Nullable
protected HandlerMethod handleNoMatch(SetSE<T> mappings,
                                                StringSE lookupPath,
                                                HttpServletRequestEE request)
                                         throws ExceptionSE
```
    一致するマッピングが見つからないときに呼び出されます。
    パラメーター:
    mappings - 登録済みのすべてのマッピング
    lookupPath - 現在のサーブレットマッピング内のマッピングルックアップパス
    request - 現在のリクエスト
    例外:
    ServletExceptionEE - エラーの場合
    ExceptionSE
  - hasCorsConfigurationSource
```
protected boolean hasCorsConfigurationSource(ObjectSE handler)
```
    クラスからコピーされた説明: AbstractHandlerMapping
    このハンドラーに CorsConfigurationSource がある場合、true を返します。
    オーバーライド:
    クラス AbstractHandlerMapping の hasCorsConfigurationSource
  - getCorsConfiguration
```
protected CorsConfiguration getCorsConfiguration(ObjectSE handler,
                                                 HttpServletRequestEE request)
```
    クラスからコピーされた説明: AbstractHandlerMapping
    指定されたハンドラーの CORS 構成を取得します。
    オーバーライド:
    クラス AbstractHandlerMapping の getCorsConfiguration
    パラメーター:
    handler - チェックするハンドラー（非 null）。
    request - 現在のリクエスト。
    戻り値:
    ハンドラーの CORS 構成、ない場合は null
  - isHandler
```
protected abstract boolean isHandler(ClassSE<?> beanType)
```
    指定された型がハンドラーメソッドを持つハンドラーかどうか。
    パラメーター:
    beanType - チェックされている Bean の型
    戻り値:
    これがハンドラー型の場合は "true"、そうでない場合は "false"。
  - getMappingForMethod
```
@Nullable
protected abstract T getMappingForMethod(MethodSE method,
                                                   ClassSE<?> handlerType)
```
    ハンドラーメソッドのマッピングを提供します。マッピングを提供できないメソッドは、ハンドラーメソッドではありません。
    パラメーター:
    method - マッピングを提供する方法
    handlerType - ハンドラー型、場合によってはメソッドの宣言クラスのサブ型
    戻り値:
    マッピング、またはメソッドがマッピングされていない場合は null
  - getMappingPathPatterns
```
@DeprecatedSE
protected SetSE<StringSE> getMappingPathPatterns(T mapping)
```
    非推奨。5.3 の時点で、代わりに getDirectPaths(Object) を介して非パターンマッピングを提供することに賛成
    指定されたマッピングに含まれる URL パスを抽出して返します。
  - getDirectPaths
```
protected SetSE<StringSE> getDirectPaths(T mapping)
```
    パターンではないリクエストマッピングパスを返します。
    導入:
    5.3
  - getMatchingMapping
```
@Nullable
protected abstract T getMatchingMapping(T mapping,
                                                  HttpServletRequestEE request)
```
    マッピングが現在のリクエストに一致するかどうかを確認し、現在のリクエストに関連する条件を含む（潜在的に新しい）マッピングを返します。
    パラメーター:
    mapping - 一致を取得するマッピング
    request - 現在の HTTP サーブレットリクエスト
    戻り値:
    一致、またはマッピングが一致しない場合は null
  - getMappingComparator
```
protected abstract ComparatorSE<T> getMappingComparator(HttpServletRequestEE request)
```
    一致するマッピングをソートするためのコンパレータを返します。返されたコンパレータは、「より良い」一致をより高い順に並べ替えます。
    パラメーター:
    request - 現在のリクエスト
    戻り値:
    コンパレータ (非 null)

クラス AbstractHandlerMethodMapping<T>

フィールドサマリー

クラス org.springframework.web.servlet.handler.AbstractHandlerMapping から継承されたフィールド

クラス org.springframework.context.support.ApplicationObjectSupport から継承されたフィールド

インターフェース org.springframework.web.servlet.HandlerMapping から継承されたフィールド

インターフェース org.springframework.core.Ordered から継承されたフィールド

コンストラクターのサマリー

メソッドのサマリー

クラス org.springframework.web.servlet.handler.AbstractHandlerMapping から継承されたメソッド

クラス org.springframework.web.context.support.WebApplicationObjectSupport から継承されたメソッド

クラス org.springframework.context.support.ApplicationObjectSupport から継承されたメソッド

クラス java.lang.ObjectSE から継承されたメソッド

コンストラクターの詳細

AbstractHandlerMethodMapping

メソッドの詳細

setPatternParser

setDetectHandlerMethodsInAncestorContexts

setHandlerMethodMappingNamingStrategy

getNamingStrategy

getHandlerMethods

getHandlerMethodsForMappingName

registerMapping

unregisterMapping

afterPropertiesSet

initHandlerMethods

getCandidateBeanNames

processCandidateBean

detectHandlerMethods

registerHandlerMethod

createHandlerMethod

initCorsConfiguration

handlerMethodsInitialized

getHandlerInternal

lookupHandlerMethod

handleMatch

handleNoMatch

hasCorsConfigurationSource

getCorsConfiguration

isHandler

getMappingForMethod

getMappingPathPatterns

getDirectPaths

getMatchingMapping

getMappingComparator