1497 : spring contract annotation alias handled (#1579)

* 1497 : spring contract annotation alias handled

Author: pavansharma36

spring4/src/main/java/feign/spring/SpringContract.java

@@ -16,6 +16,8 @@
 import feign.DeclarativeContract;
 import feign.MethodMetadata;
 import feign.Request;
+import feign.Util;
+import java.lang.reflect.Parameter;
 import java.util.ArrayList;
 import java.util.Collection;
 import org.springframework.web.bind.annotation.*;
@@ -41,8 +43,7 @@ public SpringContract() {
     registerMethodAnnotation(
         RequestMapping.class,
         (requestMapping, data) -> {
-          String[] mappings = requestMapping.value();
-          appendMappings(data, mappings);
+          appendMappings(data, mapping(requestMapping.path(), requestMapping.value()));
 
           if (requestMapping.method().length == 1)
             data.template().method(Request.HttpMethod.valueOf(requestMapping.method()[0].name()));
@@ -51,7 +52,7 @@ public SpringContract() {
     registerMethodAnnotation(
         GetMapping.class,
         (mapping, data) -> {
-          appendMappings(data, mapping.value());
+          appendMappings(data, mapping(mapping.path(), mapping.value()));
           data.template().method(Request.HttpMethod.GET);
           handleProducesAnnotation(data, mapping.produces());
           handleConsumesAnnotation(data, mapping.consumes());
@@ -60,7 +61,7 @@ public SpringContract() {
     registerMethodAnnotation(
         PostMapping.class,
         (mapping, data) -> {
-          appendMappings(data, mapping.value());
+          appendMappings(data, mapping(mapping.path(), mapping.value()));
           data.template().method(Request.HttpMethod.POST);
           handleProducesAnnotation(data, mapping.produces());
           handleConsumesAnnotation(data, mapping.consumes());
@@ -69,7 +70,7 @@ public SpringContract() {
     registerMethodAnnotation(
         PutMapping.class,
         (mapping, data) -> {
-          appendMappings(data, mapping.value());
+          appendMappings(data, mapping(mapping.path(), mapping.value()));
           data.template().method(Request.HttpMethod.PUT);
           handleProducesAnnotation(data, mapping.produces());
           handleConsumesAnnotation(data, mapping.consumes());
@@ -78,7 +79,7 @@ public SpringContract() {
     registerMethodAnnotation(
         DeleteMapping.class,
         (mapping, data) -> {
-          appendMappings(data, mapping.value());
+          appendMappings(data, mapping(mapping.path(), mapping.value()));
           data.template().method(Request.HttpMethod.DELETE);
           handleProducesAnnotation(data, mapping.produces());
           handleConsumesAnnotation(data, mapping.consumes());
@@ -87,7 +88,7 @@ public SpringContract() {
     registerMethodAnnotation(
         PatchMapping.class,
         (mapping, data) -> {
-          appendMappings(data, mapping.value());
+          appendMappings(data, mapping(mapping.path(), mapping.value()));
           data.template().method(Request.HttpMethod.PATCH);
           handleProducesAnnotation(data, mapping.produces());
           handleConsumesAnnotation(data, mapping.consumes());
@@ -103,26 +104,54 @@ public SpringContract() {
         (ann, data) -> {
           data.ignoreMethod();
         });
-    registerParameterAnnotation(
-        PathVariable.class,
-        (parameterAnnotation, data, paramIndex) -> {
-          String name = PathVariable.class.cast(parameterAnnotation).value();
-          nameParam(data, name, paramIndex);
-        });
+    registerParameterAnnotation(PathVariable.class, pathVariableParameterAnnotationProcessor());
 
     registerParameterAnnotation(
         RequestBody.class,
         (body, data, paramIndex) -> {
           handleProducesAnnotation(data, "application/json");
         });
-    registerParameterAnnotation(
-        RequestParam.class,
-        (parameterAnnotation, data, paramIndex) -> {
-          String name = RequestParam.class.cast(parameterAnnotation).value();
-          Collection<String> query = addTemplatedParam(data.template().queries().get(name), name);
-          data.template().query(name, query);
-          nameParam(data, name, paramIndex);
-        });
+    registerParameterAnnotation(RequestParam.class, requestParamParameterAnnotationProcessor());
+  }
+
+  private String[] mapping(String[] firstPriority, String[] fallback) {
+    return firstPriority.length > 0 ? firstPriority : fallback;
+  }
+
+  private String parameterName(String firstPriority, String secondPriority, Parameter parameter) {
+    if (Util.isNotBlank(firstPriority)) {
+      return firstPriority;
+    } else if (Util.isNotBlank(secondPriority)) {
+      return secondPriority;
+    } else {
+      if (parameter.isNamePresent()) {
+        return parameter.getName();
+      } else {
+        return firstPriority;
+      }
+    }
+  }
+
+  private DeclarativeContract.ParameterAnnotationProcessor<PathVariable>
+      pathVariableParameterAnnotationProcessor() {
+    return (parameterAnnotation, data, paramIndex) -> {
+      Parameter parameter = data.method().getParameters()[paramIndex];
+      String name =
+          parameterName(parameterAnnotation.name(), parameterAnnotation.value(), parameter);
+      nameParam(data, name, paramIndex);
+    };
+  }
+
+  private DeclarativeContract.ParameterAnnotationProcessor<RequestParam>
+      requestParamParameterAnnotationProcessor() {
+    return (parameterAnnotation, data, paramIndex) -> {
+      Parameter parameter = data.method().getParameters()[paramIndex];
+      String name =
+          parameterName(parameterAnnotation.name(), parameterAnnotation.value(), parameter);
+      Collection<String> query = addTemplatedParam(data.template().queries().get(name), name);
+      data.template().query(name, query);
+      nameParam(data, name, paramIndex);
+    };
   }
 
   private void appendMappings(MethodMetadata data, String[] mappings) {

spring4/src/test/java/feign/spring/SpringContractTest.java

@@ -49,6 +49,7 @@ public void setup() throws IOException {
             .noContent(HttpMethod.GET, "/health/1")
             .noContent(HttpMethod.GET, "/health/1?deep=true")
             .noContent(HttpMethod.GET, "/health/1?deep=true&dryRun=true")
+            .noContent(HttpMethod.GET, "/health/name?deep=true&dryRun=true")
             .ok(HttpMethod.GET, "/health/generic", "{}");
     resource =
         Feign.builder()
@@ -59,6 +60,20 @@ public void setup() throws IOException {
             .target(new MockTarget<>(HealthResource.class));
   }
 
+  @Test
+  public void noPath() {
+    resource.getStatus();
+
+    mockClient.verifyOne(HttpMethod.GET, "/health");
+  }
+
+  @Test
+  public void testWithName() {
+    resource.checkWithName("name", true, true);
+
+    mockClient.verifyOne(HttpMethod.GET, "/health/name?deep=true&dryRun=true");
+  }
+
   @Test
   public void requestParam() {
     resource.check("1", true);
@@ -128,5 +143,11 @@ public void check(
         reason = "This customer is not found in the system")
     @ExceptionHandler(MissingResourceException.class)
     void missingResourceExceptionHandler();
+
+    @RequestMapping(value = "/{id}", method = RequestMethod.GET)
+    void checkWithName(
+        @PathVariable(name = "id") String campaignId,
+        @RequestParam(name = "deep", defaultValue = "false") boolean deepCheck,
+        @RequestParam(name = "dryRun", defaultValue = "false") boolean dryRun);
   }
 }