类 ResourceHandlerRegistration
- java.lang.Object
- org.springframework.web.reactive.config.ResourceHandlerRegistration
public class ResourceHandlerRegistration extends Object
Assist with creating and configuring a static resources handler.- 从以下版本开始:
- 5.0
- 作者:
- Rossen Stoyanchev
构造器概要
构造器 构造器 说明 ResourceHandlerRegistration(ResourceLoader resourceLoader, String... pathPatterns)Create aResourceHandlerRegistrationinstance.
方法概要
所有方法 实例方法 具体方法 修饰符和类型 方法 说明 ResourceHandlerRegistrationaddResourceLocations(String... resourceLocations)Add one or more resource locations from which to serve static content.protected String[]getPathPatterns()Returns the URL path patterns for the resource handler.protected ResourceWebHandlergetRequestHandler()Returns aResourceWebHandlerinstance.ResourceChainRegistrationresourceChain(boolean cacheResources)Configure a chain of resource resolvers and transformers to use.ResourceChainRegistrationresourceChain(boolean cacheResources, Cache cache)Configure a chain of resource resolvers and transformers to use.ResourceHandlerRegistrationsetCacheControl(CacheControl cacheControl)Specify theCacheControlwhich should be used by the resource handler.
构造器详细资料
ResourceHandlerRegistration
public ResourceHandlerRegistration(ResourceLoader resourceLoader, String... pathPatterns)
Create aResourceHandlerRegistrationinstance.- 参数:
resourceLoader- a resource loader for turning a String location into aResourcepathPatterns- one or more resource URL path patterns
方法详细资料
addResourceLocations
public ResourceHandlerRegistration addResourceLocations(String... resourceLocations)
Add one or more resource locations from which to serve static content. Each location must point to a valid directory. Multiple locations may be specified as a comma-separated list, and the locations will be checked for a given resource in the order specified.For example, {
"/","classpath:/META-INF/public-web-resources/"} allows resources to be served both from the web application root and from any JAR on the classpath that contains a/META-INF/public-web-resources/directory, with resources in the web application root taking precedence.- 返回:
- the same
ResourceHandlerRegistrationinstance, for chained method invocation
setCacheControl
public ResourceHandlerRegistration setCacheControl(CacheControl cacheControl)
Specify theCacheControlwhich should be used by the resource handler.- 参数:
cacheControl- the CacheControl configuration to use- 返回:
- the same
ResourceHandlerRegistrationinstance, for chained method invocation
resourceChain
public ResourceChainRegistration resourceChain(boolean cacheResources)
Configure a chain of resource resolvers and transformers to use. This can be useful, for example, to apply a version strategy to resource URLs.If this method is not invoked, by default only a simple
PathResourceResolveris used in order to match URL paths to resources under the configured locations.- 参数:
cacheResources- whether to cache the result of resource resolution; setting this to "true" is recommended for production (and "false" for development, especially when applying a version strategy)- 返回:
- the same
ResourceHandlerRegistrationinstance, for chained method invocation
resourceChain
public ResourceChainRegistration resourceChain(boolean cacheResources, Cache cache)
Configure a chain of resource resolvers and transformers to use. This can be useful, for example, to apply a version strategy to resource URLs.If this method is not invoked, by default only a simple
PathResourceResolveris used in order to match URL paths to resources under the configured locations.- 参数:
cacheResources- whether to cache the result of resource resolution; setting this to "true" is recommended for production (and "false" for development, especially when applying a version strategycache- the cache to use for storing resolved and transformed resources; by default aConcurrentMapCacheis used. Since Resources aren't serializable and can be dependent on the application host, one should not use a distributed cache but rather an in-memory cache.- 返回:
- the same
ResourceHandlerRegistrationinstance, for chained method invocation
getPathPatterns
protected String[] getPathPatterns()
Returns the URL path patterns for the resource handler.
getRequestHandler
protected ResourceWebHandler getRequestHandler()
Returns aResourceWebHandlerinstance.