类 ResourceWebHandler

构造器详细资料

• ResourceWebHandler

  public ResourceWebHandler()

方法详细资料

• setLocationValues

  public void setLocationValues​(List<String> locationValues)

  Accepts a list of String-based location values to be resolved into Resource locations.

  从以下版本开始:

  5.1

• getLocationValues

  public List<String> getLocationValues()

  Return the configured location values.

  从以下版本开始:

  5.1

• setLocations

  public void setLocations​(@Nullable
                           List<Resource> locations)

  Set the List of Resource paths to use as sources for serving static resources.

• getLocations

  public List<Resource> getLocations()

  Return the List of Resource paths to use as sources for serving static resources.

  Note that if locationValues are provided, instead of loaded Resource-based locations, this method will return empty until after initialization via afterPropertiesSet().

  另请参阅:

  setLocationValues(java.util.List<java.lang.String>), setLocations(java.util.List<org.springframework.core.io.Resource>)

• setResourceResolvers

  public void setResourceResolvers​(@Nullable
                                   List<ResourceResolver> resourceResolvers)

  Configure the list of ResourceResolvers to use.

  By default PathResourceResolver is configured. If using this property, it is recommended to add PathResourceResolver as the last resolver.

• getResourceResolvers

  public List<ResourceResolver> getResourceResolvers()

  Return the list of configured resource resolvers.

• setResourceTransformers

  public void setResourceTransformers​(@Nullable
                                      List<ResourceTransformer> resourceTransformers)

  Configure the list of ResourceTransformers to use.

  By default no transformers are configured for use.

• getResourceTransformers

  public List<ResourceTransformer> getResourceTransformers()

  Return the list of configured resource transformers.

• setCacheControl

  public void setCacheControl​(@Nullable
                              CacheControl cacheControl)

  Set the CacheControl instance to build the Cache-Control HTTP response header.

• getCacheControl

  @Nullable
  public CacheControl getCacheControl()

  Return the CacheControl instance to build the Cache-Control HTTP response header.

• setResourceHttpMessageWriter

  public void setResourceHttpMessageWriter​(@Nullable
                                           ResourceHttpMessageWriter httpMessageWriter)

  Configure the ResourceHttpMessageWriter to use.

  By default a ResourceHttpMessageWriter will be configured.

• getResourceHttpMessageWriter

  @Nullable
  public ResourceHttpMessageWriter getResourceHttpMessageWriter()

  Return the configured resource message writer.

• setResourceLoader

  public void setResourceLoader​(ResourceLoader resourceLoader)

  Provide the ResourceLoader to load location values with.

  从以下版本开始:

  5.1

• afterPropertiesSet

  public void afterPropertiesSet()
                          throws Exception

  从接口复制的说明: InitializingBean
  Invoked by the containing BeanFactory after it has set all bean properties and satisfied BeanFactoryAware, ApplicationContextAware etc.

  This method allows the bean instance to perform validation of its overall configuration and final initialization when all bean properties have been set.

  指定者:

  afterPropertiesSet 在接口中 InitializingBean

  抛出:

  Exception - in the event of misconfiguration (such as failure to set an essential property) or if initialization fails for any other reason

• initAllowedLocations

  protected void initAllowedLocations()

  Look for a PathResourceResolver among the configured resource resolvers and set its allowedLocations property (if empty) to match the locations configured on this class.

• handle

  public reactor.core.publisher.Mono<Void> handle​(ServerWebExchange exchange)

  Processes a resource request.

  Checks for the existence of the requested resource in the configured list of locations. If the resource does not exist, a 404 response will be returned to the client. If the resource exists, the request will be checked for the presence of the Last-Modified header, and its value will be compared against the last-modified timestamp of the given resource, returning a 304 status code if the Last-Modified value is greater. If the resource is newer than the Last-Modified value, or the header is not present, the content resource of the resource will be written to the response with caching headers set to expire one year in the future.

  指定者:

  handle 在接口中 WebHandler

  参数:

  exchange - the current server exchange

  返回:

  Mono<Void> to indicate when request handling is complete

• getResource

  protected reactor.core.publisher.Mono<Resource> getResource​(ServerWebExchange exchange)

• processPath

  protected String processPath​(String path)

  Process the given resource path.

  The default implementation replaces:

  • Backslash with forward slash.
  • Duplicate occurrences of slash with a single slash.
  • Any combination of leading slash and control characters (00-1F and 7F) with a single "/" or "". For example " / // foo/bar" becomes "/foo/bar".

  从以下版本开始:

  3.2.12

• isInvalidPath

  protected boolean isInvalidPath​(String path)

  Identifies invalid resource paths. By default rejects:

  • Paths that contain "WEB-INF" or "META-INF"
  • Paths that contain "../" after a call to StringUtils.cleanPath(java.lang.String).
  • Paths that represent a valid URL or would represent one after the leading slash is removed.

  Note: this method assumes that leading, duplicate '/' or control characters (e.g. white space) have been trimmed so that the path starts predictably with a single '/' or does not have one.

  参数:

  path - the path to validate

  返回:

  true if the path is invalid, false otherwise

• setHeaders

  protected void setHeaders​(ServerWebExchange exchange,
                            Resource resource,
                            @Nullable
                            MediaType mediaType)
                     throws IOException

  Set headers on the response. Called for both GET and HEAD requests.

  参数:

  exchange - current exchange

  resource - the identified resource (never null)

  mediaType - the resource's media type (never null)

  抛出:

  IOException

• toString

  public String toString()

  覆盖:

  toString 在类中 Object