クラス DispatcherServlet

メソッドの詳細

• setDetectAllHandlerMappings

  public void setDetectAllHandlerMappings(boolean detectAllHandlerMappings)

  このサーブレットのコンテキスト内のすべての HandlerMapping Bean を検出するかどうかを設定します。それ以外の場合は、"handlerMapping" という名前の単一の Bean のみが想定されます。

  デフォルトは "true" です。コンテキストで複数の HandlerMapping Bean が定義されているにもかかわらず、このサーブレットで単一の HandlerMapping を使用する場合は、これをオフにします。

• setDetectAllHandlerAdapters

  public void setDetectAllHandlerAdapters(boolean detectAllHandlerAdapters)

  このサーブレットのコンテキスト内のすべての HandlerAdapter Bean を検出するかどうかを設定します。それ以外の場合は、"handlerAdapter" という名前の単一の Bean のみが想定されます。

  デフォルトは "true" です。コンテキストで複数の HandlerAdapter Bean が定義されているにもかかわらず、このサーブレットで単一の HandlerAdapter を使用する場合は、これをオフにします。

• setDetectAllHandlerExceptionResolvers

  public void setDetectAllHandlerExceptionResolvers(boolean detectAllHandlerExceptionResolvers)

  このサーブレットのコンテキスト内のすべての HandlerExceptionResolver Bean を検出するかどうかを設定します。それ以外の場合は、"handlerExceptionResolver" という名前の単一の Bean のみが想定されます。

  デフォルトは "true" です。コンテキストで複数の HandlerExceptionResolver Bean が定義されているにもかかわらず、このサーブレットで単一の HandlerExceptionResolver を使用する場合は、これをオフにします。

• setDetectAllViewResolvers

  public void setDetectAllViewResolvers(boolean detectAllViewResolvers)

  このサーブレットのコンテキスト内のすべての ViewResolver Bean を検出するかどうかを設定します。それ以外の場合は、"viewResolver" という名前の単一の Bean のみが想定されます。

  デフォルトは "true" です。コンテキストで複数の ViewResolver Bean が定義されているにもかかわらず、このサーブレットで単一の ViewResolver を使用する場合は、これをオフにします。

• setCleanupAfterInclude

  public void setCleanupAfterInclude(boolean cleanupAfterInclude)

  インクルードリクエストの後にリクエスト属性のクリーンアップを実行するかどうか、つまり、DispatcherServlet がインクルードリクエスト内で処理した後にすべてのリクエスト属性の元の状態をリセットするかどうかを設定します。そうでない場合は、DispatcherServlet 自身のリクエスト属性のみがリセットされますが、JSP のモデル属性やビューによって設定される特別な属性（JSTL など）はリセットされません。

  デフォルトは "true" です。これを強くお勧めします。ビューは、（動的）インクルードによって設定されたリクエスト属性に依存すべきではありません。これにより、含まれているコントローラーによってレンダリングされた JSP ビューは、副作用を引き起こすことなく、メイン JSP と同じ名前であっても、任意のモデル属性を使用できます。特別な必要がある場合のみ、これをオフにします。たとえば、メインの JSP が意図的に含まれているコントローラーによってレンダリングされた JSP ビューの属性にアクセスできるようにする場合です。

• onRefresh

  protected void onRefresh(ApplicationContext context)

  この実装は initStrategies(org.springframework.context.ApplicationContext) を呼び出します。

  オーバーライド:

  クラス FrameworkServlet の onRefresh 

  パラメーター:

  context - 現在の WebApplicationContext

  関連事項:

  • FrameworkServlet.refresh()

• initStrategies

  protected void initStrategies(ApplicationContext context)

  このサーブレットが使用する戦略オブジェクトを初期化します。

  さらに戦略オブジェクトを初期化するために、サブクラスでオーバーライドされる場合があります。

• getMultipartResolver

  public final @Nullable MultipartResolver getMultipartResolver()

  このサーブレットの MultipartResolver がある場合は入手します。

  戻り値:

  このサーブレットが使用する MultipartResolver。ない場合は null (マルチパートサポートが利用できないことを示す)

• getHandlerMappings

  public final @Nullable ListSE<HandlerMapping> getHandlerMappings()

  WebApplicationContext の型ごとに検出された、または DispatcherServlet.properties の戦略のデフォルトセットに基づいて初期化された、構成済みの HandlerMapping Bean を返します。

  注意 : onRefresh(ApplicationContext) の前に呼び出された場合、このメソッドは null を返すことがあります。

  戻り値:

  設定されたマッピングを持つ不変リスト、またはまだ初期化されていない場合は null 

  導入:

  5.0

