Skip to content
New issue

Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.

By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.

Already on GitHub? Sign in to your account

@Order does not work on (CommandLine|Application)Runner @Bean methods #37905

Closed
wants to merge 1 commit into from
Closed
Show file tree
Hide file tree
Changes from all commits
Commits
File filter

Filter by extension

Filter by extension

Conversations
Failed to load comments.
Loading
Jump to
Jump to file
Failed to load files.
Loading
Diff view
Diff view
Original file line number Diff line number Diff line change
Expand Up @@ -30,7 +30,7 @@
* @see CommandLineRunner
*/
@FunctionalInterface
public interface ApplicationRunner {
public non-sealed interface ApplicationRunner extends Runner {

/**
* Callback used to run the bean.
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -33,7 +33,7 @@
* @see ApplicationRunner
*/
@FunctionalInterface
public interface CommandLineRunner {
public non-sealed interface CommandLineRunner extends Runner {

/**
* Callback used to run the bean.
Expand Down
Original file line number Diff line number Diff line change
@@ -0,0 +1,28 @@
/*
* Copyright 2012-2023 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
*
* https://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.boot;

/**
* Marker interface for runners.
*
* @author Tadaya Tsuyukubo
* @see ApplicationRunner
* @see CommandLineRunner
*/
sealed interface Runner permits CommandLineRunner, ApplicationRunner {

}
Original file line number Diff line number Diff line change
Expand Up @@ -165,6 +165,7 @@
* @author Ethan Rubinson
* @author Chris Bono
* @author Moritz Halbritter
* @author Tadaya Tsuyukubo
* @since 1.0.0
* @see #run(Class, String[])
* @see #run(Class[], String[])
Expand Down Expand Up @@ -755,18 +756,14 @@ protected void afterRefresh(ConfigurableApplicationContext context, ApplicationA
}

private void callRunners(ApplicationContext context, ApplicationArguments args) {
List<Object> runners = new ArrayList<>();
runners.addAll(context.getBeansOfType(ApplicationRunner.class).values());
runners.addAll(context.getBeansOfType(CommandLineRunner.class).values());
AnnotationAwareOrderComparator.sort(runners);
for (Object runner : new LinkedHashSet<>(runners)) {
context.getBeanProvider(Runner.class).orderedStream().forEach((runner) -> {
if (runner instanceof ApplicationRunner applicationRunner) {
callRunner(applicationRunner, args);
}
if (runner instanceof CommandLineRunner commandLineRunner) {
callRunner(commandLineRunner, args);
}
}
});
}

private void callRunner(ApplicationRunner runner, ApplicationArguments args) {
Expand Down
Original file line number Diff line number Diff line change
Expand Up @@ -97,6 +97,7 @@
import org.springframework.context.support.AbstractApplicationContext;
import org.springframework.context.support.StaticApplicationContext;
import org.springframework.core.Ordered;
import org.springframework.core.annotation.Order;
import org.springframework.core.env.CommandLinePropertySource;
import org.springframework.core.env.CompositePropertySource;
import org.springframework.core.env.ConfigurableEnvironment;
Expand Down Expand Up @@ -159,6 +160,7 @@
* @author Chris Bono
* @author Sebastien Deleuze
* @author Moritz Halbritter
* @author Tadaya Tsuyukubo
*/
@ExtendWith(OutputCaptureExtension.class)
class SpringApplicationTests {
Expand Down Expand Up @@ -629,6 +631,15 @@ void runCommandLineRunnersAndApplicationRunners() {
assertThat(this.context).has(runTestRunnerBean("runnerC"));
}

@Test
void runFunctionalCommandLineRunnersAndApplicationRunners() {
SpringApplication application = new SpringApplication(FunctionalRunnerConfig.class);
application.setWebApplicationType(WebApplicationType.NONE);
this.context = application.run("arg");
FunctionalRunnerConfig config = this.context.getBean(FunctionalRunnerConfig.class);
assertThat(config.runners).containsExactly("runnerA", "runnerB", "runnerC");
}

@Test
@SuppressWarnings("unchecked")
void runnersAreCalledAfterStartedIsLoggedAndBeforeApplicationReadyEventIsPublished(CapturedOutput output)
Expand Down Expand Up @@ -1675,6 +1686,31 @@ TestCommandLineRunner runnerA() {

}

@Configuration(proxyBeanMethods = false)
static class FunctionalRunnerConfig {

List<String> runners = new ArrayList<>();

@Bean
@Order // default is LOWEST_PRECEDENCE
CommandLineRunner runnerC() {
return (args) -> this.runners.add("runnerC");
}

@Bean
@Order(Ordered.LOWEST_PRECEDENCE - 1)
ApplicationRunner runnerB() {
return (args) -> this.runners.add("runnerB");
}

@Bean
@Order(Ordered.HIGHEST_PRECEDENCE)
CommandLineRunner runnerA() {
return (args) -> this.runners.add("runnerA");
}

}

@Configuration(proxyBeanMethods = false)
static class ExitCodeCommandLineRunConfig {

Expand Down