Support Ordered and @Order for exit code generation

[dugenkui03]

Describing Your Changes

Different order in ExitCodeGenerators#generators will lead to different exitCode. I suggest add ‘order’ support in order to sort ExitCodeGenerators#generators by Ordered and @Order.

[wilkinsona]

Thanks for the proposal. Unfortunately, I think this will cause some confusion. ExitCodeGenerators currently returns the code that's furthest from zero:

https://github.com/spring-projects/spring-boot/blob/main/spring-boot-project/spring-boot/src/main/java/org/springframework/boot/ExitCodeGenerators.java#L85-L100

We have tests for this behaviour:

spring-boot/spring-boot-project/spring-boot/src/test/java/org/springframework/boot/ExitCodeGeneratorsTests.java

Lines 64 to 80 in 6865f1f

	@Test
	void getExitCodeWhenAllNegativeShouldReturnLowestValue() {
	ExitCodeGenerators generators = new ExitCodeGenerators();
	generators.add(mockGenerator(-1));
	generators.add(mockGenerator(-3));
	generators.add(mockGenerator(-2));
	assertThat(generators.getExitCode()).isEqualTo(-3);
	}
	@Test
	void getExitCodeWhenAllPositiveShouldReturnHighestValue() {
	ExitCodeGenerators generators = new ExitCodeGenerators();
	generators.add(mockGenerator(1));
	generators.add(mockGenerator(3));
	generators.add(mockGenerator(2));
	assertThat(generators.getExitCode()).isEqualTo(3);
	}

Ordering these generators would make no difference to the exit code that's returned.

The only place where ordering would make a difference is if it changed the first generator to return a non-zero value. That non-zero value will decide if the returned code is positive or negative. The other generators will then be called and the value that's further from zero in the direction determined by the first non-zero value will be returned.

Given the above, I don't think we should add ordering support as you have proposed here. We could, perhaps, consider it in combination with a change to return the first non-zero value. That would be a breaking change so we'd have to make it with some care. I'll flag this for a forthcoming team meeting so that we can discuss our options.

[dugenkui03]

Combine order with 'return the first non-zero value' will be a greate idea, it is easy to understand.

That non-zero value will decide if the returned code is positive or negative.

It seems that the 'positive or negative' of first generator value would not change the return value.

base: -1, -3, 2, output: 2

		generators.add(mockGenerator(-1));
		generators.add(mockGenerator(-3));
		generators.add(mockGenerator(2));

the 'positive or negative' would not change: 1, -3, 2, also output: 2

		generators.add(mockGenerator(1));
		generators.add(mockGenerator(-3));
		generators.add(mockGenerator(2));

order does:1, 2, -3: output: -3, not 2;

		generators.add(mockGenerator(1));
		generators.add(mockGenerator(2));
		generators.add(mockGenerator(-3));

[wilkinsona]

It seems that the 'positive or negative' of first generator value would not change the return value.

You're right. I'd misread the code. Thanks for the correction.

[philwebb]

We discussed this today and we'd like to order the ExitCodeGenerator beans then return the first non-zero result. This will be a breaking change so we'll do it in 2.7.

[dugenkui03]

@philwebb Thanks for your response. this pr is updated, does this work for the new logic: ’order the ExitCodeGenerator beans then return the first non-zero result‘.

[wilkinsona]

Thanks very much, @dugenkui03.