• getDefaultStrategy

  protected <T> T getDefaultStrategy(ApplicationContext context, ClassSE<T> strategyInterface)

  指定された戦略インターフェースのデフォルト戦略オブジェクトを返します。

  デフォルトの実装は getDefaultStrategies(org.springframework.context.ApplicationContext, java.lang.Class<T>) に委譲し、リスト内の単一のオブジェクトを期待します。

  パラメーター:

  context - 現在の WebApplicationContext

  strategyInterface - 戦略インターフェース

  戻り値:

  対応する戦略オブジェクト

  関連事項:

  • getDefaultStrategies(org.springframework.context.ApplicationContext, java.lang.Class<T>)

• getDefaultStrategies

  protected <T> ListSE<T> getDefaultStrategies(ApplicationContext context, ClassSE<T> strategyInterface)

  特定の戦略インターフェースのデフォルト戦略オブジェクトのリストを作成します。

  デフォルトの実装では、"DispatcherServlet.properties" ファイル（DispatcherServlet クラスと同じパッケージ内）を使用して、クラス名を決定します。コンテキストの BeanFactory を通じて戦略オブジェクトをインスタンス化します。

  パラメーター:

  context - 現在の WebApplicationContext

  strategyInterface - 戦略インターフェース

  戻り値:

  対応する戦略オブジェクトのリスト

• createDefaultStrategy

  protected ObjectSE createDefaultStrategy(ApplicationContext context, ClassSE<?> clazz)

  デフォルト戦略を作成します。

  デフォルトの実装では AutowireCapableBeanFactory.createBean(Class) を使用します。

  パラメーター:

  context - 現在の WebApplicationContext

  clazz - インスタンス化する戦略実装クラス

  戻り値:

  完全に構成された戦略インスタンス

  関連事項:

  • ApplicationContext.getAutowireCapableBeanFactory()
  • AutowireCapableBeanFactory.createBean(Class)

• doService

  protected void doService(HttpServletRequestEE request, HttpServletResponseEE response) throws ExceptionSE

  DispatcherServlet 固有のリクエスト属性を公開し、実際のディスパッチのために doDispatch(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse) に委譲します。

  次で指定:

  クラス FrameworkServlet の doService 

  パラメーター:

  request - 現在の HTTP リクエスト

  response - 現在の HTTP レスポンス

  例外:

  ExceptionSE - あらゆる種類の処理が失敗した場合

  関連事項:

  • HttpServlet.doGet(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)
  • HttpServlet.doPost(jakarta.servlet.http.HttpServletRequest, jakarta.servlet.http.HttpServletResponse)

• doDispatch

  protected void doDispatch(HttpServletRequestEE request, HttpServletResponseEE response) throws ExceptionSE

  ハンドラーへの実際のディスパッチを処理します。

  ハンドラーは、サーブレットの HandlerMappings を順番に適用することにより取得されます。HandlerAdapter は、サーブレットにインストールされている HandlerAdapters を照会して、ハンドラークラスをサポートする最初の HandlerAdapter を見つけることによって取得されます。

  すべての HTTP メソッドは、このメソッドによって処理されます。許容されるメソッドを決定するのは、HandlerAdapters またはハンドラー自身です。

  パラメーター:

  request - 現在の HTTP リクエスト

  response - 現在の HTTP レスポンス

  例外:

  ExceptionSE - あらゆる種類の処理が失敗した場合

• buildLocaleContext

  protected LocaleContext buildLocaleContext(HttpServletRequestEE request)

  指定されたリクエストの LocaleContext を構築し、リクエストのプライマリロケールを現在のロケールとして公開します。

  デフォルトの実装では、ディスパッチャーの LocaleResolver を使用して現在のロケールを取得しますが、これはリクエスト中に変更される可能性があります。

  オーバーライド:

  クラス FrameworkServlet の buildLocaleContext 

  パラメーター:

  request - 現在の HTTP リクエスト

  戻り値:

  対応する LocaleContext

  関連事項:

  • LocaleContextHolder.setLocaleContext(org.springframework.context.i18n.LocaleContext)

• checkMultipart

  protected HttpServletRequestEE checkMultipart(HttpServletRequestEE request) throws MultipartException

  リクエストをマルチパートリクエストに変換し、マルチパートリゾルバーを使用可能にします。

  マルチパートリゾルバーが設定されていない場合は、既存のリクエストを使用します。

  パラメーター:

  request - 現在の HTTP リクエスト

  戻り値:

  処理されたリクエスト (必要に応じてマルチパートラッパー)

  例外:

  MultipartException

  関連事項:

  • MultipartResolver.resolveMultipart(jakarta.servlet.http.HttpServletRequest)

