程序包 org.springframework.boot.web.servlet

类 ServletRegistrationBean<T extends Servlet>

java.lang.Object

org.springframework.boot.web.servlet.RegistrationBean

org.springframework.boot.web.servlet.DynamicRegistrationBean<ServletRegistration.Dynamic>

org.springframework.boot.web.servlet.ServletRegistrationBean<T>

类型参数:

T - the type of the Servlet to register

所有已实现的接口:

Aware, BeanNameAware, ServletContextInitializer, Ordered

直接已知子类:

DispatcherServletRegistrationBean

public class ServletRegistrationBean<T extends Servlet>
extends DynamicRegistrationBean<ServletRegistration.Dynamic>

A ServletContextInitializer to register Servlets in a Servlet 3.0+ container. Similar to the registration features provided by ServletContext but with a Spring Bean friendly design.

The servlet must be specified before calling RegistrationBean.onStartup(jakarta.servlet.ServletContext). URL mapping can be configured used setUrlMappings(java.util.Collection<java.lang.String>) or omitted when mapping to '/*' (unless alwaysMapUrl is set to false). The servlet name will be deduced if not specified.

从以下版本开始:

1.4.0

作者:

Phillip Webb

另请参阅:

• ServletContextInitializer
• ServletContext.addServlet(String, Servlet)
• ServletRegistration

字段概要

从接口继承的字段 org.springframework.core.Ordered

HIGHEST_PRECEDENCE, LOWEST_PRECEDENCE

构造器概要

构造器

构造器	说明
ServletRegistrationBean()	Create a new ServletRegistrationBean instance.
ServletRegistrationBean(T servlet, boolean alwaysMapUrl, String... urlMappings)	Create a new ServletRegistrationBean instance with the specified Servlet and URL mappings.
ServletRegistrationBean(T servlet, String... urlMappings)	Create a new ServletRegistrationBean instance with the specified Servlet and URL mappings.

方法概要

修饰符和类型	方法	说明
protected ServletRegistration.Dynamic	addRegistration(String description, ServletContext servletContext)
void	addUrlMappings(String... urlMappings)	Add URL mappings, as defined in the Servlet specification, for the servlet.
protected void	configure(ServletRegistration.Dynamic registration)	Configure registration settings.
protected String	getDescription()	Return a description of the registration.
MultipartConfigElement	getMultipartConfig()	Returns the multi-part configuration to be applied or null.
T	getServlet()	Return the servlet being registered.
String	getServletName()	Returns the servlet name that will be registered.
Collection<String>	getUrlMappings()	Return a mutable collection of the URL mappings, as defined in the Servlet specification, for the servlet.
void	setLoadOnStartup(int loadOnStartup)	Sets the loadOnStartup priority.
void	setMultipartConfig(MultipartConfigElement multipartConfig)	Set the multi-part configuration.
void	setServlet(T servlet)	Sets the servlet to be registered.
void	setUrlMappings(Collection<String> urlMappings)	Set the URL mappings for the servlet.
String	toString()

从类继承的方法 org.springframework.boot.web.servlet.DynamicRegistrationBean

addInitParameter, getInitParameters, getOrDeduceName, isAsyncSupported, register, setAsyncSupported, setBeanName, setIgnoreRegistrationFailure, setInitParameters, setName

从类继承的方法 org.springframework.boot.web.servlet.RegistrationBean

getOrder, isEnabled, onStartup, setEnabled, setOrder

从类继承的方法 java.lang.Object

clone, equals, finalize, getClass, hashCode, notify, notifyAll, wait, wait, wait

构造器详细资料

ServletRegistrationBean

public ServletRegistrationBean()

Create a new ServletRegistrationBean instance.

ServletRegistrationBean

public ServletRegistrationBean(T servlet,
 String... urlMappings)

Create a new ServletRegistrationBean instance with the specified Servlet and URL mappings.

参数:

servlet - the servlet being mapped

urlMappings - the URLs being mapped

ServletRegistrationBean

public ServletRegistrationBean(T servlet,
 boolean alwaysMapUrl,
 String... urlMappings)

Create a new ServletRegistrationBean instance with the specified Servlet and URL mappings.

参数:

servlet - the servlet being mapped

alwaysMapUrl - if omitted URL mappings should be replaced with '/*'

urlMappings - the URLs being mapped

方法详细资料

setServlet

public void setServlet(T servlet)

Sets the servlet to be registered.

参数:

servlet - the servlet

getServlet

public T getServlet()

Return the servlet being registered.

返回:

the servlet

setUrlMappings

public void setUrlMappings(Collection<String> urlMappings)

Set the URL mappings for the servlet. If not specified the mapping will default to '/'. This will replace any previously specified mappings.

参数:

urlMappings - the mappings to set

另请参阅:

• addUrlMappings(String...)

getUrlMappings

public Collection<String> getUrlMappings()

Return a mutable collection of the URL mappings, as defined in the Servlet specification, for the servlet.

返回:

the urlMappings

addUrlMappings

public void addUrlMappings(String... urlMappings)

Add URL mappings, as defined in the Servlet specification, for the servlet.

参数:

urlMappings - the mappings to add

另请参阅:

• setUrlMappings(Collection)

setLoadOnStartup

public void setLoadOnStartup(int loadOnStartup)

Sets the loadOnStartup priority. See ServletRegistration.Dynamic.setLoadOnStartup(int) for details.

参数:

loadOnStartup - if load on startup is enabled

setMultipartConfig

public void setMultipartConfig(MultipartConfigElement multipartConfig)

Set the multi-part configuration.

参数:

multipartConfig - the multipart configuration to set or null

getMultipartConfig

public MultipartConfigElement getMultipartConfig()

Returns the multi-part configuration to be applied or null.

返回:

the multipart config

getDescription

protected String getDescription()

从类复制的说明: RegistrationBean

Return a description of the registration. For example "Servlet resourceServlet"

指定者:

getDescription 在类中 RegistrationBean

返回:

a description of the registration

addRegistration

protected ServletRegistration.Dynamic addRegistration(String description,
 ServletContext servletContext)

指定者:

addRegistration 在类中 DynamicRegistrationBean<ServletRegistration.Dynamic>

configure

protected void configure(ServletRegistration.Dynamic registration)

Configure registration settings. Subclasses can override this method to perform additional configuration if required.

覆盖:

configure 在类中 DynamicRegistrationBean<ServletRegistration.Dynamic>

参数:

registration - the registration

getServletName

public String getServletName()

Returns the servlet name that will be registered.

返回:

the servlet name

toString

public String toString()

覆盖:

toString 在类中 Object