From 3592292e4bf2496b4545d14e16ede4b1780ab774 Mon Sep 17 00:00:00 2001 From: Guirong Hu Date: Wed, 22 Jun 2022 20:58:43 +0800 Subject: [PATCH 1/2] Use ExceptionHandler when Spring MVC uses a different management port Update `CompositeHandlerExceptionResolver` to search for beans in all contexts. Note that `BeanFactoryUtils.beansOfTypeIncludingAncestors` cannot not be used since we need to pick up all beans, even if they have the same name. See gh-31495 --- .../CompositeHandlerExceptionResolver.java | 17 +++++- ...leRestControllerEndpointWithException.java | 55 +++++++++++++++++++ ...HandlerSampleActuatorApplicationTests.java | 53 ++++++++++++++++++ 3 files changed, 122 insertions(+), 3 deletions(-) create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleRestControllerEndpointWithException.java create mode 100644 spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/test/java/smoketest/actuator/ManagementDifferentPortAndEndpointWithExceptionHandlerSampleActuatorApplicationTests.java diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/servlet/CompositeHandlerExceptionResolver.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/servlet/CompositeHandlerExceptionResolver.java index 345617df91..92892a4863 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/servlet/CompositeHandlerExceptionResolver.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/servlet/CompositeHandlerExceptionResolver.java @@ -1,5 +1,5 @@ /* - * Copyright 2012-2020 the original author or authors. + * Copyright 2012-2022 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,6 +23,8 @@ import java.util.Objects; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; +import org.springframework.beans.factory.BeanFactory; +import org.springframework.beans.factory.HierarchicalBeanFactory; import org.springframework.beans.factory.ListableBeanFactory; import org.springframework.beans.factory.annotation.Autowired; import org.springframework.boot.web.servlet.error.DefaultErrorAttributes; @@ -38,6 +40,7 @@ import org.springframework.web.servlet.mvc.support.DefaultHandlerExceptionResolv * @author Stephane Nicoll * @author Phillip Webb * @author Scott Frederick + * @author Guirong Hu */ class CompositeHandlerExceptionResolver implements HandlerExceptionResolver { @@ -57,8 +60,16 @@ class CompositeHandlerExceptionResolver implements HandlerExceptionResolver { } private List extractResolvers() { - List list = new ArrayList<>( - this.beanFactory.getBeansOfType(HandlerExceptionResolver.class).values()); + List list = new ArrayList<>(); + BeanFactory beanFactory = this.beanFactory; + while (beanFactory != null) { + if (beanFactory instanceof ListableBeanFactory) { + list.addAll( + ((ListableBeanFactory) beanFactory).getBeansOfType(HandlerExceptionResolver.class).values()); + } + beanFactory = (beanFactory instanceof HierarchicalBeanFactory) + ? ((HierarchicalBeanFactory) beanFactory).getParentBeanFactory() : null; + } list.remove(this); AnnotationAwareOrderComparator.sort(list); if (list.isEmpty()) { diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleRestControllerEndpointWithException.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleRestControllerEndpointWithException.java new file mode 100644 index 0000000000..26207123f1 --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/main/java/smoketest/actuator/SampleRestControllerEndpointWithException.java @@ -0,0 +1,55 @@ +/* + * Copyright 2012-2022 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 smoketest.actuator; + +import org.springframework.boot.actuate.endpoint.web.annotation.RestControllerEndpoint; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.stereotype.Component; +import org.springframework.web.bind.annotation.ExceptionHandler; +import org.springframework.web.bind.annotation.GetMapping; +import org.springframework.web.bind.annotation.RestControllerAdvice; + +/** + * The Sample rest controller endpoint with exception. + * + * @author Guirong Hu + */ +@Component +@RestControllerEndpoint(id = "exception") +public class SampleRestControllerEndpointWithException { + + @GetMapping("/") + public String exception() { + throw new CustomException(); + } + + @RestControllerAdvice + static class CustomExceptionHandler { + + @ExceptionHandler(CustomException.class) + ResponseEntity handleCustomException(CustomException e) { + return new ResponseEntity<>("this is a custom exception body", HttpStatus.I_AM_A_TEAPOT); + } + + } + + static class CustomException extends RuntimeException { + + } + +} diff --git a/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/test/java/smoketest/actuator/ManagementDifferentPortAndEndpointWithExceptionHandlerSampleActuatorApplicationTests.java b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/test/java/smoketest/actuator/ManagementDifferentPortAndEndpointWithExceptionHandlerSampleActuatorApplicationTests.java new file mode 100644 index 0000000000..be306f1fb8 --- /dev/null +++ b/spring-boot-tests/spring-boot-smoke-tests/spring-boot-smoke-test-actuator/src/test/java/smoketest/actuator/ManagementDifferentPortAndEndpointWithExceptionHandlerSampleActuatorApplicationTests.java @@ -0,0 +1,53 @@ +/* + * Copyright 2012-2022 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 smoketest.actuator; + +import org.junit.jupiter.api.Test; + +import org.springframework.boot.actuate.autoconfigure.web.server.LocalManagementPort; +import org.springframework.boot.actuate.endpoint.web.annotation.RestControllerEndpoint; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.boot.test.web.client.TestRestTemplate; +import org.springframework.http.HttpStatus; +import org.springframework.http.ResponseEntity; +import org.springframework.web.bind.annotation.ExceptionHandler; + +import static org.assertj.core.api.Assertions.assertThat; + +/** + * Integration tests for separate management and main service ports with Actuator's MVC + * {@link RestControllerEndpoint rest controller endpoints} and {@link ExceptionHandler + * exception handler}. + * + * @author Guirong Hu + */ +@SpringBootTest(webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, + properties = { "management.endpoints.web.exposure.include=*", "management.server.port=0" }) +class ManagementDifferentPortAndEndpointWithExceptionHandlerSampleActuatorApplicationTests { + + @LocalManagementPort + private int managementPort; + + @Test + void testExceptionHandlerRestControllerEndpoint() { + ResponseEntity entity = new TestRestTemplate("user", "password") + .getForEntity("http://localhost:" + this.managementPort + "/actuator/exception", String.class); + assertThat(entity.getStatusCode()).isEqualTo(HttpStatus.I_AM_A_TEAPOT); + assertThat(entity.getBody()).isEqualTo("this is a custom exception body"); + } + +} From aed4c47adb8b572d3eb5ea6ebbbcb8f1aa849249 Mon Sep 17 00:00:00 2001 From: Phillip Webb Date: Wed, 22 Jun 2022 16:13:03 -0700 Subject: [PATCH 2/2] Polish CompositeHandlerExceptionResolver See gh-31495 --- .../CompositeHandlerExceptionResolver.java | 50 +++++++++++-------- 1 file changed, 29 insertions(+), 21 deletions(-) diff --git a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/servlet/CompositeHandlerExceptionResolver.java b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/servlet/CompositeHandlerExceptionResolver.java index 92892a4863..a7a257da3f 100644 --- a/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/servlet/CompositeHandlerExceptionResolver.java +++ b/spring-boot-project/spring-boot-actuator-autoconfigure/src/main/java/org/springframework/boot/actuate/autoconfigure/web/servlet/CompositeHandlerExceptionResolver.java @@ -18,7 +18,6 @@ package org.springframework.boot.actuate.autoconfigure.web.servlet; import java.util.ArrayList; import java.util.List; -import java.util.Objects; import javax.servlet.http.HttpServletRequest; import javax.servlet.http.HttpServletResponse; @@ -47,36 +46,45 @@ class CompositeHandlerExceptionResolver implements HandlerExceptionResolver { @Autowired private ListableBeanFactory beanFactory; - private List resolvers; + private transient List resolvers; @Override public ModelAndView resolveException(HttpServletRequest request, HttpServletResponse response, Object handler, Exception ex) { - if (this.resolvers == null) { - this.resolvers = extractResolvers(); + for (HandlerExceptionResolver resolver : getResolvers()) { + ModelAndView resolved = resolver.resolveException(request, response, handler, ex); + if (resolved != null) { + return resolved; + } } - return this.resolvers.stream().map((resolver) -> resolver.resolveException(request, response, handler, ex)) - .filter(Objects::nonNull).findFirst().orElse(null); + return null; } - private List extractResolvers() { - List list = new ArrayList<>(); - BeanFactory beanFactory = this.beanFactory; - while (beanFactory != null) { - if (beanFactory instanceof ListableBeanFactory) { - list.addAll( - ((ListableBeanFactory) beanFactory).getBeansOfType(HandlerExceptionResolver.class).values()); + private List getResolvers() { + List resolvers = this.resolvers; + if (resolvers == null) { + resolvers = new ArrayList<>(); + collectResolverBeans(resolvers, this.beanFactory); + resolvers.remove(this); + AnnotationAwareOrderComparator.sort(resolvers); + if (resolvers.isEmpty()) { + resolvers.add(new DefaultErrorAttributes()); + resolvers.add(new DefaultHandlerExceptionResolver()); } - beanFactory = (beanFactory instanceof HierarchicalBeanFactory) - ? ((HierarchicalBeanFactory) beanFactory).getParentBeanFactory() : null; + this.resolvers = resolvers; + } + return resolvers; + } + + private void collectResolverBeans(List resolvers, BeanFactory beanFactory) { + if (beanFactory instanceof ListableBeanFactory) { + ListableBeanFactory listableBeanFactory = (ListableBeanFactory) beanFactory; + resolvers.addAll(listableBeanFactory.getBeansOfType(HandlerExceptionResolver.class).values()); } - list.remove(this); - AnnotationAwareOrderComparator.sort(list); - if (list.isEmpty()) { - list.add(new DefaultErrorAttributes()); - list.add(new DefaultHandlerExceptionResolver()); + if (beanFactory instanceof HierarchicalBeanFactory) { + HierarchicalBeanFactory hierarchicalBeanFactory = (HierarchicalBeanFactory) beanFactory; + collectResolverBeans(resolvers, hierarchicalBeanFactory.getParentBeanFactory()); } - return list; } }