• cleanupMultipart

  protected void cleanupMultipart(HttpServletRequestEE request)

  指定されたマルチパートリクエストで使用されているリソースをクリーンアップします（存在する場合）。

  パラメーター:

  request - 現在の HTTP リクエスト

  関連事項:

  • MultipartResolver.cleanupMultipart(org.springframework.web.multipart.MultipartHttpServletRequest)

• getHandler

  protected @Nullable HandlerExecutionChain getHandler(HttpServletRequestEE request) throws ExceptionSE

  このリクエストの HandlerExecutionChain を返します。

  すべてのハンドラーマッピングを順番に試行します。

  パラメーター:

  request - 現在の HTTP リクエスト

  戻り値:

  HandlerExecutionChain、またはハンドラーが見つからなかった場合は null 

  例外:

  ExceptionSE

• noHandlerFound

  protected void noHandlerFound(HttpServletRequestEE request, HttpServletResponseEE response) throws ExceptionSE

  ハンドラーが見つかりません → 適切な HTTP レスポンスステータスを設定します。

  パラメーター:

  request - 現在の HTTP リクエスト

  response - 現在の HTTP レスポンス

  例外:

  ExceptionSE - レスポンスの準備に失敗した場合

• getHandlerAdapter

  protected HandlerAdapter getHandlerAdapter(ObjectSE handler) throws ServletExceptionEE

  このハンドラーオブジェクトの HandlerAdapter を返します。

  パラメーター:

  handler - アダプターを見つけるためのハンドラーオブジェクト

  例外:

  ServletExceptionEE - ハンドラーの HandlerAdapter が見つからない場合。これは致命的なエラーです。

• processHandlerException

  protected @Nullable ModelAndView processHandlerException(HttpServletRequestEE request, HttpServletResponseEE response, @Nullable ObjectSE handler, ExceptionSE ex) throws ExceptionSE

  登録された HandlerExceptionResolvers を介してエラー ModelAndView を判別します。

  パラメーター:

  request - 現在の HTTP リクエスト

  response - 現在の HTTP レスポンス

  handler - 実行されたハンドラー、または例外時に何も選択されなかった場合は null (たとえば、マルチパート解決が失敗した場合)

  ex - ハンドラーの実行中にスローされた例外

  戻り値:

  転送する対応する ModelAndView

  例外:

  ExceptionSE - エラー ModelAndView が見つからなかった場合

• render

  protected void render(ModelAndView mv, HttpServletRequestEE request, HttpServletResponseEE response) throws ExceptionSE

  指定された ModelAndView をレンダリングします。

  これは、リクエストを処理する最後の段階です。ビューを名前で解決する必要がある場合があります。

  パラメーター:

  mv - レンダリングする ModelAndView

  request - 現在の HTTP サーブレットリクエスト

  response - 現在の HTTP サーブレットレスポンス

  例外:

  ServletExceptionEE - ビューが欠落しているか、解決できない場合

  ExceptionSE - ビューのレンダリングに問題がある場合

• getDefaultViewName

  protected @Nullable StringSE getDefaultViewName(HttpServletRequestEE request) throws ExceptionSE

  指定されたリクエストをデフォルトのビュー名に変換します。

  パラメーター:

  request - 現在の HTTP サーブレットリクエスト

  戻り値:

  ビュー名 (または、デフォルトが見つからない場合は null )

  例外:

  ExceptionSE - ビュー名の変換に失敗した場合

• resolveViewName

  protected @Nullable View resolveViewName(StringSE viewName, @Nullable MapSE<StringSE,ObjectSE> model, LocaleSE locale, HttpServletRequestEE request) throws ExceptionSE

  指定されたビュー名を（レンダリングされる）View オブジェクトに解決します。

  デフォルトの実装は、このディスパッチャーのすべての ViewResolvers をリクエストします。潜在的に特定のモデル属性またはリクエストパラメーターに基づいて、カスタム解決戦略のためにオーバーライドできます。

  パラメーター:

  viewName - 解決するビューの名前

  model - ビューに渡されるモデル

  locale - 現在のロケール

  request - 現在の HTTP サーブレットリクエスト

  戻り値:

  View オブジェクト、または何も見つからない場合は null 

  例外:

  ExceptionSE - ビューを解決できない場合 (通常、実際の View オブジェクトの作成に問題がある場合)

  関連事項:

  • ViewResolver.resolveViewName(java.lang.String, java.util.Locale)