Skip to content

Commit 2670d94

Browse files
rstoyanchevrstoyanchev
committed
Revert "Update Spring MVC Java config for ResourceResolvers"
This reverts commit f8e1f06.
1 parent 5c62c86 commit 2670d94

File tree

7 files changed

+52
-147
lines changed

7 files changed

+52
-147
lines changed

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

Lines changed: 2 additions & 10 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2013 the original author or authors.
2+
* Copyright 2002-2012 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -111,15 +111,7 @@ public ResourceHandlerRegistration setCachePeriod(Integer cachePeriod) {
111111
* Returns the URL path patterns for the resource handler.
112112
*/
113113
protected String[] getPathPatterns() {
114-
return this.pathPatterns;
115-
}
116-
117-
protected List<ResourceResolver> getResourceResolvers() {
118-
return this.resourceResolvers;
119-
}
120-
121-
protected List<ResourceTransformer> getResourceTransformers() {
122-
return this.resourceTransformers;
114+
return pathPatterns;
123115
}
124116

125117
/**

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

Lines changed: 6 additions & 48 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2013 the original author or authors.
2+
* Copyright 2002-2012 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -17,7 +17,6 @@
1717
package org.springframework.web.servlet.config.annotation;
1818

1919
import java.util.ArrayList;
20-
import java.util.Arrays;
2120
import java.util.LinkedHashMap;
2221
import java.util.List;
2322
import java.util.Map;
@@ -32,8 +31,6 @@
3231
import org.springframework.web.servlet.handler.AbstractHandlerMapping;
3332
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
3433
import org.springframework.web.servlet.resource.ResourceHttpRequestHandler;
35-
import org.springframework.web.servlet.resource.ResourceResolver;
36-
import org.springframework.web.servlet.resource.ResourceTransformer;
3734

3835
/**
3936
* Stores registrations of resource handlers for serving static resources such as images, css files and others
@@ -60,13 +57,8 @@ public class ResourceHandlerRegistry {
6057

6158
private final List<ResourceHandlerRegistration> registrations = new ArrayList<ResourceHandlerRegistration>();
6259

63-
private List<ResourceResolver> resourceResolvers;
64-
65-
private List<ResourceTransformer> resourceTransformers;
66-
6760
private int order = Integer.MAX_VALUE -1;
6861

69-
7062
public ResourceHandlerRegistry(ApplicationContext applicationContext, ServletContext servletContext) {
7163
Assert.notNull(applicationContext, "ApplicationContext is required");
7264
this.applicationContext = applicationContext;
@@ -84,18 +76,6 @@ public ResourceHandlerRegistration addResourceHandler(String... pathPatterns) {
8476
return registration;
8577
}
8678

87-
/**
88-
* Whether a resource handler has already been registered for the given pathPattern.
89-
*/
90-
public boolean hasMappingForPattern(String pathPattern) {
91-
for (ResourceHandlerRegistration registration : registrations) {
92-
if (Arrays.asList(registration.getPathPatterns()).contains(pathPattern)) {
93-
return true;
94-
}
95-
}
96-
return false;
97-
}
98-
9979
/**
10080
* Specify the order to use for resource handling relative to other {@link HandlerMapping}s configured in
10181
* the Spring MVC application context. The default value used is {@code Integer.MAX_VALUE-1}.
@@ -105,22 +85,6 @@ public ResourceHandlerRegistry setOrder(int order) {
10585
return this;
10686
}
10787

108-
/**
109-
* Configure the {@link ResourceResolver}s to use by default in resource handlers that
110-
* don't have them set.
111-
*/
112-
public void setResourceResolvers(List<ResourceResolver> resourceResolvers) {
113-
this.resourceResolvers = resourceResolvers;
114-
}
115-
116-
/**
117-
* Configure the {@link ResourceTransformer}s to use by default in resource handlers
118-
* that don't have them set.
119-
*/
120-
public void setResourceTransformers(List<ResourceTransformer> transformers) {
121-
this.resourceTransformers = transformers;
122-
}
123-
12488
/**
12589
* Return a handler mapping with the mapped resource handlers; or {@code null} in case of no registrations.
12690
*/
@@ -132,22 +96,16 @@ protected AbstractHandlerMapping getHandlerMapping() {
13296
Map<String, HttpRequestHandler> urlMap = new LinkedHashMap<String, HttpRequestHandler>();
13397
for (ResourceHandlerRegistration registration : registrations) {
13498
for (String pathPattern : registration.getPathPatterns()) {
135-
ResourceHttpRequestHandler handler = registration.getRequestHandler();
136-
handler.setServletContext(servletContext);
137-
handler.setApplicationContext(applicationContext);
138-
if ((this.resourceResolvers != null) && (registration.getResourceResolvers() == null)) {
139-
handler.setResourceResolvers(this.resourceResolvers);
140-
}
141-
if ((this.resourceTransformers != null) && (registration.getResourceTransformers() == null)) {
142-
handler.setResourceTransformers(this.resourceTransformers);
143-
}
99+
ResourceHttpRequestHandler requestHandler = registration.getRequestHandler();
100+
requestHandler.setServletContext(servletContext);
101+
requestHandler.setApplicationContext(applicationContext);
144102
try {
145-
handler.afterPropertiesSet();
103+
requestHandler.afterPropertiesSet();
146104
}
147105
catch (Exception e) {
148106
throw new BeanInitializationException("Failed to init ResourceHttpRequestHandler", e);
149107
}
150-
urlMap.put(pathPattern, handler);
108+
urlMap.put(pathPattern, requestHandler);
151109
}
152110
}
153111

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

Lines changed: 2 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -1,5 +1,5 @@
11
/*
2-
* Copyright 2002-2013 the original author or authors.
2+
* Copyright 2002-2012 the original author or authors.
33
*
44
* Licensed under the Apache License, Version 2.0 (the "License");
55
* you may not use this file except in compliance with the License.
@@ -70,7 +70,6 @@
7070
import org.springframework.web.servlet.handler.BeanNameUrlHandlerMapping;
7171
import org.springframework.web.servlet.handler.ConversionServiceExposingInterceptor;
7272
import org.springframework.web.servlet.handler.HandlerExceptionResolverComposite;
73-
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
7473
import org.springframework.web.servlet.mvc.Controller;
7574
import org.springframework.web.servlet.mvc.HttpRequestHandlerAdapter;
7675
import org.springframework.web.servlet.mvc.SimpleControllerHandlerAdapter;
@@ -79,7 +78,6 @@
7978
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerAdapter;
8079
import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
8180
import org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolver;
82-
import org.springframework.web.servlet.resource.ResourceUrlGenerator;
8381

8482
/**
8583
* This is the main class providing the configuration behind the MVC Java config.
@@ -308,23 +306,13 @@ public BeanNameUrlHandlerMapping beanNameHandlerMapping() {
308306
*/
309307
@Bean
310308
public HandlerMapping resourceHandlerMapping() {
311-
ResourceHandlerRegistry registry = new ResourceHandlerRegistry(
312-
this.applicationContext, this.servletContext);
309+
ResourceHandlerRegistry registry = new ResourceHandlerRegistry(applicationContext, servletContext);
313310
addResourceHandlers(registry);
314311
AbstractHandlerMapping handlerMapping = registry.getHandlerMapping();
315312
handlerMapping = handlerMapping != null ? handlerMapping : new EmptyHandlerMapping();
316313
return handlerMapping;
317314
}
318315

319-
/**
320-
* Return a {@link ResourceUrlGenerator} to use to generate URLs for resources.
321-
*/
322-
@Bean
323-
public ResourceUrlGenerator resourceUrlGenerator() {
324-
SimpleUrlHandlerMapping hm = (SimpleUrlHandlerMapping) resourceHandlerMapping();
325-
return new ResourceUrlGenerator(hm.getUrlMap());
326-
}
327-
328316
/**
329317
* Override this method to add resource handlers for serving static resources.
330318
* @see ResourceHandlerRegistry

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

Lines changed: 4 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -83,9 +83,9 @@ public class ResourceHttpRequestHandler extends WebContentGenerator implements H
8383

8484
private List<Resource> locations;
8585

86-
private final List<ResourceResolver> resourceResolvers = new ArrayList<ResourceResolver>();
86+
private List<ResourceResolver> resourceResolvers = new ArrayList<ResourceResolver>();
8787

88-
private final List<ResourceTransformer> resourceTransformers = new ArrayList<ResourceTransformer>();
88+
private List<ResourceTransformer> resourceTransformers = new ArrayList<ResourceTransformer>();
8989

9090

9191
public ResourceHttpRequestHandler() {
@@ -114,24 +114,15 @@ public List<Resource> getLocations() {
114114
* is recommended to add {@link PathResourceResolver} as the last resolver.
115115
*/
116116
public void setResourceResolvers(List<ResourceResolver> resourceResolvers) {
117-
this.resourceResolvers.clear();
118-
if (resourceResolvers != null) {
119-
this.resourceResolvers.addAll(resourceResolvers);
120-
}
117+
this.resourceResolvers = resourceResolvers;
121118
}
122119

123120
public List<ResourceResolver> getResourceResolvers() {
124121
return this.resourceResolvers;
125122
}
126123

127-
/**
128-
* Configure the list of {@link ResourceTransformer}s to use.
129-
*/
130124
public void setResourceTransformers(List<ResourceTransformer> transformers) {
131-
this.resourceTransformers.clear();
132-
if (transformers != null) {
133-
this.resourceTransformers.addAll(transformers);
134-
}
125+
this.resourceTransformers = (transformers != null) ? transformers : new ArrayList<ResourceTransformer>();
135126
}
136127

137128
public List<ResourceTransformer> getResourceTransformers() {

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

Lines changed: 24 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -18,13 +18,11 @@
1818

1919
import java.util.ArrayList;
2020
import java.util.List;
21-
import java.util.Map;
2221
import java.util.Map.Entry;
2322

2423
import org.springframework.core.io.Resource;
25-
import org.springframework.util.AntPathMatcher;
26-
import org.springframework.util.Assert;
2724
import org.springframework.util.PathMatcher;
25+
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
2826

2927

3028
/**
@@ -36,38 +34,39 @@
3634
*
3735
* @author Rossen Stoyanchev
3836
* @since 4.0
39-
* @see ResourceUrlFilter
4037
*/
4138
public class ResourceUrlGenerator {
4239

43-
private final List<ResourceMapping> resourceMappings;
40+
private final List<ResourceMapping> resourceMappings = new ArrayList<ResourceMapping>();
4441

4542

4643
/**
47-
* Create an instance with a Map of resource handlers.
44+
* Configure this instance with the handler mappings used to serve resources. It is
45+
* expected that the handler mapping URL map contains handlers of type
46+
* {@link ResourceHttpRequestHandler}.
4847
*
49-
* @param handlerMap
48+
* @param handlerMappings resource handler mappings
5049
*/
51-
public ResourceUrlGenerator(Map<String, ?> handlerMap) {
52-
Assert.notNull(handlerMap, "handlerMap is required");
53-
this.resourceMappings = initResourceMappings(handlerMap);
54-
}
55-
56-
private static List<ResourceMapping> initResourceMappings(Map<String, ?> handlerMap) {
57-
PathMatcher pathMatcher = new AntPathMatcher();
58-
List<ResourceMapping> result = new ArrayList<ResourceMapping>();
59-
for(Entry<String, ?> entry : handlerMap.entrySet()) {
60-
Object value = entry.getValue();
61-
if (value instanceof ResourceHttpRequestHandler) {
62-
ResourceHttpRequestHandler handler = (ResourceHttpRequestHandler) value;
63-
64-
String pattern = entry.getKey();
65-
List<ResourceResolver> resolvers = handler.getResourceResolvers();
66-
List<Resource> locations = handler.getLocations();
67-
result.add(new ResourceMapping(pattern, pathMatcher, resolvers, locations));
50+
public void setResourceHandlerMappings(List<SimpleUrlHandlerMapping> handlerMappings) {
51+
this.resourceMappings.clear();
52+
if (handlerMappings == null) {
53+
return;
54+
}
55+
for (SimpleUrlHandlerMapping handlerMapping : handlerMappings) {
56+
PathMatcher pathMatcher = handlerMapping.getPathMatcher();
57+
58+
for(Entry<String, ?> entry : handlerMapping.getUrlMap().entrySet()) {
59+
Object value = entry.getValue();
60+
if (value instanceof ResourceHttpRequestHandler) {
61+
ResourceHttpRequestHandler handler = (ResourceHttpRequestHandler) value;
62+
63+
String pattern = entry.getKey();
64+
List<ResourceResolver> resolvers = handler.getResourceResolvers();
65+
List<Resource> locations = handler.getLocations();
66+
this.resourceMappings.add(new ResourceMapping(pattern, pathMatcher, resolvers, locations));
67+
}
6868
}
6969
}
70-
return result;
7170
}
7271

7372
/**

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

Lines changed: 2 additions & 30 deletions
Original file line numberDiff line numberDiff line change
@@ -16,23 +16,18 @@
1616

1717
package org.springframework.web.servlet.config.annotation;
1818

19-
import java.util.Arrays;
20-
import java.util.List;
19+
import static org.junit.Assert.assertEquals;
20+
import static org.junit.Assert.assertNull;
2121

2222
import org.junit.Before;
2323
import org.junit.Test;
24-
import org.mockito.Mockito;
2524
import org.springframework.mock.web.test.MockHttpServletRequest;
2625
import org.springframework.mock.web.test.MockHttpServletResponse;
2726
import org.springframework.mock.web.test.MockServletContext;
2827
import org.springframework.web.context.support.GenericWebApplicationContext;
2928
import org.springframework.web.servlet.HandlerMapping;
3029
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
3130
import org.springframework.web.servlet.resource.ResourceHttpRequestHandler;
32-
import org.springframework.web.servlet.resource.ResourceResolver;
33-
import org.springframework.web.servlet.resource.ResourceTransformer;
34-
35-
import static org.junit.Assert.*;
3631

3732
/**
3833
* Test fixture with a {@link ResourceHandlerRegistry}.
@@ -89,29 +84,6 @@ public void order() {
8984
assertEquals(0, registry.getHandlerMapping().getOrder());
9085
}
9186

92-
@Test
93-
public void hasMappingForPattern() {
94-
assertTrue(registry.hasMappingForPattern("/resources/**"));
95-
assertFalse(registry.hasMappingForPattern("/whatever"));
96-
}
97-
98-
@Test
99-
public void resourceResolversAndTransformers() {
100-
ResourceResolver resolver = Mockito.mock(ResourceResolver.class);
101-
List<ResourceResolver> resolvers = Arrays.<ResourceResolver>asList(resolver);
102-
registry.setResourceResolvers(resolvers);
103-
104-
ResourceTransformer transformer = Mockito.mock(ResourceTransformer.class);
105-
List<ResourceTransformer> transformers = Arrays.asList(transformer);
106-
registry.setResourceTransformers(transformers);
107-
108-
SimpleUrlHandlerMapping hm = (SimpleUrlHandlerMapping) registry.getHandlerMapping();
109-
ResourceHttpRequestHandler handler = (ResourceHttpRequestHandler) hm.getUrlMap().values().iterator().next();
110-
111-
assertEquals(resolvers, handler.getResourceResolvers());
112-
assertEquals(transformers, handler.getResourceTransformers());
113-
}
114-
11587
private ResourceHttpRequestHandler getHandler(String pathPattern) {
11688
SimpleUrlHandlerMapping handlerMapping = (SimpleUrlHandlerMapping) registry.getHandlerMapping();
11789
return (ResourceHttpRequestHandler) handlerMapping.getUrlMap().get(pathPattern);

0 commit comments

Comments
 (0)