类 ResourceHttpRequestHandler

构造器详细资料

• ResourceHttpRequestHandler

  public ResourceHttpRequestHandler()

方法详细资料

• setLocationValues

  public void setLocationValues​(List<String> locationValues)

  An alternative to setLocations(List) that accepts a list of String-based location values, with support for UrlResource's (e.g. files or HTTP URLs) with a special prefix to indicate the charset to use when appending relative paths. For example "[charset=Windows-31J]https://example.org/path".

  从以下版本开始:

  4.3.13

• setLocations

  public void setLocations​(List<Resource> locations)

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

  另请参阅:

  setLocationValues(List)

• getLocations

  public List<Resource> getLocations()

  Return the configured List of Resource locations.

  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.

• setResourceHttpMessageConverter

  public void setResourceHttpMessageConverter​(@Nullable
                                              ResourceHttpMessageConverter messageConverter)

  Configure the ResourceHttpMessageConverter to use.

  By default a ResourceHttpMessageConverter will be configured.

  从以下版本开始:

  4.3

• getResourceHttpMessageConverter

  @Nullable
  public ResourceHttpMessageConverter getResourceHttpMessageConverter()

  Return the configured resource converter.

  从以下版本开始:

  4.3

• setResourceRegionHttpMessageConverter

  public void setResourceRegionHttpMessageConverter​(@Nullable
                                                    ResourceRegionHttpMessageConverter messageConverter)

  Configure the ResourceRegionHttpMessageConverter to use.

  By default a ResourceRegionHttpMessageConverter will be configured.

  从以下版本开始:

  4.3

• getResourceRegionHttpMessageConverter

  @Nullable
  public ResourceRegionHttpMessageConverter getResourceRegionHttpMessageConverter()

  Return the configured resource region converter.

  从以下版本开始:

  4.3

• setContentNegotiationManager

  @Deprecated
  public void setContentNegotiationManager​(@Nullable
                                           ContentNegotiationManager contentNegotiationManager)

  已过时。

  as of 5.2.4 in favor of using setMediaTypes(Map) with mappings possibly obtained from ContentNegotiationManager.getMediaTypeMappings().
  Configure a ContentNegotiationManager to help determine the media types for resources being served. If the manager contains a path extension strategy it will be checked for registered file extension.

  从以下版本开始:

  4.3

• getContentNegotiationManager

  @Nullable
  @Deprecated
  public ContentNegotiationManager getContentNegotiationManager()

  已过时。

  as of 5.2.4.
  Return the configured content negotiation manager.

  从以下版本开始:

  4.3

• setMediaTypes

  public void setMediaTypes​(Map<String,​MediaType> mediaTypes)

  Add mappings between file extensions, extracted from the filename of a static Resource, and corresponding media type to set on the response.

  Use of this method is typically not necessary since mappings are otherwise determined via ServletContext.getMimeType(String) or via MediaTypeFactory.getMediaType(Resource).

  参数:

  mediaTypes - media type mappings

  从以下版本开始:

  5.2.4

• getMediaTypes

  public Map<String,​MediaType> getMediaTypes()

  Return the configured media types.

  从以下版本开始:

  5.2.4

• setCorsConfiguration

  public void setCorsConfiguration​(CorsConfiguration corsConfiguration)

  Specify the CORS configuration for resources served by this handler.

  By default this is not set in which allows cross-origin requests.

• getCorsConfiguration

  @Nullable
  public CorsConfiguration getCorsConfiguration​(HttpServletRequest request)

  Return the specified CORS configuration.

  指定者:

  getCorsConfiguration 在接口中 CorsConfigurationSource

  返回:

  the associated CorsConfiguration, or null if none

• setUrlPathHelper

  public void setUrlPathHelper​(@Nullable
                               UrlPathHelper urlPathHelper)

  Provide a reference to the UrlPathHelper used to map requests to static resources. This helps to derive information about the lookup path such as whether it is decoded or not.

  从以下版本开始:

  4.3.13

• getUrlPathHelper

  @Nullable
  public UrlPathHelper getUrlPathHelper()

  The configured UrlPathHelper.

  从以下版本开始:

  4.3.13

• setEmbeddedValueResolver

  public void setEmbeddedValueResolver​(StringValueResolver resolver)

  从接口复制的说明: EmbeddedValueResolverAware
  Set the StringValueResolver to use for resolving embedded definition values.

  指定者:

  setEmbeddedValueResolver 在接口中 EmbeddedValueResolverAware

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

• initContentNegotiationStrategy

  @Nullable
  @Deprecated
  protected PathExtensionContentNegotiationStrategy initContentNegotiationStrategy()

  已过时。

  as of 5.2.4 this method returns null, and if a sub-class returns an actual instance,the instance is used only as a source of media type mappings, if it contains any. Please, use setMediaTypes(Map) instead, or if you need to change behavior, you can override getMediaType(HttpServletRequest, Resource).
  Initialize the strategy to use to determine the media type for a resource.

• handleRequest

  public void handleRequest​(HttpServletRequest request,
                            HttpServletResponse response)
                     throws ServletException,
                            IOException

  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.

  指定者:

  handleRequest 在接口中 HttpRequestHandler

  参数:

  request - current HTTP request

  response - current HTTP response

  抛出:

  ServletException - in case of general errors

  IOException - in case of I/O errors

• getResource

  @Nullable
  protected Resource getResource​(HttpServletRequest request)
                          throws IOException

  抛出:

  IOException

• 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

  从以下版本开始:

  3.0.6

• getMediaType

  @Nullable
  protected MediaType getMediaType​(HttpServletRequest request,
                                   Resource resource)

  Determine the media type for the given request and the resource matched to it. This implementation tries to determine the MediaType using one of the following lookups based on the resource filename and its path extension:

  1. ServletContext.getMimeType(String)
  2. getMediaTypes()
  3. MediaTypeFactory.getMediaType(String)

  参数:

  request - the current request

  resource - the resource to check

  返回:

  the corresponding media type, or null if none found

• setHeaders

  protected void setHeaders​(HttpServletResponse response,
                            Resource resource,
                            @Nullable
                            MediaType mediaType)
                     throws IOException

  Set headers on the given servlet response. Called for GET requests as well as HEAD requests.

  参数:

  response - current servlet response

  resource - the identified resource (never null)

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

  抛出:

  IOException - in case of errors while setting the headers

• toString

  public String toString()

  覆盖:

  toString 在类中 Object