RequestMappingHandlerMapping (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<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.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

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

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

メソッドのサマリー

すべてのメソッドインスタンスメソッド具象メソッド非推奨のメソッド
修飾子と型	メソッドと説明
`void`	`afterPropertiesSet()` 初期化時にハンドラーメソッドを検出します。
`protected RequestMappingInfo`	`createRequestMappingInfo(RequestMapping requestMapping, RequestCondition<?> customCondition)` 提供された `@RequestMapping` アノテーションから `RequestMappingInfo` を作成します。これは、直接宣言されたアノテーション、メタアノテーション、アノテーション階層内のアノテーション属性をマージした合成結果のいずれかです。
`RequestMappingInfo.BuilderConfiguration`	`getBuilderConfiguration()` この `HandlerMapping` の内部構成を反映でき、`RequestMappingInfo.Builder#options(RequestMappingInfo.BuilderConfiguration)` の設定に使用できる `RequestMappingInfo.BuilderConfiguration` を入手します。
`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 以降。パス拡張構成オプションの非推奨については、クラスレベルのメモを参照してください。このメソッドに代わるものはないため、5.2.x では `false` に設定する必要があります。5.3 では、デフォルトが `false` に変更され、このプロパティの使用は不要になります。
`void`	`setUseTrailingSlashMatch(boolean useTrailingSlashMatch)` 末尾のスラッシュの有無に関係なく、URL に一致するかどうか。
`boolean`	`useRegisteredSuffixPatternMatch()` 使用すべきではありません。 5.2.4 以降。`setUseRegisteredSuffixPatternMatch(boolean)` の非推奨通知を参照してください。
`boolean`	`useSuffixPatternMatch()` 使用すべきではありません。 5.2.4 以降。`setUseSuffixPatternMatch(boolean)` の非推奨通知を参照してください。
`boolean`	`useTrailingSlashMatch()` 末尾のスラッシュの有無に関係なく、URL に一致するかどうか。

クラス org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping から継承されたメソッド
getDirectPaths, 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, setPatternParser, unregisterMapping

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

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

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

- コンストラクターの詳細
  - RequestMappingHandlerMapping
```
public RequestMappingHandlerMapping()
```
- メソッドの詳細
  - setUseSuffixPatternMatch
```
@DeprecatedSE
public void setUseSuffixPatternMatch(boolean useSuffixPatternMatch)
```
    非推奨。5.2.4 現在。パス拡張構成オプションの非推奨については、クラスレベルの注記を参照してください。このメソッドに代わるものがないため、5.2.x では false に設定する必要があります。5.3 では、デフォルトが false に変更され、このプロパティの使用は不要になります
    パターンをリクエストに一致させるときにサフィックスパターン一致（".*" ）を使用するかどうか。有効にすると、"/users" にマップされたメソッドは "/users.*" にも一致します。
    デフォルト値では、これは false に設定されています。
    また、許可する特定のサフィックスのより詳細な制御については、setUseRegisteredSuffixPatternMatch(boolean) を参照してください。
    注意 : AbstractHandlerMethodMapping.setPatternParser(PathPatternParser) が構成されている場合、このプロパティは無視されます。
  - setUseRegisteredSuffixPatternMatch
```
@DeprecatedSE
public void setUseRegisteredSuffixPatternMatch(boolean useRegisteredSuffixPatternMatch)
```
    非推奨。5.2.4 現在。パス拡張構成オプションの非推奨については、クラスレベルの注意を参照してください。
    ContentNegotiationManager で明示的に登録されたパス拡張に対してのみ、サフィックスパターンマッチングが機能するかどうか。これは一般に、あいまいさを減らし、"." のような課題を回避するために推奨されます。他の理由でパスに表示されます。
    デフォルトでは、これは "false" に設定されています。
    注意 : AbstractHandlerMethodMapping.setPatternParser(PathPatternParser) が構成されている場合、このプロパティは無視されます。
  - 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 現在。setUseSuffixPatternMatch(boolean) の非推奨通知を参照してください。
    パターンマッチングに登録済みのサフィックスを使用するかどうか。
  - useRegisteredSuffixPatternMatch
```
@DeprecatedSE
public boolean useRegisteredSuffixPatternMatch()
```
    非推奨。5.2.4 現在。setUseRegisteredSuffixPatternMatch(boolean) の非推奨通知を参照してください。
    パターンマッチングに登録済みのサフィックスを使用するかどうか。
  - useTrailingSlashMatch
```
public boolean useTrailingSlashMatch()
```
    末尾のスラッシュの有無に関係なく、URL に一致するかどうか。
  - getFileExtensions
```
@Nullable
 @DeprecatedSE
public ListSE<StringSE> getFileExtensions()
```
    非推奨。5.2.4 現在。パス拡張設定オプションの廃止に関するクラスレベルの注意を参照してください。
    サフィックスパターンマッチングに使用するファイル拡張子を返します。
  - 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 アノテーションまたは型レベルの @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)
```
    ハンドラーメソッドとその一意のマッピングを登録します。検出された各ハンドラーメソッドに対して起動時に呼び出されます。
    注意 : RequestMappingInfo を作成するには、getBuilderConfiguration() を使用し、この HandlerMapping の構成方法に一致するように RequestMappingInfo.Builder#options(RequestMappingInfo.BuilderConfiguration) のオプションを設定してください。これは、たとえば PathPattern または PathMatcher ベースのマッチングを確実に使用するために重要です。
    オーバーライド:
    クラス AbstractHandlerMethodMapping<RequestMappingInfo> の registerHandlerMethod
    パラメーター:
    handler - ハンドラーまたはハンドラーインスタンスの Bean 名
    method - 登録する方法
    mapping - ハンドラーメソッドに関連付けられたマッピング条件
  - match
```
public RequestMatchResult match(HttpServletRequestEE request,
                                StringSE pattern)
```
    インターフェースからコピーされた説明: MatchableHandlerMapping
    リクエストが指定されたパターンに一致するかどうかを判別します。MatchableHandlerMapping.getPatternParser() が null を返す場合、このメソッドを使用します。これは、HandlerMapping が文字列パターンマッチングを使用していることを意味します。
    次で指定:
    インターフェース MatchableHandlerMapping の match
    パラメーター:
    request - 現在のリクエスト
    pattern - マッチングするパターン
    戻り値:
    リクエストマッチングの結果、または存在しない場合は null
  - initCorsConfiguration
```
protected CorsConfiguration initCorsConfiguration(ObjectSE handler,
                                                  MethodSE method,
                                                  RequestMappingInfo mappingInfo)
```
    クラスからコピーされた説明: AbstractHandlerMethodMapping
    マッピングの CORS 設定を抽出して返します。
    オーバーライド:
    クラス AbstractHandlerMethodMapping<RequestMappingInfo> の initCorsConfiguration

クラス RequestMappingHandlerMapping

フィールドサマリー

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

クラス 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.handler.MatchableHandlerMapping から継承されたメソッド

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

コンストラクターの詳細

RequestMappingHandlerMapping

メソッドの詳細

setUseSuffixPatternMatch

setUseRegisteredSuffixPatternMatch

setUseTrailingSlashMatch

setPathPrefixes

getPathPrefixes

setContentNegotiationManager

getContentNegotiationManager

setEmbeddedValueResolver

afterPropertiesSet

useSuffixPatternMatch

useRegisteredSuffixPatternMatch

useTrailingSlashMatch

getFileExtensions

getBuilderConfiguration

isHandler

getMappingForMethod

getCustomTypeCondition

getCustomMethodCondition

createRequestMappingInfo

resolveEmbeddedValuesInPatterns

registerMapping

registerHandlerMethod

match

initCorsConfiguration