RequestMappingHandlerMapping (Spring Framework 5.2.9.RELEASE 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<RequestMappingInfo>
      - org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping
        
        org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping

実装されたすべてのインターフェース：
Aware, BeanNameAware, InitializingBean, ApplicationContextAware, EmbeddedValueResolverAware, Ordered, ServletContextAware, MatchableHandlerMapping, HandlerMapping
```
public class RequestMappingHandlerMapping
extends RequestMappingInfoHandlerMapping
implements MatchableHandlerMapping, EmbeddedValueResolverAware
```
@Controller クラスのタイプおよびメソッドレベルの @RequestMapping アノテーションから RequestMappingInfo インスタンスを作成します。
非推奨のメモ：
5.2.4 では、useSuffixPatternMatch および useRegisteredSuffixPatternMatch は、リクエストのマッピングおよびコンテンツのネゴシエーション（ContentNegotiationManagerFactoryBean での同様の非推奨）のためのパス拡張の使用を阻止するために非推奨です。詳細については、課題 #24719 を参照してください。
導入:
3.1
作成者:
Arjen Poutsma, Rossen Stoyanchev, Sam Brannen

フィールドのサマリー
- クラス 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

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

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` 初期化時にハンドラーメソッドを検出します。
`protected RequestMappingInfo`	`createRequestMappingInfo(RequestMapping requestMapping, RequestCondition<?> customCondition)` 提供された `@RequestMapping` アノテーションから `RequestMappingInfo` を作成します。これは、直接宣言されたアノテーション、メタアノテーション、またはアノテーション階層内のアノテーション属性をマージした合成結果のいずれかです。
`ContentNegotiationManager`	`getContentNegotiationManager()` 設定された `ContentNegotiationManager` を返します。
`protected RequestCondition<?>`	`getCustomMethodCondition(MethodSE method)` カスタムのメソッドレベルのリクエスト条件を指定します。
`protected RequestCondition<?>`	`getCustomTypeCondition(ClassSE<?> handlerType)` カスタム型レベルのリクエスト条件を指定します。
`ListSE<StringSE>`	`getFileExtensions()` 使用すべきではありません。 5.2.4 現在。パス拡張設定オプションの廃止に関するクラスレベルの注意を参照してください。
`protected RequestMappingInfo`	`getMappingForMethod(MethodSE method, ClassSE<?> handlerType)` メソッドおよび型レベルの @`RequestMapping` アノテーションを使用して RequestMappingInfo を作成します。
`MapSE<StringSE,PredicateSE<ClassSE<?>>>`	`getPathPrefixes()` 構成されたパスは、読み取り専用の、おそらく空のマップとしてプレフィックスします。
`protected CorsConfiguration`	`initCorsConfiguration(ObjectSE handler, MethodSE method, RequestMappingInfo mappingInfo)` マッピングの CORS 設定を抽出して返します。
`protected boolean`	`isHandler(ClassSE<?> beanType)` 指定されたタイプがハンドラーメソッドを持つハンドラーかどうか。
`RequestMatchResult`	`match(HttpServletRequestEE request, StringSE pattern)` 指定されたリクエストがリクエスト条件に一致するかどうかを判断します。
`protected void`	`registerHandlerMethod(ObjectSE handler, MethodSE method, RequestMappingInfo mapping)` ハンドラーメソッドとその一意のマッピングを登録します。
`void`	`registerMapping(RequestMappingInfo mapping, ObjectSE handler, MethodSE method)` 指定されたマッピングを登録します。
`protected StringSE[]`	`resolveEmbeddedValuesInPatterns(StringSE[] patterns)` 指定されたパターンの配列のプレースホルダー値を解決します。
`void`	`setContentNegotiationManager(ContentNegotiationManager contentNegotiationManager)` リクエストされたメディアタイプを判別するために使用する `ContentNegotiationManager` を設定します。
`void`	`setEmbeddedValueResolver(StringValueResolver resolver)` StringValueResolver を設定して、埋め込まれた定義値の解決に使用します。
`void`	`setPathPrefixes(MapSE<StringSE,PredicateSE<ClassSE<?>>> prefixes)` コントローラーメソッドに適用するパスプレフィックスを構成します。
`void`	`setUseRegisteredSuffixPatternMatch(boolean useRegisteredSuffixPatternMatch)` 使用すべきではありません。 5.2.4 現在。パス拡張設定オプションの廃止に関するクラスレベルのコメントを参照してください。
`void`	`setUseSuffixPatternMatch(boolean useSuffixPatternMatch)` 使用すべきではありません。 5.2.4 以降。パス拡張構成オプションの非推奨については、クラスレベルのコメントを参照してください。このメソッドに代わるものはないため、当面は `false` に設定する必要があります。5.3 では、`false` がデフォルトになると、このプロパティを使用する必要がなくなります。
`void`	`setUseTrailingSlashMatch(boolean useTrailingSlashMatch)` 末尾のスラッシュの有無に関係なく、URL に一致するかどうか。
`boolean`	`useRegisteredSuffixPatternMatch()` 使用すべきではありません。 5.2.4 現在。パス拡張設定オプションの廃止に関するクラスレベルの注意を参照してください。
`boolean`	`useSuffixPatternMatch()` 使用すべきではありません。 5.2.4 現在。パス拡張設定オプションの廃止に関するクラスレベルの注意を参照してください。
`boolean`	`useTrailingSlashMatch()` 末尾のスラッシュの有無に関係なく、URL に一致するかどうか。

クラス org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping から継承されたメソッド
getHandlerInternal, getMappingComparator, getMappingPathPatterns, getMatchingMapping, handleMatch, handleNoMatch

クラス org.springframework.web.servlet.handler.AbstractHandlerMethodMapping から継承されたメソッド
createHandlerMethod, detectHandlerMethods, getCandidateBeanNames, getCorsConfiguration, getHandlerMethods, getHandlerMethodsForMappingName, getNamingStrategy, handlerMethodsInitialized, hasCorsConfigurationSource, initHandlerMethods, lookupHandlerMethod, processCandidateBean, setDetectHandlerMethodsInAncestorContexts, setHandlerMethodMappingNamingStrategy, unregisterMapping

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

クラス 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

インターフェース org.springframework.web.servlet.HandlerMapping から継承されたメソッド
getHandler

- コンストラクターの詳細
  - RequestMappingHandlerMapping
```
public RequestMappingHandlerMapping()
```
- メソッドの詳細
  - setUseSuffixPatternMatch
```
@DeprecatedSE
public void setUseSuffixPatternMatch(boolean useSuffixPatternMatch)
```
    非推奨。5.2.4 以降。パス拡張構成オプションの非推奨については、クラスレベルのコメントを参照してください。このメソッドに代わるものはないため、当面は false に設定する必要があります。5.3 で false がデフォルトになると、このプロパティを使用する必要がなくなります
    パターンをリクエストに一致させるときに、サフィックスパターン一致（".*" ）を使用するかどうか。有効にすると、「/users」にマッピングされたメソッドは「/users.*」にも一致します。
    デフォルト値は true です。
    また、許可する特定のサフィックスのより詳細な制御については、setUseRegisteredSuffixPatternMatch(boolean) を参照してください。
  - setUseRegisteredSuffixPatternMatch
```
@DeprecatedSE
public void setUseRegisteredSuffixPatternMatch(boolean useRegisteredSuffixPatternMatch)
```
    非推奨。5.2.4 現在。パス拡張設定オプションの廃止に関するクラスレベルのコメントを参照してください。
    ContentNegotiationManager で明示的に登録されたパス拡張に対してのみ、サフィックスパターンマッチングが機能するかどうか。これは一般に、あいまいさを減らし、「.」のような課題を回避するために推奨されます。他の理由でパスに表示されます。
    デフォルトでは、これは「false」に設定されています。
  - setUseTrailingSlashMatch
```
public void setUseTrailingSlashMatch(boolean useTrailingSlashMatch)
```
    末尾のスラッシュの有無に関係なく、URL に一致するかどうか。有効にすると、「/users」にマッピングされたメソッドは「/users/」にも一致します。
    デフォルト値は true です。
  - setPathPrefixes
```
public void setPathPrefixes(MapSE<StringSE,PredicateSE<ClassSE<?>>> prefixes)
```
    コントローラーメソッドに適用するパスプレフィックスを構成します。
    接頭辞は、コントローラータイプが対応する Predicate と一致するすべての @RequestMapping メソッドのマッピングを充実させるために使用されます。最初に一致する述語の接頭辞が使用されます。
    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()
  - useSuffixPatternMatch
```
@DeprecatedSE
public boolean useSuffixPatternMatch()
```
    非推奨。5.2.4 現在。パス拡張設定オプションの廃止に関するクラスレベルの注意を参照してください。
    パターンマッチングに登録済みのサフィックスを使用するかどうか。
  - useRegisteredSuffixPatternMatch
```
@DeprecatedSE
public boolean useRegisteredSuffixPatternMatch()
```
    非推奨。5.2.4 現在。パス拡張設定オプションの廃止に関するクラスレベルの注意を参照してください。
    パターンマッチングに登録済みのサフィックスを使用するかどうか。
  - useTrailingSlashMatch
```
public boolean useTrailingSlashMatch()
```
    末尾のスラッシュの有無に関係なく、URL に一致するかどうか。
  - getFileExtensions
```
@Nullable
 @DeprecatedSE
public ListSE<StringSE> getFileExtensions()
```
    非推奨。5.2.4 現在。パス拡張設定オプションの廃止に関するクラスレベルの注意を参照してください。
    サフィックスパターンマッチングに使用するファイル拡張子を返します。
  - isHandler
```
protected boolean isHandler(ClassSE<?> beanType)
```
    指定されたタイプがハンドラーメソッドを持つハンドラーかどうか。
    ハンドラーには、型レベルの @Controller アノテーションまたは型レベルの @RequestMapping アノテーションのいずれかが必要です。
    次で指定:
    クラス AbstractHandlerMethodMapping<RequestMappingInfo> の isHandler
    パラメーター:
    beanType - チェックされている Bean のタイプ
    戻り値:
    これがハンドラータイプの場合は「true」、そうでない場合は「false」。
  - getMappingForMethod
```
@Nullable
protected RequestMappingInfo getMappingForMethod(MethodSE method,
                                                           ClassSE<?> handlerType)
```
    メソッドおよび型レベルの @RequestMapping アノテーションを使用して RequestMappingInfo を作成します。
    次で指定:
    クラス AbstractHandlerMethodMapping<RequestMappingInfo> の getMappingForMethod
    パラメーター:
    method - マッピングを提供する方法
    handlerType - ハンドラー型、場合によってはメソッドの宣言クラスのサブタイプ
    戻り値:
    作成された RequestMappingInfo、またはメソッドに @RequestMapping アノテーションがない場合は null
    関連事項:
    getCustomMethodCondition(Method), getCustomTypeCondition(Class)
  - getCustomTypeCondition
```
@Nullable
protected RequestCondition<?> getCustomTypeCondition(ClassSE<?> handlerType)
```
    カスタム型レベルのリクエスト条件を指定します。カスタム RequestCondition は、カスタムリクエスト条件を組み合わせて比較できるように、このメソッドへのすべての呼び出しから同じ条件タイプが返される限り、どのタイプでもかまいません。
    カスタム条件タイプ用に AbstractRequestCondition を継承し、CompositeRequestCondition を使用して複数のカスタム条件を提供することを検討してください。
    パラメーター:
    handlerType - 条件を作成するハンドラータイプ
    戻り値:
    条件、または null
  - getCustomMethodCondition
```
@Nullable
protected RequestCondition<?> getCustomMethodCondition(MethodSE method)
```
    カスタムのメソッドレベルのリクエスト条件を指定します。カスタム RequestCondition は、カスタムリクエスト条件を組み合わせて比較できるように、このメソッドへのすべての呼び出しから同じ条件タイプが返される限り、どのタイプでもかまいません。
    カスタム条件タイプ用に AbstractRequestCondition を継承し、CompositeRequestCondition を使用して複数のカスタム条件を提供することを検討してください。
    パラメーター:
    method - 条件を作成するハンドラーメソッド
    戻り値:
    条件、または null
  - createRequestMappingInfo
```
protected RequestMappingInfo createRequestMappingInfo(RequestMapping requestMapping,
                                                      @Nullable
                                                      RequestCondition<?> customCondition)
```
    提供された @RequestMapping アノテーションから RequestMappingInfo を作成します。これは、直接宣言されたアノテーション、メタアノテーション、またはアノテーション階層内のアノテーション属性をマージした合成結果のいずれかです。
  - 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)
```
    クラスからコピーされた説明: AbstractHandlerMethodMapping
    ハンドラーメソッドとその一意のマッピングを登録します。検出された各ハンドラーメソッドに対して起動時に呼び出されます。
    オーバーライド:
    クラス AbstractHandlerMethodMapping<RequestMappingInfo> の registerHandlerMethod
    パラメーター:
    handler - ハンドラーまたはハンドラーインスタンスの Bean 名
    method - 登録する方法
    mapping - ハンドラーメソッドに関連付けられたマッピング条件
  - match
```
public RequestMatchResult match(HttpServletRequestEE request,
                                StringSE pattern)
```
    インターフェースからコピーされた説明: MatchableHandlerMapping
    指定されたリクエストがリクエスト条件に一致するかどうかを判断します。
    次で指定:
    インターフェース MatchableHandlerMapping の match
    パラメーター:
    request - 現在のリクエスト
    pattern - マッチングするパターン
    戻り値:
    リクエストマッチングの結果、または存在しない場合は null
  - initCorsConfiguration
```
protected CorsConfiguration initCorsConfiguration(ObjectSE handler,
                                                  MethodSE method,
                                                  RequestMappingInfo mappingInfo)
```
    クラスからコピーされた説明: AbstractHandlerMethodMapping
    マッピングの CORS 設定を抽出して返します。
    オーバーライド:
    クラス AbstractHandlerMethodMapping<RequestMappingInfo> の initCorsConfiguration

クラス RequestMappingHandlerMapping

フィールドのサマリー

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

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

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

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

メソッドのサマリー

クラス org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping から継承されたメソッド

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

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

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

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

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

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

コンストラクターの詳細

RequestMappingHandlerMapping

メソッドの詳細

setUseSuffixPatternMatch

setUseRegisteredSuffixPatternMatch

setUseTrailingSlashMatch

setPathPrefixes

getPathPrefixes

setContentNegotiationManager

getContentNegotiationManager

setEmbeddedValueResolver

afterPropertiesSet

useSuffixPatternMatch

useRegisteredSuffixPatternMatch

useTrailingSlashMatch

getFileExtensions

isHandler

getMappingForMethod

getCustomTypeCondition

getCustomMethodCondition

createRequestMappingInfo

resolveEmbeddedValuesInPatterns

registerMapping

registerHandlerMethod

match

initCorsConfiguration