类 ResourceHandlerRegistration

构造器详细资料

• ResourceHandlerRegistration

  public ResourceHandlerRegistration​(String... pathPatterns)

  Create a ResourceHandlerRegistration instance.

  参数:

  pathPatterns - 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.

  For URL-based resources (e.g. files, HTTP URLs, etc) this method supports a special prefix to indicate the charset associated with the URL so that relative paths appended to it can be encoded correctly, e.g. [charset=Windows-31J]https://example.org/path.

  返回:

  the same ResourceHandlerRegistration instance, for chained method invocation

• setCachePeriod

  public ResourceHandlerRegistration setCachePeriod​(Integer cachePeriod)

  Specify the cache period for the resources served by the resource handler, in seconds. The default is to not send any cache headers but to rely on last-modified timestamps only. Set to 0 in order to send cache headers that prevent caching, or to a positive number of seconds to send cache headers with the given max-age value.

  参数:

  cachePeriod - the time to cache resources in seconds

  返回:

  the same ResourceHandlerRegistration instance, for chained method invocation

• setCacheControl

  public ResourceHandlerRegistration setCacheControl​(CacheControl cacheControl)

  Specify the CacheControl which should be used by the resource handler.

  Setting a custom value here will override the configuration set with setCachePeriod(java.lang.Integer).

  参数:

  cacheControl - the CacheControl configuration to use

  返回:

  the same ResourceHandlerRegistration instance, for chained method invocation

  从以下版本开始:

  4.2

• 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 PathResourceResolver is 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 ResourceHandlerRegistration instance, for chained method invocation

  从以下版本开始:

  4.1

• 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 PathResourceResolver is 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

  cache - the cache to use for storing resolved and transformed resources; by default a ConcurrentMapCache is 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 ResourceHandlerRegistration instance, for chained method invocation

  从以下版本开始:

  4.1

• getPathPatterns

  protected String[] getPathPatterns()

  Return the URL path patterns for the resource handler.

• getRequestHandler

  protected ResourceHttpRequestHandler getRequestHandler()

  Return a ResourceHttpRequestHandler instance.