Consistent support for @order annotation as alternative to Ordered interface

Issue: SPR-12806

Author: jhoeller

spring-aop/src/main/java/org/springframework/aop/aspectj/annotation/AspectJProxyFactory.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * 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.
@@ -27,7 +27,7 @@
 import org.springframework.aop.framework.AopConfigException;
 import org.springframework.aop.framework.ProxyCreatorSupport;
 import org.springframework.aop.support.AopUtils;
-import org.springframework.core.OrderComparator;
+import org.springframework.core.annotation.AnnotationAwareOrderComparator;
 import org.springframework.util.Assert;
 import org.springframework.util.ClassUtils;
 
@@ -121,7 +121,7 @@ private void addAdvisorsFromAspectInstanceFactory(MetadataAwareAspectInstanceFac
 		List<Advisor> advisors = this.aspectFactory.getAdvisors(instanceFactory);
 		advisors = AopUtils.findAdvisorsThatCanApply(advisors, getTargetClass());
 		AspectJProxyUtils.makeAdvisorChainAspectJCapableIfNecessary(advisors);
-		OrderComparator.sort(advisors);
+		AnnotationAwareOrderComparator.sort(advisors);
 		addAdvisors(advisors);
 	}
 

spring-aop/src/main/java/org/springframework/aop/aspectj/autoproxy/AspectJPrecedenceComparator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * 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.
@@ -21,7 +21,7 @@
 import org.springframework.aop.Advisor;
 import org.springframework.aop.aspectj.AspectJAopUtils;
 import org.springframework.aop.aspectj.AspectJPrecedenceInformation;
-import org.springframework.core.OrderComparator;
+import org.springframework.core.annotation.AnnotationAwareOrderComparator;
 import org.springframework.util.Assert;
 
 /**
@@ -62,7 +62,7 @@ class AspectJPrecedenceComparator implements Comparator<Advisor> {
 	 * Create a default AspectJPrecedenceComparator.
 	 */
 	public AspectJPrecedenceComparator() {
-		this.advisorComparator = OrderComparator.INSTANCE;
+		this.advisorComparator = AnnotationAwareOrderComparator.INSTANCE;
 	}
 
 	/**

spring-aop/src/main/java/org/springframework/aop/framework/ProxyFactoryBean.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * 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.
@@ -44,7 +44,7 @@
 import org.springframework.beans.factory.FactoryBean;
 import org.springframework.beans.factory.FactoryBeanNotInitializedException;
 import org.springframework.beans.factory.ListableBeanFactory;
-import org.springframework.core.OrderComparator;
+import org.springframework.core.annotation.AnnotationAwareOrderComparator;
 import org.springframework.util.ClassUtils;
 import org.springframework.util.ObjectUtils;
 
@@ -525,7 +525,7 @@ private void addGlobalAdvisor(ListableBeanFactory beanFactory, String prefix) {
 			beans.add(bean);
 			names.put(bean, name);
 		}
-		OrderComparator.sort(beans);
+		AnnotationAwareOrderComparator.sort(beans);
 		for (Object bean : beans) {
 			String name = names.get(bean);
 			if (name.startsWith(prefix)) {

spring-aop/src/main/java/org/springframework/aop/framework/autoproxy/AbstractAdvisorAutoProxyCreator.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2012 the original author or authors.
+ * 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.
@@ -23,7 +23,7 @@
 import org.springframework.aop.support.AopUtils;
 import org.springframework.beans.factory.BeanFactory;
 import org.springframework.beans.factory.config.ConfigurableListableBeanFactory;
-import org.springframework.core.OrderComparator;
+import org.springframework.core.annotation.AnnotationAwareOrderComparator;
 
 /**
  * Generic auto proxy creator that builds AOP proxies for specific beans
@@ -138,10 +138,11 @@ protected boolean isEligibleAdvisorBean(String beanName) {
 	 * @param advisors the source List of Advisors
 	 * @return the sorted List of Advisors
 	 * @see org.springframework.core.Ordered
-	 * @see org.springframework.core.OrderComparator
+	 * @see org.springframework.core.annotation.Order
+	 * @see org.springframework.core.annotation.AnnotationAwareOrderComparator
 	 */
 	protected List<Advisor> sortAdvisors(List<Advisor> advisors) {
-		OrderComparator.sort(advisors);
+		AnnotationAwareOrderComparator.sort(advisors);
 		return advisors;
 	}
 

