Refactor Resource URL generation and Servlet Filter
Renamed ResourceUrlMapper to ResourceUrlGenerator and refactored it to be configured with Resource-serving HandlerMappings as opposed to having them detected in the ApplicationContext through the BeanPostProcessor contact. Renamed and polished ResourceUrlEncodingFilter to ResourceUrlFilter and added tests.
This commit is contained in:
Rossen Stoyanchev
@@ -0,0 +1,154 @@
|
||||
/*
|
||||
* Copyright 2002-2013 the original author or authors.
|
||||
*
|
||||
* Licensed under the Apache License, Version 2.0 (the "License");
|
||||
* you may not use this file except in compliance with the License.
|
||||
* You may obtain a copy of the License at
|
||||
*
|
||||
* http://www.apache.org/licenses/LICENSE-2.0
|
||||
*
|
||||
* Unless required by applicable law or agreed to in writing, software
|
||||
* distributed under the License is distributed on an "AS IS" BASIS,
|
||||
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
|
||||
* See the License for the specific language governing permissions and
|
||||
* limitations under the License.
|
||||
*/
|
||||
|
||||
package org.springframework.web.servlet.resource;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.List;
|
||||
|
||||
import javax.servlet.ServletException;
|
||||
import javax.servlet.http.HttpServlet;
|
||||
import javax.servlet.http.HttpServletRequest;
|
||||
import javax.servlet.http.HttpServletResponse;
|
||||
|
||||
import org.junit.Test;
|
||||
import org.springframework.context.annotation.Bean;
|
||||
import org.springframework.context.annotation.Configuration;
|
||||
import org.springframework.mock.web.test.MockFilterChain;
|
||||
import org.springframework.mock.web.test.MockHttpServletRequest;
|
||||
import org.springframework.mock.web.test.MockHttpServletResponse;
|
||||
import org.springframework.mock.web.test.MockServletContext;
|
||||
import org.springframework.web.context.WebApplicationContext;
|
||||
import org.springframework.web.context.support.AnnotationConfigWebApplicationContext;
|
||||
import org.springframework.web.servlet.config.annotation.ResourceHandlerRegistry;
|
||||
import org.springframework.web.servlet.config.annotation.WebMvcConfigurationSupport;
|
||||
import org.springframework.web.servlet.handler.SimpleUrlHandlerMapping;
|
||||
|
||||
import static org.junit.Assert.*;
|
||||
|
||||
|
||||
/**
|
||||
*
|
||||
* @author Rossen Stoyanchev
|
||||
*/
|
||||
public class ResourceUrlFilterTests {
|
||||
|
||||
private MockFilterChain filterChain;
|
||||
|
||||
private TestServlet servlet;
|
||||
|
||||
|
||||
@Test
|
||||
public void rootServletMapping() throws Exception {
|
||||
|
||||
initFilterChain(WebConfig.class);
|
||||
|
||||
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/");
|
||||
request.setRequestURI("/myapp/index.html");
|
||||
request.setContextPath("/myapp");
|
||||
request.setServletPath("/index.html");
|
||||
this.filterChain.doFilter(request, new MockHttpServletResponse());
|
||||
|
||||
String actual = this.servlet.response.encodeURL("/myapp/resources/foo.css");
|
||||
assertEquals("/myapp/resources/foo-e36d2e05253c6c7085a91522ce43a0b4.css", actual);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void prefixServletMapping() throws Exception {
|
||||
|
||||
initFilterChain(WebConfig.class);
|
||||
|
||||
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/");
|
||||
request.setRequestURI("/myapp/myservlet/index.html");
|
||||
request.setContextPath("/myapp");
|
||||
request.setServletPath("/myservlet");
|
||||
this.filterChain.doFilter(request, new MockHttpServletResponse());
|
||||
|
||||
String actual = this.servlet.response.encodeURL("/myapp/myservlet/resources/foo.css");
|
||||
assertEquals("/myapp/myservlet/resources/foo-e36d2e05253c6c7085a91522ce43a0b4.css", actual);
|
||||
}
|
||||
|
||||
@Test
|
||||
public void extensionServletMapping() throws Exception {
|
||||
|
||||
initFilterChain(WebConfig.class);
|
||||
|
||||
MockHttpServletRequest request = new MockHttpServletRequest("GET", "/");
|
||||
request.setRequestURI("/myapp/index.html");
|
||||
request.setContextPath("/myapp");
|
||||
request.setServletPath("/index.html");
|
||||
this.filterChain.doFilter(request, new MockHttpServletResponse());
|
||||
|
||||
String actual = this.servlet.response.encodeURL("/myapp/resources/foo.css");
|
||||
assertEquals("/myapp/resources/foo-e36d2e05253c6c7085a91522ce43a0b4.css", actual);
|
||||
}
|
||||
|
||||
private void initFilterChain(Class<?> configClass) throws ServletException {
|
||||
|
||||
MockServletContext servletContext = new MockServletContext();
|
||||
|
||||
AnnotationConfigWebApplicationContext cxt = new AnnotationConfigWebApplicationContext();
|
||||
cxt.setServletContext(servletContext);
|
||||
cxt.register(configClass);
|
||||
cxt.refresh();
|
||||
|
||||
servletContext.setAttribute(WebApplicationContext.ROOT_WEB_APPLICATION_CONTEXT_ATTRIBUTE, cxt);
|
||||
|
||||
ResourceUrlFilter filter = new ResourceUrlFilter();
|
||||
filter.setServletContext(servletContext);
|
||||
filter.initFilterBean();
|
||||
|
||||
this.servlet = new TestServlet();
|
||||
this.filterChain = new MockFilterChain(servlet, filter);
|
||||
}
|
||||
|
||||
|
||||
@Configuration
|
||||
static class WebConfig extends WebMvcConfigurationSupport {
|
||||
|
||||
@Override
|
||||
public void addResourceHandlers(ResourceHandlerRegistry registry) {
|
||||
|
||||
List<ResourceResolver> resourceResolvers = new ArrayList<>();
|
||||
resourceResolvers.add(new FingerprintResourceResolver());
|
||||
resourceResolvers.add(new PathResourceResolver());
|
||||
|
||||
registry.addResourceHandler("/resources/**")
|
||||
.addResourceLocations("classpath:org/springframework/web/servlet/resource/test/")
|
||||
.setResourceResolvers(resourceResolvers);
|
||||
}
|
||||
|
||||
@Bean
|
||||
public ResourceUrlGenerator resourceUrlGenerator() {
|
||||
ResourceUrlGenerator generator = new ResourceUrlGenerator();
|
||||
SimpleUrlHandlerMapping handlerMapping = (SimpleUrlHandlerMapping) resourceHandlerMapping();
|
||||
generator.setResourceHandlerMappings(Collections.singletonList(handlerMapping));
|
||||
return generator;
|
||||
}
|
||||
}
|
||||
|
||||
private static class TestServlet extends HttpServlet {
|
||||
|
||||
private HttpServletResponse response;
|
||||
|
||||
@Override
|
||||
protected void doGet(HttpServletRequest request, HttpServletResponse response) {
|
||||
this.response = response;
|
||||
}
|
||||
}
|
||||
|
||||
}
|
||||
@@ -17,6 +17,7 @@
|
||||
package org.springframework.web.servlet.resource;
|
||||
|
||||
import java.util.ArrayList;
|
||||
import java.util.Collections;
|
||||
import java.util.HashMap;
|
||||
import java.util.List;
|
||||
import java.util.Map;
|
||||
@@ -33,41 +34,42 @@ import static org.junit.Assert.*;
|
||||
/**
|
||||
*
|
||||
* @author Jeremy Grelle
|
||||
* @author Rossen Stoyanchev
|
||||
*/
|
||||
public class ResourceUrlMapperTests {
|
||||
public class ResourceUrlGeneratorTests {
|
||||
|
||||
ResourceHttpRequestHandler handler;
|
||||
|
||||
SimpleUrlHandlerMapping mapping;
|
||||
|
||||
ResourceUrlMapper mapper;
|
||||
ResourceUrlGenerator generator;
|
||||
|
||||
|
||||
@Before
|
||||
public void setUp() {
|
||||
List<Resource> resourcePaths = new ArrayList<Resource>();
|
||||
resourcePaths.add(new ClassPathResource("test/", getClass()));
|
||||
resourcePaths.add(new ClassPathResource("testalternatepath/", getClass()));
|
||||
List<Resource> locations = new ArrayList<Resource>();
|
||||
locations.add(new ClassPathResource("test/", getClass()));
|
||||
locations.add(new ClassPathResource("testalternatepath/", getClass()));
|
||||
|
||||
Map<String, ResourceHttpRequestHandler> urlMap = new HashMap<String, ResourceHttpRequestHandler>();
|
||||
handler = new ResourceHttpRequestHandler();
|
||||
handler.setLocations(resourcePaths);
|
||||
handler.setLocations(locations);
|
||||
urlMap.put("/resources/**", handler);
|
||||
|
||||
mapping = new SimpleUrlHandlerMapping();
|
||||
mapping.setUrlMap(urlMap);
|
||||
}
|
||||
|
||||
private void resetMapper() {
|
||||
mapper = new ResourceUrlMapper();
|
||||
mapper.postProcessAfterInitialization(mapping, "resourceMapping");
|
||||
mapper.onApplicationEvent(null);
|
||||
private void initGenerator() {
|
||||
generator = new ResourceUrlGenerator();
|
||||
generator.setResourceHandlerMappings(Collections.singletonList(this.mapping));
|
||||
}
|
||||
|
||||
@Test
|
||||
public void getStaticResourceUrl() {
|
||||
resetMapper();
|
||||
initGenerator();
|
||||
|
||||
String url = mapper.getUrlForResource("/resources/foo.css");
|
||||
String url = generator.getResourceUrl("/resources/foo.css");
|
||||
assertEquals("/resources/foo.css", url);
|
||||
}
|
||||
|
||||
@@ -77,9 +79,9 @@ public class ResourceUrlMapperTests {
|
||||
resolvers.add(new FingerprintResourceResolver());
|
||||
resolvers.add(new PathResourceResolver());
|
||||
handler.setResourceResolvers(resolvers);
|
||||
resetMapper();
|
||||
initGenerator();
|
||||
|
||||
String url = mapper.getUrlForResource("/resources/foo.css");
|
||||
String url = generator.getResourceUrl("/resources/foo.css");
|
||||
assertEquals("/resources/foo-e36d2e05253c6c7085a91522ce43a0b4.css", url);
|
||||
}
|
||||
|
||||
@@ -89,9 +91,9 @@ public class ResourceUrlMapperTests {
|
||||
resolvers.add(new PathExtensionResourceResolver());
|
||||
resolvers.add(new PathResourceResolver());
|
||||
handler.setResourceResolvers(resolvers);
|
||||
resetMapper();
|
||||
initGenerator();
|
||||
|
||||
String url = mapper.getUrlForResource("/resources/zoo.css");
|
||||
String url = generator.getResourceUrl("/resources/zoo.css");
|
||||
assertEquals("/resources/zoo.css", url);
|
||||
}
|
||||
|
||||
Reference in New Issue
Block a user