Added an annotation to help substitute mappings via properties

dilipkrish · dilipkrish · commit ddc08804d2e5 · 2017-04-27T20:17:03.000-05:00
Also added a handler mapping that we can use by hand to resolve controller actions, rather than have spring-mvc detect the request mappings. This allows us to resolve the endpoints via properties without introducing property sources placeholder.

(1770)
diff --git a/springfox-spring-web/src/main/java/springfox/documentation/spring/web/PropertySourcedMapping.java b/springfox-spring-web/src/main/java/springfox/documentation/spring/web/PropertySourcedMapping.java
@@ -0,0 +1,36 @@
+/*
+ *
+ *  Copyright 2017-2018 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
+ *
+ *         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 springfox.documentation.spring.web;
+
+import org.springframework.web.bind.annotation.Mapping;
+
+import java.lang.annotation.Documented;
+import java.lang.annotation.ElementType;
+import java.lang.annotation.Retention;
+import java.lang.annotation.RetentionPolicy;
+import java.lang.annotation.Target;
+
+@Target({ ElementType.METHOD, ElementType.TYPE})
+@Retention(RetentionPolicy.RUNTIME)
+@Documented
+@Mapping
+public @interface PropertySourcedMapping {
+  String propertyKey();
+  String value();
+}
diff --git a/springfox-spring-web/src/main/java/springfox/documentation/spring/web/PropertySourcedRequestMappingHandlerMapping.java b/springfox-spring-web/src/main/java/springfox/documentation/spring/web/PropertySourcedRequestMappingHandlerMapping.java
@@ -0,0 +1,124 @@
+/*
+ *
+ *  Copyright 2017-2018 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
+ *
+ *         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 springfox.documentation.spring.web;
+
+import com.google.common.base.Function;
+import com.google.common.base.Optional;
+import org.springframework.core.Ordered;
+import org.springframework.core.annotation.AnnotationUtils;
+import org.springframework.core.env.Environment;
+import org.springframework.stereotype.Controller;
+import org.springframework.web.bind.annotation.RequestMapping;
+import org.springframework.web.method.HandlerMethod;
+import org.springframework.web.servlet.HandlerMapping;
+import org.springframework.web.servlet.mvc.method.RequestMappingInfo;
+import org.springframework.web.servlet.mvc.method.annotation.RequestMappingHandlerMapping;
+import org.springframework.web.util.UriTemplate;
+
+import javax.servlet.http.HttpServletRequest;
+import java.lang.reflect.Method;
+import java.util.LinkedHashMap;
+import java.util.Map;
+
+public class PropertySourcedRequestMappingHandlerMapping extends RequestMappingHandlerMapping {
+
+  private final Map<String, HandlerMethod> handlerMethods = new LinkedHashMap<String, HandlerMethod>();
+  private final Environment environment;
+  private final Object handler;
+
+  public PropertySourcedRequestMappingHandlerMapping(
+      Environment environment,
+      Object handler) {
+    this.environment = environment;
+    this.handler = handler;
+  }
+  
+  @Override
+  protected void initHandlerMethods() {
+    logger.debug("initialising the handler methods");
+    setOrder(Ordered.HIGHEST_PRECEDENCE + 1000);
+    Class<?> clazz = handler.getClass();
+    if (isHandler(clazz)) {
+      for (Method method : clazz.getMethods()) {
+        PropertySourcedMapping mapper = AnnotationUtils.getAnnotation(method, PropertySourcedMapping.class);
+        if (mapper != null) {
+          RequestMappingInfo mapping = getMappingForMethod(method, clazz);
+          HandlerMethod handlerMethod = createHandlerMethod(handler, method);
+          String mappingPath = mappingPath(mapper);
+          if (mappingPath != null) {
+            logger.info(String.format("Mapped URL path [%s] onto method [%s]", mappingPath, handlerMethod.toString()));
+            handlerMethods.put(mappingPath, handlerMethod);
+          } else {
+            for (String path : mapping.getPatternsCondition().getPatterns()) {
+              logger.info(String.format("Mapped URL path [%s] onto method [%s]", path, handlerMethod.toString()));
+              handlerMethods.put(path, handlerMethod);
+            }
+          }
+        }
+      }
+    }
+  }
+
+  private String mappingPath(final PropertySourcedMapping mapper) {
+    final String key = mapper.value();
+    return Optional.fromNullable(environment.getProperty(key))
+        .transform(new Function<String, String>() {
+          @Override
+          public String apply(String input) {
+            return input.replace(String.format("${%s}", key), input);
+          }
+        })
+        .orNull();
+  }
+
+  @Override
+  protected boolean isHandler(Class<?> beanType) {
+    return ((AnnotationUtils.findAnnotation(beanType, Controller.class) != null) ||
+                (AnnotationUtils.findAnnotation(beanType, RequestMapping.class) != null));
+  }
+
+  /**
+   * The lookup handler method, maps the SEOMapper method to the request URL.
+   * <p>If no mapping is found, or if the URL is disabled, it will simply drop throug
+   * to the standard 404 handling.</p>
+   *
+   * @param urlPath the path to match.
+   * @param request the http servlet request.
+   * @return The HandlerMethod if one was found.
+   * @throws Exception
+   */
+  @Override
+  protected HandlerMethod lookupHandlerMethod(String urlPath, HttpServletRequest request) throws Exception {
+    logger.debug("looking up handler for path: " + urlPath);
+    HandlerMethod handlerMethod = handlerMethods.get(urlPath);
+    if (handlerMethod != null) {
+      return handlerMethod;
+    }
+    for (String path : handlerMethods.keySet()) {
+      UriTemplate template = new UriTemplate(path);
+      if (template.matches(urlPath)) {
+        request.setAttribute(
+            HandlerMapping.URI_TEMPLATE_VARIABLES_ATTRIBUTE,
+            template.match(urlPath));
+        return handlerMethods.get(path);
+      }
+    }
+    return null;
+  }
+}