spring-context/src/main/java/org/springframework/context/support/PostProcessorRegistrationDelegate.java

@@ -18,6 +18,8 @@
 
 import java.util.ArrayList;
 import java.util.Collection;
+import java.util.Collections;
+import java.util.Comparator;
 import java.util.HashSet;
 import java.util.LinkedList;
 import java.util.List;
@@ -35,6 +37,7 @@
 import org.springframework.beans.factory.config.DestructionAwareBeanPostProcessor;
 import org.springframework.beans.factory.support.BeanDefinitionRegistry;
 import org.springframework.beans.factory.support.BeanDefinitionRegistryPostProcessor;
+import org.springframework.beans.factory.support.DefaultListableBeanFactory;
 import org.springframework.beans.factory.support.MergedBeanDefinitionPostProcessor;
 import org.springframework.beans.factory.support.RootBeanDefinition;
 import org.springframework.context.ApplicationListener;
@@ -90,7 +93,7 @@ public static void invokeBeanFactoryPostProcessors(
 					processedBeans.add(ppName);
 				}
 			}
-			OrderComparator.sort(priorityOrderedPostProcessors);
+			sortPostProcessors(beanFactory, priorityOrderedPostProcessors);
 			registryPostProcessors.addAll(priorityOrderedPostProcessors);
 			invokeBeanDefinitionRegistryPostProcessors(priorityOrderedPostProcessors, registry);
 
@@ -103,7 +106,7 @@ public static void invokeBeanFactoryPostProcessors(
 					processedBeans.add(ppName);
 				}
 			}
-			OrderComparator.sort(orderedPostProcessors);
+			sortPostProcessors(beanFactory, orderedPostProcessors);
 			registryPostProcessors.addAll(orderedPostProcessors);
 			invokeBeanDefinitionRegistryPostProcessors(orderedPostProcessors, registry);
 
@@ -159,15 +162,15 @@ else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
 		}
 
 		// First, invoke the BeanFactoryPostProcessors that implement PriorityOrdered.
-		OrderComparator.sort(priorityOrderedPostProcessors);
+		sortPostProcessors(beanFactory, priorityOrderedPostProcessors);
 		invokeBeanFactoryPostProcessors(priorityOrderedPostProcessors, beanFactory);
 
 		// Next, invoke the BeanFactoryPostProcessors that implement Ordered.
 		List<BeanFactoryPostProcessor> orderedPostProcessors = new ArrayList<BeanFactoryPostProcessor>();
 		for (String postProcessorName : orderedPostProcessorNames) {
 			orderedPostProcessors.add(beanFactory.getBean(postProcessorName, BeanFactoryPostProcessor.class));
 		}
-		OrderComparator.sort(orderedPostProcessors);
+		sortPostProcessors(beanFactory, orderedPostProcessors);
 		invokeBeanFactoryPostProcessors(orderedPostProcessors, beanFactory);
 
 		// Finally, invoke all other BeanFactoryPostProcessors.
@@ -212,7 +215,7 @@ else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
 		}
 
 		// First, register the BeanPostProcessors that implement PriorityOrdered.
-		OrderComparator.sort(priorityOrderedPostProcessors);
+		sortPostProcessors(beanFactory, priorityOrderedPostProcessors);
 		registerBeanPostProcessors(beanFactory, priorityOrderedPostProcessors);
 
 		// Next, register the BeanPostProcessors that implement Ordered.
@@ -224,7 +227,7 @@ else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
 				internalPostProcessors.add(pp);
 			}
 		}
-		OrderComparator.sort(orderedPostProcessors);
+		sortPostProcessors(beanFactory, orderedPostProcessors);
 		registerBeanPostProcessors(beanFactory, orderedPostProcessors);
 
 		// Now, register all regular BeanPostProcessors.
