From 05365b79f91a6be3443561f83b926cdc9453208c Mon Sep 17 00:00:00 2001 From: Olga MaciaszekSharma Date: Mon, 26 Apr 2021 15:47:19 +0200 Subject: [PATCH 1/5] Switch version to 3.1.0-SNAPSHOT. --- docs/pom.xml | 2 +- pom.xml | 2 +- spring-cloud-openfeign-core/pom.xml | 2 +- spring-cloud-openfeign-dependencies/pom.xml | 2 +- spring-cloud-starter-openfeign/pom.xml | 2 +- 5 files changed, 5 insertions(+), 5 deletions(-) diff --git a/docs/pom.xml b/docs/pom.xml index 69b4126e..d1233ca9 100644 --- a/docs/pom.xml +++ b/docs/pom.xml @@ -6,7 +6,7 @@ org.springframework.cloud spring-cloud-openfeign - 3.0.3-SNAPSHOT + 3.1.0-SNAPSHOT spring-cloud-openfeign-docs jar diff --git a/pom.xml b/pom.xml index 94a70115..299a2ace 100644 --- a/pom.xml +++ b/pom.xml @@ -4,7 +4,7 @@ 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.3-SNAPSHOT + 3.1.0-SNAPSHOT pom Spring Cloud OpenFeign Spring Cloud OpenFeign diff --git a/spring-cloud-openfeign-core/pom.xml b/spring-cloud-openfeign-core/pom.xml index 9b95fc63..da667efd 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.3-SNAPSHOT + 3.1.0-SNAPSHOT .. spring-cloud-openfeign-core diff --git a/spring-cloud-openfeign-dependencies/pom.xml b/spring-cloud-openfeign-dependencies/pom.xml index 49674531..ed285e51 100644 --- a/spring-cloud-openfeign-dependencies/pom.xml +++ b/spring-cloud-openfeign-dependencies/pom.xml @@ -10,7 +10,7 @@ spring-cloud-openfeign-dependencies - 3.0.3-SNAPSHOT + 3.1.0-SNAPSHOT pom spring-cloud-openfeign-dependencies Spring Cloud OpenFeign Dependencies diff --git a/spring-cloud-starter-openfeign/pom.xml b/spring-cloud-starter-openfeign/pom.xml index 255260ed..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.3-SNAPSHOT + 3.1.0-SNAPSHOT .. spring-cloud-starter-openfeign From 80a7102b14a604d95ff65f3de5462ae75004957e Mon Sep 17 00:00:00 2001 From: Olga MaciaszekSharma Date: Tue, 11 May 2021 15:10:09 +0200 Subject: [PATCH 2/5] Fix gh actions setup for branch. --- .github/workflows/maven.yml | 4 ++-- 1 file changed, 2 insertions(+), 2 deletions(-) diff --git a/.github/workflows/maven.yml b/.github/workflows/maven.yml index a1fcbc58..c1b14837 100644 --- a/.github/workflows/maven.yml +++ b/.github/workflows/maven.yml @@ -5,9 +5,9 @@ name: Build on: push: - branches: [ main ] + branches: [ 3.1.x ] pull_request: - branches: [ main ] + branches: [ 3.1.x ] jobs: build: From 5f9a827a4065215a5537df78ba5745288cb699aa Mon Sep 17 00:00:00 2001 From: Olga Maciaszek-Sharma Date: Tue, 11 May 2021 15:45:00 +0200 Subject: [PATCH 3/5] Upgrade feign to 11 (#540) --- .../main/asciidoc/spring-cloud-openfeign.adoc | 8 -- .../openfeign/FeignAutoConfiguration.java | 2 - .../openfeign/support/DefaultGzipDecoder.java | 80 ------------------- .../DefaultGzipDecoderConfiguration.java | 58 -------------- ...coderTests.java => GzipDecodingTests.java} | 9 ++- .../FeignBlockingLoadBalancerClientTests.java | 16 +++- spring-cloud-openfeign-dependencies/pom.xml | 2 +- 7 files changed, 20 insertions(+), 155 deletions(-) delete mode 100644 spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoder.java delete mode 100644 spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/DefaultGzipDecoderConfiguration.java rename spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/{DefaultGzipDecoderTests.java => GzipDecodingTests.java} (94%) diff --git a/docs/src/main/asciidoc/spring-cloud-openfeign.adoc b/docs/src/main/asciidoc/spring-cloud-openfeign.adoc index b59ecfff..de867deb 100644 --- a/docs/src/main/asciidoc/spring-cloud-openfeign.adoc +++ b/docs/src/main/asciidoc/spring-cloud-openfeign.adoc @@ -498,14 +498,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/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..3c4de289 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 @@ -56,7 +56,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; @@ -84,7 +83,6 @@ import org.springframework.security.oauth2.client.resource.OAuth2ProtectedResour @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); 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/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 356412be..e5accdba 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 @@ -39,15 +39,16 @@ import static org.assertj.core.api.Assertions.assertThat; /** * @author Jaesik Kim + * @author Olga Maciaszek-Sharma */ @RunWith(SpringJUnit4ClassRunner.class) -@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; @@ -55,7 +56,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/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-dependencies/pom.xml b/spring-cloud-openfeign-dependencies/pom.xml index ed285e51..55d19709 100644 --- a/spring-cloud-openfeign-dependencies/pom.xml +++ b/spring-cloud-openfeign-dependencies/pom.xml @@ -15,7 +15,7 @@ spring-cloud-openfeign-dependencies Spring Cloud OpenFeign Dependencies - 10.12 + 11.2 3.8.0 2.1.2.RELEASE From ebe30c8d3c10d30559cea2579aca103437dea4b0 Mon Sep 17 00:00:00 2001 From: Olga MaciaszekSharma Date: Thu, 13 May 2021 14:54:10 +0200 Subject: [PATCH 4/5] Upgrade SC Build to 3.1.0-SNAPSHOT. --- pom.xml | 2 +- 1 file changed, 1 insertion(+), 1 deletion(-) diff --git a/pom.xml b/pom.xml index 299a2ace..d0f12008 100644 --- a/pom.xml +++ b/pom.xml @@ -11,7 +11,7 @@ org.springframework.cloud spring-cloud-build - 3.0.3-SNAPSHOT + 3.1.0-SNAPSHOT From 1187c3e5b806fb2c49b341a82f86bd8cbab2faf4 Mon Sep 17 00:00:00 2001 From: Olga Maciaszek-Sharma Date: Fri, 14 May 2021 17:15:31 +0200 Subject: [PATCH 5/5] Use WebConverters for Hateoas. (#543) --- .../openfeign/FeignClientsConfiguration.java | 29 +++--- .../hateoas/FeignHalAutoConfiguration.java | 32 ++----- .../hateoas/WebConvertersCustomizer.java | 41 +++++++++ .../support/EmptyObjectProvider.java | 54 +++++++++++ .../HttpMessageConverterCustomizer.java | 33 +++++++ .../openfeign/support/SpringDecoder.java | 36 ++++++-- .../openfeign/support/SpringEncoder.java | 34 +++++-- ...FeignHalAutoConfigurationContextTests.java | 28 +++--- .../FeignHalAutoConfigurationTests.java | 90 ------------------- 9 files changed, 220 insertions(+), 157 deletions(-) create mode 100644 spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/hateoas/WebConvertersCustomizer.java create mode 100644 spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/EmptyObjectProvider.java create mode 100644 spring-cloud-openfeign-core/src/main/java/org/springframework/cloud/openfeign/support/HttpMessageConverterCustomizer.java delete mode 100644 spring-cloud-openfeign-core/src/test/java/org/springframework/cloud/openfeign/hateoas/FeignHalAutoConfigurationTests.java 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..c1e378a0 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; @@ -97,22 +98,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()); @@ -133,13 +137,13 @@ public class FeignClientsConfiguration { @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 +158,7 @@ public class FeignClientsConfiguration { @Bean @ConditionalOnMissingBean(FeignLoggerFactory.class) public FeignLoggerFactory feignLoggerFactory() { - return new DefaultFeignLoggerFactory(this.logger); + return new DefaultFeignLoggerFactory(logger); } @Bean @@ -165,14 +169,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/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/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/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 5cfd6011..1eff6374 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.stream.Stream; import feign.RequestTemplate; @@ -34,6 +35,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; @@ -68,19 +70,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 @@ -96,7 +116,7 @@ public class SpringEncoder implements Encoder { } if (isMultipartType(requestContentType)) { - this.springFormEncoder.encode(requestBody, bodyType, request); + springFormEncoder.encode(requestBody, bodyType, request); return; } else { @@ -111,7 +131,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) { @@ -227,21 +249,21 @@ public class SpringEncoder implements Encoder { private final HttpHeaders httpHeaders; private FeignOutputMessage(RequestTemplate request) { - this.httpHeaders = getHttpHeaders(request.headers()); + httpHeaders = getHttpHeaders(request.headers()); } @Override public OutputStream getBody() throws IOException { - return this.outputStream; + return outputStream; } @Override public HttpHeaders getHeaders() { - return this.httpHeaders; + return httpHeaders; } public ByteArrayOutputStream getOutputStream() { - return this.outputStream; + return outputStream; } } 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 570a96fd..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 @@ -16,8 +16,8 @@ package org.springframework.cloud.openfeign.hateoas; -import org.junit.Before; -import org.junit.Test; +import org.junit.jupiter.api.BeforeEach; +import org.junit.jupiter.api.Test; import org.springframework.boot.autoconfigure.AutoConfigurations; import org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration; @@ -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; - @Before - public void setUp() { + @BeforeEach + 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 b2757760..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.Test; -import org.junit.runner.RunWith; -import org.mockito.InjectMocks; -import org.mockito.Mock; -import org.mockito.junit.MockitoJUnitRunner; - -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 - */ -@RunWith(MockitoJUnitRunner.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(); - } - -}