From 44e717566293da5729d0086ef8be7179d6e5b362 Mon Sep 17 00:00:00 2001
From: bob <146524024+NUAAwqy@users.noreply.github.com>
Date: Thu, 12 Nov 2026 01:00:31 +0800
Subject: [PATCH] [ISSUE #501] fix(spring): remove ineffective
@AutoConfigureAfter/Before on imported configurations
@AutoConfigureAfter and @AutoConfigureBefore only order auto-configuration
classes that are registered in META-INF/spring/...AutoConfiguration.imports.
In both rocketmq-spring-boot and rocketmq-v5-client-spring-boot the only
registered entry class is RocketMQAutoConfiguration; MessageConverterConfiguration,
RocketMQTransactionConfiguration and RocketMQListenerConfiguration are pulled in
via @Import, so the ordering annotations on them never take effect.
Removed the dead annotations (behavior-preserving) and added a regression
test per module asserting that no ordering annotation is declared on the
imported configurations and that any ordering target would have to be a
registered auto-configuration.
---
.../RocketMQAutoConfiguration.java | 4 -
.../RocketMQListenerConfiguration.java | 2 -
.../AutoConfigurationOrderingUsageTest.java | 113 ++++++++++++++++++
.../RocketMQAutoConfiguration.java | 4 -
.../RocketMQListenerConfiguration.java | 2 -
.../AutoConfigurationOrderingUsageTest.java | 113 ++++++++++++++++++
6 files changed, 226 insertions(+), 12 deletions(-)
create mode 100644 rocketmq-spring-boot/src/test/java/org/apache/rocketmq/spring/autoconfigure/AutoConfigurationOrderingUsageTest.java
create mode 100644 rocketmq-v5-client-spring-boot/src/test/java/org/apache/rocketmq/client/autoconfigure/AutoConfigurationOrderingUsageTest.java
diff --git a/rocketmq-spring-boot/src/main/java/org/apache/rocketmq/spring/autoconfigure/RocketMQAutoConfiguration.java b/rocketmq-spring-boot/src/main/java/org/apache/rocketmq/spring/autoconfigure/RocketMQAutoConfiguration.java
index 45d26642..c50dbd70 100644
--- a/rocketmq-spring-boot/src/main/java/org/apache/rocketmq/spring/autoconfigure/RocketMQAutoConfiguration.java
+++ b/rocketmq-spring-boot/src/main/java/org/apache/rocketmq/spring/autoconfigure/RocketMQAutoConfiguration.java
@@ -29,8 +29,6 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
-import org.springframework.boot.autoconfigure.AutoConfigureAfter;
-import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.condition.AnyNestedCondition;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
@@ -53,8 +51,6 @@
@ConditionalOnProperty(prefix = "rocketmq", value = "name-server", matchIfMissing = true)
@Import({MessageConverterConfiguration.class, ListenerContainerConfiguration.class, ExtProducerResetConfiguration.class,
ExtConsumerResetConfiguration.class, RocketMQTransactionConfiguration.class, RocketMQListenerConfiguration.class})
-@AutoConfigureAfter({MessageConverterConfiguration.class})
-@AutoConfigureBefore({RocketMQTransactionConfiguration.class})
public class RocketMQAutoConfiguration implements ApplicationContextAware {
private static final Logger log = LoggerFactory.getLogger(RocketMQAutoConfiguration.class);
diff --git a/rocketmq-spring-boot/src/main/java/org/apache/rocketmq/spring/autoconfigure/RocketMQListenerConfiguration.java b/rocketmq-spring-boot/src/main/java/org/apache/rocketmq/spring/autoconfigure/RocketMQListenerConfiguration.java
index 0761c084..54fcbaee 100644
--- a/rocketmq-spring-boot/src/main/java/org/apache/rocketmq/spring/autoconfigure/RocketMQListenerConfiguration.java
+++ b/rocketmq-spring-boot/src/main/java/org/apache/rocketmq/spring/autoconfigure/RocketMQListenerConfiguration.java
@@ -19,13 +19,11 @@
import org.apache.rocketmq.spring.annotation.RocketMQMessageListenerBeanPostProcessor;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.RootBeanDefinition;
-import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;
@Configuration
-@AutoConfigureAfter(RocketMQAutoConfiguration.class)
public class RocketMQListenerConfiguration implements ImportBeanDefinitionRegistrar {
@Override
diff --git a/rocketmq-spring-boot/src/test/java/org/apache/rocketmq/spring/autoconfigure/AutoConfigurationOrderingUsageTest.java b/rocketmq-spring-boot/src/test/java/org/apache/rocketmq/spring/autoconfigure/AutoConfigurationOrderingUsageTest.java
new file mode 100644
index 00000000..cb852a60
--- /dev/null
+++ b/rocketmq-spring-boot/src/test/java/org/apache/rocketmq/spring/autoconfigure/AutoConfigurationOrderingUsageTest.java
@@ -0,0 +1,113 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.rocketmq.spring.autoconfigure;
+
+import java.io.BufferedReader;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
+import java.util.HashSet;
+import java.util.Set;
+import org.junit.Assert;
+import org.junit.Test;
+import org.springframework.boot.autoconfigure.AutoConfigureAfter;
+import org.springframework.boot.autoconfigure.AutoConfigureBefore;
+
+/**
+ * {@link AutoConfigureAfter} and {@link AutoConfigureBefore} only order
+ * auto-configuration classes that are registered in
+ * {@code META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports}.
+ * This module registers only {@link RocketMQAutoConfiguration} there; every
+ * other configuration (message converter, transaction, listener, ...) is
+ * pulled in through {@code @Import}, so ordering annotations on those classes
+ * are dead code and mislead users into copying the pattern.
+ *
+ * @see issue #501
+ */
+public class AutoConfigurationOrderingUsageTest {
+
+ @Test
+ public void importedConfigurationsCarryNoOrderingAnnotations() {
+ assertNoOrderingAnnotations(RocketMQAutoConfiguration.class);
+ assertNoOrderingAnnotations(RocketMQListenerConfiguration.class);
+ }
+
+ @Test
+ public void orderingAnnotationTargetsAreRegisteredAutoConfigurations() throws Exception {
+ Set registered = readRegisteredAutoConfigurations();
+ Assert.assertTrue("RocketMQAutoConfiguration should be registered in "
+ + "AutoConfiguration.imports",
+ registered.contains(RocketMQAutoConfiguration.class.getName()));
+
+ for (Class> config : new Class>[] {
+ RocketMQAutoConfiguration.class, RocketMQListenerConfiguration.class}) {
+ assertTargetsRegistered(config, registered,
+ config.getAnnotation(AutoConfigureAfter.class));
+ assertTargetsRegistered(config, registered,
+ config.getAnnotation(AutoConfigureBefore.class));
+ }
+ }
+
+ private void assertNoOrderingAnnotations(Class> config) {
+ Assert.assertNull(config.getSimpleName()
+ + " must not declare @AutoConfigureAfter: it is not an "
+ + "auto-configuration entry class",
+ config.getAnnotation(AutoConfigureAfter.class));
+ Assert.assertNull(config.getSimpleName()
+ + " must not declare @AutoConfigureBefore: it is not an "
+ + "auto-configuration entry class",
+ config.getAnnotation(AutoConfigureBefore.class));
+ }
+
+ private void assertTargetsRegistered(Class> config, Set registered,
+ Object orderingAnnotation) {
+ if (orderingAnnotation == null) {
+ return;
+ }
+ Class>[] targets = orderingAnnotation instanceof AutoConfigureAfter
+ ? ((AutoConfigureAfter) orderingAnnotation).value()
+ : ((AutoConfigureBefore) orderingAnnotation).value();
+ for (Class> target : targets) {
+ Assert.assertTrue(config.getSimpleName() + " orders itself against "
+ + target.getName() + ", which is not a registered "
+ + "auto-configuration, so the annotation has no effect",
+ registered.contains(target.getName()));
+ }
+ }
+
+ private Set readRegisteredAutoConfigurations() throws Exception {
+ Set registered = new HashSet();
+ try (InputStream in = getClass().getClassLoader().getResourceAsStream(
+ "META-INF/spring/"
+ + "org.springframework.boot.autoconfigure.AutoConfiguration.imports")) {
+ Assert.assertNotNull("AutoConfiguration.imports not found on the "
+ + "classpath", in);
+ try (BufferedReader reader = new BufferedReader(
+ new InputStreamReader(in, StandardCharsets.UTF_8))) {
+ String line;
+ while ((line = reader.readLine()) != null) {
+ line = line.trim();
+ if (!line.isEmpty() && !line.startsWith("#")) {
+ registered.add(line);
+ }
+ }
+ }
+ }
+ return registered;
+ }
+}
diff --git a/rocketmq-v5-client-spring-boot/src/main/java/org/apache/rocketmq/client/autoconfigure/RocketMQAutoConfiguration.java b/rocketmq-v5-client-spring-boot/src/main/java/org/apache/rocketmq/client/autoconfigure/RocketMQAutoConfiguration.java
index 83748903..fc4a7c48 100644
--- a/rocketmq-v5-client-spring-boot/src/main/java/org/apache/rocketmq/client/autoconfigure/RocketMQAutoConfiguration.java
+++ b/rocketmq-v5-client-spring-boot/src/main/java/org/apache/rocketmq/client/autoconfigure/RocketMQAutoConfiguration.java
@@ -28,8 +28,6 @@
import org.slf4j.Logger;
import org.slf4j.LoggerFactory;
import org.springframework.beans.BeansException;
-import org.springframework.boot.autoconfigure.AutoConfigureAfter;
-import org.springframework.boot.autoconfigure.AutoConfigureBefore;
import org.springframework.boot.autoconfigure.condition.AnyNestedCondition;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
@@ -54,8 +52,6 @@
@EnableConfigurationProperties(RocketMQProperties.class)
@Import({MessageConverterConfiguration.class, ListenerContainerConfiguration.class, ExtTemplateResetConfiguration.class,
ExtConsumerResetConfiguration.class, RocketMQTransactionConfiguration.class, RocketMQListenerConfiguration.class})
-@AutoConfigureAfter({MessageConverterConfiguration.class})
-@AutoConfigureBefore({RocketMQTransactionConfiguration.class})
public class RocketMQAutoConfiguration implements ApplicationContextAware {
private static final Logger log = LoggerFactory.getLogger(RocketMQAutoConfiguration.class);
public static final String ROCKETMQ_TEMPLATE_DEFAULT_GLOBAL_NAME = "rocketMQClientTemplate";
diff --git a/rocketmq-v5-client-spring-boot/src/main/java/org/apache/rocketmq/client/autoconfigure/RocketMQListenerConfiguration.java b/rocketmq-v5-client-spring-boot/src/main/java/org/apache/rocketmq/client/autoconfigure/RocketMQListenerConfiguration.java
index c8afc127..401d3d1e 100644
--- a/rocketmq-v5-client-spring-boot/src/main/java/org/apache/rocketmq/client/autoconfigure/RocketMQListenerConfiguration.java
+++ b/rocketmq-v5-client-spring-boot/src/main/java/org/apache/rocketmq/client/autoconfigure/RocketMQListenerConfiguration.java
@@ -19,13 +19,11 @@
import org.apache.rocketmq.client.annotation.RocketMQMessageListenerBeanPostProcessor;
import org.springframework.beans.factory.support.BeanDefinitionRegistry;
import org.springframework.beans.factory.support.RootBeanDefinition;
-import org.springframework.boot.autoconfigure.AutoConfigureAfter;
import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.ImportBeanDefinitionRegistrar;
import org.springframework.core.type.AnnotationMetadata;
@Configuration
-@AutoConfigureAfter(RocketMQAutoConfiguration.class)
public class RocketMQListenerConfiguration implements ImportBeanDefinitionRegistrar {
@Override
public void registerBeanDefinitions(AnnotationMetadata importingClassMetadata, BeanDefinitionRegistry registry) {
diff --git a/rocketmq-v5-client-spring-boot/src/test/java/org/apache/rocketmq/client/autoconfigure/AutoConfigurationOrderingUsageTest.java b/rocketmq-v5-client-spring-boot/src/test/java/org/apache/rocketmq/client/autoconfigure/AutoConfigurationOrderingUsageTest.java
new file mode 100644
index 00000000..be3ad8a9
--- /dev/null
+++ b/rocketmq-v5-client-spring-boot/src/test/java/org/apache/rocketmq/client/autoconfigure/AutoConfigurationOrderingUsageTest.java
@@ -0,0 +1,113 @@
+/*
+ * Licensed to the Apache Software Foundation (ASF) under one or more
+ * contributor license agreements. See the NOTICE file distributed with
+ * this work for additional information regarding copyright ownership.
+ * The ASF licenses this file to You 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.apache.rocketmq.client.autoconfigure;
+
+import java.io.BufferedReader;
+import java.io.InputStream;
+import java.io.InputStreamReader;
+import java.nio.charset.StandardCharsets;
+import java.util.HashSet;
+import java.util.Set;
+import org.junit.Assert;
+import org.junit.Test;
+import org.springframework.boot.autoconfigure.AutoConfigureAfter;
+import org.springframework.boot.autoconfigure.AutoConfigureBefore;
+
+/**
+ * {@link AutoConfigureAfter} and {@link AutoConfigureBefore} only order
+ * auto-configuration classes that are registered in
+ * {@code META-INF/spring/org.springframework.boot.autoconfigure.AutoConfiguration.imports}.
+ * This module registers only {@link RocketMQAutoConfiguration} there; every
+ * other configuration (message converter, transaction, listener, ...) is
+ * pulled in through {@code @Import}, so ordering annotations on those classes
+ * are dead code and mislead users into copying the pattern.
+ *
+ * @see issue #501
+ */
+public class AutoConfigurationOrderingUsageTest {
+
+ @Test
+ public void importedConfigurationsCarryNoOrderingAnnotations() {
+ assertNoOrderingAnnotations(RocketMQAutoConfiguration.class);
+ assertNoOrderingAnnotations(RocketMQListenerConfiguration.class);
+ }
+
+ @Test
+ public void orderingAnnotationTargetsAreRegisteredAutoConfigurations() throws Exception {
+ Set registered = readRegisteredAutoConfigurations();
+ Assert.assertTrue("RocketMQAutoConfiguration (v5 client) should be registered in "
+ + "AutoConfiguration.imports",
+ registered.contains(RocketMQAutoConfiguration.class.getName()));
+
+ for (Class> config : new Class>[] {
+ RocketMQAutoConfiguration.class, RocketMQListenerConfiguration.class}) {
+ assertTargetsRegistered(config, registered,
+ config.getAnnotation(AutoConfigureAfter.class));
+ assertTargetsRegistered(config, registered,
+ config.getAnnotation(AutoConfigureBefore.class));
+ }
+ }
+
+ private void assertNoOrderingAnnotations(Class> config) {
+ Assert.assertNull(config.getSimpleName()
+ + " must not declare @AutoConfigureAfter: it is not an "
+ + "auto-configuration entry class",
+ config.getAnnotation(AutoConfigureAfter.class));
+ Assert.assertNull(config.getSimpleName()
+ + " must not declare @AutoConfigureBefore: it is not an "
+ + "auto-configuration entry class",
+ config.getAnnotation(AutoConfigureBefore.class));
+ }
+
+ private void assertTargetsRegistered(Class> config, Set registered,
+ Object orderingAnnotation) {
+ if (orderingAnnotation == null) {
+ return;
+ }
+ Class>[] targets = orderingAnnotation instanceof AutoConfigureAfter
+ ? ((AutoConfigureAfter) orderingAnnotation).value()
+ : ((AutoConfigureBefore) orderingAnnotation).value();
+ for (Class> target : targets) {
+ Assert.assertTrue(config.getSimpleName() + " orders itself against "
+ + target.getName() + ", which is not a registered "
+ + "auto-configuration, so the annotation has no effect",
+ registered.contains(target.getName()));
+ }
+ }
+
+ private Set readRegisteredAutoConfigurations() throws Exception {
+ Set registered = new HashSet();
+ try (InputStream in = getClass().getClassLoader().getResourceAsStream(
+ "META-INF/spring/"
+ + "org.springframework.boot.autoconfigure.AutoConfiguration.imports")) {
+ Assert.assertNotNull("AutoConfiguration.imports not found on the "
+ + "classpath", in);
+ try (BufferedReader reader = new BufferedReader(
+ new InputStreamReader(in, StandardCharsets.UTF_8))) {
+ String line;
+ while ((line = reader.readLine()) != null) {
+ line = line.trim();
+ if (!line.isEmpty() && !line.startsWith("#")) {
+ registered.add(line);
+ }
+ }
+ }
+ }
+ return registered;
+ }
+}