Browse Source

Revert "Update Spring MVC Java config for ResourceResolvers"

This reverts commit f8e1f06d08.
pull/374/head
Rossen Stoyanchev 13 years ago
parent
commit
2670d94c6a
  1. 12
      spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/ResourceHandlerRegistration.java
  2. 54
      spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/ResourceHandlerRegistry.java
  3. 16
      spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java
  4. 17
      spring-webmvc/src/main/java/org/springframework/web/servlet/resource/ResourceHttpRequestHandler.java
  5. 49
      spring-webmvc/src/main/java/org/springframework/web/servlet/resource/ResourceUrlGenerator.java
  6. 32
      spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/ResourceHandlerRegistryTests.java
  7. 19
      spring-webmvc/src/test/java/org/springframework/web/servlet/resource/ResourceUrlGeneratorTests.java

12
spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/ResourceHandlerRegistration.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2013 the original author or authors. * Copyright 2002-2012 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -111,15 +111,7 @@ public class ResourceHandlerRegistration {
* Returns the URL path patterns for the resource handler. * Returns the URL path patterns for the resource handler.
*/ */
protected String[] getPathPatterns() { protected String[] getPathPatterns() {
return this.pathPatterns; return pathPatterns;
}
protected List<ResourceResolver> getResourceResolvers() {
return this.resourceResolvers;
}
protected List<ResourceTransformer> getResourceTransformers() {
return this.resourceTransformers;
} }
/** /**

54
spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/ResourceHandlerRegistry.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2013 the original author or authors. * Copyright 2002-2012 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -17,7 +17,6 @@
package org.springframework.web.servlet.config.annotation; package org.springframework.web.servlet.config.annotation;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Arrays;
import java.util.LinkedHashMap; import java.util.LinkedHashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
@ -32,8 +31,6 @@ import org.springframework.web.servlet.HandlerMapping;
import org.springframework.web.servlet.handler.AbstractHandlerMapping; import org.springframework.web.servlet.handler.AbstractHandlerMapping;
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping; import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
import org.springframework.web.servlet.resource.ResourceHttpRequestHandler; import org.springframework.web.servlet.resource.ResourceHttpRequestHandler;
import org.springframework.web.servlet.resource.ResourceResolver;
import org.springframework.web.servlet.resource.ResourceTransformer;
/** /**
* Stores registrations of resource handlers for serving static resources such as images, css files and others * Stores registrations of resource handlers for serving static resources such as images, css files and others
@ -60,13 +57,8 @@ public class ResourceHandlerRegistry {
private final List<ResourceHandlerRegistration> registrations = new ArrayList<ResourceHandlerRegistration>(); private final List<ResourceHandlerRegistration> registrations = new ArrayList<ResourceHandlerRegistration>();
private List<ResourceResolver> resourceResolvers;
private List<ResourceTransformer> resourceTransformers;
private int order = Integer.MAX_VALUE -1; private int order = Integer.MAX_VALUE -1;
public ResourceHandlerRegistry(ApplicationContext applicationContext, ServletContext servletContext) { public ResourceHandlerRegistry(ApplicationContext applicationContext, ServletContext servletContext) {
Assert.notNull(applicationContext, "ApplicationContext is required"); Assert.notNull(applicationContext, "ApplicationContext is required");
this.applicationContext = applicationContext; this.applicationContext = applicationContext;
@ -84,18 +76,6 @@ public class ResourceHandlerRegistry {
return registration; return registration;
} }
/**
* Whether a resource handler has already been registered for the given pathPattern.
*/
public boolean hasMappingForPattern(String pathPattern) {
for (ResourceHandlerRegistration registration : registrations) {
if (Arrays.asList(registration.getPathPatterns()).contains(pathPattern)) {
return true;
}
}
return false;
}
/** /**
* Specify the order to use for resource handling relative to other {@link HandlerMapping}s configured in * Specify the order to use for resource handling relative to other {@link HandlerMapping}s configured in
* the Spring MVC application context. The default value used is {@code Integer.MAX_VALUE-1}. * the Spring MVC application context. The default value used is {@code Integer.MAX_VALUE-1}.
@ -105,22 +85,6 @@ public class ResourceHandlerRegistry {
return this; return this;
} }
/**
* Configure the {@link ResourceResolver}s to use by default in resource handlers that
* don't have them set.
*/
public void setResourceResolvers(List<ResourceResolver> resourceResolvers) {
this.resourceResolvers = resourceResolvers;
}
/**
* Configure the {@link ResourceTransformer}s to use by default in resource handlers
* that don't have them set.
*/
public void setResourceTransformers(List<ResourceTransformer> transformers) {
this.resourceTransformers = transformers;
}
/** /**
* Return a handler mapping with the mapped resource handlers; or {@code null} in case of no registrations. * Return a handler mapping with the mapped resource handlers; or {@code null} in case of no registrations.
*/ */
@ -132,22 +96,16 @@ public class ResourceHandlerRegistry {
Map<String, HttpRequestHandler> urlMap = new LinkedHashMap<String, HttpRequestHandler>(); Map<String, HttpRequestHandler> urlMap = new LinkedHashMap<String, HttpRequestHandler>();
for (ResourceHandlerRegistration registration : registrations) { for (ResourceHandlerRegistration registration : registrations) {
for (String pathPattern : registration.getPathPatterns()) { for (String pathPattern : registration.getPathPatterns()) {
ResourceHttpRequestHandler handler = registration.getRequestHandler(); ResourceHttpRequestHandler requestHandler = registration.getRequestHandler();
handler.setServletContext(servletContext); requestHandler.setServletContext(servletContext);
handler.setApplicationContext(applicationContext); requestHandler.setApplicationContext(applicationContext);
if ((this.resourceResolvers != null) && (registration.getResourceResolvers() == null)) {
handler.setResourceResolvers(this.resourceResolvers);
}
if ((this.resourceTransformers != null) && (registration.getResourceTransformers() == null)) {
handler.setResourceTransformers(this.resourceTransformers);
}
try { try {
handler.afterPropertiesSet(); requestHandler.afterPropertiesSet();
} }
catch (Exception e) { catch (Exception e) {
throw new BeanInitializationException("Failed to init ResourceHttpRequestHandler", e); throw new BeanInitializationException("Failed to init ResourceHttpRequestHandler", e);
} }
urlMap.put(pathPattern, handler); urlMap.put(pathPattern, requestHandler);
} }
} }

16
spring-webmvc/src/main/java/org/springframework/web/servlet/config/annotation/WebMvcConfigurationSupport.java

@ -1,5 +1,5 @@
/* /*
* Copyright 2002-2013 the original author or authors. * Copyright 2002-2012 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@ -70,7 +70,6 @@ import org.springframework.web.servlet.handler.AbstractHandlerMapping;
import org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping; import org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping;
import org.springframework.web.servlet.handler.ConversionServiceExposingInterceptor; import org.springframework.web.servlet.handler.ConversionServiceExposingInterceptor;
import org.springframework.web.servlet.handler.HandlerExceptionResolverComposite; import org.springframework.web.servlet.handler.HandlerExceptionResolverComposite;
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
import org.springframework.web.servlet.mvc.Controller; import org.springframework.web.servlet.mvc.Controller;
import org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter; import org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter;
import org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter; import org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter;
@ -79,7 +78,6 @@ import org.springframework.web.servlet.mvc.method.annotation.ExceptionHandlerExc
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter; import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping; import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
import org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver; import org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver;
import org.springframework.web.servlet.resource.ResourceUrlGenerator;
/** /**
* This is the main class providing the configuration behind the MVC Java config. * This is the main class providing the configuration behind the MVC Java config.
@ -308,23 +306,13 @@ public class WebMvcConfigurationSupport implements ApplicationContextAware, Serv
*/ */
@Bean @Bean
public HandlerMapping resourceHandlerMapping() { public HandlerMapping resourceHandlerMapping() {
ResourceHandlerRegistry registry = new ResourceHandlerRegistry( ResourceHandlerRegistry registry = new ResourceHandlerRegistry(applicationContext, servletContext);
this.applicationContext, this.servletContext);
addResourceHandlers(registry); addResourceHandlers(registry);
AbstractHandlerMapping handlerMapping = registry.getHandlerMapping(); AbstractHandlerMapping handlerMapping = registry.getHandlerMapping();
handlerMapping = handlerMapping != null ? handlerMapping : new EmptyHandlerMapping(); handlerMapping = handlerMapping != null ? handlerMapping : new EmptyHandlerMapping();
return handlerMapping; return handlerMapping;
} }
/**
* Return a {@link ResourceUrlGenerator} to use to generate URLs for resources.
*/
@Bean
public ResourceUrlGenerator resourceUrlGenerator() {
SimpleUrlHandlerMapping hm = (SimpleUrlHandlerMapping) resourceHandlerMapping();
return new ResourceUrlGenerator(hm.getUrlMap());
}
/** /**
* Override this method to add resource handlers for serving static resources. * Override this method to add resource handlers for serving static resources.
* @see ResourceHandlerRegistry * @see ResourceHandlerRegistry

17
spring-webmvc/src/main/java/org/springframework/web/servlet/resource/ResourceHttpRequestHandler.java

@ -83,9 +83,9 @@ public class ResourceHttpRequestHandler extends WebContentGenerator implements H
private List<Resource> locations; private List<Resource> locations;
private final List<ResourceResolver> resourceResolvers = new ArrayList<ResourceResolver>(); private List<ResourceResolver> resourceResolvers = new ArrayList<ResourceResolver>();
private final List<ResourceTransformer> resourceTransformers = new ArrayList<ResourceTransformer>(); private List<ResourceTransformer> resourceTransformers = new ArrayList<ResourceTransformer>();
public ResourceHttpRequestHandler() { public ResourceHttpRequestHandler() {
@ -114,24 +114,15 @@ public class ResourceHttpRequestHandler extends WebContentGenerator implements H
* is recommended to add {@link PathResourceResolver} as the last resolver. * is recommended to add {@link PathResourceResolver} as the last resolver.
*/ */
public void setResourceResolvers(List<ResourceResolver> resourceResolvers) { public void setResourceResolvers(List<ResourceResolver> resourceResolvers) {
this.resourceResolvers.clear(); this.resourceResolvers = resourceResolvers;
if (resourceResolvers != null) {
this.resourceResolvers.addAll(resourceResolvers);
}
} }
public List<ResourceResolver> getResourceResolvers() { public List<ResourceResolver> getResourceResolvers() {
return this.resourceResolvers; return this.resourceResolvers;
} }
/**
* Configure the list of {@link ResourceTransformer}s to use.
*/
public void setResourceTransformers(List<ResourceTransformer> transformers) { public void setResourceTransformers(List<ResourceTransformer> transformers) {
this.resourceTransformers.clear(); this.resourceTransformers = (transformers != null) ? transformers : new ArrayList<ResourceTransformer>();
if (transformers != null) {
this.resourceTransformers.addAll(transformers);
}
} }
public List<ResourceTransformer> getResourceTransformers() { public List<ResourceTransformer> getResourceTransformers() {

49
spring-webmvc/src/main/java/org/springframework/web/servlet/resource/ResourceUrlGenerator.java

@ -18,13 +18,11 @@ package org.springframework.web.servlet.resource;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.List; import java.util.List;
import java.util.Map;
import java.util.Map.Entry; import java.util.Map.Entry;
import org.springframework.core.io.Resource; import org.springframework.core.io.Resource;
import org.springframework.util.AntPathMatcher;
import org.springframework.util.Assert;
import org.springframework.util.PathMatcher; import org.springframework.util.PathMatcher;
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
/** /**
@ -36,38 +34,39 @@ import org.springframework.util.PathMatcher;
* *
* @author Rossen Stoyanchev * @author Rossen Stoyanchev
* @since 4.0 * @since 4.0
* @see ResourceUrlFilter
*/ */
public class ResourceUrlGenerator { public class ResourceUrlGenerator {
private final List<ResourceMapping> resourceMappings; private final List<ResourceMapping> resourceMappings = new ArrayList<ResourceMapping>();
/** /**
* Create an instance with a Map of resource handlers. * Configure this instance with the handler mappings used to serve resources. It is
* expected that the handler mapping URL map contains handlers of type
* {@link ResourceHttpRequestHandler}.
* *
* @param handlerMap * @param handlerMappings resource handler mappings
*/ */
public ResourceUrlGenerator(Map<String, ?> handlerMap) { public void setResourceHandlerMappings(List<SimpleUrlHandlerMapping> handlerMappings) {
Assert.notNull(handlerMap, "handlerMap is required"); this.resourceMappings.clear();
this.resourceMappings = initResourceMappings(handlerMap); if (handlerMappings == null) {
} return;
}
private static List<ResourceMapping> initResourceMappings(Map<String, ?> handlerMap) { for (SimpleUrlHandlerMapping handlerMapping : handlerMappings) {
PathMatcher pathMatcher = new AntPathMatcher(); PathMatcher pathMatcher = handlerMapping.getPathMatcher();
List<ResourceMapping> result = new ArrayList<ResourceMapping>();
for(Entry<String, ?> entry : handlerMap.entrySet()) { for(Entry<String, ?> entry : handlerMapping.getUrlMap().entrySet()) {
Object value = entry.getValue(); Object value = entry.getValue();
if (value instanceof ResourceHttpRequestHandler) { if (value instanceof ResourceHttpRequestHandler) {
ResourceHttpRequestHandler handler = (ResourceHttpRequestHandler) value; ResourceHttpRequestHandler handler = (ResourceHttpRequestHandler) value;
String pattern = entry.getKey(); String pattern = entry.getKey();
List<ResourceResolver> resolvers = handler.getResourceResolvers(); List<ResourceResolver> resolvers = handler.getResourceResolvers();
List<Resource> locations = handler.getLocations(); List<Resource> locations = handler.getLocations();
result.add(new ResourceMapping(pattern, pathMatcher, resolvers, locations)); this.resourceMappings.add(new ResourceMapping(pattern, pathMatcher, resolvers, locations));
}
} }
} }
return result;
} }
/** /**

32
spring-webmvc/src/test/java/org/springframework/web/servlet/config/annotation/ResourceHandlerRegistryTests.java

@ -16,12 +16,11 @@
package org.springframework.web.servlet.config.annotation; package org.springframework.web.servlet.config.annotation;
import java.util.Arrays; import static org.junit.Assert.assertEquals;
import java.util.List; import static org.junit.Assert.assertNull;
import org.junit.Before; import org.junit.Before;
import org.junit.Test; import org.junit.Test;
import org.mockito.Mockito;
import org.springframework.mock.web.test.MockHttpServletRequest; import org.springframework.mock.web.test.MockHttpServletRequest;
import org.springframework.mock.web.test.MockHttpServletResponse; import org.springframework.mock.web.test.MockHttpServletResponse;
import org.springframework.mock.web.test.MockServletContext; import org.springframework.mock.web.test.MockServletContext;
@ -29,10 +28,6 @@ import org.springframework.web.context.support.GenericWebApplicationContext;
import org.springframework.web.servlet.HandlerMapping; import org.springframework.web.servlet.HandlerMapping;
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping; import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
import org.springframework.web.servlet.resource.ResourceHttpRequestHandler; import org.springframework.web.servlet.resource.ResourceHttpRequestHandler;
import org.springframework.web.servlet.resource.ResourceResolver;
import org.springframework.web.servlet.resource.ResourceTransformer;
import static org.junit.Assert.*;
/** /**
* Test fixture with a {@link ResourceHandlerRegistry}. * Test fixture with a {@link ResourceHandlerRegistry}.
@ -89,29 +84,6 @@ public class ResourceHandlerRegistryTests {
assertEquals(0, registry.getHandlerMapping().getOrder()); assertEquals(0, registry.getHandlerMapping().getOrder());
} }
@Test
public void hasMappingForPattern() {
assertTrue(registry.hasMappingForPattern("/resources/**"));
assertFalse(registry.hasMappingForPattern("/whatever"));
}
@Test
public void resourceResolversAndTransformers() {
ResourceResolver resolver = Mockito.mock(ResourceResolver.class);
List<ResourceResolver> resolvers = Arrays.<ResourceResolver>asList(resolver);
registry.setResourceResolvers(resolvers);
ResourceTransformer transformer = Mockito.mock(ResourceTransformer.class);
List<ResourceTransformer> transformers = Arrays.asList(transformer);
registry.setResourceTransformers(transformers);
SimpleUrlHandlerMapping hm = (SimpleUrlHandlerMapping) registry.getHandlerMapping();
ResourceHttpRequestHandler handler = (ResourceHttpRequestHandler) hm.getUrlMap().values().iterator().next();
assertEquals(resolvers, handler.getResourceResolvers());
assertEquals(transformers, handler.getResourceTransformers());
}
private ResourceHttpRequestHandler getHandler(String pathPattern) { private ResourceHttpRequestHandler getHandler(String pathPattern) {
SimpleUrlHandlerMapping handlerMapping = (SimpleUrlHandlerMapping) registry.getHandlerMapping(); SimpleUrlHandlerMapping handlerMapping = (SimpleUrlHandlerMapping) registry.getHandlerMapping();
return (ResourceHttpRequestHandler) handlerMapping.getUrlMap().get(pathPattern); return (ResourceHttpRequestHandler) handlerMapping.getUrlMap().get(pathPattern);

19
spring-webmvc/src/test/java/org/springframework/web/servlet/resource/ResourceUrlGeneratorTests.java

@ -17,6 +17,7 @@
package org.springframework.web.servlet.resource; package org.springframework.web.servlet.resource;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collections;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
@ -25,6 +26,7 @@ import org.junit.Before;
import org.junit.Test; import org.junit.Test;
import org.springframework.core.io.ClassPathResource; import org.springframework.core.io.ClassPathResource;
import org.springframework.core.io.Resource; import org.springframework.core.io.Resource;
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
import static org.junit.Assert.*; import static org.junit.Assert.*;
@ -36,9 +38,9 @@ import static org.junit.Assert.*;
*/ */
public class ResourceUrlGeneratorTests { public class ResourceUrlGeneratorTests {
private ResourceHttpRequestHandler handler; ResourceHttpRequestHandler handler;
private Map<String, ResourceHttpRequestHandler> handlerMap; SimpleUrlHandlerMapping mapping;
ResourceUrlGenerator generator; ResourceUrlGenerator generator;
@ -49,15 +51,18 @@ public class ResourceUrlGeneratorTests {
locations.add(new ClassPathResource("test/", getClass())); locations.add(new ClassPathResource("test/", getClass()));
locations.add(new ClassPathResource("testalternatepath/", getClass())); locations.add(new ClassPathResource("testalternatepath/", getClass()));
this.handler = new ResourceHttpRequestHandler(); Map<String, ResourceHttpRequestHandler> urlMap = new HashMap<String, ResourceHttpRequestHandler>();
this.handler.setLocations(locations); handler = new ResourceHttpRequestHandler();
handler.setLocations(locations);
urlMap.put("/resources/**", handler);
this.handlerMap = new HashMap<String, ResourceHttpRequestHandler>(); mapping = new SimpleUrlHandlerMapping();
this.handlerMap.put("/resources/**", handler); mapping.setUrlMap(urlMap);
} }
private void initGenerator() { private void initGenerator() {
this.generator = new ResourceUrlGenerator(handlerMap); generator = new ResourceUrlGenerator();
generator.setResourceHandlerMappings(Collections.singletonList(this.mapping));
} }
@Test @Test

Loading…
Cancel
Save