Execute HandlerInterceptors in registration order

Prior to this commit, registering `HandlerInterceptor`s using the
`InterceptorRegistry` would not guarantee their order of execution. In
fact, `HandlerInterceptor`s would always be executed before
`MappedInterceptor`s.

This change makes `MappedInterceptor` implement the `HandlerInterceptor`
interface, in order to register all interceptors in a single ordered
list. The order of execution of interceptors is now guaranteed in the
`HandlerExecutionChain` built by `AbstractHandlerMapping`.

Issue: SPR-12673

spring-webmvc/src/test/java/org/springframework/web/servlet/handler/AbstractHandlerMappingTests.java

@@ -0,0 +1,92 @@
+/*
+ * Copyright 2002-2015 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.handler;
+
+import java.io.IOException;
+
+import javax.servlet.ServletException;
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
+import org.hamcrest.Matchers;
+import org.junit.Assert;
+import org.junit.Before;
+import org.junit.Test;
+import org.mockito.Mockito;
+
+import org.springframework.http.HttpStatus;
+import org.springframework.mock.web.test.MockHttpServletRequest;
+import org.springframework.mock.web.test.MockHttpServletResponse;
+import org.springframework.web.HttpRequestHandler;
+import org.springframework.web.context.support.StaticWebApplicationContext;
+import org.springframework.web.servlet.HandlerExecutionChain;
+import org.springframework.web.servlet.HandlerInterceptor;
+import org.springframework.web.servlet.support.WebContentGenerator;
+
+/**
+ * @author Brian Clozel
+ */
+public class AbstractHandlerMappingTests {
+
+	private MockHttpServletRequest request;
+	private AbstractHandlerMapping handlerMapping;
+	private StaticWebApplicationContext context;
+
+	@Before
+	public void setup() {
+		this.context = new StaticWebApplicationContext();
+		this.handlerMapping = new TestHandlerMapping();
+		this.request = new MockHttpServletRequest();
+	}
+
+	@Test
+	public void orderedInterceptors() throws Exception {
+		MappedInterceptor firstMappedInterceptor = new MappedInterceptor(new String[]{"/**"}, Mockito.mock(HandlerInterceptor.class));
+		HandlerInterceptor secondHandlerInterceptor = Mockito.mock(HandlerInterceptor.class);
+		MappedInterceptor thirdMappedInterceptor = new MappedInterceptor(new String[]{"/**"}, Mockito.mock(HandlerInterceptor.class));
+		HandlerInterceptor fourthHandlerInterceptor = Mockito.mock(HandlerInterceptor.class);
+
+		this.handlerMapping.setInterceptors(new Object[]{firstMappedInterceptor, secondHandlerInterceptor,
+				thirdMappedInterceptor, fourthHandlerInterceptor});
+		this.handlerMapping.setApplicationContext(this.context);
+		HandlerExecutionChain chain = this.handlerMapping.getHandlerExecutionChain(new SimpleHandler(), this.request);
+		Assert.assertThat(chain.getInterceptors(),
+				Matchers.arrayContaining(firstMappedInterceptor, secondHandlerInterceptor, thirdMappedInterceptor, fourthHandlerInterceptor));
+	}
+
+	class TestHandlerMapping extends AbstractHandlerMapping {
+
+		@Override
+		protected Object getHandlerInternal(HttpServletRequest request) throws Exception {
+			return new SimpleHandler();
+		}
+	}
+
+	class SimpleHandler extends WebContentGenerator implements HttpRequestHandler {
+
+		public SimpleHandler() {
+			super(METHOD_GET);
+		}
+
+		@Override
+		public void handleRequest(HttpServletRequest request, HttpServletResponse response) throws ServletException, IOException {
+			response.setStatus(HttpStatus.OK.value());
+		}
+
+	}
+
+}

spring-webmvc/src/test/java/org/springframework/web/servlet/handler/MappedInterceptorTests.java

@@ -15,18 +15,26 @@
  */
 package org.springframework.web.servlet.handler;
 
+import static org.junit.Assert.*;
+import static org.mockito.BDDMockito.any;
+import static org.mockito.BDDMockito.*;
+import static org.mockito.Mockito.mock;
+
 import java.util.Comparator;
 import java.util.Map;
 
+import javax.servlet.http.HttpServletRequest;
+import javax.servlet.http.HttpServletResponse;
+
 import org.junit.Before;
 import org.junit.Test;
 
 import org.springframework.util.AntPathMatcher;
 import org.springframework.util.PathMatcher;
+import org.springframework.web.servlet.HandlerInterceptor;
+import org.springframework.web.servlet.ModelAndView;
 import org.springframework.web.servlet.i18n.LocaleChangeInterceptor;
 
-import static org.junit.Assert.*;
-
 /**
  * Test fixture for {@link MappedInterceptor} tests.
  *
@@ -89,6 +97,35 @@ public class MappedInterceptorTests {
 		assertFalse(mappedInterceptor.matches("/foo/bar", pathMatcher));
 	}
 
+	@Test
+	public void preHandle() throws Exception {
+		HandlerInterceptor interceptor = mock(HandlerInterceptor.class);
+		MappedInterceptor mappedInterceptor = new MappedInterceptor(new String[] { "/**" }, interceptor);
+		mappedInterceptor.preHandle(mock(HttpServletRequest.class), mock(HttpServletResponse.class), null);
+
+		then(interceptor).should().preHandle(any(HttpServletRequest.class), any(HttpServletResponse.class), any());
+	}
+
+	@Test
+	public void postHandle() throws Exception {
+		HandlerInterceptor interceptor = mock(HandlerInterceptor.class);
+		MappedInterceptor mappedInterceptor = new MappedInterceptor(new String[] { "/**" }, interceptor);
+		mappedInterceptor.postHandle(mock(HttpServletRequest.class), mock(HttpServletResponse.class),
+				null, mock(ModelAndView.class));
+
+		then(interceptor).should().postHandle(any(), any(), any(), any());
+	}
+
+	@Test
+	public void afterCompletion() throws Exception {
+		HandlerInterceptor interceptor = mock(HandlerInterceptor.class);
+		MappedInterceptor mappedInterceptor = new MappedInterceptor(new String[] { "/**" }, interceptor);
+		mappedInterceptor.afterCompletion(mock(HttpServletRequest.class), mock(HttpServletResponse.class),
+				null, mock(Exception.class));
+
+		then(interceptor).should().afterCompletion(any(), any(), any(), any());
+	}
+
 
 
 	public static class TestPathMatcher implements PathMatcher {