类 AbstractDispatcherServletInitializer

字段详细资料

• DEFAULT_SERVLET_NAME

  public static final String DEFAULT_SERVLET_NAME

  The default servlet name. Can be customized by overriding getServletName().

  另请参阅:

  常量字段值

构造器详细资料

• AbstractDispatcherServletInitializer

  public AbstractDispatcherServletInitializer()

方法详细资料

• onStartup

  public void onStartup​(ServletContext servletContext)
                 throws ServletException

  从接口复制的说明: WebApplicationInitializer
  Configure the given ServletContext with any servlets, filters, listeners context-params and attributes necessary for initializing this web application. See examples above.

  指定者:

  onStartup 在接口中 WebApplicationInitializer

  覆盖:

  onStartup 在类中 AbstractContextLoaderInitializer

  参数:

  servletContext - the ServletContext to initialize

  抛出:

  ServletException - if any call against the given ServletContext throws a ServletException

• registerDispatcherServlet

  protected void registerDispatcherServlet​(ServletContext servletContext)

  Register a DispatcherServlet against the given servlet context.

  This method will create a DispatcherServlet with the name returned by getServletName(), initializing it with the application context returned from createServletApplicationContext(), and mapping it to the patterns returned from getServletMappings().

  Further customization can be achieved by overriding customizeRegistration(ServletRegistration.Dynamic) or createDispatcherServlet(WebApplicationContext).

  参数:

  servletContext - the context to register the servlet against

• getServletName

  protected String getServletName()

  Return the name under which the DispatcherServlet will be registered. Defaults to DEFAULT_SERVLET_NAME.

  另请参阅:

  registerDispatcherServlet(ServletContext)

• createServletApplicationContext

  protected abstract WebApplicationContext createServletApplicationContext()

  Create a servlet application context to be provided to the DispatcherServlet.

  The returned context is delegated to Spring's DispatcherServlet(WebApplicationContext). As such, it typically contains controllers, view resolvers, locale resolvers, and other web-related beans.

  另请参阅:

  registerDispatcherServlet(ServletContext)

• createDispatcherServlet

  protected FrameworkServlet createDispatcherServlet​(WebApplicationContext servletAppContext)

  Create a DispatcherServlet (or other kind of FrameworkServlet-derived dispatcher) with the specified WebApplicationContext.

  Note: This allows for any FrameworkServlet subclass as of 4.2.3. Previously, it insisted on returning a DispatcherServlet or subclass thereof.

• getServletApplicationContextInitializers

  @Nullable
  protected ApplicationContextInitializer<?>[] getServletApplicationContextInitializers()

  Specify application context initializers to be applied to the servlet-specific application context that the DispatcherServlet is being created with.

  从以下版本开始:

  4.2

  另请参阅:

  createServletApplicationContext(), FrameworkServlet.setContextInitializers(org.springframework.context.ApplicationContextInitializer<?>...), AbstractContextLoaderInitializer.getRootApplicationContextInitializers()

• getServletMappings

  protected abstract String[] getServletMappings()

  Specify the servlet mapping(s) for the DispatcherServlet — for example "/", "/app", etc.

  另请参阅:

  registerDispatcherServlet(ServletContext)

• getServletFilters

  @Nullable
  protected Filter[] getServletFilters()

  Specify filters to add and map to the DispatcherServlet.

  返回:

  an array of filters or null

  另请参阅:

  registerServletFilter(ServletContext, Filter)

• registerServletFilter

  protected FilterRegistration.Dynamic registerServletFilter​(ServletContext servletContext,
                                                             Filter filter)

  Add the given filter to the ServletContext and map it to the DispatcherServlet as follows:

  • a default filter name is chosen based on its concrete type
  • the asyncSupported flag is set depending on the return value of asyncSupported
  • a filter mapping is created with dispatcher types REQUEST, FORWARD, INCLUDE, and conditionally ASYNC depending on the return value of asyncSupported

  If the above defaults are not suitable or insufficient, override this method and register filters directly with the ServletContext.

  参数:

  servletContext - the servlet context to register filters with

  filter - the filter to be registered

  返回:

  the filter registration

• isAsyncSupported

  protected boolean isAsyncSupported()

  A single place to control the asyncSupported flag for the DispatcherServlet and all filters added via getServletFilters().

  The default value is "true".

• customizeRegistration

  protected void customizeRegistration​(ServletRegistration.Dynamic registration)

  Optionally perform further registration customization once registerDispatcherServlet(ServletContext) has completed.

  参数:

  registration - the DispatcherServlet registration to be customized

  另请参阅:

  registerDispatcherServlet(ServletContext)