[AI-8th]Add ProblemDetail (RFC 7807) support for standardized SOFABoot REST error responses

sofa-boot-project/sofa-boot-actuator-autoconfigure/pom.xml

@@ -31,6 +31,11 @@
             <artifactId>spring-boot-actuator-autoconfigure</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-configuration-processor</artifactId>

sofa-boot-project/sofa-boot-actuator-autoconfigure/src/main/java/com/alipay/sofa/boot/actuator/autoconfigure/health/HealthProperties.java

@@ -17,8 +17,10 @@
 package com.alipay.sofa.boot.actuator.autoconfigure.health;
 
 import com.alipay.sofa.boot.actuator.health.HealthCheckerConfig;
+import jakarta.validation.constraints.Positive;
 import org.springframework.boot.context.properties.ConfigurationProperties;
 import org.springframework.boot.context.properties.NestedConfigurationProperty;
+import org.springframework.validation.annotation.Validated;
 
 import java.util.ArrayList;
 import java.util.HashMap;
@@ -33,6 +35,7 @@
  * Created on 2020/5/18
  */
 @ConfigurationProperties("sofa.boot.actuator.health")
+@Validated
 public class HealthProperties {
 
     /**
@@ -54,6 +57,7 @@ public class HealthProperties {
     /**
      * Timeout duration of parallel health check, in milliseconds.
      */
+    @Positive(message = "并行健康检查超时时间必须大于 0")
     private long                                                                                parallelCheckTimeout         = 120 * 1000;
 
     /**
@@ -84,6 +88,7 @@ public class HealthProperties {
     /**
      * Global {@link com.alipay.sofa.boot.actuator.health.HealthChecker} health check timeout，in milliseconds.
      */
+    @Positive(message = "HealthChecker 全局超时时间必须大于 0")
     private int                                                                                 globalHealthCheckerTimeout   = 60 * 1000;
 
     /**
@@ -95,6 +100,7 @@ public class HealthProperties {
     /**
      * Global {@link org.springframework.boot.actuate.health.HealthIndicator} health check timeout，in milliseconds.
      */
+    @Positive(message = "HealthIndicator 全局超时时间必须大于 0")
     private int                                                                                 globalHealthIndicatorTimeout = 60 * 1000;
 
     /**

sofa-boot-project/sofa-boot-actuator-autoconfigure/src/test/java/com/alipay/sofa/boot/actuator/autoconfigure/health/ReadinessAutoConfigurationTests.java

@@ -32,6 +32,7 @@
 import org.springframework.boot.autoconfigure.AutoConfigurations;
 import org.springframework.boot.test.context.FilteredClassLoader;
 import org.springframework.boot.test.context.runner.ApplicationContextRunner;
+import org.springframework.core.NestedExceptionUtils;
 
 import java.util.concurrent.ExecutorService;
 import java.util.concurrent.ThreadPoolExecutor;
@@ -148,6 +149,17 @@ void customHealthCheckParallelCheck() {
                 });
     }
 
+    @Test
+    void invalidHealthPropertiesShouldFailFast() {
+        this.contextRunner
+                .withPropertyValues("sofa.boot.actuator.health.parallelCheckTimeout=0")
+                .run((context) -> {
+                    assertThat(context).hasFailed();
+                    assertThat(NestedExceptionUtils.getMostSpecificCause(context.getStartupFailure()).getMessage())
+                            .contains("并行健康检查超时时间必须大于 0");
+                });
+    }
+
     @Test
     void runWhenWithIsleConfiguration() {
         this.contextRunner

sofa-boot-project/sofa-boot-autoconfigure/pom.xml

@@ -26,6 +26,11 @@
             <artifactId>spring-boot-autoconfigure</artifactId>
         </dependency>
 
+        <dependency>
+            <groupId>org.springframework.boot</groupId>
+            <artifactId>spring-boot-starter-validation</artifactId>
+        </dependency>
+
         <dependency>
             <groupId>org.springframework.boot</groupId>
             <artifactId>spring-boot-configuration-processor</artifactId>

sofa-boot-project/sofa-boot-autoconfigure/src/main/java/com/alipay/sofa/boot/autoconfigure/isle/SofaModuleProperties.java

@@ -16,7 +16,9 @@
  */
 package com.alipay.sofa.boot.autoconfigure.isle;
 
+import jakarta.validation.constraints.Positive;
 import org.springframework.boot.context.properties.ConfigurationProperties;
+import org.springframework.validation.annotation.Validated;
 
 import java.util.ArrayList;
 import java.util.List;
@@ -28,6 +30,7 @@
  * @author huzijie
  */
 @ConfigurationProperties("sofa.boot.isle")
+@Validated
 public class SofaModuleProperties {
 
     /**
@@ -78,16 +81,19 @@ public class SofaModuleProperties {
     /**
      * Thead pool size factor used in parallel sofa module application context refresh.
      */
+    @Positive(message = "模块并行刷新线程池倍率必须大于 0")
     private float        parallelRefreshPoolSizeFactor = 5.0f;
 
     /**
      * Timeout used in parallel sofa module application context refresh, in milliseconds.
      */
+    @Positive(message = "模块并行刷新超时时间必须大于 0")
     private long         parallelRefreshTimeout        = 60;
 
     /**
      * Monitor period used in parallel sofa module application context refresh, in milliseconds.
      */
+    @Positive(message = "模块并行刷新检查周期必须大于 0")
     private long         parallelRefreshCheckPeriod    = 30;
 
     public List<String> getActiveProfiles() {

sofa-boot-project/sofa-boot-autoconfigure/src/main/java/com/alipay/sofa/boot/autoconfigure/problem/AbstractSofaProblemDetailExceptionMapper.java

@@ -0,0 +1,79 @@
+/*
+ * 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 com.alipay.sofa.boot.autoconfigure.problem;
+
+import org.springframework.http.ProblemDetail;
+import org.springframework.util.StringUtils;
+
+import javax.ws.rs.core.Context;
+import javax.ws.rs.core.HttpHeaders;
+import javax.ws.rs.core.MediaType;
+import javax.ws.rs.core.Response;
+import javax.ws.rs.core.UriInfo;
+import javax.ws.rs.ext.ExceptionMapper;
+import java.util.List;
+import java.util.Locale;
+
+/**
+ * Base JAX-RS exception mapper for SOFA problem detail responses.
+ *
+ * @author OpenAI
+ */
+public abstract class AbstractSofaProblemDetailExceptionMapper<T extends Throwable>
+                                                                                    implements
+                                                                                    ExceptionMapper<T> {
+
+    private final SofaProblemDetailFactory factory;
+
+    @Context
+    private UriInfo                        uriInfo;
+
+    @Context
+    private HttpHeaders                    headers;
+
+    protected AbstractSofaProblemDetailExceptionMapper(SofaProblemDetailFactory factory) {
+        this.factory = factory;
+    }
+
+    @Override
+    public Response toResponse(T exception) {
+        ProblemDetail problemDetail = factory.create(exception, resolveInstancePath(),
+            resolveLocale());
+        return Response.status(problemDetail.getStatus())
+            .type(MediaType.valueOf("application/problem+json"))
+            .entity(factory.render(problemDetail)).build();
+    }
+
+    private String resolveInstancePath() {
+        if (uriInfo == null || uriInfo.getRequestUri() == null) {
+            return null;
+        }
+        String path = uriInfo.getRequestUri().getPath();
+        if (!StringUtils.hasText(path)) {
+            return null;
+        }
+        return path.startsWith("/") ? path : "/" + path;
+    }
+
+    private Locale resolveLocale() {
+        if (headers == null) {
+            return Locale.getDefault();
+        }
+        List<Locale> acceptableLanguages = headers.getAcceptableLanguages();
+        return acceptableLanguages.isEmpty() ? Locale.getDefault() : acceptableLanguages.get(0);
+    }
+}

sofa-boot-project/sofa-boot-autoconfigure/src/main/java/com/alipay/sofa/boot/autoconfigure/problem/SofaBootRpcRuntimeExceptionProblemDetailExceptionMapper.java

@@ -0,0 +1,36 @@
+/*
+ * 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 com.alipay.sofa.boot.autoconfigure.problem;
+
+import com.alipay.sofa.rpc.boot.common.SofaBootRpcRuntimeException;
+
+import javax.ws.rs.ext.Provider;
+
+/**
+ * JAX-RS mapper for {@link SofaBootRpcRuntimeException}.
+ *
+ * @author OpenAI
+ */
+@Provider
+public class SofaBootRpcRuntimeExceptionProblemDetailExceptionMapper
+                                                                    extends
+                                                                    AbstractSofaProblemDetailExceptionMapper<SofaBootRpcRuntimeException> {
+
+    public SofaBootRpcRuntimeExceptionProblemDetailExceptionMapper(SofaProblemDetailFactory factory) {
+        super(factory);
+    }
+}

sofa-boot-project/sofa-boot-autoconfigure/src/main/java/com/alipay/sofa/boot/autoconfigure/problem/SofaProblemDetailAutoConfiguration.java

@@ -0,0 +1,97 @@
+/*
+ * 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 com.alipay.sofa.boot.autoconfigure.problem;
+
+import com.alipay.sofa.boot.autoconfigure.rpc.SofaRpcAutoConfiguration;
+import com.alipay.sofa.rpc.config.JAXRSProviderManager;
+import org.springframework.beans.factory.ObjectProvider;
+import org.springframework.boot.autoconfigure.AutoConfiguration;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnClass;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty;
+import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication;
+import org.springframework.boot.context.properties.EnableConfigurationProperties;
+import org.springframework.context.MessageSource;
+import org.springframework.context.annotation.Bean;
+import org.springframework.context.annotation.Configuration;
+import org.springframework.core.env.Environment;
+import org.springframework.http.ProblemDetail;
+
+import javax.ws.rs.ext.ExceptionMapper;
+
+/**
+ * Auto-configuration for SOFABoot problem detail support.
+ *
+ * @author OpenAI
+ */
+@AutoConfiguration(after = SofaRpcAutoConfiguration.class)
+@ConditionalOnClass(ProblemDetail.class)
+@ConditionalOnProperty(prefix = "sofa.boot.problem-detail", name = "enabled", havingValue = "true", matchIfMissing = true)
+@EnableConfigurationProperties(SofaProblemDetailProperties.class)
+public class SofaProblemDetailAutoConfiguration {
+
+    @Bean
+    @ConditionalOnMissingBean
+    public SofaProblemDetailFactory sofaProblemDetailFactory(SofaProblemDetailProperties properties,
+                                                             ObjectProvider<MessageSource> messageSource,
+                                                             Environment environment) {
+        return new SofaProblemDetailFactory(properties, messageSource.getIfAvailable(), environment);
+    }
+
+    @Configuration(proxyBeanMethods = false)
+    @ConditionalOnWebApplication(type = ConditionalOnWebApplication.Type.SERVLET)
+    static class ServletProblemDetailConfiguration {
+
+        @Bean
+        @ConditionalOnMissingBean
+        public SofaProblemDetailExceptionHandler sofaProblemDetailExceptionHandler(SofaProblemDetailFactory factory) {
+            return new SofaProblemDetailExceptionHandler(factory);
+        }
+    }
+
+    @Configuration(proxyBeanMethods = false)
+    @ConditionalOnClass({ ExceptionMapper.class, JAXRSProviderManager.class })
+    static class JaxrsProblemDetailConfiguration {
+
+        @Bean
+        @ConditionalOnMissingBean
+        public SofaRpcExceptionProblemDetailExceptionMapper sofaRpcExceptionProblemDetailExceptionMapper(SofaProblemDetailFactory factory) {
+            SofaRpcExceptionProblemDetailExceptionMapper mapper = new SofaRpcExceptionProblemDetailExceptionMapper(
+                factory);
+            JAXRSProviderManager.registerCustomProviderInstance(mapper);
+            return mapper;
+        }
+
+        @Bean
+        @ConditionalOnMissingBean
+        public SofaRpcRuntimeExceptionProblemDetailExceptionMapper sofaRpcRuntimeExceptionProblemDetailExceptionMapper(SofaProblemDetailFactory factory) {
+            SofaRpcRuntimeExceptionProblemDetailExceptionMapper mapper = new SofaRpcRuntimeExceptionProblemDetailExceptionMapper(
+                factory);
+            JAXRSProviderManager.registerCustomProviderInstance(mapper);
+            return mapper;
+        }
+
+        @Bean
+        @ConditionalOnMissingBean
+        public SofaBootRpcRuntimeExceptionProblemDetailExceptionMapper sofaBootRpcRuntimeExceptionProblemDetailExceptionMapper(SofaProblemDetailFactory factory) {
+            SofaBootRpcRuntimeExceptionProblemDetailExceptionMapper mapper = new SofaBootRpcRuntimeExceptionProblemDetailExceptionMapper(
+                factory);
+            JAXRSProviderManager.registerCustomProviderInstance(mapper);
+            return mapper;
+        }
+    }
+}