diff --git a/README.adoc b/README.adoc index c8917b89..1637c57e 100644 --- a/README.adoc +++ b/README.adoc @@ -66,23 +66,9 @@ the `.mvn` configuration, so if you find you have to do it to make a build succeed, please raise a ticket to get the settings added to source control. -For hints on how to build the project look in `.travis.yml` if there -is one. There should be a "script" and maybe "install" command. Also -look at the "services" section to see if any services need to be -running locally (e.g. mongo or rabbit). Ignore the git-related bits -that you might find in "before_install" since they're related to setting git -credentials and you already have those. - -The projects that require middleware generally include a -`docker-compose.yml`, so consider using -https://docs.docker.com/compose/[Docker Compose] to run the middeware servers -in Docker containers. See the README in the -https://github.com/spring-cloud-samples/scripts[scripts demo -repository] for specific instructions about the common cases of mongo, -rabbit and redis. - -NOTE: If all else fails, build with the command from `.travis.yml` (usually -`./mvnw install`). +The projects that require middleware (i.e. Redis) for testing generally +require that a local instance of [Docker](https://www.docker.com/get-started) is installed and running. + === Documentation diff --git a/docs/pom.xml b/docs/pom.xml index 6ffe2c05..d1233ca9 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -6,7 +6,7 @@ org.springframework.cloud spring-cloud-openfeign - 3.0.4-SNAPSHOT + 3.1.0-SNAPSHOT spring-cloud-openfeign-docs jar diff --git a/docs/src/main/asciidoc/_configprops.adoc b/docs/src/main/asciidoc/_configprops.adoc index 6a46bd84..3bba5138 100644 --- a/docs/src/main/asciidoc/_configprops.adoc +++ b/docs/src/main/asciidoc/_configprops.adoc @@ -13,7 +13,6 @@ |feign.compression.request.mime-types | `[text/xml, application/xml, application/json]` | The list of supported mime types. |feign.compression.request.min-request-size | `2048` | The minimum threshold content size. |feign.compression.response.enabled | `false` | Enables the response from Feign to be compressed. -|feign.compression.response.useGzipDecoder | `false` | Enables the default gzip decoder to be used. |feign.encoder.charset-from-content-type | `false` | Indicates whether the charset should be derived from the {@code Content-Type} header. |feign.httpclient.connection-timeout | `2000` | |feign.httpclient.connection-timer-repeat | `3000` | diff --git a/docs/src/main/asciidoc/index.adoc b/docs/src/main/asciidoc/index.adoc deleted file mode 120000 index f609d02f..00000000 --- a/docs/src/main/asciidoc/index.adoc +++ /dev/null @@ -1 +0,0 @@ -spring-cloud-openfeign.adoc \ No newline at end of file diff --git a/docs/src/main/asciidoc/index.adoc b/docs/src/main/asciidoc/index.adoc new file mode 100644 index 00000000..503e0a53 --- /dev/null +++ b/docs/src/main/asciidoc/index.adoc @@ -0,0 +1 @@ +include::spring-cloud-openfeign.adoc[] diff --git a/docs/src/main/asciidoc/spring-cloud-openfeign.adoc b/docs/src/main/asciidoc/spring-cloud-openfeign.adoc index b59ecfff..95c69c18 100644 --- a/docs/src/main/asciidoc/spring-cloud-openfeign.adoc +++ b/docs/src/main/asciidoc/spring-cloud-openfeign.adoc @@ -52,6 +52,9 @@ public interface StoreClient { @RequestMapping(method = RequestMethod.POST, value = "/stores/{storeId}", consumes = "application/json") Store update(@PathVariable("storeId") Long storeId, Store store); + + @RequestMapping(method = RequestMethod.DELETE, value = "/stores/{storeId:\\d+}") + void delete(@PathVariable Long storeId); } ---- @@ -70,6 +73,11 @@ in your external configuration using https://cloud.spring.io/spring-cloud-static Spring Cloud OpenFeign supports all the features available for the blocking mode of Spring Cloud LoadBalancer. You can read more about them in the https://docs.spring.io/spring-cloud-commons/docs/current/reference/html/#spring-cloud-loadbalancer[project documentation]. +TIP: To use `@EnableFeignClients` annotation on `@Configuration`-annotated-classes, make sure to specify where the clients are located, for example: +`@EnableFeignClients(basePackages = "com.example.clients")` +or list them explicitly: +`@EnableFeignClients(clients = InventoryServiceFeignClient.class)` + [[spring-cloud-feign-overriding-defaults]] === Overriding Feign Defaults @@ -343,7 +351,22 @@ public class FooConfiguration { } ---- -The circuit breaker name follows this pattern `#`. When calling a `@FeignClient` with name `foo` and the called interface method is `bar` then the circuit breaker name will be `foo_bar`. +The circuit breaker name follows this pattern `#()`. When calling a `@FeignClient` with `FooClient` interface and the called interface method that has no parameters is `bar` then the circuit breaker name will be `FooClient#bar()`. + +NOTE: As of 2020.0.2, the circuit breaker name pattern has changed from `_`. +Using `CircuitBreakerNameResolver` introduced in 2020.0.4, circuit breaker names can retain the old pattern. + +Providing a bean of `CircuitBreakerNameResolver`, you can change the circuit breaker name pattern. +[source,java,indent=0] +---- +@Configuration +public class FooConfiguration { + @Bean + public CircuitBreakerNameResolver circuitBreakerNameResolver() { + return (String feignClientName, Target target, Method method) -> feignClientName + "_" + method.getName(); + } +} +---- To enable Spring Cloud CircuitBreaker group set the `feign.circuitbreaker.group.enabled` property to `true` (by default `false`). @@ -472,9 +495,9 @@ public interface UserClient extends UserService { ---- NOTE: It is generally not advisable to share an interface between a -server and a client. It introduces tight coupling, and also actually -doesn't work with Spring MVC in its current form (method parameter -mapping is not inherited). +server and a client. It introduces tight coupling, and is also not supported by +all the maintained Spring MVC versions (method parameter +mapping is not inherited in some versions). === Feign request/response compression @@ -498,14 +521,6 @@ feign.compression.request.min-request-size=2048 These properties allow you to be selective about the compressed media types and minimum request threshold length. -For http clients except OkHttpClient, default gzip decoder can be enabled to decode gzip response in UTF-8 encoding: - -[source,java] ----- -feign.compression.response.enabled=true -feign.compression.response.useGzipDecoder=true ----- - === Feign logging A logger is created for each Feign client created. By default the name of the logger is the full class name of the interface used to create the Feign client. Feign logging only responds to the `DEBUG` level. diff --git a/pom.xml b/pom.xml index d24c3c9b..38899ff8 100644 --- a/pom.xml +++ b/pom.xml @@ -4,14 +4,14 @@ xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> 4.0.0 spring-cloud-openfeign - 3.0.4-SNAPSHOT + 3.1.0-SNAPSHOT pom Spring Cloud OpenFeign Spring Cloud OpenFeign org.springframework.cloud spring-cloud-build - 3.0.4-SNAPSHOT + 3.1.0-SNAPSHOT @@ -26,7 +26,7 @@ ${basedir} 2.11.3 - 3.0.4-SNAPSHOT + 3.1.0-SNAPSHOT 2.10 diff --git a/spring-cloud-openfeign-core/pom.xml b/spring-cloud-openfeign-core/pom.xml index d48d8be4..1f87df49 100644 --- a/spring-cloud-openfeign-core/pom.xml +++ b/spring-cloud-openfeign-core/pom.xml @@ -6,7 +6,7 @@ org.springframework.cloud spring-cloud-openfeign - 3.0.4-SNAPSHOT + 3.1.0-SNAPSHOT .. spring-cloud-openfeign-core diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/CircuitBreakerNameResolver.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/CircuitBreakerNameResolver.java new file mode 100644 index 00000000..a7425250 --- /dev/null +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/CircuitBreakerNameResolver.java @@ -0,0 +1,34 @@ +/* + * Copyright 2013-2021 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 + * + * https://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 org.springframework.cloud.openfeign; + +import java.lang.reflect.Method; + +import feign.Target; + +/** + * Used to resolve a circuitbreaker name which will be used in + * {@link org.springframework.cloud.client.circuitbreaker.CircuitBreakerFactory}. + * + * @author Kwangyong Kim + * @since 2020.0.4 + */ +public interface CircuitBreakerNameResolver { + + String resolveCircuitBreakerName(String feignClientName, Target target, Method method); + +} diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignAutoConfiguration.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignAutoConfiguration.java index fd2dd7be..3df17bd5 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignAutoConfiguration.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignAutoConfiguration.java @@ -17,6 +17,7 @@ package org.springframework.cloud.openfeign; import java.io.IOException; +import java.lang.reflect.Method; import java.util.ArrayList; import java.util.List; import java.util.Timer; @@ -29,6 +30,7 @@ import com.fasterxml.jackson.databind.Module; import feign.Client; import feign.Feign; import feign.RequestInterceptor; +import feign.Target; import feign.hc5.ApacheHttp5Client; import feign.httpclient.ApacheHttpClient; import feign.okhttp.OkHttpClient; @@ -56,7 +58,6 @@ import org.springframework.cloud.commons.httpclient.ApacheHttpClientFactory; import org.springframework.cloud.commons.httpclient.OkHttpClientConnectionPoolFactory; import org.springframework.cloud.commons.httpclient.OkHttpClientFactory; import org.springframework.cloud.openfeign.security.OAuth2FeignRequestInterceptor; -import org.springframework.cloud.openfeign.support.DefaultGzipDecoderConfiguration; import org.springframework.cloud.openfeign.support.FeignEncoderProperties; import org.springframework.cloud.openfeign.support.FeignHttpClientProperties; import org.springframework.cloud.openfeign.support.PageJacksonModule; @@ -79,12 +80,12 @@ import org.springframework.security.oauth2.client.resource.OAuth2ProtectedResour * @author Olga Maciaszek-Sharma * @author Nguyen Ky Thanh * @author Andrii Bohutskyi + * @author Kwangyong Kim */ @Configuration(proxyBeanMethods = false) @ConditionalOnClass(Feign.class) @EnableConfigurationProperties({ FeignClientProperties.class, FeignHttpClientProperties.class, FeignEncoderProperties.class }) -@Import(DefaultGzipDecoderConfiguration.class) public class FeignAutoConfiguration { private static final Log LOG = LogFactory.getLog(FeignAutoConfiguration.class); @@ -146,12 +147,29 @@ public class FeignAutoConfiguration { return new DefaultTargeter(); } + @Bean + @ConditionalOnMissingBean(CircuitBreakerNameResolver.class) + public CircuitBreakerNameResolver circuitBreakerNameResolver() { + return new DefaultCircuitBreakerNameResolver(); + } + @Bean @ConditionalOnMissingBean @ConditionalOnBean(CircuitBreakerFactory.class) public Targeter circuitBreakerFeignTargeter(CircuitBreakerFactory circuitBreakerFactory, - @Value("${feign.circuitbreaker.group.enabled:false}") boolean circuitBreakerGroupEnabled) { - return new FeignCircuitBreakerTargeter(circuitBreakerFactory, circuitBreakerGroupEnabled); + @Value("${feign.circuitbreaker.group.enabled:false}") boolean circuitBreakerGroupEnabled, + CircuitBreakerNameResolver circuitBreakerNameResolver) { + return new FeignCircuitBreakerTargeter(circuitBreakerFactory, circuitBreakerGroupEnabled, + circuitBreakerNameResolver); + } + + static class DefaultCircuitBreakerNameResolver implements CircuitBreakerNameResolver { + + @Override + public String resolveCircuitBreakerName(String feignClientName, Target target, Method method) { + return Feign.configKey(target.getClass(), method); + } + } } diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignCircuitBreaker.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignCircuitBreaker.java index 979d079b..f7d55b4b 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignCircuitBreaker.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignCircuitBreaker.java @@ -27,6 +27,7 @@ import org.springframework.cloud.client.circuitbreaker.CircuitBreakerFactory; * * @author Marcin Grzejszczak * @author Andrii Bohutskyi + * @author Kwangyong Kim * @since 3.0.0 */ public final class FeignCircuitBreaker { @@ -53,6 +54,8 @@ public final class FeignCircuitBreaker { private boolean circuitBreakerGroupEnabled; + private CircuitBreakerNameResolver circuitBreakerNameResolver; + Builder circuitBreakerFactory(CircuitBreakerFactory circuitBreakerFactory) { this.circuitBreakerFactory = circuitBreakerFactory; return this; @@ -68,6 +71,11 @@ public final class FeignCircuitBreaker { return this; } + Builder circuitBreakerNameResolver(CircuitBreakerNameResolver circuitBreakerNameResolver) { + this.circuitBreakerNameResolver = circuitBreakerNameResolver; + return this; + } + public T target(Target target, T fallback) { return build(fallback != null ? new FallbackFactory.Default(fallback) : null).newInstance(target); } @@ -82,9 +90,9 @@ public final class FeignCircuitBreaker { } public Feign build(final FallbackFactory nullableFallbackFactory) { - super.invocationHandlerFactory( - (target, dispatch) -> new FeignCircuitBreakerInvocationHandler(circuitBreakerFactory, - feignClientName, target, dispatch, nullableFallbackFactory, circuitBreakerGroupEnabled)); + super.invocationHandlerFactory((target, dispatch) -> new FeignCircuitBreakerInvocationHandler( + circuitBreakerFactory, feignClientName, target, dispatch, nullableFallbackFactory, + circuitBreakerGroupEnabled, circuitBreakerNameResolver)); return super.build(); } diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignCircuitBreakerInvocationHandler.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignCircuitBreakerInvocationHandler.java index 3cf62021..531e3c78 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignCircuitBreakerInvocationHandler.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignCircuitBreakerInvocationHandler.java @@ -24,7 +24,6 @@ import java.util.Map; import java.util.function.Function; import java.util.function.Supplier; -import feign.Feign; import feign.InvocationHandlerFactory; import feign.Target; @@ -51,9 +50,11 @@ class FeignCircuitBreakerInvocationHandler implements InvocationHandler { private final boolean circuitBreakerGroupEnabled; + private final CircuitBreakerNameResolver circuitBreakerNameResolver; + FeignCircuitBreakerInvocationHandler(CircuitBreakerFactory factory, String feignClientName, Target target, Map dispatch, FallbackFactory nullableFallbackFactory, - boolean circuitBreakerGroupEnabled) { + boolean circuitBreakerGroupEnabled, CircuitBreakerNameResolver circuitBreakerNameResolver) { this.factory = factory; this.feignClientName = feignClientName; this.target = checkNotNull(target, "target"); @@ -61,6 +62,7 @@ class FeignCircuitBreakerInvocationHandler implements InvocationHandler { this.fallbackMethodMap = toFallbackMethod(dispatch); this.nullableFallbackFactory = nullableFallbackFactory; this.circuitBreakerGroupEnabled = circuitBreakerGroupEnabled; + this.circuitBreakerNameResolver = circuitBreakerNameResolver; } @Override @@ -82,7 +84,8 @@ class FeignCircuitBreakerInvocationHandler implements InvocationHandler { else if ("toString".equals(method.getName())) { return toString(); } - String circuitName = Feign.configKey(target.type(), method); + + String circuitName = circuitBreakerNameResolver.resolveCircuitBreakerName(feignClientName, target, method); CircuitBreaker circuitBreaker = circuitBreakerGroupEnabled ? factory.create(circuitName, feignClientName) : factory.create(circuitName); Supplier supplier = asSupplier(method, args); @@ -106,7 +109,7 @@ class FeignCircuitBreakerInvocationHandler implements InvocationHandler { return () -> { try { RequestContextHolder.setRequestAttributes(requestAttributes); - return this.dispatch.get(method).invoke(args); + return dispatch.get(method).invoke(args); } catch (RuntimeException throwable) { throw throwable; @@ -114,9 +117,6 @@ class FeignCircuitBreakerInvocationHandler implements InvocationHandler { catch (Throwable throwable) { throw new RuntimeException(throwable); } - finally { - RequestContextHolder.resetRequestAttributes(); - } }; } diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignCircuitBreakerTargeter.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignCircuitBreakerTargeter.java index 0a122856..f1ac0238 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignCircuitBreakerTargeter.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignCircuitBreakerTargeter.java @@ -29,9 +29,13 @@ class FeignCircuitBreakerTargeter implements Targeter { private final boolean circuitBreakerGroupEnabled; - FeignCircuitBreakerTargeter(CircuitBreakerFactory circuitBreakerFactory, boolean circuitBreakerGroupEnabled) { + private final CircuitBreakerNameResolver circuitBreakerNameResolver; + + FeignCircuitBreakerTargeter(CircuitBreakerFactory circuitBreakerFactory, boolean circuitBreakerGroupEnabled, + CircuitBreakerNameResolver circuitBreakerNameResolver) { this.circuitBreakerFactory = circuitBreakerFactory; this.circuitBreakerGroupEnabled = circuitBreakerGroupEnabled; + this.circuitBreakerNameResolver = circuitBreakerNameResolver; } @Override @@ -85,7 +89,8 @@ class FeignCircuitBreakerTargeter implements Targeter { private FeignCircuitBreaker.Builder builder(String feignClientName, FeignCircuitBreaker.Builder builder) { return builder.circuitBreakerFactory(circuitBreakerFactory).feignClientName(feignClientName) - .circuitBreakerGroupEnabled(circuitBreakerGroupEnabled); + .circuitBreakerGroupEnabled(circuitBreakerGroupEnabled) + .circuitBreakerNameResolver(circuitBreakerNameResolver); } } diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientFactoryBean.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientFactoryBean.java index ef290045..969520c9 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientFactoryBean.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientFactoryBean.java @@ -17,6 +17,7 @@ package org.springframework.cloud.openfeign; import java.util.ArrayList; +import java.util.Collection; import java.util.List; import java.util.Map; import java.util.Objects; @@ -276,13 +277,8 @@ public class FeignClientFactoryBean builder.encoder(getOrInstantiate(config.getEncoder())); } - if (Objects.nonNull(config.getDefaultRequestHeaders())) { - builder.requestInterceptor(requestTemplate -> requestTemplate.headers(config.getDefaultRequestHeaders())); - } - - if (Objects.nonNull(config.getDefaultQueryParameters())) { - builder.requestInterceptor(requestTemplate -> requestTemplate.queries(config.getDefaultQueryParameters())); - } + addDefaultRequestHeaders(config, builder); + addDefaultQueryParams(config, builder); if (Objects.nonNull(config.getDecoder())) { builder.decoder(getOrInstantiate(config.getDecoder())); @@ -301,6 +297,35 @@ public class FeignClientFactoryBean } } + private void addDefaultQueryParams(FeignClientProperties.FeignClientConfiguration config, Feign.Builder builder) { + Map> defaultQueryParameters = config.getDefaultQueryParameters(); + if (Objects.nonNull(defaultQueryParameters)) { + builder.requestInterceptor(requestTemplate -> { + Map> queries = requestTemplate.queries(); + defaultQueryParameters.keySet().forEach(key -> { + if (!queries.containsKey(key)) { + requestTemplate.query(key, defaultQueryParameters.get(key)); + } + }); + }); + } + } + + private void addDefaultRequestHeaders(FeignClientProperties.FeignClientConfiguration config, + Feign.Builder builder) { + Map> defaultRequestHeaders = config.getDefaultRequestHeaders(); + if (Objects.nonNull(defaultRequestHeaders)) { + builder.requestInterceptor(requestTemplate -> { + Map> headers = requestTemplate.headers(); + defaultRequestHeaders.keySet().forEach(key -> { + if (!headers.containsKey(key)) { + requestTemplate.header(key, defaultRequestHeaders.get(key)); + } + }); + }); + } + } + private T getOrInstantiate(Class tClass) { try { return beanFactory != null ? beanFactory.getBean(tClass) : applicationContext.getBean(tClass); diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java index eda8d607..f25b0da0 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/FeignClientsConfiguration.java @@ -47,6 +47,7 @@ import org.springframework.cloud.client.circuitbreaker.CircuitBreakerFactory; import org.springframework.cloud.openfeign.clientconfig.FeignClientConfigurer; import org.springframework.cloud.openfeign.support.AbstractFormWriter; import org.springframework.cloud.openfeign.support.FeignEncoderProperties; +import org.springframework.cloud.openfeign.support.HttpMessageConverterCustomizer; import org.springframework.cloud.openfeign.support.PageableSpringEncoder; import org.springframework.cloud.openfeign.support.PageableSpringQueryMapEncoder; import org.springframework.cloud.openfeign.support.ResponseEntityDecoder; @@ -70,6 +71,7 @@ import static feign.form.ContentType.MULTIPART; * @author Jonatan Ivanov * @author Olga Maciaszek-Sharma * @author Hyeonmin Park + * @author Yanming Zhou */ @Configuration(proxyBeanMethods = false) public class FeignClientsConfiguration { @@ -97,22 +99,25 @@ public class FeignClientsConfiguration { @Bean @ConditionalOnMissingBean - public Decoder feignDecoder() { - return new OptionalDecoder(new ResponseEntityDecoder(new SpringDecoder(this.messageConverters))); + public Decoder feignDecoder(ObjectProvider customizers) { + return new OptionalDecoder(new ResponseEntityDecoder(new SpringDecoder(messageConverters, customizers))); } @Bean @ConditionalOnMissingBean @ConditionalOnMissingClass("org.springframework.data.domain.Pageable") - public Encoder feignEncoder(ObjectProvider formWriterProvider) { - return springEncoder(formWriterProvider, encoderProperties); + public Encoder feignEncoder(ObjectProvider formWriterProvider, + ObjectProvider customizers) { + return springEncoder(formWriterProvider, encoderProperties, customizers); } @Bean @ConditionalOnClass(name = "org.springframework.data.domain.Pageable") @ConditionalOnMissingBean - public Encoder feignEncoderPageable(ObjectProvider formWriterProvider) { - PageableSpringEncoder encoder = new PageableSpringEncoder(springEncoder(formWriterProvider, encoderProperties)); + public Encoder feignEncoderPageable(ObjectProvider formWriterProvider, + ObjectProvider customizers) { + PageableSpringEncoder encoder = new PageableSpringEncoder( + springEncoder(formWriterProvider, encoderProperties, customizers)); if (springDataWebProperties != null) { encoder.setPageParameter(springDataWebProperties.getPageable().getPageParameter()); @@ -126,20 +131,26 @@ public class FeignClientsConfiguration { @ConditionalOnClass(name = "org.springframework.data.domain.Pageable") @ConditionalOnMissingBean public QueryMapEncoder feignQueryMapEncoderPageable() { - return new PageableSpringQueryMapEncoder(); + PageableSpringQueryMapEncoder queryMapEncoder = new PageableSpringQueryMapEncoder(); + if (springDataWebProperties != null) { + queryMapEncoder.setPageParameter(springDataWebProperties.getPageable().getPageParameter()); + queryMapEncoder.setSizeParameter(springDataWebProperties.getPageable().getSizeParameter()); + queryMapEncoder.setSortParameter(springDataWebProperties.getSort().getSortParameter()); + } + return queryMapEncoder; } @Bean @ConditionalOnMissingBean public Contract feignContract(ConversionService feignConversionService) { boolean decodeSlash = feignClientProperties == null || feignClientProperties.isDecodeSlash(); - return new SpringMvcContract(this.parameterProcessors, feignConversionService, decodeSlash); + return new SpringMvcContract(parameterProcessors, feignConversionService, decodeSlash); } @Bean public FormattingConversionService feignConversionService() { FormattingConversionService conversionService = new DefaultFormattingConversionService(); - for (FeignFormatterRegistrar feignFormatterRegistrar : this.feignFormatterRegistrars) { + for (FeignFormatterRegistrar feignFormatterRegistrar : feignFormatterRegistrars) { feignFormatterRegistrar.registerFormatters(conversionService); } return conversionService; @@ -154,7 +165,7 @@ public class FeignClientsConfiguration { @Bean @ConditionalOnMissingBean(FeignLoggerFactory.class) public FeignLoggerFactory feignLoggerFactory() { - return new DefaultFeignLoggerFactory(this.logger); + return new DefaultFeignLoggerFactory(logger); } @Bean @@ -165,14 +176,15 @@ public class FeignClientsConfiguration { } private Encoder springEncoder(ObjectProvider formWriterProvider, - FeignEncoderProperties encoderProperties) { + FeignEncoderProperties encoderProperties, ObjectProvider customizers) { AbstractFormWriter formWriter = formWriterProvider.getIfAvailable(); if (formWriter != null) { - return new SpringEncoder(new SpringPojoFormEncoder(formWriter), this.messageConverters, encoderProperties); + return new SpringEncoder(new SpringPojoFormEncoder(formWriter), messageConverters, encoderProperties, + customizers); } else { - return new SpringEncoder(new SpringFormEncoder(), this.messageConverters, encoderProperties); + return new SpringEncoder(new SpringFormEncoder(), messageConverters, encoderProperties, customizers); } } diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/annotation/CookieValueParameterProcessor.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/annotation/CookieValueParameterProcessor.java new file mode 100644 index 00000000..3edd4d7b --- /dev/null +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/annotation/CookieValueParameterProcessor.java @@ -0,0 +1,67 @@ +/* + * Copyright 2013-2021 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 + * + * https://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 org.springframework.cloud.openfeign.annotation; + +import java.lang.annotation.Annotation; +import java.lang.reflect.Method; +import java.util.Arrays; + +import feign.MethodMetadata; + +import org.springframework.cloud.openfeign.AnnotatedParameterProcessor; +import org.springframework.http.HttpHeaders; +import org.springframework.web.bind.annotation.CookieValue; + +import static feign.Util.checkState; +import static feign.Util.emptyToNull; + +/** + * @{link CookieValue} annotation processor. + * @author Gong Yi + * + */ +public class CookieValueParameterProcessor implements AnnotatedParameterProcessor { + + private static final Class ANNOTATION = CookieValue.class; + + @Override + public Class getAnnotationType() { + return ANNOTATION; + } + + @Override + public boolean processArgument(AnnotatedParameterContext context, Annotation annotation, Method method) { + int parameterIndex = context.getParameterIndex(); + MethodMetadata data = context.getMethodMetadata(); + CookieValue cookie = ANNOTATION.cast(annotation); + String name = cookie.value().trim(); + checkState(emptyToNull(name) != null, "Cookie.name() was empty on parameter %s", parameterIndex); + context.setParameterName(name); + String cookieExpression = data.template().headers().getOrDefault(HttpHeaders.COOKIE, Arrays.asList("")).stream() + .findFirst().orElse(""); + if (cookieExpression.length() == 0) { + cookieExpression = String.format("%s={%s}", name, name); + } + else { + cookieExpression += String.format("; %s={%s}", name, name); + } + data.template().removeHeader(HttpHeaders.COOKIE); + data.template().header(HttpHeaders.COOKIE, cookieExpression); + return true; + } + +} diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/annotation/PathVariableParameterProcessor.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/annotation/PathVariableParameterProcessor.java index fdfb31a3..80741ee7 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/annotation/PathVariableParameterProcessor.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/annotation/PathVariableParameterProcessor.java @@ -34,6 +34,7 @@ import static feign.Util.emptyToNull; * * @author Jakub Narloch * @author Abhijit Sarkar + * @author Yanming Zhou * @see AnnotatedParameterProcessor */ public class PathVariableParameterProcessor implements AnnotatedParameterProcessor { @@ -54,7 +55,8 @@ public class PathVariableParameterProcessor implements AnnotatedParameterProcess MethodMetadata data = context.getMethodMetadata(); String varName = '{' + name + '}'; - if (!data.template().url().contains(varName) && !searchMapValues(data.template().queries(), varName) + String varNameRegex = ".*\\{" + name + "(:[^}]+)?\\}.*"; + if (!data.template().url().matches(varNameRegex) && !searchMapValues(data.template().queries(), varName) && !searchMapValues(data.template().headers(), varName)) { data.formParams().add(name); } diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/hateoas/FeignHalAutoConfiguration.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/hateoas/FeignHalAutoConfiguration.java index e20d1f43..1a67fe1d 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/hateoas/FeignHalAutoConfiguration.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/hateoas/FeignHalAutoConfiguration.java @@ -16,26 +16,18 @@ package org.springframework.cloud.openfeign.hateoas; -import java.util.Collections; - -import com.fasterxml.jackson.databind.ObjectMapper; - -import org.springframework.beans.factory.ObjectProvider; import org.springframework.boot.autoconfigure.AutoConfigureAfter; import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnClass; -import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnWebApplication; import org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration; import org.springframework.boot.autoconfigure.http.HttpMessageConvertersAutoConfiguration; import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration; +import org.springframework.cloud.openfeign.support.HttpMessageConverterCustomizer; import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Configuration; -import org.springframework.hateoas.RepresentationModel; -import org.springframework.hateoas.mediatype.hal.HalMediaTypeConfiguration; -import org.springframework.hateoas.server.mvc.TypeConstrainedMappingJackson2HttpMessageConverter; - -import static org.springframework.hateoas.MediaTypes.HAL_JSON; +import org.springframework.hateoas.config.HateoasConfiguration; +import org.springframework.hateoas.config.WebConverters; /** * @author Hector Espert @@ -43,23 +35,15 @@ import static org.springframework.hateoas.MediaTypes.HAL_JSON; */ @Configuration(proxyBeanMethods = false) @ConditionalOnWebApplication -@ConditionalOnClass(RepresentationModel.class) +@ConditionalOnClass(WebConverters.class) @AutoConfigureAfter({ JacksonAutoConfiguration.class, HttpMessageConvertersAutoConfiguration.class, - RepositoryRestMvcAutoConfiguration.class }) + RepositoryRestMvcAutoConfiguration.class, HateoasConfiguration.class }) public class FeignHalAutoConfiguration { @Bean - @ConditionalOnBean(HalMediaTypeConfiguration.class) - @ConditionalOnMissingBean - public TypeConstrainedMappingJackson2HttpMessageConverter halJacksonHttpMessageConverter( - ObjectProvider objectMapper, HalMediaTypeConfiguration halConfiguration) { - ObjectMapper mapper = objectMapper.getIfAvailable(ObjectMapper::new).copy(); - halConfiguration.configureObjectMapper(mapper); - TypeConstrainedMappingJackson2HttpMessageConverter converter = new TypeConstrainedMappingJackson2HttpMessageConverter( - RepresentationModel.class); - converter.setSupportedMediaTypes(Collections.singletonList(HAL_JSON)); - converter.setObjectMapper(mapper); - return converter; + @ConditionalOnBean(WebConverters.class) + HttpMessageConverterCustomizer webConvertersCustomizer(WebConverters webConverters) { + return new WebConvertersCustomizer(webConverters); } } diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/hateoas/WebConvertersCustomizer.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/hateoas/WebConvertersCustomizer.java new file mode 100644 index 00000000..79909862 --- /dev/null +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/hateoas/WebConvertersCustomizer.java @@ -0,0 +1,41 @@ +/* + * Copyright 2016-2021 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 + * + * https://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 org.springframework.cloud.openfeign.hateoas; + +import java.util.List; + +import org.springframework.cloud.openfeign.support.HttpMessageConverterCustomizer; +import org.springframework.hateoas.config.WebConverters; +import org.springframework.http.converter.HttpMessageConverter; + +/** + * @author Olga Maciaszek-Sharma + */ +public class WebConvertersCustomizer implements HttpMessageConverterCustomizer { + + private final WebConverters webConverters; + + public WebConvertersCustomizer(WebConverters webConverters) { + this.webConverters = webConverters; + } + + @Override + public void accept(List> httpMessageConverters) { + webConverters.augmentClient(httpMessageConverters); + } + +} diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoder.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoder.java deleted file mode 100644 index 896e8272..00000000 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoder.java +++ /dev/null @@ -1,80 +0,0 @@ -/* - * Copyright 2013-2020 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 - * - * https://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 org.springframework.cloud.openfeign.support; - -import java.io.BufferedReader; -import java.io.IOException; -import java.io.InputStreamReader; -import java.lang.reflect.Type; -import java.nio.charset.StandardCharsets; -import java.util.Collection; -import java.util.zip.GZIPInputStream; - -import feign.FeignException; -import feign.Response; -import feign.codec.Decoder; - -import org.springframework.cloud.openfeign.encoding.HttpEncoding; - -/** - * When response is compressed as gzip, this decompresses and uses {@link SpringDecoder} - * to decode. - * - * @author Jaesik Kim - */ -public class DefaultGzipDecoder implements Decoder { - - private Decoder decoder; - - public DefaultGzipDecoder(Decoder decoder) { - this.decoder = decoder; - } - - @Override - public Object decode(final Response response, Type type) throws IOException, FeignException { - Collection encoding = response.headers().containsKey(HttpEncoding.CONTENT_ENCODING_HEADER) - ? response.headers().get(HttpEncoding.CONTENT_ENCODING_HEADER) : null; - - if (encoding != null) { - if (encoding.contains(HttpEncoding.GZIP_ENCODING)) { - String decompressedBody = decompress(response); - if (decompressedBody != null) { - Response decompressedResponse = response.toBuilder().body(decompressedBody.getBytes()).build(); - return decoder.decode(decompressedResponse, type); - } - } - } - return decoder.decode(response, type); - } - - private String decompress(Response response) throws IOException { - if (response.body() == null) { - return null; - } - try (GZIPInputStream gzipInputStream = new GZIPInputStream(response.body().asInputStream()); - BufferedReader reader = new BufferedReader( - new InputStreamReader(gzipInputStream, StandardCharsets.UTF_8))) { - String outputString = ""; - String line; - while ((line = reader.readLine()) != null) { - outputString += line; - } - return outputString; - } - } - -} diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoderConfiguration.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoderConfiguration.java deleted file mode 100644 index 2d476060..00000000 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoderConfiguration.java +++ /dev/null @@ -1,58 +0,0 @@ -/* - * Copyright 2013-2020 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 - * - * https://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 org.springframework.cloud.openfeign.support; - -import feign.codec.Decoder; -import feign.optionals.OptionalDecoder; - -import org.springframework.beans.factory.ObjectFactory; -import org.springframework.boot.autoconfigure.AutoConfigureAfter; -import org.springframework.boot.autoconfigure.condition.ConditionalOnMissingBean; -import org.springframework.boot.autoconfigure.condition.ConditionalOnProperty; -import org.springframework.boot.autoconfigure.http.HttpMessageConverters; -import org.springframework.cloud.openfeign.FeignAutoConfiguration; -import org.springframework.context.annotation.Bean; -import org.springframework.context.annotation.Configuration; - -/** - * Configures Default Gzip Decoder. - * - * @author Jaesik Kim - */ -@Configuration(proxyBeanMethods = false) -@ConditionalOnProperty("feign.compression.response.enabled") -// The OK HTTP client uses "transparent" compression. -// If the accept-encoding header is present, it disables transparent compression -@ConditionalOnMissingBean(type = "okhttp3.OkHttpClient") -@AutoConfigureAfter(FeignAutoConfiguration.class) -public class DefaultGzipDecoderConfiguration { - - private ObjectFactory messageConverters; - - public DefaultGzipDecoderConfiguration(ObjectFactory messageConverters) { - this.messageConverters = messageConverters; - } - - @Bean - @ConditionalOnMissingBean - @ConditionalOnProperty("feign.compression.response.useGzipDecoder") - public Decoder defaultGzipDecoder() { - return new OptionalDecoder( - new ResponseEntityDecoder(new DefaultGzipDecoder(new SpringDecoder(messageConverters)))); - } - -} diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/EmptyObjectProvider.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/EmptyObjectProvider.java new file mode 100644 index 00000000..35b55726 --- /dev/null +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/EmptyObjectProvider.java @@ -0,0 +1,54 @@ +/* + * Copyright 2013-2021 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 + * + * https://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 org.springframework.cloud.openfeign.support; + +import java.util.function.Consumer; + +import org.springframework.beans.BeansException; +import org.springframework.beans.factory.ObjectProvider; + +/** + * @author Olga Maciaszek-Sharma + */ +class EmptyObjectProvider implements ObjectProvider { + + @Override + public T getObject(Object... args) throws BeansException { + return null; + } + + @Override + public T getIfAvailable() throws BeansException { + return null; + } + + @Override + public T getIfUnique() throws BeansException { + return null; + } + + @Override + public T getObject() throws BeansException { + return null; + } + + @Override + public void forEach(Consumer action) { + // do nothing + } + +} diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/HttpMessageConverterCustomizer.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/HttpMessageConverterCustomizer.java new file mode 100644 index 00000000..f204637e --- /dev/null +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/HttpMessageConverterCustomizer.java @@ -0,0 +1,33 @@ +/* + * Copyright 2016-2021 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 + * + * https://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 org.springframework.cloud.openfeign.support; + +import java.util.List; +import java.util.function.Consumer; + +import org.springframework.http.converter.HttpMessageConverter; + +/** + * Allows customising {@link HttpMessageConverter} objects passed via {@link Consumer} + * parameter. + * + * @author Olga Maciaszek-Sharma + * @since 3.1.0 + */ +public interface HttpMessageConverterCustomizer extends Consumer>> { + +} diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/PageableSpringEncoder.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/PageableSpringEncoder.java index 916044f1..d0f66ac0 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/PageableSpringEncoder.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/PageableSpringEncoder.java @@ -32,6 +32,7 @@ import org.springframework.data.domain.Sort; * Provides support for encoding spring Pageable via composition. * * @author Pascal Büttiker + * @author Yanming Zhou */ public class PageableSpringEncoder implements Encoder { @@ -82,8 +83,8 @@ public class PageableSpringEncoder implements Encoder { Pageable pageable = (Pageable) object; if (pageable.isPaged()) { - template.query(pageParameter, pageable.getPageNumber() + ""); - template.query(sizeParameter, pageable.getPageSize() + ""); + template.query(pageParameter, String.valueOf(pageable.getPageNumber())); + template.query(sizeParameter, String.valueOf(pageable.getPageSize())); } if (pageable.getSort() != null) { diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/PageableSpringQueryMapEncoder.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/PageableSpringQueryMapEncoder.java index 0a2171b6..ab72411a 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/PageableSpringQueryMapEncoder.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/PageableSpringQueryMapEncoder.java @@ -31,10 +31,38 @@ import org.springframework.data.domain.Sort; * {@link org.springframework.cloud.openfeign.SpringQueryMap}. * * @author Hyeonmin Park + * @author Yanming Zhou * @since 2.2.8 */ public class PageableSpringQueryMapEncoder extends BeanQueryMapEncoder { + /** + * Page index parameter name. + */ + private String pageParameter = "page"; + + /** + * Page size parameter name. + */ + private String sizeParameter = "size"; + + /** + * Sort parameter name. + */ + private String sortParameter = "sort"; + + public void setPageParameter(String pageParameter) { + this.pageParameter = pageParameter; + } + + public void setSizeParameter(String sizeParameter) { + this.sizeParameter = sizeParameter; + } + + public void setSortParameter(String sortParameter) { + this.sortParameter = sortParameter; + } + @Override public Map encode(Object object) { if (supports(object)) { @@ -44,8 +72,8 @@ public class PageableSpringQueryMapEncoder extends BeanQueryMapEncoder { Pageable pageable = (Pageable) object; if (pageable.isPaged()) { - queryMap.put("page", pageable.getPageNumber()); - queryMap.put("size", pageable.getPageSize()); + queryMap.put(pageParameter, pageable.getPageNumber()); + queryMap.put(sizeParameter, pageable.getPageSize()); } if (pageable.getSort() != null) { @@ -69,7 +97,7 @@ public class PageableSpringQueryMapEncoder extends BeanQueryMapEncoder { sortQueries.add(order.getProperty() + "%2C" + order.getDirection()); } if (!sortQueries.isEmpty()) { - queryMap.put("sort", sortQueries); + queryMap.put(sortParameter, sortQueries); } } diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringDecoder.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringDecoder.java index 41aa94b4..b4ecd810 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringDecoder.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringDecoder.java @@ -21,6 +21,7 @@ import java.io.InputStream; import java.lang.reflect.ParameterizedType; import java.lang.reflect.Type; import java.lang.reflect.WildcardType; +import java.util.List; import feign.FeignException; import feign.Response; @@ -28,31 +29,48 @@ import feign.codec.DecodeException; import feign.codec.Decoder; import org.springframework.beans.factory.ObjectFactory; +import org.springframework.beans.factory.ObjectProvider; import org.springframework.boot.autoconfigure.http.HttpMessageConverters; import org.springframework.http.HttpHeaders; import org.springframework.http.HttpStatus; import org.springframework.http.client.ClientHttpResponse; +import org.springframework.http.converter.HttpMessageConverter; import org.springframework.web.client.HttpMessageConverterExtractor; import static org.springframework.cloud.openfeign.support.FeignUtils.getHttpHeaders; /** * @author Spencer Gibb + * @author Olga Maciaszek-Sharma */ public class SpringDecoder implements Decoder { - private ObjectFactory messageConverters; + private final ObjectFactory messageConverters; + private final ObjectProvider customizers; + + /** + * @deprecated in favour of + * {@link SpringDecoder#SpringDecoder(ObjectFactory, ObjectProvider)} + */ + @Deprecated public SpringDecoder(ObjectFactory messageConverters) { + this(messageConverters, new EmptyObjectProvider<>()); + } + + public SpringDecoder(ObjectFactory messageConverters, + ObjectProvider customizers) { this.messageConverters = messageConverters; + this.customizers = customizers; } @Override public Object decode(final Response response, Type type) throws IOException, FeignException { if (type instanceof Class || type instanceof ParameterizedType || type instanceof WildcardType) { + List> converters = messageConverters.getObject().getConverters(); + customizers.forEach(customizer -> customizer.accept(converters)); @SuppressWarnings({ "unchecked", "rawtypes" }) - HttpMessageConverterExtractor extractor = new HttpMessageConverterExtractor(type, - this.messageConverters.getObject().getConverters()); + HttpMessageConverterExtractor extractor = new HttpMessageConverterExtractor(type, converters); return extractor.extractData(new FeignResponseAdapter(response)); } @@ -70,23 +88,23 @@ public class SpringDecoder implements Decoder { @Override public HttpStatus getStatusCode() throws IOException { - return HttpStatus.valueOf(this.response.status()); + return HttpStatus.valueOf(response.status()); } @Override public int getRawStatusCode() throws IOException { - return this.response.status(); + return response.status(); } @Override public String getStatusText() throws IOException { - return this.response.reason(); + return response.reason(); } @Override public void close() { try { - this.response.body().close(); + response.body().close(); } catch (IOException ex) { // Ignore exception on close... @@ -95,12 +113,12 @@ public class SpringDecoder implements Decoder { @Override public InputStream getBody() throws IOException { - return this.response.body().asInputStream(); + return response.body().asInputStream(); } @Override public HttpHeaders getHeaders() { - return getHttpHeaders(this.response.headers()); + return getHttpHeaders(response.headers()); } } diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringEncoder.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringEncoder.java index 7fa082a3..fd061390 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringEncoder.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringEncoder.java @@ -24,6 +24,7 @@ import java.nio.charset.Charset; import java.nio.charset.StandardCharsets; import java.util.Arrays; import java.util.Collection; +import java.util.List; import java.util.Objects; import java.util.stream.Stream; @@ -35,6 +36,7 @@ import org.apache.commons.logging.Log; import org.apache.commons.logging.LogFactory; import org.springframework.beans.factory.ObjectFactory; +import org.springframework.beans.factory.ObjectProvider; import org.springframework.boot.autoconfigure.http.HttpMessageConverters; import org.springframework.cloud.openfeign.encoding.HttpEncoding; import org.springframework.http.HttpHeaders; @@ -74,19 +76,37 @@ public class SpringEncoder implements Encoder { private final FeignEncoderProperties encoderProperties; + private final ObjectProvider customizers; + public SpringEncoder(ObjectFactory messageConverters) { this(new SpringFormEncoder(), messageConverters); } + /** + * @deprecated in favour of + * {@link SpringEncoder#SpringEncoder(SpringFormEncoder, ObjectFactory, FeignEncoderProperties, ObjectProvider)} + */ + @Deprecated public SpringEncoder(SpringFormEncoder springFormEncoder, ObjectFactory messageConverters) { this(springFormEncoder, messageConverters, new FeignEncoderProperties()); } + /** + * @deprecated in favour of + * {@link SpringEncoder#SpringEncoder(SpringFormEncoder, ObjectFactory, FeignEncoderProperties, ObjectProvider)} + */ + @Deprecated public SpringEncoder(SpringFormEncoder springFormEncoder, ObjectFactory messageConverters, FeignEncoderProperties encoderProperties) { + this(springFormEncoder, messageConverters, encoderProperties, new EmptyObjectProvider<>()); + } + + public SpringEncoder(SpringFormEncoder springFormEncoder, ObjectFactory messageConverters, + FeignEncoderProperties encoderProperties, ObjectProvider customizers) { this.springFormEncoder = springFormEncoder; this.messageConverters = messageConverters; this.encoderProperties = encoderProperties; + this.customizers = customizers; } @Override @@ -117,7 +137,9 @@ public class SpringEncoder implements Encoder { private void encodeWithMessageConverter(Object requestBody, Type bodyType, RequestTemplate request, MediaType requestContentType) { - for (HttpMessageConverter messageConverter : this.messageConverters.getObject().getConverters()) { + List> converters = messageConverters.getObject().getConverters(); + customizers.forEach(customizer -> customizer.accept(converters)); + for (HttpMessageConverter messageConverter : converters) { FeignOutputMessage outputMessage; try { if (messageConverter instanceof GenericHttpMessageConverter) { diff --git a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringMvcContract.java b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringMvcContract.java index a3f2c8b5..504c9262 100644 --- a/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringMvcContract.java +++ b/spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/SpringMvcContract.java @@ -38,6 +38,7 @@ import feign.Request; import org.springframework.cloud.openfeign.AnnotatedParameterProcessor; import org.springframework.cloud.openfeign.CollectionFormat; +import org.springframework.cloud.openfeign.annotation.CookieValueParameterProcessor; import org.springframework.cloud.openfeign.annotation.MatrixVariableParameterProcessor; import org.springframework.cloud.openfeign.annotation.PathVariableParameterProcessor; import org.springframework.cloud.openfeign.annotation.QueryMapParameterProcessor; @@ -360,6 +361,7 @@ public class SpringMvcContract extends Contract.BaseContract implements Resource annotatedArgumentResolvers.add(new RequestHeaderParameterProcessor()); annotatedArgumentResolvers.add(new QueryMapParameterProcessor()); annotatedArgumentResolvers.add(new RequestPartParameterProcessor()); + annotatedArgumentResolvers.add(new CookieValueParameterProcessor()); return annotatedArgumentResolvers; } diff --git a/spring-cloud-openfeign-core/src/main/resources/META-INF/additional-spring-configuration-metadata.json b/spring-cloud-openfeign-core/src/main/resources/META-INF/additional-spring-configuration-metadata.json index c7de5d77..8b4fc57a 100644 --- a/spring-cloud-openfeign-core/src/main/resources/META-INF/additional-spring-configuration-metadata.json +++ b/spring-cloud-openfeign-core/src/main/resources/META-INF/additional-spring-configuration-metadata.json @@ -44,12 +44,6 @@ "description": "Enables the response from Feign to be compressed.", "defaultValue": "false" }, - { - "name": "feign.compression.response.useGzipDecoder", - "type": "java.lang.Boolean", - "description": "Enables the default gzip decoder to be used.", - "defaultValue": "false" - }, { "name": "feign.compression.request.enabled", "type": "java.lang.Boolean", diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/FeignAutoConfigurationTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/FeignAutoConfigurationTests.java index 0ba44516..9d9568ef 100644 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/FeignAutoConfigurationTests.java +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/FeignAutoConfigurationTests.java @@ -16,12 +16,16 @@ package org.springframework.cloud.openfeign; +import java.lang.reflect.Method; + +import feign.Target; import org.assertj.core.api.Condition; import org.junit.jupiter.api.Test; import org.springframework.boot.autoconfigure.AutoConfigurations; import org.springframework.boot.test.context.runner.ApplicationContextRunner; import org.springframework.cloud.client.circuitbreaker.CircuitBreakerFactory; +import org.springframework.cloud.openfeign.FeignAutoConfiguration.CircuitBreakerPresentFeignTargeterConfiguration.DefaultCircuitBreakerNameResolver; import org.springframework.context.ConfigurableApplicationContext; import static org.assertj.core.api.Assertions.assertThat; @@ -31,6 +35,7 @@ import static org.mockito.Mockito.mock; * @author Tim Peeters * @author Olga Maciaszek-Sharma * @author Andrii Bohutskyi + * @author Kwangyong Kim */ class FeignAutoConfigurationTests { @@ -50,6 +55,8 @@ class FeignAutoConfigurationTests { .withPropertyValues("feign.circuitbreaker.enabled=true").run(ctx -> { assertOnlyOneTargeterPresent(ctx, FeignCircuitBreakerTargeter.class); assertThatFeignCircuitBreakerTargeterHasGroupEnabledPropertyWithValue(ctx, false); + assertThatFeignCircuitBreakerTargeterHasSameCircuitBreakerNameResolver(ctx, + DefaultCircuitBreakerNameResolver.class); }); } @@ -63,6 +70,17 @@ class FeignAutoConfigurationTests { }); } + @Test + void shouldInstantiateFeignCircuitBreakerTargeterWhenEnabledWithCustomCircuitBreakerNameResolver() { + runner.withBean(CircuitBreakerFactory.class, () -> mock(CircuitBreakerFactory.class)) + .withBean(CircuitBreakerNameResolver.class, CustomCircuitBreakerNameResolver::new) + .withPropertyValues("feign.circuitbreaker.enabled=true").run(ctx -> { + assertOnlyOneTargeterPresent(ctx, FeignCircuitBreakerTargeter.class); + assertThatFeignCircuitBreakerTargeterHasSameCircuitBreakerNameResolver(ctx, + CustomCircuitBreakerNameResolver.class); + }); + } + private void assertOnlyOneTargeterPresent(ConfigurableApplicationContext ctx, Class beanClass) { assertThat(ctx.getBeansOfType(Targeter.class)).hasSize(1).hasValueSatisfying(new Condition<>( beanClass::isInstance, String.format("Targeter should be an instance of %s", beanClass))); @@ -75,4 +93,19 @@ class FeignAutoConfigurationTests { assertThat(bean).hasFieldOrPropertyWithValue("circuitBreakerGroupEnabled", expectedValue); } + private void assertThatFeignCircuitBreakerTargeterHasSameCircuitBreakerNameResolver( + ConfigurableApplicationContext ctx, Class beanClass) { + final CircuitBreakerNameResolver bean = ctx.getBean(CircuitBreakerNameResolver.class); + assertThat(bean).isExactlyInstanceOf(beanClass); + } + + static class CustomCircuitBreakerNameResolver implements CircuitBreakerNameResolver { + + @Override + public String resolveCircuitBreakerName(String feignClientName, Target target, Method method) { + return feignClientName + "_" + method.getName(); + } + + } + } diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/DefaultGzipDecoderTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/GzipDecodingTests.java similarity index 94% rename from spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/DefaultGzipDecoderTests.java rename to spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/GzipDecodingTests.java index bc217406..65fd573b 100644 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/DefaultGzipDecoderTests.java +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/GzipDecodingTests.java @@ -37,14 +37,15 @@ import static org.assertj.core.api.Assertions.assertThat; /** * @author Jaesik Kim + * @author Olga Maciaszek-Sharma */ -@SpringBootTest(classes = DefaultGzipDecoderTests.Application.class, +@SpringBootTest(classes = GzipDecodingTests.Application.class, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, value = { "spring.application.name=defaultGzipDecoderTests", "feign.compression.response.enabled=true", - "feign.compression.response.useGzipDecoder=true", "feign.client.config.default.loggerLevel=full", + "feign.client.config.default.loggerLevel=none", "feign.metrics.enabled=false", "logging.level.org.springframework.cloud.openfeign=DEBUG" }) @DirtiesContext -public class DefaultGzipDecoderTests extends FeignClientFactoryBean { +public class GzipDecodingTests extends FeignClientFactoryBean { @Autowired FeignContext context; @@ -52,7 +53,7 @@ public class DefaultGzipDecoderTests extends FeignClientFactoryBean { @Value("${local.server.port}") private int port = 0; - public DefaultGzipDecoderTests() { + public GzipDecodingTests() { setName("tests"); setContextId("test"); } diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/hateoas/FeignHalAutoConfigurationContextTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/hateoas/FeignHalAutoConfigurationContextTests.java index 1a54f492..5ecaa1ae 100644 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/hateoas/FeignHalAutoConfigurationContextTests.java +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/hateoas/FeignHalAutoConfigurationContextTests.java @@ -27,19 +27,20 @@ import org.springframework.boot.autoconfigure.jackson.JacksonAutoConfiguration; import org.springframework.boot.test.context.FilteredClassLoader; import org.springframework.boot.test.context.runner.WebApplicationContextRunner; import org.springframework.data.rest.webmvc.config.RepositoryRestMvcConfiguration; -import org.springframework.hateoas.RepresentationModel; +import org.springframework.hateoas.config.WebConverters; import static org.assertj.core.api.Assertions.assertThat; /** * @author Hector Espert + * @author Olga Maciaszek-Sharma */ -public class FeignHalAutoConfigurationContextTests { +class FeignHalAutoConfigurationContextTests { private WebApplicationContextRunner contextRunner; @BeforeEach - public void setUp() { + void setUp() { contextRunner = new WebApplicationContextRunner() .withConfiguration(AutoConfigurations.of(JacksonAutoConfiguration.class, HttpMessageConvertersAutoConfiguration.class, HypermediaAutoConfiguration.class, @@ -48,23 +49,18 @@ public class FeignHalAutoConfigurationContextTests { } @Test - public void testHalJacksonHttpMessageConverterIsNotLoaded() { + void shouldNotLoadWebConvertersCustomizerWhenNotWebConvertersNotInClasspath() { FilteredClassLoader filteredClassLoader = new FilteredClassLoader(RepositoryRestMvcConfiguration.class, - RepresentationModel.class); + WebConverters.class); contextRunner.withClassLoader(filteredClassLoader) - .run(context -> assertThat(context).doesNotHaveBean("halJacksonHttpMessageConverter")); + .run(context -> assertThat(context).doesNotHaveBean("webConvertersCustomizer")); } @Test - public void testHalJacksonHttpMessageConverterIsLoaded() { + void shouldLoadWebConvertersCustomizer() { FilteredClassLoader filteredClassLoader = new FilteredClassLoader(RepositoryRestMvcConfiguration.class); contextRunner.withClassLoader(filteredClassLoader) - .run(context -> assertThat(context).hasBean("halJacksonHttpMessageConverter")); - } - - @Test - public void testHalJacksonHttpMessageConverterIsNotLoadedUseRestDataMessageConverterInstead() { - contextRunner.run(context -> assertThat(context).hasBean("halJacksonHttpMessageConverter")); + .run(context -> assertThat(context).hasBean("webConvertersCustomizer")); } } diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/hateoas/FeignHalAutoConfigurationTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/hateoas/FeignHalAutoConfigurationTests.java deleted file mode 100644 index 887f1727..00000000 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/hateoas/FeignHalAutoConfigurationTests.java +++ /dev/null @@ -1,90 +0,0 @@ -/* - * Copyright 2016-2020 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 - * - * https://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 org.springframework.cloud.openfeign.hateoas; - -import java.util.Collections; - -import com.fasterxml.jackson.databind.ObjectMapper; -import org.junit.jupiter.api.Test; -import org.junit.jupiter.api.extension.ExtendWith; -import org.mockito.InjectMocks; -import org.mockito.Mock; -import org.mockito.junit.jupiter.MockitoExtension; - -import org.springframework.beans.factory.ObjectProvider; -import org.springframework.beans.factory.support.DefaultListableBeanFactory; -import org.springframework.hateoas.mediatype.MessageResolver; -import org.springframework.hateoas.mediatype.hal.CurieProvider; -import org.springframework.hateoas.mediatype.hal.HalConfiguration; -import org.springframework.hateoas.mediatype.hal.HalMediaTypeConfiguration; -import org.springframework.hateoas.mediatype.hal.Jackson2HalModule; -import org.springframework.hateoas.server.LinkRelationProvider; -import org.springframework.hateoas.server.mvc.TypeConstrainedMappingJackson2HttpMessageConverter; - -import static org.assertj.core.api.Assertions.assertThat; -import static org.mockito.ArgumentMatchers.any; -import static org.mockito.Mockito.mock; -import static org.mockito.Mockito.when; -import static org.springframework.hateoas.MediaTypes.HAL_JSON; - -/** - * @author Hector Espert - * @author Olga Maciaszek-Sharma - */ -@ExtendWith(MockitoExtension.class) -public class FeignHalAutoConfigurationTests { - - @Mock - private ObjectProvider halConfiguration; - - @Mock - private ObjectProvider objectMapper; - - @Mock - private LinkRelationProvider relProvider; - - @Mock - private ObjectProvider curieProvider; - - @Mock - private MessageResolver messageResolver; - - @InjectMocks - private FeignHalAutoConfiguration feignHalAutoConfiguration; - - @Test - public void halJacksonHttpMessageConverter() { - ObjectMapper mapper = new ObjectMapper(); - when(objectMapper.getIfAvailable(any())).thenReturn(mapper); - - when(halConfiguration.getIfAvailable(any())).thenReturn(mock(HalConfiguration.class)); - when(curieProvider.getIfAvailable(any())).thenReturn(mock(CurieProvider.class)); - - HalMediaTypeConfiguration halMediaTypeConfiguration = new HalMediaTypeConfiguration(relProvider, curieProvider, - halConfiguration, messageResolver, new DefaultListableBeanFactory()); - - TypeConstrainedMappingJackson2HttpMessageConverter converter = feignHalAutoConfiguration - .halJacksonHttpMessageConverter(objectMapper, halMediaTypeConfiguration); - - assertThat(converter).isNotNull(); - assertThat(converter.getObjectMapper()).isNotNull(); - assertThat(converter.getSupportedMediaTypes()).isEqualTo(Collections.singletonList(HAL_JSON)); - - assertThat(Jackson2HalModule.isAlreadyRegisteredIn(converter.getObjectMapper())).isTrue(); - } - -} diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/loadbalancer/FeignBlockingLoadBalancerClientTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/loadbalancer/FeignBlockingLoadBalancerClientTests.java index daf22e7c..468df6a1 100644 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/loadbalancer/FeignBlockingLoadBalancerClientTests.java +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/loadbalancer/FeignBlockingLoadBalancerClientTests.java @@ -16,7 +16,9 @@ package org.springframework.cloud.openfeign.loadbalancer; +import java.io.BufferedReader; import java.io.IOException; +import java.io.InputStreamReader; import java.net.URI; import java.nio.charset.StandardCharsets; import java.util.Collection; @@ -105,8 +107,7 @@ class FeignBlockingLoadBalancerClientTests { Response response = feignBlockingLoadBalancerClient.execute(request, new Request.Options()); assertThat(response.status()).isEqualTo(HttpStatus.SERVICE_UNAVAILABLE.value()); - assertThat(response.body().toString()) - .isEqualTo("Load balancer does not contain an instance for the service test"); + assertThat(read(response)).isEqualTo("Load balancer does not contain an instance for the service test"); } @Test @@ -167,6 +168,17 @@ class FeignBlockingLoadBalancerClientTests { .contains(HttpStatus.OK); } + private String read(Response response) throws IOException { + BufferedReader reader = new BufferedReader( + new InputStreamReader(response.body().asInputStream(), StandardCharsets.UTF_8)); + String outputString = ""; + String line; + while ((line = reader.readLine()) != null) { + outputString += line; + } + return outputString; + } + private Request testRequest() { return testRequest("test"); } diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableEncoderTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableEncoderTests.java index bca3d7e1..5fbde229 100644 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableEncoderTests.java +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableEncoderTests.java @@ -35,6 +35,7 @@ import static org.springframework.boot.test.context.SpringBootTest.WebEnvironmen * Tests the pagination encoding and sorting. * * @author Charlie Mordant. + * @author Yanming Zhou */ @SpringBootTest(classes = SpringEncoderTests.Application.class, webEnvironment = RANDOM_PORT, value = { "spring.application.name=springencodertest", "spring.jmx.enabled=false" }) @@ -52,6 +53,18 @@ public class PageableEncoderTests { @Autowired private FeignContext context; + protected String getPageParameter() { + return "page"; + } + + protected String getSizeParameter() { + return "size"; + } + + protected String getSortParameter() { + return "sort"; + } + @Test public void testPaginationAndSortingRequest() { Encoder encoder = this.context.getInstance("foo", Encoder.class); @@ -62,11 +75,11 @@ public class PageableEncoderTests { // Request queries shall contain three entries assertThat(request.queries()).hasSize(3); // Request page shall contain page - assertThat(request.queries().get("page")).contains(String.valueOf(PAGE)); + assertThat(request.queries().get(getPageParameter())).contains(String.valueOf(PAGE)); // Request size shall contain size - assertThat(request.queries().get("size")).contains(String.valueOf(SIZE)); + assertThat(request.queries().get(getSizeParameter())).contains(String.valueOf(SIZE)); // Request sort size shall contain sort entries - assertThat(request.queries().get("sort")).hasSize(2); + assertThat(request.queries().get(getSortParameter())).hasSize(2); } private Pageable createPageAndSortRequest() { @@ -81,11 +94,11 @@ public class PageableEncoderTests { encoder.encode(createPageAndRequest(), null, request); assertThat(request.queries().size()).isEqualTo(2); // Request page shall contain page - assertThat(request.queries().get("page")).contains(String.valueOf(PAGE)); + assertThat(request.queries().get(getPageParameter())).contains(String.valueOf(PAGE)); // Request size shall contain size - assertThat(request.queries().get("size")).contains(String.valueOf(SIZE)); + assertThat(request.queries().get(getSizeParameter())).contains(String.valueOf(SIZE)); // Request sort size shall contain sort entries - assertThat(request.queries()).doesNotContainKey("sort"); + assertThat(request.queries()).doesNotContainKey(getSortParameter()); } private Pageable createPageAndRequest() { @@ -102,7 +115,7 @@ public class PageableEncoderTests { // Request queries shall contain three entries assertThat(request.queries().size()).isEqualTo(1); // Request sort size shall contain sort entries - assertThat(request.queries().get("sort")).hasSize(2); + assertThat(request.queries().get(getSortParameter())).hasSize(2); } private Sort createSort() { diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableEncoderWithSpringDataWebTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableEncoderWithSpringDataWebTests.java new file mode 100644 index 00000000..a81c46b3 --- /dev/null +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableEncoderWithSpringDataWebTests.java @@ -0,0 +1,52 @@ +/* + * Copyright 2013-2020 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 + * + * https://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 org.springframework.cloud.openfeign.support; + +import org.springframework.boot.autoconfigure.data.web.SpringDataWebProperties; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.SpringBootTest; + +import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; + +/** + * Tests the pagination encoding and sorting. + * + * @author Yanming Zhou + */ +@EnableConfigurationProperties(SpringDataWebProperties.class) +@SpringBootTest(classes = SpringEncoderTests.Application.class, webEnvironment = RANDOM_PORT, + value = { "spring.application.name=springencodertest", "spring.jmx.enabled=false", + "spring.data.web.pageable.pageParameter=pageNo", "spring.data.web.pageable.sizeParameter=pageSize", + "spring.data.web.sort.sortParameter=orderBy" }) +public class PageableEncoderWithSpringDataWebTests extends PageableEncoderTests { + + @Override + protected String getPageParameter() { + return "pageNo"; + } + + @Override + protected String getSizeParameter() { + return "pageSize"; + } + + @Override + protected String getSortParameter() { + return "orderBy"; + } + +} diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableSpringQueryMapEncoderTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableSpringQueryMapEncoderTests.java new file mode 100644 index 00000000..79749d8f --- /dev/null +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableSpringQueryMapEncoderTests.java @@ -0,0 +1,124 @@ +/* + * Copyright 2013-2020 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 + * + * https://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 org.springframework.cloud.openfeign.support; + +import java.util.List; +import java.util.Map; + +import feign.QueryMapEncoder; +import org.junit.jupiter.api.Test; + +import org.springframework.beans.factory.annotation.Autowired; +import org.springframework.boot.test.context.SpringBootTest; +import org.springframework.cloud.openfeign.FeignContext; +import org.springframework.data.domain.PageRequest; +import org.springframework.data.domain.Pageable; +import org.springframework.data.domain.Sort; +import org.springframework.test.annotation.DirtiesContext; + +import static org.assertj.core.api.Assertions.assertThat; +import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; + +/** + * Tests the pagination encoding and sorting. + * + * @author Yanming Zhou + */ +@SpringBootTest(classes = SpringEncoderTests.Application.class, webEnvironment = RANDOM_PORT, + value = { "spring.application.name=springencodertest", "spring.jmx.enabled=false" }) +@DirtiesContext +public class PageableSpringQueryMapEncoderTests { + + public static final int PAGE = 1; + + public static final int SIZE = 10; + + public static final String SORT_2 = "sort2"; + + public static final String SORT_1 = "sort1"; + + @Autowired + private FeignContext context; + + protected String getPageParameter() { + return "page"; + } + + protected String getSizeParameter() { + return "size"; + } + + protected String getSortParameter() { + return "sort"; + } + + @Test + public void testPaginationAndSortingRequest() { + QueryMapEncoder encoder = this.context.getInstance("foo", QueryMapEncoder.class); + assertThat(encoder).isNotNull(); + + Map map = encoder.encode(createPageAndSortRequest()); + assertThat(map).hasSize(3); + assertThat((Integer) map.get(getPageParameter())).isEqualTo(PAGE); + assertThat((Integer) map.get(getSizeParameter())).isEqualTo(SIZE); + assertThat((List) map.get(getSortParameter())).hasSize(2); + } + + private Pageable createPageAndSortRequest() { + return PageRequest.of(PAGE, SIZE, Sort.Direction.ASC, SORT_1, SORT_2); + } + + @Test + public void testPaginationRequest() { + QueryMapEncoder encoder = this.context.getInstance("foo", QueryMapEncoder.class); + assertThat(encoder).isNotNull(); + + Map map = encoder.encode(createPageAndRequest()); + assertThat(map).hasSize(2); + assertThat((Integer) map.get(getPageParameter())).isEqualTo(PAGE); + assertThat((Integer) map.get(getSizeParameter())).isEqualTo(SIZE); + assertThat(map).doesNotContainKey(getSortParameter()); + } + + private Pageable createPageAndRequest() { + return PageRequest.of(PAGE, SIZE); + } + + @Test + public void testSortingRequest() { + QueryMapEncoder encoder = this.context.getInstance("foo", QueryMapEncoder.class); + assertThat(encoder).isNotNull(); + + Map map = encoder.encode(createSort()); + assertThat(map).hasSize(1); + assertThat((List) map.get(getSortParameter())).hasSize(2); + } + + private Sort createSort() { + return Sort.by(SORT_1, SORT_2).ascending(); + } + + @Test + public void testUnpagedRequest() { + QueryMapEncoder encoder = this.context.getInstance("foo", QueryMapEncoder.class); + assertThat(encoder).isNotNull(); + + Map map = encoder.encode(Pageable.unpaged()); + assertThat(map).isEmpty(); + } + +} diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableSpringQueryMapEncoderWithSpringDataWebTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableSpringQueryMapEncoderWithSpringDataWebTests.java new file mode 100644 index 00000000..914a0516 --- /dev/null +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/PageableSpringQueryMapEncoderWithSpringDataWebTests.java @@ -0,0 +1,52 @@ +/* + * Copyright 2013-2020 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 + * + * https://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 org.springframework.cloud.openfeign.support; + +import org.springframework.boot.autoconfigure.data.web.SpringDataWebProperties; +import org.springframework.boot.context.properties.EnableConfigurationProperties; +import org.springframework.boot.test.context.SpringBootTest; + +import static org.springframework.boot.test.context.SpringBootTest.WebEnvironment.RANDOM_PORT; + +/** + * Tests the pagination encoding and sorting. + * + * @author Yanming Zhou + */ +@EnableConfigurationProperties(SpringDataWebProperties.class) +@SpringBootTest(classes = SpringEncoderTests.Application.class, webEnvironment = RANDOM_PORT, + value = { "spring.application.name=springencodertest", "spring.jmx.enabled=false", + "spring.data.web.pageable.pageParameter=pageNo", "spring.data.web.pageable.sizeParameter=pageSize", + "spring.data.web.sort.sortParameter=orderBy" }) +public class PageableSpringQueryMapEncoderWithSpringDataWebTests extends PageableSpringQueryMapEncoderTests { + + @Override + protected String getPageParameter() { + return "pageNo"; + } + + @Override + protected String getSizeParameter() { + return "pageSize"; + } + + @Override + protected String getSortParameter() { + return "orderBy"; + } + +} diff --git a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/SpringMvcContractTests.java b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/SpringMvcContractTests.java index 145ac5b8..458b1f00 100644 --- a/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/SpringMvcContractTests.java +++ b/spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/support/SpringMvcContractTests.java @@ -45,6 +45,7 @@ import org.springframework.http.MediaType; import org.springframework.http.ResponseEntity; import org.springframework.util.MultiValueMap; import org.springframework.util.ReflectionUtils; +import org.springframework.web.bind.annotation.CookieValue; import org.springframework.web.bind.annotation.ExceptionHandler; import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.MatrixVariable; @@ -131,6 +132,16 @@ public class SpringMvcContractTests { assertThat(data.template().decodeSlash()).isTrue(); } + @Test + public void testProcessAnnotationOnMethod_Simple_RegexPathVariable() throws Exception { + Method method = TestTemplate_Simple.class.getDeclaredMethod("getTestWithDigitalId", String.class); + MethodMetadata data = contract.parseAndValidateMetadata(method.getDeclaringClass(), method); + + assertThat(data.template().url()).isEqualTo("/test/{id:\\d+}"); + assertThat(data.template().method()).isEqualTo("GET"); + assertThat(data.formParams()).isEmpty(); + } + @Test public void testProcessAnnotationOnMethod_Simple_SlashEncoded() throws Exception { contract = new SpringMvcContract(Collections.emptyList(), getConversionService(), false); @@ -580,6 +591,24 @@ public class SpringMvcContractTests { assertThat(data.formParams()).contains("file", "id"); } + @Test + public void testSingleCookieAnnotation() throws NoSuchMethodException { + Method method = TestTemplate_Cookies.class.getDeclaredMethod("singleCookie", String.class, String.class); + + MethodMetadata data = contract.parseAndValidateMetadata(method.getDeclaringClass(), method); + assertThat(data.template().headers().get("cookie").iterator().next()).isEqualTo("cookie1={cookie1}"); + } + + @Test + public void testMultipleCookiesAnnotation() throws NoSuchMethodException { + Method method = TestTemplate_Cookies.class.getDeclaredMethod("multipleCookies", String.class, String.class, + String.class); + + MethodMetadata data = contract.parseAndValidateMetadata(method.getDeclaringClass(), method); + assertThat(data.template().headers().get("cookie").iterator().next()) + .isEqualTo("cookie1={cookie1}; cookie2={cookie2}"); + } + private ConversionService getConversionService() { FormattingConversionServiceFactoryBean conversionServiceFactoryBean = new FormattingConversionServiceFactoryBean(); conversionServiceFactoryBean.afterPropertiesSet(); @@ -591,6 +620,9 @@ public class SpringMvcContractTests { @RequestMapping(value = "/test/{id}", method = RequestMethod.GET, produces = MediaType.APPLICATION_JSON_VALUE) ResponseEntity getTest(@PathVariable("id") String id); + @GetMapping("/test/{id:\\d+}") + ResponseEntity getTestWithDigitalId(@PathVariable("id") String id); + @GetMapping(produces = MediaType.APPLICATION_JSON_VALUE) TestObject getTest(); @@ -627,6 +659,17 @@ public class SpringMvcContractTests { } + public interface TestTemplate_Cookies { + + @GetMapping("/test/{id}") + ResponseEntity singleCookie(@PathVariable("id") String id, @CookieValue("cookie1") String cookie1); + + @GetMapping("/test/{id}") + ResponseEntity multipleCookies(@PathVariable("id") String id, + @CookieValue("cookie1") String cookie1, @CookieValue("cookie2") String cookie2); + + } + public interface TestTemplate_HeadersWithoutValues { @GetMapping(value = "/test/{id}", headers = { "X-Foo", "!X-Bar", "X-Baz!=fooBar" }) diff --git a/spring-cloud-openfeign-dependencies/pom.xml b/spring-cloud-openfeign-dependencies/pom.xml index 8b7a9892..50f60c8f 100644 --- a/spring-cloud-openfeign-dependencies/pom.xml +++ b/spring-cloud-openfeign-dependencies/pom.xml @@ -6,16 +6,16 @@ spring-cloud-dependencies-parent org.springframework.cloud - 3.0.4-SNAPSHOT + 3.1.0-SNAPSHOT spring-cloud-openfeign-dependencies - 3.0.4-SNAPSHOT + 3.1.0-SNAPSHOT pom spring-cloud-openfeign-dependencies Spring Cloud OpenFeign Dependencies - 10.12 + 11.6 3.8.0 2.1.2.RELEASE diff --git a/spring-cloud-starter-openfeign/pom.xml b/spring-cloud-starter-openfeign/pom.xml index 30f899cb..b8c4fb13 100644 --- a/spring-cloud-starter-openfeign/pom.xml +++ b/spring-cloud-starter-openfeign/pom.xml @@ -5,7 +5,7 @@ org.springframework.cloud spring-cloud-openfeign - 3.0.4-SNAPSHOT + 3.1.0-SNAPSHOT .. spring-cloud-starter-openfeign