@@ -239,12 +242,23 @@ else if (beanFactory.isTypeMatch(ppName, Ordered.class)) {
 		registerBeanPostProcessors(beanFactory, nonOrderedPostProcessors);
 
 		// Finally, re-register all internal BeanPostProcessors.
-		OrderComparator.sort(internalPostProcessors);
+		sortPostProcessors(beanFactory, internalPostProcessors);
 		registerBeanPostProcessors(beanFactory, internalPostProcessors);
 
 		beanFactory.addBeanPostProcessor(new ApplicationListenerDetector(applicationContext));
 	}
 
+	private static void sortPostProcessors(ConfigurableListableBeanFactory beanFactory, List<?> postProcessors) {
+		Comparator<Object> comparatorToUse = null;
+		if (beanFactory instanceof DefaultListableBeanFactory) {
+			comparatorToUse = ((DefaultListableBeanFactory) beanFactory).getDependencyComparator();
+		}
+		if (comparatorToUse == null) {
+			comparatorToUse = OrderComparator.INSTANCE;
+		}
+		Collections.sort(postProcessors, comparatorToUse);
+	}
+
 	/**
 	 * Invoke the given BeanDefinitionRegistryPostProcessor beans.
 	 */

spring-tx/src/main/java/org/springframework/transaction/support/TransactionSynchronizationManager.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2014 the original author or authors.
+ * 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.
@@ -28,7 +28,7 @@
 import org.apache.commons.logging.LogFactory;
 
 import org.springframework.core.NamedThreadLocal;
