Merge pull request #513 from UbaidurRehman1/enhancement/gh-340-api-gateway

update config server and discovery server to fix spring fox exception with spring boot 2.6.2 (gh-512)

Author: ubaid4j

config/src/main/java/com/ubaid/ms/config/ConfigServer.java

@@ -1,8 +1,18 @@
 package com.ubaid.ms.config;
 
+import java.lang.reflect.Field;
+import java.util.List;
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.config.BeanPostProcessor;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.config.server.EnableConfigServer;
+import org.springframework.context.annotation.Bean;
+import org.springframework.lang.NonNull;
+import org.springframework.util.ReflectionUtils;
+import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
+import springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider;
+import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;
 
 @EnableConfigServer
 @SpringBootApplication
@@ -12,4 +22,41 @@ public static void main(String[] args) {
         SpringApplication.run(ConfigServer.class, args);
     }
 
+    @Bean
+    public static BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {
+        return new BeanPostProcessor() {
+
+            @Override
+            public Object postProcessAfterInitialization(@NonNull Object bean, @NonNull String beanName) throws BeansException {
+                if (bean instanceof WebMvcRequestHandlerProvider
+                    || bean instanceof WebFluxRequestHandlerProvider) {
+                    customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
+                }
+                return bean;
+            }
+
+            private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(
+                List<T> mappings) {
+                List<T> copy = mappings.stream()
+                    .filter(mapping -> mapping.getPatternParser() == null)
+                    .toList();
+                mappings.clear();
+                mappings.addAll(copy);
+            }
+
+            @SuppressWarnings("unchecked")
+            private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) {
+                try {
+                    Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
+                    assert field != null;
+                    field.setAccessible(true);
+                    return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
+                } catch (IllegalArgumentException | IllegalAccessException e) {
+                    throw new IllegalStateException(e);
+                }
+            }
+        };
+    }
+
+
 }

config/src/main/resources/application.yml

@@ -3,5 +3,10 @@ spring:
         name: spring-cloud-config-server
     profiles:
         active: @activatedProperties@
+    mvc:
+        pathmatch:
+            matching-strategy: ant_path_matcher
+    main:
+        allow-bean-definition-overriding: true
 server:
-    port: 8888
+    port: 8888

discovery/src/main/java/com/ubaid/ms/discovery/DiscoveryApp.java

@@ -1,12 +1,59 @@
 package com.ubaid.ms.discovery;
 
+import java.lang.reflect.Field;
+import java.util.List;
+import org.springframework.beans.BeansException;
+import org.springframework.beans.factory.config.BeanPostProcessor;
 import org.springframework.boot.SpringApplication;
 import org.springframework.boot.autoconfigure.SpringBootApplication;
 import org.springframework.cloud.netflix.eureka.server.EnableEurekaServer;
+import org.springframework.context.annotation.Bean;
+import org.springframework.lang.NonNull;
+import org.springframework.util.ReflectionUtils;
+import org.springframework.web.servlet.mvc.method.RequestMappingInfoHandlerMapping;
+import springfox.documentation.spring.web.plugins.WebFluxRequestHandlerProvider;
+import springfox.documentation.spring.web.plugins.WebMvcRequestHandlerProvider;
 
 @SpringBootApplication
 @EnableEurekaServer
 public class DiscoveryApp {
 
     public static void main(String[] args) { SpringApplication.run(DiscoveryApp.class, args); }
+
+    @Bean
+    public static BeanPostProcessor springfoxHandlerProviderBeanPostProcessor() {
+        return new BeanPostProcessor() {
+
+            @Override
+            public Object postProcessAfterInitialization(@NonNull Object bean, @NonNull String beanName) throws BeansException {
+                if (bean instanceof WebMvcRequestHandlerProvider
+                    || bean instanceof WebFluxRequestHandlerProvider) {
+                    customizeSpringfoxHandlerMappings(getHandlerMappings(bean));
+                }
+                return bean;
+            }
+
+            private <T extends RequestMappingInfoHandlerMapping> void customizeSpringfoxHandlerMappings(
+                List<T> mappings) {
+                List<T> copy = mappings.stream()
+                    .filter(mapping -> mapping.getPatternParser() == null)
+                    .toList();
+                mappings.clear();
+                mappings.addAll(copy);
+            }
+
+            @SuppressWarnings("unchecked")
+            private List<RequestMappingInfoHandlerMapping> getHandlerMappings(Object bean) {
+                try {
+                    Field field = ReflectionUtils.findField(bean.getClass(), "handlerMappings");
+                    assert field != null;
+                    field.setAccessible(true);
+                    return (List<RequestMappingInfoHandlerMapping>) field.get(bean);
+                } catch (IllegalArgumentException | IllegalAccessException e) {
+                    throw new IllegalStateException(e);
+                }
+            }
+        };
+    }
+
 }

discovery/src/main/resources/application.properties

@@ -11,3 +11,7 @@ eureka.instance.prefer-ip-address=true
 eureka.instance.instance-id=${spring.cloud.client.ip-address}:${server.port}
 eureka.instance.hostname=${spring.cloud.client.ip-address}
 
+
+#----------------------------Disabling warnings ------#
+spring.mvc.pathmatch.matching-strategy=ant_path_matcher
+spring.main.allow-circular-references=true