Support Spring formatting annotations for params (#48)

* Add factory for Param.Expander using ConversionService. Instances use ConversionService and passes annotations (through TypeDescriptor) - ConversionService can now pick up @DateTimeFormat and @NumberFormat and convert the params applying those.

spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/SpringMvcContractTests.java

@@ -18,12 +18,24 @@ package org.springframework.cloud.openfeign.support;
 
 import java.lang.reflect.InvocationTargetException;
 import java.lang.reflect.Method;
+import java.math.BigDecimal;
+import java.time.LocalDateTime;
+import java.time.format.DateTimeFormatter;
 import java.util.Collection;
+import java.util.Collections;
 import java.util.List;
+import java.util.Locale;
 import java.util.Map;
 
+import feign.Param;
 import org.junit.Before;
 import org.junit.Test;
+
+import org.springframework.core.convert.ConversionService;
+import org.springframework.format.annotation.DateTimeFormat;
+import org.springframework.format.annotation.NumberFormat;
+import org.springframework.format.number.NumberStyleFormatter;
+import org.springframework.format.support.FormattingConversionServiceFactoryBean;
 import org.springframework.http.MediaType;
 import org.springframework.http.ResponseEntity;
 import org.springframework.util.MultiValueMap;
@@ -48,6 +60,7 @@ import feign.MethodMetadata;
 
 /**
  * @author chadjaros
+ * @author Halvdan Hoem Grelland
  */
 public class SpringMvcContractTests {
 	private static final Class<?> EXECUTABLE_TYPE;
@@ -67,7 +80,12 @@ public class SpringMvcContractTests {
 
 	@Before
 	public void setup() {
-		this.contract = new SpringMvcContract();
+		FormattingConversionServiceFactoryBean conversionServiceFactoryBean
+				= new FormattingConversionServiceFactoryBean();
+		conversionServiceFactoryBean.afterPropertiesSet();
+		ConversionService conversionService = conversionServiceFactoryBean.getObject();
+
+		this.contract = new SpringMvcContract(Collections.emptyList(), conversionService);
 	}
 
 	@Test
@@ -255,6 +273,47 @@ public class SpringMvcContractTests {
 				data.template().queries().get("amount").iterator().next());
 	}
 
+	@Test
+	public void testProcessAnnotations_DateTimeFormatParam() throws Exception {
+		Method method = TestTemplate_DateTimeFormatParameter.class.getDeclaredMethod(
+				"getTest", LocalDateTime.class);
+		MethodMetadata data = this.contract
+				.parseAndValidateMetadata(method.getDeclaringClass(), method);
+
+		Param.Expander expander = data.indexToExpander().get(0);
+		assertNotNull(expander);
+
+		LocalDateTime input = LocalDateTime.of(2001, 10, 12, 23, 56, 3);
+
+		DateTimeFormatter formatter = DateTimeFormatter.ofPattern(
+				TestTemplate_DateTimeFormatParameter.CUSTOM_PATTERN);
+
+		String expected = formatter.format(input);
+
+		assertEquals(expected, expander.expand(input));
+	}
+
+	@Test
+	public void testProcessAnnotations_NumberFormatParam() throws Exception {
+		Method method = TestTemplate_NumberFormatParameter.class.getDeclaredMethod(
+				"getTest", BigDecimal.class);
+		MethodMetadata data = this.contract
+				.parseAndValidateMetadata(method.getDeclaringClass(), method);
+
+		Param.Expander expander = data.indexToExpander().get(0);
+		assertNotNull(expander);
+
+		NumberStyleFormatter formatter = new NumberStyleFormatter(
+				TestTemplate_NumberFormatParameter.CUSTOM_PATTERN);
+
+		BigDecimal input = BigDecimal.valueOf(1220.345);
+
+		String expected = formatter.print(input, Locale.getDefault());
+		String actual = expander.expand(input);
+
+		assertEquals(expected, actual);
+	}
+
 	@Test
 	public void testProcessAnnotations_Advanced2() throws Exception {
 		Method method = TestTemplate_Advanced.class.getDeclaredMethod("getTest");
@@ -539,6 +598,24 @@ public class SpringMvcContractTests {
 		TestObject getTest();
 	}
 
+	public interface TestTemplate_DateTimeFormatParameter {
+
+		String CUSTOM_PATTERN = "dd-MM-yyyy HH:mm";
+
+		@RequestMapping(method = RequestMethod.GET)
+		String getTest(@RequestParam(name = "localDateTime")
+				@DateTimeFormat(pattern = CUSTOM_PATTERN) LocalDateTime localDateTime);
+	}
+
+	public interface TestTemplate_NumberFormatParameter {
+
+		String CUSTOM_PATTERN = "$###,###.###";
+
+		@RequestMapping(method = RequestMethod.GET)
+		String getTest(@RequestParam("amount")
+				@NumberFormat(pattern = CUSTOM_PATTERN) BigDecimal amount);
+	}
+
 	@JsonAutoDetect(fieldVisibility = JsonAutoDetect.Visibility.ANY, getterVisibility = JsonAutoDetect.Visibility.NONE, setterVisibility = JsonAutoDetect.Visibility.NONE)
 	public class TestObject {
 

spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/valid/FeignClientTests.java

@@ -20,6 +20,7 @@ import java.lang.reflect.InvocationHandler;
 import java.lang.reflect.Method;
 import java.lang.reflect.Proxy;
 import java.text.ParseException;
+import java.time.LocalDate;
 import java.util.ArrayList;
 import java.util.Arrays;
 import java.util.Collection;
@@ -53,6 +54,7 @@ import org.springframework.context.annotation.Configuration;
 import org.springframework.context.annotation.Import;
 import org.springframework.format.Formatter;
 import org.springframework.format.FormatterRegistry;
+import org.springframework.format.annotation.DateTimeFormat;
 import org.springframework.http.HttpEntity;
 import org.springframework.http.HttpStatus;
 import org.springframework.http.ResponseEntity;
@@ -95,6 +97,7 @@ import rx.Single;
  * @author Spencer Gibb
  * @author Jakub Narloch
  * @author Erik Kringen
+ * @author Halvdan Hoem Grelland
  */
 @RunWith(SpringJUnit4ClassRunner.class)
 @SpringBootTest(classes = FeignClientTests.Application.class, webEnvironment = WebEnvironment.RANDOM_PORT, value = {
@@ -189,6 +192,11 @@ public class FeignClientTests {
 		@RequestMapping(method = RequestMethod.GET, path = "/helloparams")
 		List<String> getParams(@RequestParam("params") List<String> params);
 
+		@RequestMapping(method = RequestMethod.GET, path = "/formattedparams")
+		List<LocalDate> getFormattedParams(
+				@RequestParam("params")
+				@DateTimeFormat(pattern = "dd-MM-yyyy") List<LocalDate> params);
+
 		@RequestMapping(method = RequestMethod.GET, path = "/hellos")
 		HystrixCommand<List<Hello>> getHellosHystrix();
 
@@ -444,6 +452,13 @@ public class FeignClientTests {
 			return params;
 		}
 
+		@RequestMapping(method = RequestMethod.GET, path = "/formattedparams")
+		public List<LocalDate> getFormattedParams(
+				@RequestParam("params")
+				@DateTimeFormat(pattern = "dd-MM-yyyy") List<LocalDate> params) {
+			return params;
+		}
+
 		@RequestMapping(method = RequestMethod.GET, path = "/noContent")
 		ResponseEntity<Void> noContent() {
 			return ResponseEntity.noContent().build();
@@ -586,6 +601,15 @@ public class FeignClientTests {
 		assertEquals("params size was wrong", list.size(), params.size());
 	}
 
+	@Test
+	public void testFormattedParams() {
+		List<LocalDate> list = Arrays.asList(
+				LocalDate.of(2001, 1, 1), LocalDate.of(2018, 6, 10));
+		List<LocalDate> params = this.testClient.getFormattedParams(list);
+		assertNotNull("params was null", params);
+		assertEquals("params not converted correctly", list, params);
+	}
+
 	@Test
 	public void testHystrixCommand() throws NoSuchMethodException {
 		HystrixCommand<List<Hello>> command = this.testClient.getHellosHystrix();