-import org.springframework.core.OrderComparator;
+import org.springframework.core.annotation.AnnotationAwareOrderComparator;
 import org.springframework.util.Assert;
 
 /**
@@ -314,7 +314,7 @@ public static List<TransactionSynchronization> getSynchronizations() throws Ille
 		else {
 			// Sort lazily here, not in registerSynchronization.
 			List<TransactionSynchronization> sortedSynchs = new ArrayList<TransactionSynchronization>(synchs);
-			OrderComparator.sort(sortedSynchs);
+			AnnotationAwareOrderComparator.sort(sortedSynchs);
 			return Collections.unmodifiableList(sortedSynchs);
 		}
 	}

spring-webmvc-portlet/src/main/java/org/springframework/web/portlet/DispatcherPortlet.java

@@ -1,5 +1,5 @@
 /*
- * Copyright 2002-2013 the original author or authors.
+ * 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.
@@ -48,7 +48,7 @@
 import org.springframework.beans.factory.BeanInitializationException;
 import org.springframework.beans.factory.NoSuchBeanDefinitionException;
 import org.springframework.context.ApplicationContext;
-import org.springframework.core.OrderComparator;
+import org.springframework.core.annotation.AnnotationAwareOrderComparator;
 import org.springframework.core.io.ClassPathResource;
 import org.springframework.core.io.support.PropertiesLoaderUtils;
 import org.springframework.core.style.StylerUtils;
@@ -66,9 +66,8 @@
  * controllers. Dispatches to registered handlers for processing a portlet request.
  *
  * <p>This portlet is very flexible: It can be used with just about any workflow,
- * with the installation of the appropriate adapter classes. It offers the
- * following functionality that distinguishes it from other request-driven
- * portlet MVC frameworks:
+ * with the installation of the appropriate adapter classes. It offers the following
+ * functionality that distinguishes it from other request-driven Portlet MVC frameworks:
  *
  * <ul>
  * <li>It is based around a JavaBeans configuration mechanism.
@@ -77,8 +76,8 @@
  * as part of an application - to control the routing of requests to handler objects.
  * Default is a {@link org.springframework.web.portlet.mvc.annotation.DefaultAnnotationHandlerMapping}.
  * HandlerMapping objects can be defined as beans in the portlet's application context,
- * implementing the HandlerMapping interface, overriding the default HandlerMapping if present.
- * HandlerMappings can be given any bean name (they are tested by type).
+ * implementing the HandlerMapping interface, overriding the default HandlerMapping
+ * if present. HandlerMappings can be given any bean name (they are tested by type).
  *
  * <li>It can use any {@link HandlerAdapter}; this allows for using any handler interface.
  * The default adapter is {@link org.springframework.web.portlet.mvc.SimpleControllerHandlerAdapter}
@@ -102,27 +101,24 @@
  * (they are tested by type).
  *
  * <li>The dispatcher's strategy for resolving multipart requests is determined by a
- * {@link org.springframework.web.portlet.multipart.PortletMultipartResolver} implementation.
- * An implementations for Jakarta Commons FileUpload is included:
+ * {@link org.springframework.web.portlet.multipart.PortletMultipartResolver}
+ * implementation. An implementations for Apache Commons FileUpload is included:
  * {@link org.springframework.web.portlet.multipart.CommonsPortletMultipartResolver}.
  * The MultipartResolver bean name is "portletMultipartResolver"; default is none.
  * </ul>
  *
- * <p><b>NOTE: The {@code @RequestMapping} annotation will only be processed
- * if a corresponding {@code HandlerMapping} (for type level annotations)
- * and/or {@code HandlerAdapter} (for method level annotations)
- * is present in the dispatcher.</b> This is the case by default.
- * However, if you are defining custom {@code HandlerMappings} or
- * {@code HandlerAdapters}, then you need to make sure that a
- * corresponding custom {@code DefaultAnnotationHandlerMapping}
- * and/or {@code AnnotationMethodHandlerAdapter} is defined as well
- * - provided that you intend to use {@code @RequestMapping}.
+ * <p><b>NOTE: The {@code @RequestMapping} annotation will only be processed if a
+ * corresponding {@code HandlerMapping} (for type-level annotations) and/or
+ * {@code HandlerAdapter} (for method-level annotations) is present in the dispatcher.</b>
+ * This is the case by default. However, if you are defining custom {@code HandlerMappings}
+ * or {@code HandlerAdapters}, then you need to make sure that a corresponding custom
+ * {@code DefaultAnnotationHandlerMapping} and/or {@code AnnotationMethodHandlerAdapter}
+ * is defined as well - provided that you intend to use {@code @RequestMapping}.
  *
  * <p><b>A web application can define any number of DispatcherPortlets.</b>
- * Each portlet will operate in its own namespace, loading its own application
- * context with mappings, handlers, etc. Only the root application context
- * as loaded by {@link org.springframework.web.context.ContextLoaderListener},
- * if any, will be shared.
+ * Each portlet will operate in its own namespace, loading its own application context
+ * with mappings, handlers, etc. Only the root application context as loaded by
+ * {@link org.springframework.web.context.ContextLoaderListener}, if any, will be shared.
  *
  * <p>Thanks to Rainer Schmitz, Nick Lothian and Eric Dalquist for their suggestions!
  *
@@ -401,7 +397,7 @@ private void initHandlerMappings(ApplicationContext context) {
 			if (!matchingBeans.isEmpty()) {
 				this.handlerMappings = new ArrayList<HandlerMapping>(matchingBeans.values());
 				// We keep HandlerMappings in sorted order.
-				OrderComparator.sort(this.handlerMappings);
+				AnnotationAwareOrderComparator.sort(this.handlerMappings);
 			}
 		}
 		else {
@@ -439,7 +435,7 @@ private void initHandlerAdapters(ApplicationContext context) {
 			if (!matchingBeans.isEmpty()) {
 				this.handlerAdapters = new ArrayList<HandlerAdapter>(matchingBeans.values());
 				// We keep HandlerAdapters in sorted order.
-				OrderComparator.sort(this.handlerAdapters);
+				AnnotationAwareOrderComparator.sort(this.handlerAdapters);
 			}
 		}
 		else {
@@ -477,7 +473,7 @@ private void initHandlerExceptionResolvers(ApplicationContext context) {
 			if (!matchingBeans.isEmpty()) {
 				this.handlerExceptionResolvers = new ArrayList<HandlerExceptionResolver>(matchingBeans.values());
 				// We keep HandlerExceptionResolvers in sorted order.
-				OrderComparator.sort(this.handlerExceptionResolvers);
+				AnnotationAwareOrderComparator.sort(this.handlerExceptionResolvers);
 			}
 		}
 		else {
@@ -516,7 +512,7 @@ private void initViewResolvers(ApplicationContext context) {
 			if (!matchingBeans.isEmpty()) {
 				this.viewResolvers = new ArrayList<ViewResolver>(matchingBeans.values());
 				// We keep ViewResolvers in sorted order.
-				OrderComparator.sort(this.viewResolvers);
+				AnnotationAwareOrderComparator.sort(this.viewResolvers);
 			}
 		}
 		else {