Compare commits

...
75 Commits
Author SHA1 Message Date
buildmaster 245b106a76 Bumping versions 2022-09-11 23:33:49 +00:00
Olga Maciaszek-Sharma 666a59df6b Adjust to changes in commons. 2022-09-05 16:50:00 +02:00
Olga Maciaszek-Sharma 5a21e22002 Merge remote-tracking branch 'origin/3.1.x' 2022-09-05 16:43:41 +02:00
Olga Maciaszek-Sharma bdcbaa7f3b Allow overriding binary content types. Fixes gh-734. 2022-09-05 16:37:12 +02:00
buildmaster 375241803d Bumping versions to 3.1.5-SNAPSHOT after release 2022-09-02 23:46:06 +00:00
buildmaster 0213d4be21 Going back to snapshots 2022-09-02 23:46:05 +00:00
buildmaster 73cde28fcf Update SNAPSHOT to 3.1.4 2022-09-02 23:44:34 +00:00
小魏,小魏,我们要去哪里呀 5bddccf720 Customize load balanced requests according to the chosen ServiceInstance (#735) 2022-09-01 11:38:09 +02:00
Olga Maciaszek-Sharma 5f40f245af Merge remote-tracking branch 'origin/main' 2022-08-31 12:40:12 +02:00
buildmaster e4bdc13c51 Going back to snapshots 2022-07-29 19:39:18 +00:00
buildmaster f344125527 Update SNAPSHOT to 4.0.0-M4 2022-07-29 19:37:18 +00:00
Olga Maciaszek-Sharma 26e157fd46 Merge remote-tracking branch 'origin/3.1.x' 2022-07-25 16:43:26 +02:00
Olga Maciaszek-Sharma efbf71294d Merge remote-tracking branch 'origin/3.0.x' into 3.1.x 2022-07-25 16:27:38 +02:00
fml2 b4c9567de5 Update spring-cloud-openfeign.adoc 2022-07-25 16:00:28 +02:00
fml2 9529e43c01 Update spring-cloud-openfeign.adoc 2022-07-25 15:52:05 +02:00
Kwangyong Kim a26095bb6c Fix a typo in sample code
I found a typo in the latest release.
It should be `@FeignClient(url = "http://localhost:8080")`
2022-07-25 15:22:52 +02:00
Nikita Konev 8fdb488697 fix cascading deserialization Spring Data's Page by setting @JsonIgnoreProperties(ignoreUnknown = true), revert ignoring getTotalPages(), getNumberOfElements(), isFirst(), isLast() (#653) 2022-07-25 15:12:22 +02:00
spencergibb 540ec0410d Removes libs-*-local repos 2022-07-18 13:03:18 -04:00
spencergibb 8989036e93 Removes libs-*-local repos 2022-07-18 12:59:55 -04:00
Olga Maciaszek-Sharma 1c8e8056e4 Remove vulnerable transitive dependency. Fix checkstyle. 2022-07-01 16:57:29 +02:00
Olga Maciaszek-Sharma a29f28506f Remove vulnerable transitive dependency. 2022-07-01 16:38:55 +02:00
Olga Maciaszek-Sharma 926f1151c1 Add deprecations for OAuth2. 2022-07-01 16:14:32 +02:00
buildmaster 1e70aec75c Bumping versions 2022-06-30 10:59:53 +00:00
buildmaster 7e01355317 Bumping versions to 3.0.8-SNAPSHOT after release 2022-06-29 22:15:46 +00:00
buildmaster fc459044b5 Going back to snapshots 2022-06-29 22:15:46 +00:00
buildmaster e321e72e3d Update SNAPSHOT to 3.0.7 2022-06-29 22:14:15 +00:00
Olga Maciaszek-Sharma ae63aae6eb Add deprecations for OAuth2. 2022-06-29 17:40:23 +02:00
Olga Maciaszek-Sharma 10fefea29b Remove incompatible test. 2022-06-28 15:46:11 +02:00
Olga MaciaszekSharma 24d9b08d5c Backport bugfix and resolve conflicts. 2022-06-28 15:36:06 +02:00
Olga Maciaszek-Sharma d4832788f6 Resolve conflicts for backport. 2022-06-28 15:02:16 +02:00
Olga Maciaszek-Sharma ff96850ec0 Wrap underlying checked exception with IllegalStateException. Add tests. 2022-06-28 14:53:37 +02:00
Olga Maciaszek-Sharma 9023cc2dc5 Unwarap InvocationTargetException and NoFallbackAvailableException. 2022-06-28 14:53:27 +02:00
Olga Maciaszek-Sharma 6c3b8c257e Fixes gh-680. 2022-06-28 14:44:00 +02:00
buildmaster 3f55dbecba Going back to snapshots 2022-06-15 12:52:34 +00:00
buildmaster 1a72f2502e Update SNAPSHOT to 4.0.0-M3 2022-06-15 12:50:33 +00:00
spencergibb f8b3ed971e Bumps to next snapshot version 2022-05-27 13:45:43 -04:00
Olga Maciaszek-Sharma 8493de9aa6 Fix @LocalServerPort imports. 2022-05-18 14:10:43 +02:00
buildmaster 001b7388a7 Going back to snapshots 2022-03-31 21:53:30 +00:00
buildmaster 0c5c3befbc Update SNAPSHOT to 4.0.0-M2 2022-03-31 21:51:31 +00:00
Olga Maciaszek-Sharma 952a7b0ff0 Fix merge 3.1.x. 2022-03-30 15:18:37 +02:00
Olga Maciaszek-Sharma 2b1ac9caa8 merge 3.1.x 2022-03-30 13:59:03 +02:00
Olga Maciaszek-Sharma 2a008d12c8 Merge remote-tracking branch 'origin/3.1.x' 2022-03-16 14:05:31 +01:00
Ryan Baxter 295b5e4861 Fixing checkstyle and test errors 2022-03-10 20:06:37 -05:00
Ryan Baxter efbb0b8224 Adopt new circuit breaking naming convention by default 2022-03-10 19:53:45 -05:00
Ryan Baxter 4e1859eea6 Merge branch '3.1.x' 2022-03-10 19:53:10 -05:00
spencergibb 0972d4211f Migrates to TestSocketUtils from spring-cloud-test-support 2022-03-09 12:47:33 -05:00
buildmaster 2f8f114667 Bumping versions 2022-02-28 23:22:06 +00:00
Olga Maciaszek-Sharma 0d0ff50842 Use raw types in ResponseData. (#685) 2022-02-28 16:48:31 +01:00
Olga Maciaszek-Sharma 088221b9fb Merge remote-tracking branch 'origin/3.1.x' 2022-02-25 13:14:29 +01:00
Olga Maciaszek-Sharma 8998eb3423 Merge remote-tracking branch 'origin/3.1.x' 2022-02-24 12:57:55 +01:00
buildmaster fe43b6c52b Bumping versions 2022-02-24 10:52:51 +00:00
Can Bezmen ddc1b94555 Fix gh-490 (#679) 2022-02-15 12:54:35 +01:00
Olga Maciaszek-Sharma cef268947f Merge remote-tracking branch 'origin/3.1.x' 2022-02-14 13:14:07 +01:00
buildmaster 8d802a3fee Bumping versions 2022-02-04 00:23:21 +00:00
Olga Maciaszek-Sharma e674f488d2 Remove unnecessary dependencies. 2022-02-03 17:19:50 +01:00
Olga Maciaszek-Sharma 2eea81f93b Merge remote-tracking branch 'origin/3.1.x' 2022-01-28 10:49:07 +01:00
buildmaster ee8a42e401 Going back to snapshots 2022-01-27 21:47:37 +00:00
buildmaster 53428758ad Update SNAPSHOT to 4.0.0-M1 2022-01-27 21:45:39 +00:00
buildmaster 59ac5c1b3c Bumping versions 2022-01-27 00:24:12 +00:00
spencergibb 4f7892f34d formatting 2022-01-26 16:33:21 -05:00
buildmaster 261fc58a5e Bumping versions 2022-01-20 00:23:54 +00:00
Olga MaciaszekSharma 67e8c9072d Merge remote-tracking branch 'origin/3.1.x' 2022-01-17 12:41:39 +01:00
Olga MaciaszekSharma 7b08279aae Merge remote-tracking branch 'origin/3.1.x' 2022-01-17 10:51:54 +01:00
buildmaster f60859120d Bumping versions 2022-01-15 00:23:41 +00:00
Olga MaciaszekSharma c665d2c029 Merge remote-tracking branch 'origin/3.1.x' 2022-01-14 20:02:56 +01:00
Olga MaciaszekSharma 7f425704e4 Merge remote-tracking branch 'origin/3.1.x' 2022-01-14 17:23:03 +01:00
Olga MaciaszekSharma 6c130af613 Merge remote-tracking branch 'origin/3.1.x' 2022-01-14 17:04:11 +01:00
Olga MaciaszekSharma 98b2511d1f Merge remote-tracking branch 'origin/3.1.x' 2022-01-12 18:14:46 +01:00
Olga MaciaszekSharma 10ad8a0c6e Update license entries. 2022-01-11 15:05:02 +01:00
Olga MaciaszekSharma 505894315d Merge remote-tracking branch 'origin/3.1.x' 2022-01-11 15:03:45 +01:00
Olga MaciaszekSharma e2048b3719 Merge remote-tracking branch 'origin/3.1.x' 2022-01-11 14:28:05 +01:00
buildmaster e389726ba2 Bumping versions 2022-01-06 00:32:53 +00:00
Spencer Gibb 2cf8adf482 Update github actions to use java 17 2022-01-04 13:16:49 -05:00
spencergibb 6a1d9fe074 Updates to version 4.0.0-SNAPSHOT
Updates to java 17, framework 6, boot 3 and javax -> jakarta
2022-01-04 13:02:13 -05:00
spencergibb b6b16a034a Updates to version 4.0.0-SNAPSHOT
Updates to java 17, framework 6, boot 3 and javax -> jakarta
2022-01-04 12:26:00 -05:00
86 changed files with 681 additions and 432 deletions
+1 -1
View File
@@ -16,7 +16,7 @@ jobs:
strategy: strategy:
matrix: matrix:
java: ["8", "11", "16"] java: ["17"]
steps: steps:
- uses: actions/checkout@v2 - uses: actions/checkout@v2
+1 -1
View File
@@ -1,3 +1,3 @@
# Enable auto-env through the sdkman_auto_env config # Enable auto-env through the sdkman_auto_env config
# Add key=value pairs of SDKs to use below # Add key=value pairs of SDKs to use below
java=8.0.292.hs-adpt java=17.0.1-tem
+1 -1
View File
@@ -6,7 +6,7 @@
<parent> <parent>
<groupId>org.springframework.cloud</groupId> <groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-openfeign</artifactId> <artifactId>spring-cloud-openfeign</artifactId>
<version>3.1.3</version> <version>4.0.0-SNAPSHOT</version>
</parent> </parent>
<artifactId>spring-cloud-openfeign-docs</artifactId> <artifactId>spring-cloud-openfeign-docs</artifactId>
<packaging>jar</packaging> <packaging>jar</packaging>
+33 -34
View File
@@ -1,38 +1,37 @@
|=== |===
|Name | Default | Description |Name | Default | Description
|feign.autoconfiguration.jackson.enabled | `false` | If true, PageJacksonModule and SortJacksonModule bean will be provided for Jackson page decoding. |spring.cloud.openfeign.autoconfiguration.jackson.enabled | `false` | If true, PageJacksonModule and SortJacksonModule bean will be provided for Jackson page decoding.
|feign.circuitbreaker.alphanumeric-ids.enabled | `false` | If true, Circuit Breaker ids will only contain alphanumeric characters to allow for configuration via configuration properties. |spring.cloud.openfeign.circuitbreaker.enabled | `false` | If true, an OpenFeign client will be wrapped with a Spring Cloud CircuitBreaker circuit breaker.
|feign.circuitbreaker.enabled | `false` | If true, an OpenFeign client will be wrapped with a Spring Cloud CircuitBreaker circuit breaker. |spring.cloud.openfeign.circuitbreaker.group.enabled | `false` | If true, an OpenFeign client will be wrapped with a Spring Cloud CircuitBreaker circuit breaker with with group.
|feign.circuitbreaker.group.enabled | `false` | If true, an OpenFeign client will be wrapped with a Spring Cloud CircuitBreaker circuit breaker with with group. |spring.cloud.openfeign.client.config | |
|feign.client.config | | |spring.cloud.openfeign.client.decode-slash | `true` | Feign clients do not encode slash `/` characters by default. To change this behavior, set the `decodeSlash` to `false`.
|feign.client.decode-slash | `true` | Feign clients do not encode slash `/` characters by default. To change this behavior, set the `decodeSlash` to `false`. |spring.cloud.openfeign.client.default-config | `default` |
|feign.client.default-config | `default` | |spring.cloud.openfeign.client.default-to-properties | `true` |
|feign.client.default-to-properties | `true` | |spring.cloud.openfeign.client.refresh-enabled | `false` | Enables options value refresh capability for Feign.
|feign.client.refresh-enabled | `false` | Enables options value refresh capability for Feign. |spring.cloud.openfeign.compression.request.enabled | `false` | Enables the request sent by Feign to be compressed.
|feign.compression.request.enabled | `false` | Enables the request sent by Feign to be compressed. |spring.cloud.openfeign.compression.request.mime-types | `[text/xml, application/xml, application/json]` | The list of supported mime types.
|feign.compression.request.mime-types | `[text/xml, application/xml, application/json]` | The list of supported mime types. |spring.cloud.openfeign.compression.request.min-request-size | `2048` | The minimum threshold content size.
|feign.compression.request.min-request-size | `2048` | The minimum threshold content size. |spring.cloud.openfeign.compression.response.enabled | `false` | Enables the response from Feign to be compressed.
|feign.compression.response.enabled | `false` | Enables the response from Feign to be compressed. |spring.cloud.openfeign.encoder.charset-from-content-type | `false` | Indicates whether the charset should be derived from the {@code Content-Type} header.
|feign.encoder.charset-from-content-type | `false` | Indicates whether the charset should be derived from the {@code Content-Type} header. |spring.cloud.openfeign.httpclient.connection-timeout | `2000` |
|feign.httpclient.connection-timeout | `2000` | |spring.cloud.openfeign.httpclient.connection-timer-repeat | `3000` |
|feign.httpclient.connection-timer-repeat | `3000` | |spring.cloud.openfeign.httpclient.disable-ssl-validation | `false` |
|feign.httpclient.disable-ssl-validation | `false` | |spring.cloud.openfeign.httpclient.enabled | `true` | Enables the use of the Apache HTTP Client by Feign.
|feign.httpclient.enabled | `true` | Enables the use of the Apache HTTP Client by Feign. |spring.cloud.openfeign.httpclient.follow-redirects | `true` |
|feign.httpclient.follow-redirects | `true` | |spring.cloud.openfeign.httpclient.hc5.enabled | `false` | Enables the use of the Apache HTTP Client 5 by Feign.
|feign.httpclient.hc5.enabled | `false` | Enables the use of the Apache HTTP Client 5 by Feign. |spring.cloud.openfeign.httpclient.hc5.pool-concurrency-policy | | Pool concurrency policies.
|feign.httpclient.hc5.pool-concurrency-policy | | Pool concurrency policies. |spring.cloud.openfeign.httpclient.hc5.pool-reuse-policy | | Pool connection re-use policies.
|feign.httpclient.hc5.pool-reuse-policy | | Pool connection re-use policies. |spring.cloud.openfeign.httpclient.hc5.socket-timeout | `5` | Default value for socket timeout.
|feign.httpclient.hc5.socket-timeout | `5` | Default value for socket timeout. |spring.cloud.openfeign.httpclient.hc5.socket-timeout-unit | | Default value for socket timeout unit.
|feign.httpclient.hc5.socket-timeout-unit | | Default value for socket timeout unit. |spring.cloud.openfeign.httpclient.max-connections | `200` |
|feign.httpclient.max-connections | `200` | |spring.cloud.openfeign.httpclient.max-connections-per-route | `50` |
|feign.httpclient.max-connections-per-route | `50` | |spring.cloud.openfeign.httpclient.ok-http.read-timeout | `60s` | {@link OkHttpClient} read timeout; defaults to 60 seconds.
|feign.httpclient.ok-http.read-timeout | `60s` | {@link OkHttpClient} read timeout; defaults to 60 seconds. |spring.cloud.openfeign.httpclient.time-to-live | `900` |
|feign.httpclient.time-to-live | `900` | |spring.cloud.openfeign.httpclient.time-to-live-unit | |
|feign.httpclient.time-to-live-unit | | |spring.cloud.openfeign.metrics.enabled | `true` | Enables metrics capability for Feign.
|feign.metrics.enabled | `true` | Enables metrics capability for Feign. |spring.cloud.openfeign.oauth2.enabled | `false` | Enables feign interceptor for managing oauth2 access token.
|feign.oauth2.enabled | `false` | Enables feign interceptor for managing oauth2 access token. |spring.cloud.openfeign.oauth2.load-balanced | `false` | Enables load balancing for oauth2 access token provider.
|feign.oauth2.load-balanced | `false` | Enables load balancing for oauth2 access token provider. |spring.cloud.openfeign.okhttp.enabled | `false` | Enables the use of the OK HTTP Client by Feign.
|feign.okhttp.enabled | `false` | Enables the use of the OK HTTP Client by Feign.
|=== |===
@@ -122,7 +122,7 @@ Spring Cloud OpenFeign provides the following beans by default for feign (`BeanT
* `Encoder` feignEncoder: `SpringEncoder` * `Encoder` feignEncoder: `SpringEncoder`
* `Logger` feignLogger: `Slf4jLogger` * `Logger` feignLogger: `Slf4jLogger`
* `MicrometerCapability` micrometerCapability: If `feign-micrometer` is on the classpath and `MeterRegistry` is available * `MicrometerCapability` micrometerCapability: If `feign-micrometer` is on the classpath and `MeterRegistry` is available
* `CachingCapability` cachingCapability: If `@EnableCaching` annotation is used. Can be disabled via `feign.cache.enabled`. * `CachingCapability` cachingCapability: If `@EnableCaching` annotation is used. Can be disabled via `spring.cloud.openfeign.cache.enabled`.
* `Contract` feignContract: `SpringMvcContract` * `Contract` feignContract: `SpringMvcContract`
* `Feign.Builder` feignBuilder: `FeignCircuitBreaker.Builder` * `Feign.Builder` feignBuilder: `FeignCircuitBreaker.Builder`
* `Client` feignClient: If Spring Cloud LoadBalancer is on the classpath, `FeignBlockingLoadBalancerClient` is used. * `Client` feignClient: If Spring Cloud LoadBalancer is on the classpath, `FeignBlockingLoadBalancerClient` is used.
@@ -130,7 +130,7 @@ If none of them is on the classpath, the default feign client is used.
NOTE: `spring-cloud-starter-openfeign` supports `spring-cloud-starter-loadbalancer`. However, as is an optional dependency, you need to make sure it been added to your project if you want to use it. NOTE: `spring-cloud-starter-openfeign` supports `spring-cloud-starter-loadbalancer`. However, as is an optional dependency, you need to make sure it been added to your project if you want to use it.
The OkHttpClient and ApacheHttpClient and ApacheHC5 feign clients can be used by setting `feign.okhttp.enabled` or `feign.httpclient.enabled` or `feign.httpclient.hc5.enabled` to `true`, respectively, and having them on the classpath. The OkHttpClient and ApacheHttpClient and ApacheHC5 feign clients can be used by setting `spring.cloud.openfeign.okhttp.enabled` or `spring.cloud.openfeign.httpclient.enabled` or `spring.cloud.openfeign.httpclient.hc5.enabled` to `true`, respectively, and having them on the classpath.
You can customize the HTTP client used by providing a bean of either `org.apache.http.impl.client.CloseableHttpClient` when using Apache or `okhttp3.OkHttpClient` when using OK HTTP or `org.apache.hc.client5.http.impl.classic.CloseableHttpClient` when using Apache HC5. You can customize the HTTP client used by providing a bean of either `org.apache.http.impl.client.CloseableHttpClient` when using Apache or `okhttp3.OkHttpClient` when using OK HTTP or `org.apache.hc.client5.http.impl.classic.CloseableHttpClient` when using Apache HC5.
Spring Cloud OpenFeign _does not_ provide the following beans by default for feign, but still looks up beans of these types from the application context to create the feign client: Spring Cloud OpenFeign _does not_ provide the following beans by default for feign, but still looks up beans of these types from the application context to create the feign client:
@@ -173,54 +173,58 @@ This replaces the `SpringMvcContract` with `feign.Contract.Default` and adds a `
application.yml application.yml
[source,yaml] [source,yaml]
---- ----
feign: spring:
client: cloud:
config: openfeign:
feignName: client:
connectTimeout: 5000 config:
readTimeout: 5000 feignName:
loggerLevel: full connectTimeout: 5000
errorDecoder: com.example.SimpleErrorDecoder readTimeout: 5000
retryer: com.example.SimpleRetryer loggerLevel: full
defaultQueryParameters: errorDecoder: com.example.SimpleErrorDecoder
query: queryValue retryer: com.example.SimpleRetryer
defaultRequestHeaders: defaultQueryParameters:
header: headerValue query: queryValue
requestInterceptors: defaultRequestHeaders:
- com.example.FooRequestInterceptor header: headerValue
- com.example.BarRequestInterceptor requestInterceptors:
decode404: false - com.example.FooRequestInterceptor
encoder: com.example.SimpleEncoder - com.example.BarRequestInterceptor
decoder: com.example.SimpleDecoder decode404: false
contract: com.example.SimpleContract encoder: com.example.SimpleEncoder
capabilities: decoder: com.example.SimpleDecoder
- com.example.FooCapability contract: com.example.SimpleContract
- com.example.BarCapability capabilities:
queryMapEncoder: com.example.SimpleQueryMapEncoder - com.example.FooCapability
metrics.enabled: false - com.example.BarCapability
queryMapEncoder: com.example.SimpleQueryMapEncoder
metrics.enabled: false
---- ----
Default configurations can be specified in the `@EnableFeignClients` attribute `defaultConfiguration` in a similar manner as described above. The difference is that this configuration will apply to _all_ feign clients. Default configurations can be specified in the `@EnableFeignClients` attribute `defaultConfiguration` in a similar manner as described above. The difference is that this configuration will apply to _all_ feign clients.
If you prefer using configuration properties to configured all `@FeignClient`, you can create configuration properties with `default` feign name. If you prefer using configuration properties to configure all `@FeignClient`, you can create configuration properties with `default` feign name.
You can use `feign.client.config.feignName.defaultQueryParameters` and `feign.client.config.feignName.defaultRequestHeaders` to specify query parameters and headers that will be sent with every request of the client named `feignName`. You can use `spring.cloud.openfeign.client.config.feignName.defaultQueryParameters` and `spring.cloud.openfeign.client.config.feignName.defaultRequestHeaders` to specify query parameters and headers that will be sent with every request of the client named `feignName`.
application.yml application.yml
[source,yaml] [source,yaml]
---- ----
feign: spring:
client: cloud:
config: openfeign:
default: client:
connectTimeout: 5000 config:
readTimeout: 5000 default:
loggerLevel: basic connectTimeout: 5000
readTimeout: 5000
loggerLevel: basic
---- ----
If we create both `@Configuration` bean and configuration properties, configuration properties will win. If we create both `@Configuration` bean and configuration properties, configuration properties will win.
It will override `@Configuration` values. But if you want to change the priority to `@Configuration`, It will override `@Configuration` values. But if you want to change the priority to `@Configuration`,
you can change `feign.client.default-to-properties` to `false`. you can change `spring.cloud.openfeign.client.default-to-properties` to `false`.
If we want to create multiple feign clients with the same name or url If we want to create multiple feign clients with the same name or url
so that they would point to the same server but each with a different custom configuration then so that they would point to the same server but each with a different custom configuration then
@@ -266,13 +270,13 @@ public FeignClientConfigurer feignClientConfigurer() {
} }
---- ----
TIP: By default, Feign clients do not encode slash `/` characters. You can change this behaviour, by setting the value of `feign.client.decodeSlash` to `false`. TIP: By default, Feign clients do not encode slash `/` characters. You can change this behaviour, by setting the value of `spring.cloud.openfeign.client.decodeSlash` to `false`.
==== `SpringEncoder` configuration ==== `SpringEncoder` configuration
In the `SpringEncoder` that we provide, we set `null` charset for binary content types and `UTF-8` for all the other ones. In the `SpringEncoder` that we provide, we set `null` charset for binary content types and `UTF-8` for all the other ones.
You can modify this behaviour to derive the charset from the `Content-Type` header charset instead by setting the value of `feign.encoder.charset-from-content-type` to `true`. You can modify this behaviour to derive the charset from the `Content-Type` header charset instead by setting the value of `spring.cloud.openfeign.encoder.charset-from-content-type` to `true`.
[[timeout-handling]] [[timeout-handling]]
=== Timeout Handling === Timeout Handling
@@ -337,7 +341,7 @@ You can do this by overriding calling `inheritParentContext(false)` on the `Buil
[[spring-cloud-feign-circuitbreaker]] [[spring-cloud-feign-circuitbreaker]]
=== Feign Spring Cloud CircuitBreaker Support === Feign Spring Cloud CircuitBreaker Support
If Spring Cloud CircuitBreaker is on the classpath and `feign.circuitbreaker.enabled=true`, Feign will wrap all methods with a circuit breaker. If Spring Cloud CircuitBreaker is on the classpath and `spring.cloud.openfeign.circuitbreaker.enabled=true`, Feign will wrap all methods with a circuit breaker.
To disable Spring Cloud CircuitBreaker support on a per-client basis create a vanilla `Feign.Builder` with the "prototype" scope, e.g.: To disable Spring Cloud CircuitBreaker support on a per-client basis create a vanilla `Feign.Builder` with the "prototype" scope, e.g.:
@@ -370,22 +374,18 @@ public class FooConfiguration {
} }
---- ----
To enable Spring Cloud CircuitBreaker group set the `feign.circuitbreaker.group.enabled` property to `true` (by default `false`). To enable Spring Cloud CircuitBreaker group set the `spring.cloud.openfeign.circuitbreaker.group.enabled` property to `true` (by default `false`).
[[spring-clou-feign-circuitbreaker-configurationproperties]] [[spring-clou-feign-circuitbreaker-configurationproperties]]
=== Configuring CircuitBreakers With Configuration Properties === Configuring CircuitBreakers With Configuration Properties
You can configure CircuitBreakers via configuration properties. To do set You can configure CircuitBreakers via configuration properties.
`feign.circuitbreaker.alphanumeric-ids.enabled` to `true`. Since
you cannot use characters like `#`, `(`, `)` `,` in configuration property names we need to
change the naming convention for the ids of the circuit breakers generated by OpenFeign. The above
property will do this for you.
For example, if you had this Feign client For example, if you had this Feign client
[source,java,indent=0] [source,java,indent=0]
---- ----
@FeignClienturl = "http://localhost:8080") @FeignClient(url = "http://localhost:8080")
public interface DemoClient { public interface DemoClient {
@GetMapping("demo") @GetMapping("demo")
@@ -413,6 +413,8 @@ resilience4j:
timeoutDuration: 10s timeoutDuration: 10s
---- ----
NOTE: If you want to switch back to the circuit breaker names used prior to Spring Cloud
2022.0.0 you can set `spring.cloud.openfeign.circuitbreaker.alphanumeric-ids.enabled` to `false`.
[[spring-cloud-feign-circuitbreaker-fallback]] [[spring-cloud-feign-circuitbreaker-fallback]]
=== Feign Spring Cloud CircuitBreaker Fallbacks === Feign Spring Cloud CircuitBreaker Fallbacks
@@ -546,17 +548,17 @@ Feign requests. You can do this by enabling one of the properties:
[source,java] [source,java]
---- ----
feign.compression.request.enabled=true spring.cloud.openfeign.compression.request.enabled=true
feign.compression.response.enabled=true spring.cloud.openfeign.compression.response.enabled=true
---- ----
Feign request compression gives you settings similar to what you may set for your web server: Feign request compression gives you settings similar to what you may set for your web server:
[source,java] [source,java]
---- ----
feign.compression.request.enabled=true spring.cloud.openfeign.compression.request.enabled=true
feign.compression.request.mime-types=text/xml,application/xml,application/json spring.cloud.openfeign.compression.request.mime-types=text/xml,application/xml,application/json
feign.compression.request.min-request-size=2048 spring.cloud.openfeign.compression.request.min-request-size=2048
---- ----
These properties allow you to be selective about the compressed media types and minimum request threshold length. These properties allow you to be selective about the compressed media types and minimum request threshold length.
@@ -617,8 +619,8 @@ If all of the following conditions are true, a `MicrometerCapability` bean is cr
* `feign-micrometer` is on the classpath * `feign-micrometer` is on the classpath
* A `MeterRegistry` bean is available * A `MeterRegistry` bean is available
* feign metrics properties are set to `true` (by default) * feign metrics properties are set to `true` (by default)
- `feign.metrics.enabled=true` (for all clients) - `spring.cloud.openfeign.metrics.enabled=true` (for all clients)
- `feign.client.config.feignName.metrics.enabled=true` (for a single client) - `spring.cloud.openfeign.client.config.feignName.metrics.enabled=true` (for a single client)
NOTE: If your application already uses Micrometer, enabling metrics is as simple as putting `feign-micrometer` onto your classpath. NOTE: If your application already uses Micrometer, enabling metrics is as simple as putting `feign-micrometer` onto your classpath.
@@ -626,11 +628,11 @@ You can also disable the feature by either:
* excluding `feign-micrometer` from your classpath * excluding `feign-micrometer` from your classpath
* setting one of the feign metrics properties to `false` * setting one of the feign metrics properties to `false`
- `feign.metrics.enabled=false` - `spring.cloud.openfeign.metrics.enabled=false`
- `feign.client.config.feignName.metrics.enabled=false` - `spring.cloud.openfeign.client.config.feignName.metrics.enabled=false`
NOTE: `feign.metrics.enabled=false` disables metrics support for *all* Feign clients regardless of the value of the client-level flags: `feign.client.config.feignName.metrics.enabled`. NOTE: `spring.cloud.openfeign.metrics.enabled=false` disables metrics support for *all* Feign clients regardless of the value of the client-level flags: `spring.cloud.openfeign.client.config.feignName.metrics.enabled`.
If you want to enable or disable merics per client, don't set `feign.metrics.enabled` and use `feign.client.config.feignName.metrics.enabled`. If you want to enable or disable merics per client, don't set `spring.cloud.openfeign.metrics.enabled` and use `spring.cloud.openfeign.client.config.feignName.metrics.enabled`.
You can also customize the `MicrometerCapability` by registering your own bean: You can also customize the `MicrometerCapability` by registering your own bean:
@@ -659,7 +661,7 @@ public interface DemoClient {
} }
---- ----
You can also disable the feature via property `feign.cache.enabled=false`. You can also disable the feature via property `spring.cloud.openfeign.cache.enabled=false`.
=== Feign @QueryMap support === Feign @QueryMap support
@@ -789,7 +791,7 @@ You may consider enabling Jackson Modules for the support `org.springframework.d
[source,java] [source,java]
---- ----
feign.autoconfiguration.jackson.enabled=true spring.cloud.openfeign.autoconfiguration.jackson.enabled=true
---- ----
=== Spring `@RefreshScope` Support === Spring `@RefreshScope` Support
@@ -798,21 +800,48 @@ If Feign client refresh is enabled, each feign client is created with `feign.Req
By default, refresh behavior in Feign clients is disabled. Use the following property to enable refresh behavior: By default, refresh behavior in Feign clients is disabled. Use the following property to enable refresh behavior:
[source,java] [source,java]
---- ----
feign.client.refresh-enabled=true spring.cloud.openfeign.client.refresh-enabled=true
---- ----
TIP: DO NOT annotate the `@FeignClient` interface with the `@RefreshScope` annotation. TIP: DO NOT annotate the `@FeignClient` interface with the `@RefreshScope` annotation.
=== OAuth2 Support === OAuth2 Support
OAuth2 support can be enabled by setting following flag: OAuth2 support can be enabled by setting following flag:
---- ----
feign.oauth2.enabled=true spring.cloud.openfeign.oauth2.enabled=true
---- ----
When the flag is set to true, and the oauth2 client context resource details are present, a bean of class `OAuth2FeignRequestInterceptor` is created. Before each request, the interceptor resolves the required access token and includes it as a header. When the flag is set to true, and the oauth2 client context resource details are present, a bean of class `OAuth2FeignRequestInterceptor` is created. Before each request, the interceptor resolves the required access token and includes it as a header.
Sometimes, when load balancing is enabled for Feign clients, you may want to use load balancing for fetching access tokens, too. To do so, you should ensure that the load balancer is on the classpath (spring-cloud-starter-loadbalancer) and explicitly enable load balancing for OAuth2FeignRequestInterceptor by setting the following flag: Sometimes, when load balancing is enabled for Feign clients, you may want to use load balancing for fetching access tokens, too. To do so, you should ensure that the load balancer is on the classpath (spring-cloud-starter-loadbalancer) and explicitly enable load balancing for OAuth2FeignRequestInterceptor by setting the following flag:
---- ----
feign.oauth2.load-balanced=true spring.cloud.openfeign.oauth2.load-balanced=true
---- ----
=== Transform the load-balanced HTTP request
You can use the selected `ServiceInstance` to transform the load-balanced HTTP Request.
For `Request`, you need to implement and define `LoadBalancerFeignRequestTransformer`, as follows:
[source,java,indent=0]
----
@Bean
public LoadBalancerFeignRequestTransformer transformer() {
return new LoadBalancerFeignRequestTransformer() {
@Override
public Request transformRequest(Request request, ServiceInstance instance) {
Map<String, Collection<String>> headers = new HashMap<>(request.headers());
headers.put("X-ServiceId", Collections.singletonList(instance.getServiceId()));
headers.put("X-InstanceId", Collections.singletonList(instance.getInstanceId()));
return Request.create(request.httpMethod(), request.url(), headers, request.body(), request.charset(),
request.requestTemplate());
}
};
}
----
If multiple transformers are defined, they are applied in the order in which beans are defined.
Alternatively, you can use `LoadBalancerFeignRequestTransformer.DEFAULT_ORDER` to specify the order.
== Configuration properties == Configuration properties
To see the list of all Spring Cloud OpenFeign related configuration properties please check link:appendix.html[the Appendix page]. To see the list of all Spring Cloud OpenFeign related configuration properties please check link:appendix.html[the Appendix page].
+8 -15
View File
@@ -4,14 +4,14 @@
xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd"> xsi:schemaLocation="http://maven.apache.org/POM/4.0.0 https://maven.apache.org/xsd/maven-4.0.0.xsd">
<modelVersion>4.0.0</modelVersion> <modelVersion>4.0.0</modelVersion>
<artifactId>spring-cloud-openfeign</artifactId> <artifactId>spring-cloud-openfeign</artifactId>
<version>3.1.3</version> <version>4.0.0-SNAPSHOT</version>
<packaging>pom</packaging> <packaging>pom</packaging>
<name>Spring Cloud OpenFeign</name> <name>Spring Cloud OpenFeign</name>
<description>Spring Cloud OpenFeign</description> <description>Spring Cloud OpenFeign</description>
<parent> <parent>
<groupId>org.springframework.cloud</groupId> <groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-build</artifactId> <artifactId>spring-cloud-build</artifactId>
<version>3.1.3</version> <version>4.0.0-SNAPSHOT</version>
<relativePath/> <relativePath/>
</parent> </parent>
<scm> <scm>
@@ -26,7 +26,7 @@
<properties> <properties>
<main.basedir>${basedir}</main.basedir> <main.basedir>${basedir}</main.basedir>
<jackson.version>2.11.3</jackson.version> <jackson.version>2.11.3</jackson.version>
<spring-cloud-commons.version>3.1.3</spring-cloud-commons.version> <spring-cloud-commons.version>4.0.0-SNAPSHOT</spring-cloud-commons.version>
<!-- Plugin versions --> <!-- Plugin versions -->
<maven-eclipse-plugin.version>2.10</maven-eclipse-plugin.version> <maven-eclipse-plugin.version>2.10</maven-eclipse-plugin.version>
@@ -64,13 +64,6 @@
</additionalConfig> </additionalConfig>
</configuration> </configuration>
</plugin> </plugin>
<plugin>
<artifactId>maven-compiler-plugin</artifactId>
<configuration>
<source>1.8</source>
<target>1.8</target>
</configuration>
</plugin>
<plugin> <plugin>
<groupId>org.apache.maven.plugins</groupId> <groupId>org.apache.maven.plugins</groupId>
<artifactId>maven-checkstyle-plugin</artifactId> <artifactId>maven-checkstyle-plugin</artifactId>
@@ -142,7 +135,7 @@
<repository> <repository>
<id>spring-snapshots</id> <id>spring-snapshots</id>
<name>Spring Snapshots</name> <name>Spring Snapshots</name>
<url>https://repo.spring.io/libs-snapshot-local</url> <url>https://repo.spring.io/snapshot</url>
<snapshots> <snapshots>
<enabled>true</enabled> <enabled>true</enabled>
</snapshots> </snapshots>
@@ -153,7 +146,7 @@
<repository> <repository>
<id>spring-milestones</id> <id>spring-milestones</id>
<name>Spring Milestones</name> <name>Spring Milestones</name>
<url>https://repo.spring.io/libs-milestone-local</url> <url>https://repo.spring.io/milestone</url>
<snapshots> <snapshots>
<enabled>false</enabled> <enabled>false</enabled>
</snapshots> </snapshots>
@@ -171,7 +164,7 @@
<pluginRepository> <pluginRepository>
<id>spring-snapshots</id> <id>spring-snapshots</id>
<name>Spring Snapshots</name> <name>Spring Snapshots</name>
<url>https://repo.spring.io/libs-snapshot-local</url> <url>https://repo.spring.io/snapshot</url>
<snapshots> <snapshots>
<enabled>true</enabled> <enabled>true</enabled>
</snapshots> </snapshots>
@@ -182,7 +175,7 @@
<pluginRepository> <pluginRepository>
<id>spring-milestones</id> <id>spring-milestones</id>
<name>Spring Milestones</name> <name>Spring Milestones</name>
<url>https://repo.spring.io/libs-milestone-local</url> <url>https://repo.spring.io/milestone</url>
<snapshots> <snapshots>
<enabled>false</enabled> <enabled>false</enabled>
</snapshots> </snapshots>
@@ -190,7 +183,7 @@
<pluginRepository> <pluginRepository>
<id>spring-releases</id> <id>spring-releases</id>
<name>Spring Releases</name> <name>Spring Releases</name>
<url>https://repo.spring.io/libs-release-local</url> <url>https://repo.spring.io/release</url>
<snapshots> <snapshots>
<enabled>false</enabled> <enabled>false</enabled>
</snapshots> </snapshots>
+18 -11
View File
@@ -6,7 +6,7 @@
<parent> <parent>
<groupId>org.springframework.cloud</groupId> <groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-openfeign</artifactId> <artifactId>spring-cloud-openfeign</artifactId>
<version>3.1.3</version> <version>4.0.0-SNAPSHOT</version>
<relativePath>..</relativePath> <!-- lookup parent from repository --> <relativePath>..</relativePath> <!-- lookup parent from repository -->
</parent> </parent>
<artifactId>spring-cloud-openfeign-core</artifactId> <artifactId>spring-cloud-openfeign-core</artifactId>
@@ -61,11 +61,6 @@
<artifactId>reactor-core</artifactId> <artifactId>reactor-core</artifactId>
<optional>true</optional> <optional>true</optional>
</dependency> </dependency>
<dependency>
<groupId>io.reactivex</groupId>
<artifactId>rxjava-reactive-streams</artifactId>
<optional>true</optional>
</dependency>
<dependency> <dependency>
<groupId>org.springframework.retry</groupId> <groupId>org.springframework.retry</groupId>
<artifactId>spring-retry</artifactId> <artifactId>spring-retry</artifactId>
@@ -99,6 +94,13 @@
<dependency> <dependency>
<groupId>io.github.openfeign.form</groupId> <groupId>io.github.openfeign.form</groupId>
<artifactId>feign-form-spring</artifactId> <artifactId>feign-form-spring</artifactId>
<exclusions>
<!-- Vulnerable in 3.8.0-->
<exclusion>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
</exclusion>
</exclusions>
</dependency> </dependency>
<dependency> <dependency>
<groupId>io.github.openfeign</groupId> <groupId>io.github.openfeign</groupId>
@@ -125,11 +127,6 @@
<artifactId>feign-okhttp</artifactId> <artifactId>feign-okhttp</artifactId>
<optional>true</optional> <optional>true</optional>
</dependency> </dependency>
<dependency>
<groupId>io.reactivex</groupId>
<artifactId>rxjava</artifactId>
<optional>true</optional>
</dependency>
<dependency> <dependency>
<groupId>com.squareup.okhttp3</groupId> <groupId>com.squareup.okhttp3</groupId>
<artifactId>okhttp</artifactId> <artifactId>okhttp</artifactId>
@@ -148,6 +145,10 @@
<groupId>javax.activation</groupId> <groupId>javax.activation</groupId>
<artifactId>javax.activation-api</artifactId> <artifactId>javax.activation-api</artifactId>
</exclusion> </exclusion>
<exclusion>
<groupId>com.sun.activation</groupId>
<artifactId>jakarta.activation</artifactId>
</exclusion>
</exclusions> </exclusions>
</dependency> </dependency>
<dependency> <dependency>
@@ -208,6 +209,12 @@
<artifactId>spring-cloud-loadbalancer</artifactId> <artifactId>spring-cloud-loadbalancer</artifactId>
<optional>true</optional> <optional>true</optional>
</dependency> </dependency>
<dependency>
<groupId>commons-io</groupId>
<artifactId>commons-io</artifactId>
<version>2.11.0</version>
<scope>test</scope>
</dependency>
</dependencies> </dependencies>
<profiles> <profiles>
<profile> <profile>
@@ -25,8 +25,6 @@ import java.util.Timer;
import java.util.TimerTask; import java.util.TimerTask;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
import javax.annotation.PreDestroy;
import com.fasterxml.jackson.databind.Module; import com.fasterxml.jackson.databind.Module;
import feign.Capability; import feign.Capability;
import feign.Client; import feign.Client;
@@ -36,6 +34,7 @@ import feign.Target;
import feign.hc5.ApacheHttp5Client; import feign.hc5.ApacheHttp5Client;
import feign.httpclient.ApacheHttpClient; import feign.httpclient.ApacheHttpClient;
import feign.okhttp.OkHttpClient; import feign.okhttp.OkHttpClient;
import jakarta.annotation.PreDestroy;
import okhttp3.ConnectionPool; import okhttp3.ConnectionPool;
import org.apache.commons.logging.Log; import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory; import org.apache.commons.logging.LogFactory;
@@ -116,7 +115,7 @@ public class FeignAutoConfiguration {
} }
@Bean @Bean
@ConditionalOnProperty(value = "feign.cache.enabled", matchIfMissing = true) @ConditionalOnProperty(value = "spring.cloud.openfeign.cache.enabled", matchIfMissing = true)
@ConditionalOnBean(CacheInterceptor.class) @ConditionalOnBean(CacheInterceptor.class)
public Capability cachingCapability(CacheInterceptor cacheInterceptor) { public Capability cachingCapability(CacheInterceptor cacheInterceptor) {
return new CachingCapability(cacheInterceptor); return new CachingCapability(cacheInterceptor);
@@ -124,7 +123,7 @@ public class FeignAutoConfiguration {
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@ConditionalOnClass({ Module.class, Page.class, Sort.class }) @ConditionalOnClass({ Module.class, Page.class, Sort.class })
@ConditionalOnProperty(value = "feign.autoconfiguration.jackson.enabled", havingValue = "true") @ConditionalOnProperty(value = "spring.cloud.openfeign.autoconfiguration.jackson.enabled", havingValue = "true")
protected static class FeignJacksonConfiguration { protected static class FeignJacksonConfiguration {
@Bean @Bean
@@ -155,7 +154,7 @@ public class FeignAutoConfiguration {
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@ConditionalOnClass(CircuitBreaker.class) @ConditionalOnClass(CircuitBreaker.class)
@ConditionalOnProperty(value = "feign.circuitbreaker.enabled", havingValue = "true") @ConditionalOnProperty(value = "spring.cloud.openfeign.circuitbreaker.enabled", havingValue = "true")
protected static class CircuitBreakerPresentFeignTargeterConfiguration { protected static class CircuitBreakerPresentFeignTargeterConfiguration {
@Bean @Bean
@@ -166,15 +165,16 @@ public class FeignAutoConfiguration {
@Bean @Bean
@ConditionalOnMissingBean(CircuitBreakerNameResolver.class) @ConditionalOnMissingBean(CircuitBreakerNameResolver.class)
@ConditionalOnProperty(value = "feign.circuitbreaker.alphanumeric-ids.enabled", havingValue = "false", @ConditionalOnProperty(value = "spring.cloud.openfeign.circuitbreaker.alphanumeric-ids.enabled",
matchIfMissing = true) havingValue = "false")
public CircuitBreakerNameResolver circuitBreakerNameResolver() { public CircuitBreakerNameResolver circuitBreakerNameResolver() {
return new DefaultCircuitBreakerNameResolver(); return new DefaultCircuitBreakerNameResolver();
} }
@Bean @Bean
@ConditionalOnMissingBean(CircuitBreakerNameResolver.class) @ConditionalOnMissingBean(CircuitBreakerNameResolver.class)
@ConditionalOnProperty(value = "feign.circuitbreaker.alphanumeric-ids.enabled", havingValue = "true") @ConditionalOnProperty(value = "spring.cloud.openfeign.circuitbreaker.alphanumeric-ids.enabled",
havingValue = "true", matchIfMissing = true)
public CircuitBreakerNameResolver alphanumericCircuitBreakerNameResolver() { public CircuitBreakerNameResolver alphanumericCircuitBreakerNameResolver() {
return new AlphanumericCircuitBreakerNameResolver(); return new AlphanumericCircuitBreakerNameResolver();
} }
@@ -183,7 +183,7 @@ public class FeignAutoConfiguration {
@ConditionalOnMissingBean @ConditionalOnMissingBean
@ConditionalOnBean(CircuitBreakerFactory.class) @ConditionalOnBean(CircuitBreakerFactory.class)
public Targeter circuitBreakerFeignTargeter(CircuitBreakerFactory circuitBreakerFactory, public Targeter circuitBreakerFeignTargeter(CircuitBreakerFactory circuitBreakerFactory,
@Value("${feign.circuitbreaker.group.enabled:false}") boolean circuitBreakerGroupEnabled, @Value("${spring.cloud.openfeign.circuitbreaker.group.enabled:false}") boolean circuitBreakerGroupEnabled,
CircuitBreakerNameResolver circuitBreakerNameResolver) { CircuitBreakerNameResolver circuitBreakerNameResolver) {
return new FeignCircuitBreakerTargeter(circuitBreakerFactory, circuitBreakerGroupEnabled, return new FeignCircuitBreakerTargeter(circuitBreakerFactory, circuitBreakerGroupEnabled,
circuitBreakerNameResolver); circuitBreakerNameResolver);
@@ -216,7 +216,7 @@ public class FeignAutoConfiguration {
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@ConditionalOnClass(ApacheHttpClient.class) @ConditionalOnClass(ApacheHttpClient.class)
@ConditionalOnMissingBean(CloseableHttpClient.class) @ConditionalOnMissingBean(CloseableHttpClient.class)
@ConditionalOnProperty(value = "feign.httpclient.enabled", matchIfMissing = true) @ConditionalOnProperty(value = "spring.cloud.openfeign.httpclient.enabled", matchIfMissing = true)
@Conditional(HttpClient5DisabledConditions.class) @Conditional(HttpClient5DisabledConditions.class)
protected static class HttpClientFeignConfiguration { protected static class HttpClientFeignConfiguration {
@@ -284,7 +284,7 @@ public class FeignAutoConfiguration {
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@ConditionalOnClass(OkHttpClient.class) @ConditionalOnClass(OkHttpClient.class)
@ConditionalOnMissingBean(okhttp3.OkHttpClient.class) @ConditionalOnMissingBean(okhttp3.OkHttpClient.class)
@ConditionalOnProperty("feign.okhttp.enabled") @ConditionalOnProperty("spring.cloud.openfeign.okhttp.enabled")
protected static class OkHttpFeignConfiguration { protected static class OkHttpFeignConfiguration {
private okhttp3.OkHttpClient okHttpClient; private okhttp3.OkHttpClient okHttpClient;
@@ -331,7 +331,7 @@ public class FeignAutoConfiguration {
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@ConditionalOnClass(ApacheHttp5Client.class) @ConditionalOnClass(ApacheHttp5Client.class)
@ConditionalOnMissingBean(org.apache.hc.client5.http.impl.classic.CloseableHttpClient.class) @ConditionalOnMissingBean(org.apache.hc.client5.http.impl.classic.CloseableHttpClient.class)
@ConditionalOnProperty(value = "feign.httpclient.hc5.enabled", havingValue = "true") @ConditionalOnProperty(value = "spring.cloud.openfeign.httpclient.hc5.enabled", havingValue = "true")
@Import(org.springframework.cloud.openfeign.clientconfig.HttpClient5FeignConfiguration.class) @Import(org.springframework.cloud.openfeign.clientconfig.HttpClient5FeignConfiguration.class)
protected static class HttpClient5FeignConfiguration { protected static class HttpClient5FeignConfiguration {
@@ -345,12 +345,13 @@ public class FeignAutoConfiguration {
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@ConditionalOnClass(OAuth2ClientContext.class) @ConditionalOnClass(OAuth2ClientContext.class)
@ConditionalOnProperty("feign.oauth2.enabled") @ConditionalOnProperty("spring.cloud.openfeign.oauth2.enabled")
@Deprecated // spring-security-oauth2 reached EOL
protected static class Oauth2FeignConfiguration { protected static class Oauth2FeignConfiguration {
@ConditionalOnBean({ RetryLoadBalancerInterceptor.class, OAuth2ClientContext.class, @ConditionalOnBean({ RetryLoadBalancerInterceptor.class, OAuth2ClientContext.class,
OAuth2ProtectedResourceDetails.class }) OAuth2ProtectedResourceDetails.class })
@ConditionalOnProperty(value = "feign.oauth2.load-balanced", havingValue = "true") @ConditionalOnProperty(value = "spring.cloud.openfeign.oauth2.load-balanced", havingValue = "true")
@Bean @Bean
public OAuth2FeignRequestInterceptorConfigurer retryLoadBalancerInterceptorInjectingConfigurer( public OAuth2FeignRequestInterceptorConfigurer retryLoadBalancerInterceptorInjectingConfigurer(
final RetryLoadBalancerInterceptor loadBalancerInterceptor) { final RetryLoadBalancerInterceptor loadBalancerInterceptor) {
@@ -359,7 +360,7 @@ public class FeignAutoConfiguration {
@ConditionalOnBean({ LoadBalancerInterceptor.class, OAuth2ClientContext.class, @ConditionalOnBean({ LoadBalancerInterceptor.class, OAuth2ClientContext.class,
OAuth2ProtectedResourceDetails.class }) OAuth2ProtectedResourceDetails.class })
@ConditionalOnProperty(value = "feign.oauth2.load-balanced", havingValue = "true") @ConditionalOnProperty(value = "spring.cloud.openfeign.oauth2.load-balanced", havingValue = "true")
@Bean @Bean
public OAuth2FeignRequestInterceptorConfigurer loadBalancerInterceptorInjectingConfigurer( public OAuth2FeignRequestInterceptorConfigurer loadBalancerInterceptorInjectingConfigurer(
final LoadBalancerInterceptor loadBalancerInterceptor) { final LoadBalancerInterceptor loadBalancerInterceptor) {
@@ -31,7 +31,8 @@ class FeignCircuitBreakerDisabledConditions extends AnyNestedCondition {
} }
@ConditionalOnProperty(value = "feign.circuitbreaker.enabled", havingValue = "false", matchIfMissing = true) @ConditionalOnProperty(value = "spring.cloud.openfeign.circuitbreaker.enabled", havingValue = "false",
matchIfMissing = true)
static class CircuitBreakerDisabled { static class CircuitBreakerDisabled {
} }
@@ -36,7 +36,7 @@ class FeignClientMetricsEnabledCondition implements Condition {
.getConfig(); .getConfig();
if (feignClientConfigMap != null) { if (feignClientConfigMap != null) {
FeignClientProperties.FeignClientConfiguration feignClientConfig = feignClientConfigMap FeignClientProperties.FeignClientConfiguration feignClientConfig = feignClientConfigMap
.get(context.getEnvironment().getProperty("feign.client.name")); .get(context.getEnvironment().getProperty("spring.cloud.openfeign.client.name"));
if (feignClientConfig != null) { if (feignClientConfig != null) {
FeignClientProperties.MetricsProperties metrics = feignClientConfig.getMetrics(); FeignClientProperties.MetricsProperties metrics = feignClientConfig.getMetrics();
if (metrics != null && metrics.getEnabled() != null) { if (metrics != null && metrics.getEnabled() != null) {
@@ -43,7 +43,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
* @author Hyeonmin Park * @author Hyeonmin Park
*/ */
@ConfigurationProperties("feign.client") @ConfigurationProperties("spring.cloud.openfeign.client")
public class FeignClientProperties { public class FeignClientProperties {
private boolean defaultToProperties = true; private boolean defaultToProperties = true;
@@ -214,7 +214,7 @@ public class FeignClientsConfiguration {
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@ConditionalOnClass(CircuitBreaker.class) @ConditionalOnClass(CircuitBreaker.class)
@ConditionalOnProperty("feign.circuitbreaker.enabled") @ConditionalOnProperty("spring.cloud.openfeign.circuitbreaker.enabled")
protected static class CircuitBreakerPresentFeignBuilderConfiguration { protected static class CircuitBreakerPresentFeignBuilderConfiguration {
@Bean @Bean
@@ -237,7 +237,7 @@ public class FeignClientsConfiguration {
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@ConditionalOnBean(type = "io.micrometer.core.instrument.MeterRegistry") @ConditionalOnBean(type = "io.micrometer.core.instrument.MeterRegistry")
@ConditionalOnClass(name = "feign.micrometer.MicrometerCapability") @ConditionalOnClass(name = "feign.micrometer.MicrometerCapability")
@ConditionalOnProperty(name = "feign.metrics.enabled", matchIfMissing = true) @ConditionalOnProperty(name = "spring.cloud.openfeign.metrics.enabled", matchIfMissing = true)
@Conditional(FeignClientMetricsEnabledCondition.class) @Conditional(FeignClientMetricsEnabledCondition.class)
protected static class MetricsConfiguration { protected static class MetricsConfiguration {
@@ -440,7 +440,7 @@ class FeignClientsRegistrar implements ImportBeanDefinitionRegistrar, ResourceLo
} }
private boolean isClientRefreshEnabled() { private boolean isClientRefreshEnabled() {
return environment.getProperty("feign.client.refresh-enabled", Boolean.class, false); return environment.getProperty("spring.cloud.openfeign.client.refresh-enabled", Boolean.class, false);
} }
} }
@@ -35,7 +35,7 @@ import org.springframework.lang.Nullable;
public class FeignContext extends NamedContextFactory<FeignClientSpecification> { public class FeignContext extends NamedContextFactory<FeignClientSpecification> {
public FeignContext() { public FeignContext() {
super(FeignClientsConfiguration.class, "feign", "feign.client.name"); super(FeignClientsConfiguration.class, "spring.cloud.openfeign", "spring.cloud.openfeign.client.name");
} }
@Nullable @Nullable
@@ -34,7 +34,8 @@ public class HttpClient5DisabledConditions extends AnyNestedCondition {
} }
@ConditionalOnProperty(value = "feign.httpclient.hc5.enabled", havingValue = "false", matchIfMissing = true) @ConditionalOnProperty(value = "spring.cloud.openfeign.httpclient.hc5.enabled", havingValue = "false",
matchIfMissing = true)
static class HttpClient5Disabled { static class HttpClient5Disabled {
} }
@@ -23,11 +23,11 @@ import java.security.cert.CertificateException;
import java.security.cert.X509Certificate; import java.security.cert.X509Certificate;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
import javax.annotation.PreDestroy;
import javax.net.ssl.SSLContext; import javax.net.ssl.SSLContext;
import javax.net.ssl.TrustManager; import javax.net.ssl.TrustManager;
import javax.net.ssl.X509TrustManager; import javax.net.ssl.X509TrustManager;
import jakarta.annotation.PreDestroy;
import org.apache.commons.logging.Log; import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory; import org.apache.commons.logging.LogFactory;
import org.apache.hc.client5.http.config.RequestConfig; import org.apache.hc.client5.http.config.RequestConfig;
@@ -20,8 +20,7 @@ import java.io.IOException;
import java.util.Timer; import java.util.Timer;
import java.util.TimerTask; import java.util.TimerTask;
import javax.annotation.PreDestroy; import jakarta.annotation.PreDestroy;
import org.apache.commons.logging.Log; import org.apache.commons.logging.Log;
import org.apache.commons.logging.LogFactory; import org.apache.commons.logging.LogFactory;
import org.apache.http.client.config.RequestConfig; import org.apache.http.client.config.RequestConfig;
@@ -80,7 +79,7 @@ public class HttpClientFeignConfiguration {
} }
@Bean @Bean
@ConditionalOnProperty(value = "feign.compression.response.enabled", havingValue = "true") @ConditionalOnProperty(value = "spring.cloud.openfeign.compression.response.enabled", havingValue = "true")
public CloseableHttpClient customHttpClient(HttpClientConnectionManager httpClientConnectionManager, public CloseableHttpClient customHttpClient(HttpClientConnectionManager httpClientConnectionManager,
FeignHttpClientProperties httpClientProperties) { FeignHttpClientProperties httpClientProperties) {
HttpClientBuilder builder = HttpClientBuilder.create().disableCookieManagement().useSystemProperties(); HttpClientBuilder builder = HttpClientBuilder.create().disableCookieManagement().useSystemProperties();
@@ -89,7 +88,8 @@ public class HttpClientFeignConfiguration {
} }
@Bean @Bean
@ConditionalOnProperty(value = "feign.compression.response.enabled", havingValue = "false", matchIfMissing = true) @ConditionalOnProperty(value = "spring.cloud.openfeign.compression.response.enabled", havingValue = "false",
matchIfMissing = true)
public CloseableHttpClient httpClient(ApacheHttpClientFactory httpClientFactory, public CloseableHttpClient httpClient(ApacheHttpClientFactory httpClientFactory,
HttpClientConnectionManager httpClientConnectionManager, FeignHttpClientProperties httpClientProperties) { HttpClientConnectionManager httpClientConnectionManager, FeignHttpClientProperties httpClientProperties) {
this.httpClient = createClient(httpClientFactory.createBuilder(), httpClientConnectionManager, this.httpClient = createClient(httpClientFactory.createBuilder(), httpClientConnectionManager,
@@ -19,8 +19,7 @@ package org.springframework.cloud.openfeign.clientconfig;
import java.time.Duration; import java.time.Duration;
import java.util.concurrent.TimeUnit; import java.util.concurrent.TimeUnit;
import javax.annotation.PreDestroy; import jakarta.annotation.PreDestroy;
import okhttp3.ConnectionPool; import okhttp3.ConnectionPool;
import okhttp3.OkHttpClient; import okhttp3.OkHttpClient;
@@ -39,7 +39,7 @@ import org.springframework.context.annotation.Configuration;
@EnableConfigurationProperties(FeignClientEncodingProperties.class) @EnableConfigurationProperties(FeignClientEncodingProperties.class)
@ConditionalOnClass(Feign.class) @ConditionalOnClass(Feign.class)
@ConditionalOnBean(Client.class) @ConditionalOnBean(Client.class)
@ConditionalOnProperty(value = "feign.compression.response.enabled", matchIfMissing = false) @ConditionalOnProperty(value = "spring.cloud.openfeign.compression.response.enabled", matchIfMissing = false)
// The OK HTTP client uses "transparent" compression. // The OK HTTP client uses "transparent" compression.
// If the accept-encoding header is present it disable transparent compression // If the accept-encoding header is present it disable transparent compression
@ConditionalOnMissingBean(type = "okhttp3.OkHttpClient") @ConditionalOnMissingBean(type = "okhttp3.OkHttpClient")
@@ -26,7 +26,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
* *
* @author Jakub Narloch * @author Jakub Narloch
*/ */
@ConfigurationProperties("feign.compression.request") @ConfigurationProperties("spring.cloud.openfeign.compression.request")
public class FeignClientEncodingProperties { public class FeignClientEncodingProperties {
/** /**
@@ -39,7 +39,7 @@ import org.springframework.context.annotation.Configuration;
// The OK HTTP client uses "transparent" compression. // The OK HTTP client uses "transparent" compression.
// If the content-encoding header is present it disable transparent compression // If the content-encoding header is present it disable transparent compression
@ConditionalOnMissingBean(type = "okhttp3.OkHttpClient") @ConditionalOnMissingBean(type = "okhttp3.OkHttpClient")
@ConditionalOnProperty("feign.compression.request.enabled") @ConditionalOnProperty("spring.cloud.openfeign.compression.request.enabled")
@AutoConfigureAfter(FeignAutoConfiguration.class) @AutoConfigureAfter(FeignAutoConfiguration.class)
public class FeignContentGzipEncodingAutoConfiguration { public class FeignContentGzipEncodingAutoConfiguration {
@@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2021 the original author or authors. * Copyright 2016-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -16,6 +16,8 @@
package org.springframework.cloud.openfeign.loadbalancer; package org.springframework.cloud.openfeign.loadbalancer;
import java.util.List;
import feign.Client; import feign.Client;
import org.springframework.boot.autoconfigure.condition.ConditionalOnBean; import org.springframework.boot.autoconfigure.condition.ConditionalOnBean;
@@ -36,6 +38,7 @@ import org.springframework.context.annotation.Configuration;
* that uses {@link Client.Default} under the hood. * that uses {@link Client.Default} under the hood.
* *
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
* @author changjin wei(魏昌进)
* @since 2.2.0 * @since 2.2.0
*/ */
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@@ -46,9 +49,10 @@ class DefaultFeignLoadBalancerConfiguration {
@ConditionalOnMissingBean @ConditionalOnMissingBean
@Conditional(OnRetryNotEnabledCondition.class) @Conditional(OnRetryNotEnabledCondition.class)
public Client feignClient(LoadBalancerClient loadBalancerClient, public Client feignClient(LoadBalancerClient loadBalancerClient,
LoadBalancerClientFactory loadBalancerClientFactory) { LoadBalancerClientFactory loadBalancerClientFactory,
List<LoadBalancerFeignRequestTransformer> transformers) {
return new FeignBlockingLoadBalancerClient(new Client.Default(null, null), loadBalancerClient, return new FeignBlockingLoadBalancerClient(new Client.Default(null, null), loadBalancerClient,
loadBalancerClientFactory); loadBalancerClientFactory, transformers);
} }
@Bean @Bean
@@ -58,9 +62,10 @@ class DefaultFeignLoadBalancerConfiguration {
@ConditionalOnProperty(value = "spring.cloud.loadbalancer.retry.enabled", havingValue = "true", @ConditionalOnProperty(value = "spring.cloud.loadbalancer.retry.enabled", havingValue = "true",
matchIfMissing = true) matchIfMissing = true)
public Client feignRetryClient(LoadBalancerClient loadBalancerClient, public Client feignRetryClient(LoadBalancerClient loadBalancerClient,
LoadBalancedRetryFactory loadBalancedRetryFactory, LoadBalancerClientFactory loadBalancerClientFactory) { LoadBalancedRetryFactory loadBalancedRetryFactory, LoadBalancerClientFactory loadBalancerClientFactory,
List<LoadBalancerFeignRequestTransformer> transformers) {
return new RetryableFeignBlockingLoadBalancerClient(new Client.Default(null, null), loadBalancerClient, return new RetryableFeignBlockingLoadBalancerClient(new Client.Default(null, null), loadBalancerClient,
loadBalancedRetryFactory, loadBalancerClientFactory); loadBalancedRetryFactory, loadBalancerClientFactory, transformers);
} }
} }
@@ -19,6 +19,8 @@ package org.springframework.cloud.openfeign.loadbalancer;
import java.io.IOException; import java.io.IOException;
import java.net.URI; import java.net.URI;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import java.util.Collections;
import java.util.List;
import java.util.Set; import java.util.Set;
import feign.Client; import feign.Client;
@@ -49,6 +51,7 @@ import static org.springframework.cloud.openfeign.loadbalancer.LoadBalancerUtils
* {@link ServiceInstance} to use while resolving the request host. * {@link ServiceInstance} to use while resolving the request host.
* *
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
* @author changjin wei(魏昌进)
* @since 2.2.0 * @since 2.2.0
*/ */
@SuppressWarnings({ "unchecked", "rawtypes" }) @SuppressWarnings({ "unchecked", "rawtypes" })
@@ -62,9 +65,11 @@ public class FeignBlockingLoadBalancerClient implements Client {
private final LoadBalancerClientFactory loadBalancerClientFactory; private final LoadBalancerClientFactory loadBalancerClientFactory;
private final List<LoadBalancerFeignRequestTransformer> transformers;
/** /**
* @deprecated in favour of * @deprecated in favour of
* {@link FeignBlockingLoadBalancerClient#FeignBlockingLoadBalancerClient(Client, LoadBalancerClient, LoadBalancerClientFactory)} * {@link FeignBlockingLoadBalancerClient#FeignBlockingLoadBalancerClient(Client, LoadBalancerClient, LoadBalancerClientFactory, List)}
*/ */
@Deprecated @Deprecated
public FeignBlockingLoadBalancerClient(Client delegate, LoadBalancerClient loadBalancerClient, public FeignBlockingLoadBalancerClient(Client delegate, LoadBalancerClient loadBalancerClient,
@@ -72,13 +77,29 @@ public class FeignBlockingLoadBalancerClient implements Client {
this.delegate = delegate; this.delegate = delegate;
this.loadBalancerClient = loadBalancerClient; this.loadBalancerClient = loadBalancerClient;
this.loadBalancerClientFactory = loadBalancerClientFactory; this.loadBalancerClientFactory = loadBalancerClientFactory;
this.transformers = Collections.emptyList();
} }
/**
* @deprecated in favour of
* {@link FeignBlockingLoadBalancerClient#FeignBlockingLoadBalancerClient(Client, LoadBalancerClient, LoadBalancerClientFactory, List)}
*/
@Deprecated
public FeignBlockingLoadBalancerClient(Client delegate, LoadBalancerClient loadBalancerClient, public FeignBlockingLoadBalancerClient(Client delegate, LoadBalancerClient loadBalancerClient,
LoadBalancerClientFactory loadBalancerClientFactory) { LoadBalancerClientFactory loadBalancerClientFactory) {
this.delegate = delegate; this.delegate = delegate;
this.loadBalancerClient = loadBalancerClient; this.loadBalancerClient = loadBalancerClient;
this.loadBalancerClientFactory = loadBalancerClientFactory; this.loadBalancerClientFactory = loadBalancerClientFactory;
this.transformers = Collections.emptyList();
}
public FeignBlockingLoadBalancerClient(Client delegate, LoadBalancerClient loadBalancerClient,
LoadBalancerClientFactory loadBalancerClientFactory,
List<LoadBalancerFeignRequestTransformer> transformers) {
this.delegate = delegate;
this.loadBalancerClient = loadBalancerClient;
this.loadBalancerClientFactory = loadBalancerClientFactory;
this.transformers = transformers;
} }
@Override @Override
@@ -109,10 +130,9 @@ public class FeignBlockingLoadBalancerClient implements Client {
.body(message, StandardCharsets.UTF_8).build(); .body(message, StandardCharsets.UTF_8).build();
} }
String reconstructedUrl = loadBalancerClient.reconstructURI(instance, originalUri).toString(); String reconstructedUrl = loadBalancerClient.reconstructURI(instance, originalUri).toString();
Request newRequest = buildRequest(request, reconstructedUrl); Request newRequest = buildRequest(request, reconstructedUrl, instance);
LoadBalancerProperties loadBalancerProperties = loadBalancerClientFactory.getProperties(serviceId);
return executeWithLoadBalancerLifecycleProcessing(delegate, options, newRequest, lbRequest, lbResponse, return executeWithLoadBalancerLifecycleProcessing(delegate, options, newRequest, lbRequest, lbResponse,
supportedLifecycleProcessors, loadBalancerProperties.isUseRawStatusCodeInResponseData()); supportedLifecycleProcessors);
} }
protected Request buildRequest(Request request, String reconstructedUrl) { protected Request buildRequest(Request request, String reconstructedUrl) {
@@ -120,6 +140,16 @@ public class FeignBlockingLoadBalancerClient implements Client {
request.charset(), request.requestTemplate()); request.charset(), request.requestTemplate());
} }
protected Request buildRequest(Request request, String reconstructedUrl, ServiceInstance instance) {
Request newRequest = buildRequest(request, reconstructedUrl);
if (transformers != null) {
for (LoadBalancerFeignRequestTransformer transformer : transformers) {
newRequest = transformer.transformRequest(newRequest, instance);
}
}
return newRequest;
}
// Visible for Sleuth instrumentation // Visible for Sleuth instrumentation
public Client getDelegate() { public Client getDelegate() {
return delegate; return delegate;
@@ -16,6 +16,8 @@
package org.springframework.cloud.openfeign.loadbalancer; package org.springframework.cloud.openfeign.loadbalancer;
import java.util.List;
import feign.Client; import feign.Client;
import feign.hc5.ApacheHttp5Client; import feign.hc5.ApacheHttp5Client;
import org.apache.hc.client5.http.classic.HttpClient; import org.apache.hc.client5.http.classic.HttpClient;
@@ -40,11 +42,12 @@ import org.springframework.context.annotation.Import;
* that uses {@link ApacheHttp5Client} under the hood. * that uses {@link ApacheHttp5Client} under the hood.
* *
* @author Nguyen Ky Thanh * @author Nguyen Ky Thanh
* @author changjin wei(魏昌进)
*/ */
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@ConditionalOnClass(ApacheHttp5Client.class) @ConditionalOnClass(ApacheHttp5Client.class)
@ConditionalOnBean({ LoadBalancerClient.class, LoadBalancerClientFactory.class }) @ConditionalOnBean({ LoadBalancerClient.class, LoadBalancerClientFactory.class })
@ConditionalOnProperty(value = "feign.httpclient.hc5.enabled", havingValue = "true") @ConditionalOnProperty(value = "spring.cloud.openfeign.httpclient.hc5.enabled", havingValue = "true")
@Import(HttpClient5FeignConfiguration.class) @Import(HttpClient5FeignConfiguration.class)
@EnableConfigurationProperties(LoadBalancerClientsProperties.class) @EnableConfigurationProperties(LoadBalancerClientsProperties.class)
class HttpClient5FeignLoadBalancerConfiguration { class HttpClient5FeignLoadBalancerConfiguration {
@@ -53,9 +56,11 @@ class HttpClient5FeignLoadBalancerConfiguration {
@ConditionalOnMissingBean @ConditionalOnMissingBean
@Conditional(OnRetryNotEnabledCondition.class) @Conditional(OnRetryNotEnabledCondition.class)
public Client feignClient(LoadBalancerClient loadBalancerClient, HttpClient httpClient5, public Client feignClient(LoadBalancerClient loadBalancerClient, HttpClient httpClient5,
LoadBalancerClientFactory loadBalancerClientFactory) { LoadBalancerClientFactory loadBalancerClientFactory,
List<LoadBalancerFeignRequestTransformer> transformers) {
Client delegate = new ApacheHttp5Client(httpClient5); Client delegate = new ApacheHttp5Client(httpClient5);
return new FeignBlockingLoadBalancerClient(delegate, loadBalancerClient, loadBalancerClientFactory); return new FeignBlockingLoadBalancerClient(delegate, loadBalancerClient, loadBalancerClientFactory,
transformers);
} }
@Bean @Bean
@@ -65,10 +70,11 @@ class HttpClient5FeignLoadBalancerConfiguration {
@ConditionalOnProperty(value = "spring.cloud.loadbalancer.retry.enabled", havingValue = "true", @ConditionalOnProperty(value = "spring.cloud.loadbalancer.retry.enabled", havingValue = "true",
matchIfMissing = true) matchIfMissing = true)
public Client feignRetryClient(LoadBalancerClient loadBalancerClient, HttpClient httpClient5, public Client feignRetryClient(LoadBalancerClient loadBalancerClient, HttpClient httpClient5,
LoadBalancedRetryFactory loadBalancedRetryFactory, LoadBalancerClientFactory loadBalancerClientFactory) { LoadBalancedRetryFactory loadBalancedRetryFactory, LoadBalancerClientFactory loadBalancerClientFactory,
List<LoadBalancerFeignRequestTransformer> transformers) {
Client delegate = new ApacheHttp5Client(httpClient5); Client delegate = new ApacheHttp5Client(httpClient5);
return new RetryableFeignBlockingLoadBalancerClient(delegate, loadBalancerClient, loadBalancedRetryFactory, return new RetryableFeignBlockingLoadBalancerClient(delegate, loadBalancerClient, loadBalancedRetryFactory,
loadBalancerClientFactory); loadBalancerClientFactory, transformers);
} }
} }
@@ -16,6 +16,8 @@
package org.springframework.cloud.openfeign.loadbalancer; package org.springframework.cloud.openfeign.loadbalancer;
import java.util.List;
import feign.Client; import feign.Client;
import feign.httpclient.ApacheHttpClient; import feign.httpclient.ApacheHttpClient;
import org.apache.http.client.HttpClient; import org.apache.http.client.HttpClient;
@@ -42,12 +44,13 @@ import org.springframework.context.annotation.Import;
* *
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
* @author Nguyen Ky Thanh * @author Nguyen Ky Thanh
* @author changjin wei(魏昌进)
* @since 2.2.0 * @since 2.2.0
*/ */
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@ConditionalOnClass(ApacheHttpClient.class) @ConditionalOnClass(ApacheHttpClient.class)
@ConditionalOnBean({ LoadBalancerClient.class, LoadBalancerClientFactory.class }) @ConditionalOnBean({ LoadBalancerClient.class, LoadBalancerClientFactory.class })
@ConditionalOnProperty(value = "feign.httpclient.enabled", matchIfMissing = true) @ConditionalOnProperty(value = "spring.cloud.openfeign.httpclient.enabled", matchIfMissing = true)
@Conditional(HttpClient5DisabledConditions.class) @Conditional(HttpClient5DisabledConditions.class)
@Import(HttpClientFeignConfiguration.class) @Import(HttpClientFeignConfiguration.class)
@EnableConfigurationProperties(LoadBalancerClientsProperties.class) @EnableConfigurationProperties(LoadBalancerClientsProperties.class)
@@ -57,9 +60,11 @@ class HttpClientFeignLoadBalancerConfiguration {
@ConditionalOnMissingBean @ConditionalOnMissingBean
@Conditional(OnRetryNotEnabledCondition.class) @Conditional(OnRetryNotEnabledCondition.class)
public Client feignClient(LoadBalancerClient loadBalancerClient, HttpClient httpClient, public Client feignClient(LoadBalancerClient loadBalancerClient, HttpClient httpClient,
LoadBalancerClientFactory loadBalancerClientFactory) { LoadBalancerClientFactory loadBalancerClientFactory,
List<LoadBalancerFeignRequestTransformer> transformers) {
ApacheHttpClient delegate = new ApacheHttpClient(httpClient); ApacheHttpClient delegate = new ApacheHttpClient(httpClient);
return new FeignBlockingLoadBalancerClient(delegate, loadBalancerClient, loadBalancerClientFactory); return new FeignBlockingLoadBalancerClient(delegate, loadBalancerClient, loadBalancerClientFactory,
transformers);
} }
@Bean @Bean
@@ -69,10 +74,11 @@ class HttpClientFeignLoadBalancerConfiguration {
@ConditionalOnProperty(value = "spring.cloud.loadbalancer.retry.enabled", havingValue = "true", @ConditionalOnProperty(value = "spring.cloud.loadbalancer.retry.enabled", havingValue = "true",
matchIfMissing = true) matchIfMissing = true)
public Client feignRetryClient(LoadBalancerClient loadBalancerClient, HttpClient httpClient, public Client feignRetryClient(LoadBalancerClient loadBalancerClient, HttpClient httpClient,
LoadBalancedRetryFactory loadBalancedRetryFactory, LoadBalancerClientFactory loadBalancerClientFactory) { LoadBalancedRetryFactory loadBalancedRetryFactory, LoadBalancerClientFactory loadBalancerClientFactory,
List<LoadBalancerFeignRequestTransformer> transformers) {
ApacheHttpClient delegate = new ApacheHttpClient(httpClient); ApacheHttpClient delegate = new ApacheHttpClient(httpClient);
return new RetryableFeignBlockingLoadBalancerClient(delegate, loadBalancerClient, loadBalancedRetryFactory, return new RetryableFeignBlockingLoadBalancerClient(delegate, loadBalancerClient, loadBalancedRetryFactory,
loadBalancerClientFactory); loadBalancerClientFactory, transformers);
} }
} }
@@ -0,0 +1,47 @@
/*
* Copyright 2013-2022 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.loadbalancer;
import feign.Request;
import org.springframework.cloud.client.ServiceInstance;
import org.springframework.core.annotation.Order;
/**
* Allows applications to transform the load-balanced {@link Request} given the chosen
* {@link org.springframework.cloud.client.ServiceInstance}.
*
* @author changjin wei(魏昌进)
*/
@Order(LoadBalancerFeignRequestTransformer.DEFAULT_ORDER)
public interface LoadBalancerFeignRequestTransformer {
/**
* Order for the {@link LoadBalancerFeignRequestTransformer}.
*/
int DEFAULT_ORDER = 0;
/**
* Allows transforming load-balanced requests based on the provided
* {@link ServiceInstance}.
* @param request Original request.
* @param instance ServiceInstance returned from LoadBalancer.
* @return New request or original request
*/
Request transformRequest(Request request, ServiceInstance instance);
}
@@ -33,7 +33,7 @@ import org.springframework.cloud.client.loadbalancer.RequestData;
import org.springframework.cloud.client.loadbalancer.ResponseData; import org.springframework.cloud.client.loadbalancer.ResponseData;
import org.springframework.http.HttpHeaders; import org.springframework.http.HttpHeaders;
import org.springframework.http.HttpMethod; import org.springframework.http.HttpMethod;
import org.springframework.http.HttpStatus; import org.springframework.http.HttpStatusCode;
/** /**
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
@@ -50,15 +50,14 @@ final class LoadBalancerUtils {
static Response executeWithLoadBalancerLifecycleProcessing(Client feignClient, Request.Options options, static Response executeWithLoadBalancerLifecycleProcessing(Client feignClient, Request.Options options,
Request feignRequest, org.springframework.cloud.client.loadbalancer.Request lbRequest, Request feignRequest, org.springframework.cloud.client.loadbalancer.Request lbRequest,
org.springframework.cloud.client.loadbalancer.Response<ServiceInstance> lbResponse, org.springframework.cloud.client.loadbalancer.Response<ServiceInstance> lbResponse,
Set<LoadBalancerLifecycle> supportedLifecycleProcessors, boolean loadBalanced, boolean useRawStatusCodes) Set<LoadBalancerLifecycle> supportedLifecycleProcessors, boolean loadBalanced) throws IOException {
throws IOException {
supportedLifecycleProcessors.forEach(lifecycle -> lifecycle.onStartRequest(lbRequest, lbResponse)); supportedLifecycleProcessors.forEach(lifecycle -> lifecycle.onStartRequest(lbRequest, lbResponse));
try { try {
Response response = feignClient.execute(feignRequest, options); Response response = feignClient.execute(feignRequest, options);
if (loadBalanced) { if (loadBalanced) {
supportedLifecycleProcessors.forEach( supportedLifecycleProcessors.forEach(
lifecycle -> lifecycle.onComplete(new CompletionContext<>(CompletionContext.Status.SUCCESS, lifecycle -> lifecycle.onComplete(new CompletionContext<>(CompletionContext.Status.SUCCESS,
lbRequest, lbResponse, buildResponseData(response, useRawStatusCodes)))); lbRequest, lbResponse, buildResponseData(response))));
} }
return response; return response;
} }
@@ -71,13 +70,10 @@ final class LoadBalancerUtils {
} }
} }
static ResponseData buildResponseData(Response response, boolean useRawStatusCodes) { static ResponseData buildResponseData(Response response) {
HttpHeaders responseHeaders = new HttpHeaders(); HttpHeaders responseHeaders = new HttpHeaders();
response.headers().forEach((key, value) -> responseHeaders.put(key, new ArrayList<>(value))); response.headers().forEach((key, value) -> responseHeaders.put(key, new ArrayList<>(value)));
if (useRawStatusCodes) { return new ResponseData(HttpStatusCode.valueOf(response.status()), responseHeaders, null,
return new ResponseData(responseHeaders, null, buildRequestData(response.request()), response.status());
}
return new ResponseData(HttpStatus.resolve(response.status()), responseHeaders, null,
buildRequestData(response.request())); buildRequestData(response.request()));
} }
@@ -91,9 +87,9 @@ final class LoadBalancerUtils {
static Response executeWithLoadBalancerLifecycleProcessing(Client feignClient, Request.Options options, static Response executeWithLoadBalancerLifecycleProcessing(Client feignClient, Request.Options options,
Request feignRequest, org.springframework.cloud.client.loadbalancer.Request lbRequest, Request feignRequest, org.springframework.cloud.client.loadbalancer.Request lbRequest,
org.springframework.cloud.client.loadbalancer.Response<ServiceInstance> lbResponse, org.springframework.cloud.client.loadbalancer.Response<ServiceInstance> lbResponse,
Set<LoadBalancerLifecycle> supportedLifecycleProcessors, boolean useRawStatusCodes) throws IOException { Set<LoadBalancerLifecycle> supportedLifecycleProcessors) throws IOException {
return executeWithLoadBalancerLifecycleProcessing(feignClient, options, feignRequest, lbRequest, lbResponse, return executeWithLoadBalancerLifecycleProcessing(feignClient, options, feignRequest, lbRequest, lbResponse,
supportedLifecycleProcessors, true, useRawStatusCodes); supportedLifecycleProcessors, true);
} }
} }
@@ -16,6 +16,8 @@
package org.springframework.cloud.openfeign.loadbalancer; package org.springframework.cloud.openfeign.loadbalancer;
import java.util.List;
import feign.Client; import feign.Client;
import feign.okhttp.OkHttpClient; import feign.okhttp.OkHttpClient;
@@ -39,11 +41,12 @@ import org.springframework.context.annotation.Import;
* that uses {@link OkHttpClient} under the hood. * that uses {@link OkHttpClient} under the hood.
* *
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
* @author changjin wei(魏昌进)
* @since 2.2.0 * @since 2.2.0
*/ */
@Configuration(proxyBeanMethods = false) @Configuration(proxyBeanMethods = false)
@ConditionalOnClass(OkHttpClient.class) @ConditionalOnClass(OkHttpClient.class)
@ConditionalOnProperty("feign.okhttp.enabled") @ConditionalOnProperty("spring.cloud.openfeign.okhttp.enabled")
@ConditionalOnBean({ LoadBalancerClient.class, LoadBalancerClientFactory.class }) @ConditionalOnBean({ LoadBalancerClient.class, LoadBalancerClientFactory.class })
@Import(OkHttpFeignConfiguration.class) @Import(OkHttpFeignConfiguration.class)
@EnableConfigurationProperties(LoadBalancerClientsProperties.class) @EnableConfigurationProperties(LoadBalancerClientsProperties.class)
@@ -53,9 +56,11 @@ class OkHttpFeignLoadBalancerConfiguration {
@ConditionalOnMissingBean @ConditionalOnMissingBean
@Conditional(OnRetryNotEnabledCondition.class) @Conditional(OnRetryNotEnabledCondition.class)
public Client feignClient(okhttp3.OkHttpClient okHttpClient, LoadBalancerClient loadBalancerClient, public Client feignClient(okhttp3.OkHttpClient okHttpClient, LoadBalancerClient loadBalancerClient,
LoadBalancerClientFactory loadBalancerClientFactory) { LoadBalancerClientFactory loadBalancerClientFactory,
List<LoadBalancerFeignRequestTransformer> transformers) {
OkHttpClient delegate = new OkHttpClient(okHttpClient); OkHttpClient delegate = new OkHttpClient(okHttpClient);
return new FeignBlockingLoadBalancerClient(delegate, loadBalancerClient, loadBalancerClientFactory); return new FeignBlockingLoadBalancerClient(delegate, loadBalancerClient, loadBalancerClientFactory,
transformers);
} }
@Bean @Bean
@@ -65,10 +70,11 @@ class OkHttpFeignLoadBalancerConfiguration {
@ConditionalOnProperty(value = "spring.cloud.loadbalancer.retry.enabled", havingValue = "true", @ConditionalOnProperty(value = "spring.cloud.loadbalancer.retry.enabled", havingValue = "true",
matchIfMissing = true) matchIfMissing = true)
public Client feignRetryClient(LoadBalancerClient loadBalancerClient, okhttp3.OkHttpClient okHttpClient, public Client feignRetryClient(LoadBalancerClient loadBalancerClient, okhttp3.OkHttpClient okHttpClient,
LoadBalancedRetryFactory loadBalancedRetryFactory, LoadBalancerClientFactory loadBalancerClientFactory) { LoadBalancedRetryFactory loadBalancedRetryFactory, LoadBalancerClientFactory loadBalancerClientFactory,
List<LoadBalancerFeignRequestTransformer> transformers) {
OkHttpClient delegate = new OkHttpClient(okHttpClient); OkHttpClient delegate = new OkHttpClient(okHttpClient);
return new RetryableFeignBlockingLoadBalancerClient(delegate, loadBalancerClient, loadBalancedRetryFactory, return new RetryableFeignBlockingLoadBalancerClient(delegate, loadBalancerClient, loadBalancedRetryFactory,
loadBalancerClientFactory); loadBalancerClientFactory, transformers);
} }
} }
@@ -20,6 +20,7 @@ import java.io.IOException;
import java.net.URI; import java.net.URI;
import java.util.ArrayList; import java.util.ArrayList;
import java.util.Collection; import java.util.Collection;
import java.util.Collections;
import java.util.HashMap; import java.util.HashMap;
import java.util.List; import java.util.List;
import java.util.Map; import java.util.Map;
@@ -65,6 +66,7 @@ import static org.springframework.cloud.openfeign.loadbalancer.LoadBalancerUtils
* load-balanced with Spring Cloud LoadBalancer. * load-balanced with Spring Cloud LoadBalancer.
* *
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
* @author changjin wei(魏昌进)
* @since 2.2.6 * @since 2.2.6
*/ */
@SuppressWarnings({ "rawtypes", "unchecked" }) @SuppressWarnings({ "rawtypes", "unchecked" })
@@ -80,9 +82,11 @@ public class RetryableFeignBlockingLoadBalancerClient implements Client {
private final LoadBalancerClientFactory loadBalancerClientFactory; private final LoadBalancerClientFactory loadBalancerClientFactory;
private final List<LoadBalancerFeignRequestTransformer> transformers;
/** /**
* @deprecated in favour of * @deprecated in favour of
* {@link RetryableFeignBlockingLoadBalancerClient#RetryableFeignBlockingLoadBalancerClient(Client, LoadBalancerClient, LoadBalancedRetryFactory, LoadBalancerClientFactory)} * {@link RetryableFeignBlockingLoadBalancerClient#RetryableFeignBlockingLoadBalancerClient(Client, LoadBalancerClient, LoadBalancedRetryFactory, LoadBalancerClientFactory, List)}
*/ */
@Deprecated @Deprecated
public RetryableFeignBlockingLoadBalancerClient(Client delegate, LoadBalancerClient loadBalancerClient, public RetryableFeignBlockingLoadBalancerClient(Client delegate, LoadBalancerClient loadBalancerClient,
@@ -92,14 +96,31 @@ public class RetryableFeignBlockingLoadBalancerClient implements Client {
this.loadBalancerClient = loadBalancerClient; this.loadBalancerClient = loadBalancerClient;
this.loadBalancedRetryFactory = loadBalancedRetryFactory; this.loadBalancedRetryFactory = loadBalancedRetryFactory;
this.loadBalancerClientFactory = loadBalancerClientFactory; this.loadBalancerClientFactory = loadBalancerClientFactory;
this.transformers = Collections.emptyList();
} }
/**
* @deprecated in favour of
* {@link RetryableFeignBlockingLoadBalancerClient#RetryableFeignBlockingLoadBalancerClient(Client, LoadBalancerClient, LoadBalancedRetryFactory, LoadBalancerClientFactory, List)}
*/
@Deprecated
public RetryableFeignBlockingLoadBalancerClient(Client delegate, LoadBalancerClient loadBalancerClient, public RetryableFeignBlockingLoadBalancerClient(Client delegate, LoadBalancerClient loadBalancerClient,
LoadBalancedRetryFactory loadBalancedRetryFactory, LoadBalancerClientFactory loadBalancerClientFactory) { LoadBalancedRetryFactory loadBalancedRetryFactory, LoadBalancerClientFactory loadBalancerClientFactory) {
this.delegate = delegate; this.delegate = delegate;
this.loadBalancerClient = loadBalancerClient; this.loadBalancerClient = loadBalancerClient;
this.loadBalancedRetryFactory = loadBalancedRetryFactory; this.loadBalancedRetryFactory = loadBalancedRetryFactory;
this.loadBalancerClientFactory = loadBalancerClientFactory; this.loadBalancerClientFactory = loadBalancerClientFactory;
this.transformers = Collections.emptyList();
}
public RetryableFeignBlockingLoadBalancerClient(Client delegate, LoadBalancerClient loadBalancerClient,
LoadBalancedRetryFactory loadBalancedRetryFactory, LoadBalancerClientFactory loadBalancerClientFactory,
List<LoadBalancerFeignRequestTransformer> transformers) {
this.delegate = delegate;
this.loadBalancerClient = loadBalancerClient;
this.loadBalancedRetryFactory = loadBalancedRetryFactory;
this.loadBalancerClientFactory = loadBalancerClientFactory;
this.transformers = transformers;
} }
@Override @Override
@@ -158,15 +179,14 @@ public class RetryableFeignBlockingLoadBalancerClient implements Client {
} }
String reconstructedUrl = loadBalancerClient.reconstructURI(retrievedServiceInstance, originalUri) String reconstructedUrl = loadBalancerClient.reconstructURI(retrievedServiceInstance, originalUri)
.toString(); .toString();
feignRequest = buildRequest(request, reconstructedUrl); feignRequest = buildRequest(request, reconstructedUrl, retrievedServiceInstance);
} }
} }
org.springframework.cloud.client.loadbalancer.Response<ServiceInstance> lbResponse = new DefaultResponse( org.springframework.cloud.client.loadbalancer.Response<ServiceInstance> lbResponse = new DefaultResponse(
retrievedServiceInstance); retrievedServiceInstance);
LoadBalancerProperties loadBalancerProperties = loadBalancerClientFactory.getProperties(serviceId);
Response response = LoadBalancerUtils.executeWithLoadBalancerLifecycleProcessing(delegate, options, Response response = LoadBalancerUtils.executeWithLoadBalancerLifecycleProcessing(delegate, options,
feignRequest, lbRequest, lbResponse, supportedLifecycleProcessors, retrievedServiceInstance != null, feignRequest, lbRequest, lbResponse, supportedLifecycleProcessors,
loadBalancerProperties.isUseRawStatusCodeInResponseData()); retrievedServiceInstance != null);
int responseStatus = response.status(); int responseStatus = response.status();
if (retryPolicy != null && retryPolicy.retryableStatusCode(responseStatus)) { if (retryPolicy != null && retryPolicy.retryableStatusCode(responseStatus)) {
if (LOG.isDebugEnabled()) { if (LOG.isDebugEnabled()) {
@@ -192,6 +212,16 @@ public class RetryableFeignBlockingLoadBalancerClient implements Client {
request.charset(), request.requestTemplate()); request.charset(), request.requestTemplate());
} }
protected Request buildRequest(Request request, String reconstructedUrl, ServiceInstance instance) {
Request newRequest = buildRequest(request, reconstructedUrl);
if (transformers != null) {
for (LoadBalancerFeignRequestTransformer transformer : transformers) {
newRequest = transformer.transformRequest(newRequest, instance);
}
}
return newRequest;
}
private RetryTemplate buildRetryTemplate(String serviceId, Request request, LoadBalancedRetryPolicy retryPolicy) { private RetryTemplate buildRetryTemplate(String serviceId, Request request, LoadBalancedRetryPolicy retryPolicy) {
RetryTemplate retryTemplate = new RetryTemplate(); RetryTemplate retryTemplate = new RetryTemplate();
BackOffPolicy backOffPolicy = this.loadBalancedRetryFactory.createBackOffPolicy(serviceId); BackOffPolicy backOffPolicy = this.loadBalancedRetryFactory.createBackOffPolicy(serviceId);
@@ -43,6 +43,7 @@ import org.springframework.security.oauth2.common.OAuth2AccessToken;
* @author Tim Ysewyn * @author Tim Ysewyn
* @since 3.0.0 * @since 3.0.0
*/ */
@Deprecated // spring-security-oauth2 reached EOL
public class OAuth2FeignRequestInterceptor implements RequestInterceptor { public class OAuth2FeignRequestInterceptor implements RequestInterceptor {
/** /**
@@ -1,5 +1,5 @@
/* /*
* Copyright 2015-2021 the original author or authors. * Copyright 2015-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -24,7 +24,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
* @since 2.2.8 * @since 2.2.8
*/ */
@ConfigurationProperties("feign.encoder") @ConfigurationProperties("spring.cloud.openfeign.encoder")
public class FeignEncoderProperties { public class FeignEncoderProperties {
/** /**
@@ -28,7 +28,7 @@ import org.springframework.boot.context.properties.ConfigurationProperties;
* @author Nguyen Ky Thanh * @author Nguyen Ky Thanh
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
*/ */
@ConfigurationProperties(prefix = "feign.httpclient") @ConfigurationProperties(prefix = "spring.cloud.openfeign.httpclient")
public class FeignHttpClientProperties { public class FeignHttpClientProperties {
/** /**
@@ -1,5 +1,5 @@
/* /*
* Copyright 2016-2021 the original author or authors. * Copyright 2016-2022 the original author or authors.
* *
* Licensed under the Apache License, Version 2.0 (the "License"); * Licensed under the Apache License, Version 2.0 (the "License");
* you may not use this file except in compliance with the License. * you may not use this file except in compliance with the License.
@@ -247,7 +247,7 @@ public class SpringEncoder implements Encoder {
return Objects.equals(APPLICATION_FORM_URLENCODED, requestContentType); return Objects.equals(APPLICATION_FORM_URLENCODED, requestContentType);
} }
private boolean binaryContentType(FeignOutputMessage outputMessage) { protected boolean binaryContentType(FeignOutputMessage outputMessage) {
MediaType contentType = outputMessage.getHeaders().getContentType(); MediaType contentType = outputMessage.getHeaders().getContentType();
return contentType == null || Stream return contentType == null || Stream
.of(MediaType.APPLICATION_CBOR, MediaType.APPLICATION_OCTET_STREAM, MediaType.APPLICATION_PDF, .of(MediaType.APPLICATION_CBOR, MediaType.APPLICATION_OCTET_STREAM, MediaType.APPLICATION_PDF,
@@ -3,79 +3,79 @@
], ],
"properties": [ "properties": [
{ {
"name": "feign.autoconfiguration.jackson.enabled", "name": "spring.cloud.openfeign.autoconfiguration.jackson.enabled",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "If true, PageJacksonModule and SortJacksonModule bean will be provided for Jackson page decoding.", "description": "If true, PageJacksonModule and SortJacksonModule bean will be provided for Jackson page decoding.",
"defaultValue": "false" "defaultValue": "false"
}, },
{ {
"name": "feign.circuitbreaker.enabled", "name": "spring.cloud.openfeign.circuitbreaker.enabled",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "If true, an OpenFeign client will be wrapped with a Spring Cloud CircuitBreaker circuit breaker.", "description": "If true, an OpenFeign client will be wrapped with a Spring Cloud CircuitBreaker circuit breaker.",
"defaultValue": "false" "defaultValue": "false"
}, },
{ {
"name": "feign.circuitbreaker.alphanumeric-ids.enabled", "name": "spring.cloud.openfeign.circuitbreaker.group.enabled",
"type": "java.lang.Boolean",
"description": "If true, Circuit Breaker ids will only contain alphanumeric characters to allow for configuration via configuration properties.",
"defaultValue": "false"
},
{
"name": "feign.circuitbreaker.group.enabled",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "If true, an OpenFeign client will be wrapped with a Spring Cloud CircuitBreaker circuit breaker with with group.", "description": "If true, an OpenFeign client will be wrapped with a Spring Cloud CircuitBreaker circuit breaker with with group.",
"defaultValue": "false" "defaultValue": "false"
}, },
{ {
"name": "feign.httpclient.enabled", "name": "spring.cloud.openfeign.circuitbreaker.alphanumeric-ids.enabled",
"type": "java.lang.Boolean",
"description": "If true, Circuit Breaker ids will only contain alphanumeric characters to allow for configuration via configuration properties.",
"defaultValue": "false"
},
{
"name": "spring.cloud.openfeign.httpclient.enabled",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "Enables the use of the Apache HTTP Client by Feign.", "description": "Enables the use of the Apache HTTP Client by Feign.",
"defaultValue": "true" "defaultValue": "true"
}, },
{ {
"name": "feign.httpclient.hc5.enabled", "name": "spring.cloud.openfeign.httpclient.hc5.enabled",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "Enables the use of the Apache HTTP Client 5 by Feign.", "description": "Enables the use of the Apache HTTP Client 5 by Feign.",
"defaultValue": "false" "defaultValue": "false"
}, },
{ {
"name": "feign.okhttp.enabled", "name": "spring.cloud.openfeign.okhttp.enabled",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "Enables the use of the OK HTTP Client by Feign.", "description": "Enables the use of the OK HTTP Client by Feign.",
"defaultValue": "false" "defaultValue": "false"
}, },
{ {
"name": "feign.compression.response.enabled", "name": "spring.cloud.openfeign.compression.response.enabled",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "Enables the response from Feign to be compressed.", "description": "Enables the response from Feign to be compressed.",
"defaultValue": "false" "defaultValue": "false"
}, },
{ {
"name": "feign.compression.request.enabled", "name": "spring.cloud.openfeign.compression.request.enabled",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "Enables the request sent by Feign to be compressed.", "description": "Enables the request sent by Feign to be compressed.",
"defaultValue": "false" "defaultValue": "false"
}, },
{ {
"name": "feign.metrics.enabled", "name": "spring.cloud.openfeign.metrics.enabled",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "Enables metrics capability for Feign.", "description": "Enables metrics capability for Feign.",
"defaultValue": "true" "defaultValue": "true"
}, },
{ {
"name": "feign.client.refresh-enabled", "name": "spring.cloud.openfeign.client.refresh-enabled",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "Enables options value refresh capability for Feign.", "description": "Enables options value refresh capability for Feign.",
"defaultValue": "false" "defaultValue": "false"
}, },
{ {
"name": "feign.oauth2.enabled", "name": "spring.cloud.openfeign.oauth2.enabled",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "Enables feign interceptor for managing oauth2 access token.", "description": "Enables feign interceptor for managing oauth2 access token.",
"defaultValue": "false" "defaultValue": "false"
}, },
{ {
"name": "feign.oauth2.load-balanced", "name": "spring.cloud.openfeign.oauth2.load-balanced",
"type": "java.lang.Boolean", "type": "java.lang.Boolean",
"description": "Enables load balancing for oauth2 access token provider.", "description": "Enables load balancing for oauth2 access token provider.",
"defaultValue": "false" "defaultValue": "false"
@@ -47,7 +47,7 @@ class EnableFeignClientsTests {
@BeforeEach @BeforeEach
void setUp() { void setUp() {
context = new SpringApplicationBuilder().web(WebApplicationType.NONE) context = new SpringApplicationBuilder().web(WebApplicationType.NONE)
.properties("debug=true", "feign.httpclient.enabled=false") .properties("debug=true", "spring.cloud.openfeign.httpclient.enabled=false")
.sources(EnableFeignClientsTests.PlainConfiguration.class).run(); .sources(EnableFeignClientsTests.PlainConfiguration.class).run();
} }
@@ -27,7 +27,7 @@ import org.springframework.boot.test.context.assertj.AssertableApplicationContex
import org.springframework.boot.test.context.runner.ApplicationContextRunner; import org.springframework.boot.test.context.runner.ApplicationContextRunner;
import org.springframework.cloud.client.circuitbreaker.CircuitBreakerFactory; import org.springframework.cloud.client.circuitbreaker.CircuitBreakerFactory;
import org.springframework.cloud.client.loadbalancer.LoadBalancerInterceptor; import org.springframework.cloud.client.loadbalancer.LoadBalancerInterceptor;
import org.springframework.cloud.openfeign.FeignAutoConfiguration.CircuitBreakerPresentFeignTargeterConfiguration.DefaultCircuitBreakerNameResolver; import org.springframework.cloud.openfeign.FeignAutoConfiguration.CircuitBreakerPresentFeignTargeterConfiguration.AlphanumericCircuitBreakerNameResolver;
import org.springframework.cloud.openfeign.security.MockOAuth2ClientContext; import org.springframework.cloud.openfeign.security.MockOAuth2ClientContext;
import org.springframework.cloud.openfeign.security.OAuth2FeignRequestInterceptor; import org.springframework.cloud.openfeign.security.OAuth2FeignRequestInterceptor;
import org.springframework.cloud.openfeign.security.OAuth2FeignRequestInterceptorBuilder; import org.springframework.cloud.openfeign.security.OAuth2FeignRequestInterceptorBuilder;
@@ -51,30 +51,30 @@ class FeignAutoConfigurationTests {
private final ApplicationContextRunner runner = new ApplicationContextRunner() private final ApplicationContextRunner runner = new ApplicationContextRunner()
.withConfiguration(AutoConfigurations.of(FeignAutoConfiguration.class)) .withConfiguration(AutoConfigurations.of(FeignAutoConfiguration.class))
.withPropertyValues("feign.httpclient.enabled=false"); .withPropertyValues("spring.cloud.openfeign.httpclient.enabled=false");
@Test @Test
void shouldInstantiateDefaultTargeterWhenFeignCircuitBreakerIsDisabled() { void shouldInstantiateDefaultTargeterWhenFeignCircuitBreakerIsDisabled() {
runner.withPropertyValues("feign.circuitbreaker.enabled=false") runner.withPropertyValues("spring.cloud.openfeign.circuitbreaker.enabled=false")
.run(ctx -> assertOnlyOneTargeterPresent(ctx, DefaultTargeter.class)); .run(ctx -> assertOnlyOneTargeterPresent(ctx, DefaultTargeter.class));
} }
@Test @Test
void shouldInstantiateFeignCircuitBreakerTargeterWhenEnabled() { void shouldInstantiateFeignCircuitBreakerTargeterWhenEnabled() {
runner.withBean(CircuitBreakerFactory.class, () -> mock(CircuitBreakerFactory.class)) runner.withBean(CircuitBreakerFactory.class, () -> mock(CircuitBreakerFactory.class))
.withPropertyValues("feign.circuitbreaker.enabled=true").run(ctx -> { .withPropertyValues("spring.cloud.openfeign.circuitbreaker.enabled=true").run(ctx -> {
assertOnlyOneTargeterPresent(ctx, FeignCircuitBreakerTargeter.class); assertOnlyOneTargeterPresent(ctx, FeignCircuitBreakerTargeter.class);
assertThatFeignCircuitBreakerTargeterHasGroupEnabledPropertyWithValue(ctx, false); assertThatFeignCircuitBreakerTargeterHasGroupEnabledPropertyWithValue(ctx, false);
assertThatFeignCircuitBreakerTargeterHasSameCircuitBreakerNameResolver(ctx, assertThatFeignCircuitBreakerTargeterHasSameCircuitBreakerNameResolver(ctx,
DefaultCircuitBreakerNameResolver.class); AlphanumericCircuitBreakerNameResolver.class);
}); });
} }
@Test @Test
void shouldInstantiateFeignCircuitBreakerTargeterWithEnabledGroup() { void shouldInstantiateFeignCircuitBreakerTargeterWithEnabledGroup() {
runner.withBean(CircuitBreakerFactory.class, () -> mock(CircuitBreakerFactory.class)) runner.withBean(CircuitBreakerFactory.class, () -> mock(CircuitBreakerFactory.class))
.withPropertyValues("feign.circuitbreaker.enabled=true") .withPropertyValues("spring.cloud.openfeign.circuitbreaker.enabled=true")
.withPropertyValues("feign.circuitbreaker.group.enabled=true").run(ctx -> { .withPropertyValues("spring.cloud.openfeign.circuitbreaker.group.enabled=true").run(ctx -> {
assertOnlyOneTargeterPresent(ctx, FeignCircuitBreakerTargeter.class); assertOnlyOneTargeterPresent(ctx, FeignCircuitBreakerTargeter.class);
assertThatFeignCircuitBreakerTargeterHasGroupEnabledPropertyWithValue(ctx, true); assertThatFeignCircuitBreakerTargeterHasGroupEnabledPropertyWithValue(ctx, true);
}); });
@@ -84,7 +84,7 @@ class FeignAutoConfigurationTests {
void shouldInstantiateFeignCircuitBreakerTargeterWhenEnabledWithCustomCircuitBreakerNameResolver() { void shouldInstantiateFeignCircuitBreakerTargeterWhenEnabledWithCustomCircuitBreakerNameResolver() {
runner.withBean(CircuitBreakerFactory.class, () -> mock(CircuitBreakerFactory.class)) runner.withBean(CircuitBreakerFactory.class, () -> mock(CircuitBreakerFactory.class))
.withBean(CircuitBreakerNameResolver.class, CustomCircuitBreakerNameResolver::new) .withBean(CircuitBreakerNameResolver.class, CustomCircuitBreakerNameResolver::new)
.withPropertyValues("feign.circuitbreaker.enabled=true").run(ctx -> { .withPropertyValues("spring.cloud.openfeign.circuitbreaker.enabled=true").run(ctx -> {
assertOnlyOneTargeterPresent(ctx, FeignCircuitBreakerTargeter.class); assertOnlyOneTargeterPresent(ctx, FeignCircuitBreakerTargeter.class);
assertThatFeignCircuitBreakerTargeterHasSameCircuitBreakerNameResolver(ctx, assertThatFeignCircuitBreakerTargeterHasSameCircuitBreakerNameResolver(ctx,
CustomCircuitBreakerNameResolver.class); CustomCircuitBreakerNameResolver.class);
@@ -93,8 +93,8 @@ class FeignAutoConfigurationTests {
@Test @Test
void shouldInstantiateFeignOAuth2FeignRequestInterceptorWithoutInterceptors() { void shouldInstantiateFeignOAuth2FeignRequestInterceptorWithoutInterceptors() {
runner.withPropertyValues("feign.oauth2.enabled=true").withBean(MockOAuth2ClientContext.class, "token") runner.withPropertyValues("spring.cloud.openfeign.oauth2.enabled=true")
.withBean(BaseOAuth2ProtectedResourceDetails.class) .withBean(MockOAuth2ClientContext.class, "token").withBean(BaseOAuth2ProtectedResourceDetails.class)
.withBean(LoadBalancerInterceptor.class, () -> mock(LoadBalancerInterceptor.class)).run(ctx -> { .withBean(LoadBalancerInterceptor.class, () -> mock(LoadBalancerInterceptor.class)).run(ctx -> {
assertOauth2FeignRequestInterceptorExists(ctx); assertOauth2FeignRequestInterceptorExists(ctx);
assertAccessTokenProviderInterceptorNotExists(ctx, LoadBalancerInterceptor.class); assertAccessTokenProviderInterceptorNotExists(ctx, LoadBalancerInterceptor.class);
@@ -103,8 +103,9 @@ class FeignAutoConfigurationTests {
@Test @Test
void shouldInstantiateFeignOAuth2FeignRequestInterceptorWithLoadBalancedInterceptor() { void shouldInstantiateFeignOAuth2FeignRequestInterceptorWithLoadBalancedInterceptor() {
runner.withPropertyValues("feign.oauth2.enabled=true", "feign.oauth2.load-balanced=true") runner.withPropertyValues("spring.cloud.openfeign.oauth2.enabled=true",
.withBean(MockOAuth2ClientContext.class, "token").withBean(BaseOAuth2ProtectedResourceDetails.class) "spring.cloud.openfeign.oauth2.load-balanced=true").withBean(MockOAuth2ClientContext.class, "token")
.withBean(BaseOAuth2ProtectedResourceDetails.class)
.withBean(LoadBalancerInterceptor.class, () -> mock(LoadBalancerInterceptor.class)).run(ctx -> { .withBean(LoadBalancerInterceptor.class, () -> mock(LoadBalancerInterceptor.class)).run(ctx -> {
assertOauth2FeignRequestInterceptorExists(ctx); assertOauth2FeignRequestInterceptorExists(ctx);
assertAccessTokenProviderInterceptorExists(ctx, LoadBalancerInterceptor.class); assertAccessTokenProviderInterceptorExists(ctx, LoadBalancerInterceptor.class);
@@ -113,9 +114,9 @@ class FeignAutoConfigurationTests {
@Test @Test
void shouldInstantiateFeignOAuth2FeignRequestInterceptorWithoutLoadBalancedInterceptorIfNoBeanPresent() { void shouldInstantiateFeignOAuth2FeignRequestInterceptorWithoutLoadBalancedInterceptorIfNoBeanPresent() {
runner.withPropertyValues("feign.oauth2.enabled=true", "feign.oauth2.load-balanced=true") runner.withPropertyValues("spring.cloud.openfeign.oauth2.enabled=true",
.withBean(MockOAuth2ClientContext.class, "token").withBean(BaseOAuth2ProtectedResourceDetails.class) "spring.cloud.openfeign.oauth2.load-balanced=true").withBean(MockOAuth2ClientContext.class, "token")
.run(ctx -> { .withBean(BaseOAuth2ProtectedResourceDetails.class).run(ctx -> {
assertOauth2FeignRequestInterceptorExists(ctx); assertOauth2FeignRequestInterceptorExists(ctx);
assertAccessTokenProviderInterceptorNotExists(ctx, LoadBalancerInterceptor.class); assertAccessTokenProviderInterceptorNotExists(ctx, LoadBalancerInterceptor.class);
}); });
@@ -123,8 +124,8 @@ class FeignAutoConfigurationTests {
@Test @Test
void shouldInstantiateFeignOAuth2FeignRequestInterceptorWithCustomAccessTokenProviderInterceptor() { void shouldInstantiateFeignOAuth2FeignRequestInterceptorWithCustomAccessTokenProviderInterceptor() {
runner.withPropertyValues("feign.oauth2.enabled=true").withBean(MockOAuth2ClientContext.class, "token") runner.withPropertyValues("spring.cloud.openfeign.oauth2.enabled=true")
.withBean(BaseOAuth2ProtectedResourceDetails.class) .withBean(MockOAuth2ClientContext.class, "token").withBean(BaseOAuth2ProtectedResourceDetails.class)
.withBean(CustomOAuth2FeignRequestInterceptorConfigurer.class).run(ctx -> { .withBean(CustomOAuth2FeignRequestInterceptorConfigurer.class).run(ctx -> {
assertOauth2FeignRequestInterceptorExists(ctx); assertOauth2FeignRequestInterceptorExists(ctx);
assertAccessTokenProviderInterceptorExists(ctx, BasicAuthenticationInterceptor.class); assertAccessTokenProviderInterceptorExists(ctx, BasicAuthenticationInterceptor.class);
@@ -79,7 +79,7 @@ class FeignClientMetricsEnabledConditionTests {
when(beanProvider.getIfAvailable()).thenReturn(null); when(beanProvider.getIfAvailable()).thenReturn(null);
assertThat(condition.matches(context, metadata)).isTrue(); assertThat(condition.matches(context, metadata)).isTrue();
verify(environment, never()).getProperty("feign.client.name"); verify(environment, never()).getProperty("spring.cloud.openfeign.client.name");
} }
@Test @Test
@@ -89,7 +89,7 @@ class FeignClientMetricsEnabledConditionTests {
when(feignClientProperties.getConfig()).thenReturn(null); when(feignClientProperties.getConfig()).thenReturn(null);
assertThat(condition.matches(context, metadata)).isTrue(); assertThat(condition.matches(context, metadata)).isTrue();
verify(environment, never()).getProperty("feign.client.name"); verify(environment, never()).getProperty("spring.cloud.openfeign.client.name");
} }
@Test @Test
@@ -97,11 +97,11 @@ class FeignClientMetricsEnabledConditionTests {
FeignClientProperties feignClientProperties = mock(FeignClientProperties.class); FeignClientProperties feignClientProperties = mock(FeignClientProperties.class);
when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties); when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties);
when(context.getEnvironment()).thenReturn(environment); when(context.getEnvironment()).thenReturn(environment);
when(environment.getProperty("feign.client.name")).thenReturn("foo"); when(environment.getProperty("spring.cloud.openfeign.client.name")).thenReturn("foo");
when(feignClientProperties.getConfig()).thenReturn(new HashMap<>()); when(feignClientProperties.getConfig()).thenReturn(new HashMap<>());
assertThat(condition.matches(context, metadata)).isTrue(); assertThat(condition.matches(context, metadata)).isTrue();
verify(environment).getProperty("feign.client.name"); verify(environment).getProperty("spring.cloud.openfeign.client.name");
} }
@Test @Test
@@ -109,11 +109,11 @@ class FeignClientMetricsEnabledConditionTests {
FeignClientProperties feignClientProperties = mock(FeignClientProperties.class); FeignClientProperties feignClientProperties = mock(FeignClientProperties.class);
when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties); when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties);
when(context.getEnvironment()).thenReturn(environment); when(context.getEnvironment()).thenReturn(environment);
when(environment.getProperty("feign.client.name")).thenReturn(null); when(environment.getProperty("spring.cloud.openfeign.client.name")).thenReturn(null);
when(feignClientProperties.getConfig()).thenReturn(new HashMap<>()); when(feignClientProperties.getConfig()).thenReturn(new HashMap<>());
assertThat(condition.matches(context, metadata)).isTrue(); assertThat(condition.matches(context, metadata)).isTrue();
verify(environment).getProperty("feign.client.name"); verify(environment).getProperty("spring.cloud.openfeign.client.name");
} }
@Test @Test
@@ -121,12 +121,12 @@ class FeignClientMetricsEnabledConditionTests {
FeignClientProperties feignClientProperties = mock(FeignClientProperties.class); FeignClientProperties feignClientProperties = mock(FeignClientProperties.class);
when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties); when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties);
when(context.getEnvironment()).thenReturn(environment); when(context.getEnvironment()).thenReturn(environment);
when(environment.getProperty("feign.client.name")).thenReturn(""); when(environment.getProperty("spring.cloud.openfeign.client.name")).thenReturn("");
when(feignClientProperties.getConfig()).thenReturn(new HashMap<>()); when(feignClientProperties.getConfig()).thenReturn(new HashMap<>());
assertThat(condition.matches(context, metadata)).isTrue(); assertThat(condition.matches(context, metadata)).isTrue();
verify(environment).getProperty("feign.client.name"); verify(environment).getProperty("spring.cloud.openfeign.client.name");
} }
@Test @Test
@@ -134,11 +134,11 @@ class FeignClientMetricsEnabledConditionTests {
FeignClientProperties feignClientProperties = mock(FeignClientProperties.class); FeignClientProperties feignClientProperties = mock(FeignClientProperties.class);
when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties); when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties);
when(context.getEnvironment()).thenReturn(environment); when(context.getEnvironment()).thenReturn(environment);
when(environment.getProperty("feign.client.name")).thenReturn("foo"); when(environment.getProperty("spring.cloud.openfeign.client.name")).thenReturn("foo");
when(feignClientProperties.getConfig()).thenReturn(Maps.newHashMap("foo", null)); when(feignClientProperties.getConfig()).thenReturn(Maps.newHashMap("foo", null));
assertThat(condition.matches(context, metadata)).isTrue(); assertThat(condition.matches(context, metadata)).isTrue();
verify(environment).getProperty("feign.client.name"); verify(environment).getProperty("spring.cloud.openfeign.client.name");
} }
@Test @Test
@@ -148,12 +148,12 @@ class FeignClientMetricsEnabledConditionTests {
FeignClientProperties.FeignClientConfiguration.class); FeignClientProperties.FeignClientConfiguration.class);
when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties); when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties);
when(context.getEnvironment()).thenReturn(environment); when(context.getEnvironment()).thenReturn(environment);
when(environment.getProperty("feign.client.name")).thenReturn("foo"); when(environment.getProperty("spring.cloud.openfeign.client.name")).thenReturn("foo");
when(feignClientProperties.getConfig()).thenReturn(Maps.newHashMap("foo", feignClientConfig)); when(feignClientProperties.getConfig()).thenReturn(Maps.newHashMap("foo", feignClientConfig));
when(feignClientConfig.getMetrics()).thenReturn(null); when(feignClientConfig.getMetrics()).thenReturn(null);
assertThat(condition.matches(context, metadata)).isTrue(); assertThat(condition.matches(context, metadata)).isTrue();
verify(environment).getProperty("feign.client.name"); verify(environment).getProperty("spring.cloud.openfeign.client.name");
} }
@Test @Test
@@ -163,12 +163,12 @@ class FeignClientMetricsEnabledConditionTests {
FeignClientProperties.FeignClientConfiguration.class); FeignClientProperties.FeignClientConfiguration.class);
when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties); when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties);
when(context.getEnvironment()).thenReturn(environment); when(context.getEnvironment()).thenReturn(environment);
when(environment.getProperty("feign.client.name")).thenReturn("foo"); when(environment.getProperty("spring.cloud.openfeign.client.name")).thenReturn("foo");
when(feignClientProperties.getConfig()).thenReturn(Maps.newHashMap("foo", feignClientConfig)); when(feignClientProperties.getConfig()).thenReturn(Maps.newHashMap("foo", feignClientConfig));
when(feignClientConfig.getMetrics()).thenReturn(new FeignClientProperties.MetricsProperties()); when(feignClientConfig.getMetrics()).thenReturn(new FeignClientProperties.MetricsProperties());
assertThat(condition.matches(context, metadata)).isTrue(); assertThat(condition.matches(context, metadata)).isTrue();
verify(environment).getProperty("feign.client.name"); verify(environment).getProperty("spring.cloud.openfeign.client.name");
} }
@Test @Test
@@ -178,14 +178,14 @@ class FeignClientMetricsEnabledConditionTests {
FeignClientProperties.FeignClientConfiguration.class); FeignClientProperties.FeignClientConfiguration.class);
when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties); when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties);
when(context.getEnvironment()).thenReturn(environment); when(context.getEnvironment()).thenReturn(environment);
when(environment.getProperty("feign.client.name")).thenReturn("foo"); when(environment.getProperty("spring.cloud.openfeign.client.name")).thenReturn("foo");
when(feignClientProperties.getConfig()).thenReturn(Maps.newHashMap("foo", feignClientConfig)); when(feignClientProperties.getConfig()).thenReturn(Maps.newHashMap("foo", feignClientConfig));
FeignClientProperties.MetricsProperties metricsProperties = new FeignClientProperties.MetricsProperties(); FeignClientProperties.MetricsProperties metricsProperties = new FeignClientProperties.MetricsProperties();
metricsProperties.setEnabled(null); metricsProperties.setEnabled(null);
when(feignClientConfig.getMetrics()).thenReturn(metricsProperties); when(feignClientConfig.getMetrics()).thenReturn(metricsProperties);
assertThat(condition.matches(context, metadata)).isTrue(); assertThat(condition.matches(context, metadata)).isTrue();
verify(environment).getProperty("feign.client.name"); verify(environment).getProperty("spring.cloud.openfeign.client.name");
} }
@Test @Test
@@ -195,14 +195,14 @@ class FeignClientMetricsEnabledConditionTests {
FeignClientProperties.FeignClientConfiguration.class); FeignClientProperties.FeignClientConfiguration.class);
when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties); when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties);
when(context.getEnvironment()).thenReturn(environment); when(context.getEnvironment()).thenReturn(environment);
when(environment.getProperty("feign.client.name")).thenReturn("foo"); when(environment.getProperty("spring.cloud.openfeign.client.name")).thenReturn("foo");
when(feignClientProperties.getConfig()).thenReturn(Maps.newHashMap("foo", feignClientConfig)); when(feignClientProperties.getConfig()).thenReturn(Maps.newHashMap("foo", feignClientConfig));
FeignClientProperties.MetricsProperties metricsProperties = new FeignClientProperties.MetricsProperties(); FeignClientProperties.MetricsProperties metricsProperties = new FeignClientProperties.MetricsProperties();
metricsProperties.setEnabled(true); metricsProperties.setEnabled(true);
when(feignClientConfig.getMetrics()).thenReturn(metricsProperties); when(feignClientConfig.getMetrics()).thenReturn(metricsProperties);
assertThat(condition.matches(context, metadata)).isTrue(); assertThat(condition.matches(context, metadata)).isTrue();
verify(environment).getProperty("feign.client.name"); verify(environment).getProperty("spring.cloud.openfeign.client.name");
} }
@Test @Test
@@ -212,14 +212,14 @@ class FeignClientMetricsEnabledConditionTests {
FeignClientProperties.FeignClientConfiguration.class); FeignClientProperties.FeignClientConfiguration.class);
when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties); when(beanProvider.getIfAvailable()).thenReturn(feignClientProperties);
when(context.getEnvironment()).thenReturn(environment); when(context.getEnvironment()).thenReturn(environment);
when(environment.getProperty("feign.client.name")).thenReturn("foo"); when(environment.getProperty("spring.cloud.openfeign.client.name")).thenReturn("foo");
when(feignClientProperties.getConfig()).thenReturn(Maps.newHashMap("foo", feignClientConfig)); when(feignClientProperties.getConfig()).thenReturn(Maps.newHashMap("foo", feignClientConfig));
FeignClientProperties.MetricsProperties metricsProperties = new FeignClientProperties.MetricsProperties(); FeignClientProperties.MetricsProperties metricsProperties = new FeignClientProperties.MetricsProperties();
metricsProperties.setEnabled(false); metricsProperties.setEnabled(false);
when(feignClientConfig.getMetrics()).thenReturn(metricsProperties); when(feignClientConfig.getMetrics()).thenReturn(metricsProperties);
assertThat(condition.matches(context, metadata)).isFalse(); assertThat(condition.matches(context, metadata)).isFalse();
verify(environment).getProperty("feign.client.name"); verify(environment).getProperty("spring.cloud.openfeign.client.name");
} }
} }
@@ -44,9 +44,9 @@ import static org.assertj.core.api.Assertions.assertThat;
*/ */
@DirtiesContext @DirtiesContext
@SpringBootTest(classes = FeignClientUsingConfigurerTest.Application.class, value = { @SpringBootTest(classes = FeignClientUsingConfigurerTest.Application.class, value = {
"feign.client.config.default.loggerLevel=full", "spring.cloud.openfeign.client.config.default.loggerLevel=full",
"feign.client.config.default.requestInterceptors[0]=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.FooRequestInterceptor", "spring.cloud.openfeign.client.config.default.requestInterceptors[0]=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.FooRequestInterceptor",
"feign.client.config.default.requestInterceptors[1]=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.BarRequestInterceptor" }) "spring.cloud.openfeign.client.config.default.requestInterceptors[1]=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.BarRequestInterceptor" })
class FeignClientUsingConfigurerTest { class FeignClientUsingConfigurerTest {
private static final String BEAN_NAME_PREFIX = "org.springframework.cloud.openfeign.FeignClientUsingConfigurerTest$"; private static final String BEAN_NAME_PREFIX = "org.springframework.cloud.openfeign.FeignClientUsingConfigurerTest$";
@@ -32,8 +32,6 @@ import java.util.concurrent.TimeUnit;
import java.util.stream.Collectors; import java.util.stream.Collectors;
import java.util.stream.Stream; import java.util.stream.Stream;
import javax.servlet.http.HttpServletRequest;
import feign.Capability; import feign.Capability;
import feign.Feign; import feign.Feign;
import feign.InvocationHandlerFactory; import feign.InvocationHandlerFactory;
@@ -47,6 +45,7 @@ import feign.codec.EncodeException;
import feign.codec.Encoder; import feign.codec.Encoder;
import feign.codec.ErrorDecoder; import feign.codec.ErrorDecoder;
import feign.micrometer.MicrometerCapability; import feign.micrometer.MicrometerCapability;
import jakarta.servlet.http.HttpServletRequest;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import org.junit.jupiter.api.condition.DisabledForJreRange; import org.junit.jupiter.api.condition.DisabledForJreRange;
import org.junit.jupiter.api.condition.JRE; import org.junit.jupiter.api.condition.JRE;
@@ -45,8 +45,9 @@ class FeignCompressionTests {
@Test @Test
void testInterceptors() { void testInterceptors() {
new ApplicationContextRunner() new ApplicationContextRunner()
.withPropertyValues("feign.compression.response.enabled=true", "feign.compression.request.enabled=true", .withPropertyValues("spring.cloud.openfeign.compression.response.enabled=true",
"feign.okhttp.enabled=false") "spring.cloud.openfeign.compression.request.enabled=true",
"spring.cloud.openfeign.okhttp.enabled=false")
.withConfiguration(AutoConfigurations.of(FeignAutoConfiguration.class, .withConfiguration(AutoConfigurations.of(FeignAutoConfiguration.class,
FeignContentGzipEncodingAutoConfiguration.class, FeignAcceptGzipEncodingAutoConfiguration.class, FeignContentGzipEncodingAutoConfiguration.class, FeignAcceptGzipEncodingAutoConfiguration.class,
HttpClientConfiguration.class, PlainConfig.class)) HttpClientConfiguration.class, PlainConfig.class))
@@ -60,7 +60,8 @@ class FeignHttpClient5ConfigurationTests {
@Test @Test
void verifyHttpClient5AutoConfig() { void verifyHttpClient5AutoConfig() {
ConfigurableApplicationContext context = new SpringApplicationBuilder() ConfigurableApplicationContext context = new SpringApplicationBuilder()
.properties("feign.httpclient.hc5.enabled=true", "feign.httpclient.enabled=false") .properties("spring.cloud.openfeign.httpclient.hc5.enabled=true",
"spring.cloud.openfeign.httpclient.enabled=false")
.web(WebApplicationType.NONE).sources(HttpClientConfiguration.class, FeignAutoConfiguration.class) .web(WebApplicationType.NONE).sources(HttpClientConfiguration.class, FeignAutoConfiguration.class)
.run(); .run();
@@ -74,7 +75,8 @@ class FeignHttpClient5ConfigurationTests {
@Test @Test
void hc5ShouldWinIfTheBothVersionsAvailable() { void hc5ShouldWinIfTheBothVersionsAvailable() {
ConfigurableApplicationContext context = new SpringApplicationBuilder() ConfigurableApplicationContext context = new SpringApplicationBuilder()
.properties("feign.httpclient.hc5.enabled=true", "feign.httpclient.enabled=true") .properties("spring.cloud.openfeign.httpclient.hc5.enabled=true",
"spring.cloud.openfeign.httpclient.enabled=true")
.web(WebApplicationType.NONE).sources(HttpClientConfiguration.class, FeignAutoConfiguration.class) .web(WebApplicationType.NONE).sources(HttpClientConfiguration.class, FeignAutoConfiguration.class)
.run(); .run();
@@ -89,7 +91,8 @@ class FeignHttpClient5ConfigurationTests {
@Test @Test
void hc4ShouldBeTheDefaultIfHc5NotEnabled() { void hc4ShouldBeTheDefaultIfHc5NotEnabled() {
ConfigurableApplicationContext context = new SpringApplicationBuilder() ConfigurableApplicationContext context = new SpringApplicationBuilder()
.properties("feign.httpclient.hc5.enabled=false", "feign.httpclient.enabled=true") .properties("spring.cloud.openfeign.httpclient.hc5.enabled=false",
"spring.cloud.openfeign.httpclient.enabled=true")
.web(WebApplicationType.NONE).sources(HttpClientConfiguration.class, FeignAutoConfiguration.class) .web(WebApplicationType.NONE).sources(HttpClientConfiguration.class, FeignAutoConfiguration.class)
.run(); .run();
@@ -107,7 +110,7 @@ class FeignHttpClient5ConfigurationTests {
@Test @Test
void hc4ShouldWinEvenHc5ConfigEnabled() { void hc4ShouldWinEvenHc5ConfigEnabled() {
ConfigurableApplicationContext context = new SpringApplicationBuilder() ConfigurableApplicationContext context = new SpringApplicationBuilder()
.properties("feign.httpclient.hc5.enabled=true").web(WebApplicationType.NONE) .properties("spring.cloud.openfeign.httpclient.hc5.enabled=true").web(WebApplicationType.NONE)
.sources(HttpClientConfiguration.class, FeignAutoConfiguration.class).run(); .sources(HttpClientConfiguration.class, FeignAutoConfiguration.class).run();
verifyHc4BeansAvailable(context); verifyHc4BeansAvailable(context);
@@ -48,8 +48,9 @@ class FeignHttpClientConfigurationTests {
@BeforeEach @BeforeEach
void setUp() { void setUp() {
this.context = new SpringApplicationBuilder() this.context = new SpringApplicationBuilder()
.properties("debug=true", "feign.httpclient.disableSslValidation=true").web(WebApplicationType.NONE) .properties("debug=true", "spring.cloud.openfeign.httpclient.disableSslValidation=true")
.sources(HttpClientConfiguration.class, FeignAutoConfiguration.class).run(); .web(WebApplicationType.NONE).sources(HttpClientConfiguration.class, FeignAutoConfiguration.class)
.run();
} }
@AfterEach @AfterEach
@@ -31,12 +31,12 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.cloud.openfeign.test.NoSecurityConfiguration; import org.springframework.cloud.openfeign.test.NoSecurityConfiguration;
import org.springframework.cloud.test.TestSocketUtils;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import; import org.springframework.context.annotation.Import;
import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.annotation.DirtiesContext;
import org.springframework.util.ReflectionUtils; import org.springframework.util.ReflectionUtils;
import org.springframework.util.SocketUtils;
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController; import org.springframework.web.bind.annotation.RestController;
@@ -48,8 +48,8 @@ import static org.springframework.boot.test.context.SpringBootTest.WebEnvironmen
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
*/ */
@SpringBootTest(classes = FeignHttpClientUrlTests.TestConfig.class, webEnvironment = DEFINED_PORT, @SpringBootTest(classes = FeignHttpClientUrlTests.TestConfig.class, webEnvironment = DEFINED_PORT,
value = { "spring.application.name=feignclienturltest", "feign.circuitbreaker.enabled=false", value = { "spring.application.name=feignclienturltest", "spring.cloud.openfeign.circuitbreaker.enabled=false",
"feign.okhttp.enabled=false", "spring.cloud.loadbalancer.retry.enabled=false" }) "spring.cloud.openfeign.okhttp.enabled=false", "spring.cloud.loadbalancer.retry.enabled=false" })
@DirtiesContext @DirtiesContext
class FeignHttpClientUrlTests { class FeignHttpClientUrlTests {
@@ -66,7 +66,7 @@ class FeignHttpClientUrlTests {
@BeforeAll @BeforeAll
static void beforeClass() { static void beforeClass() {
port = SocketUtils.findAvailableTcpPort(); port = TestSocketUtils.findAvailableTcpPort();
System.setProperty("server.port", String.valueOf(port)); System.setProperty("server.port", String.valueOf(port));
} }
@@ -31,12 +31,12 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.cloud.openfeign.test.NoSecurityConfiguration; import org.springframework.cloud.openfeign.test.NoSecurityConfiguration;
import org.springframework.cloud.test.TestSocketUtils;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import; import org.springframework.context.annotation.Import;
import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.annotation.DirtiesContext;
import org.springframework.util.ReflectionUtils; import org.springframework.util.ReflectionUtils;
import org.springframework.util.SocketUtils;
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController; import org.springframework.web.bind.annotation.RestController;
@@ -48,8 +48,9 @@ import static org.springframework.boot.test.context.SpringBootTest.WebEnvironmen
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
*/ */
@SpringBootTest(classes = FeignHttpClientUrlTestsWithRetryableLoadBalancer.TestConfig.class, @SpringBootTest(classes = FeignHttpClientUrlTestsWithRetryableLoadBalancer.TestConfig.class,
webEnvironment = DEFINED_PORT, value = { "spring.application.name=feignclienturlwithretryableloadbalancertest", webEnvironment = DEFINED_PORT,
"feign.hystrix.enabled=false", "feign.okhttp.enabled=false" }) value = { "spring.application.name=feignclienturlwithretryableloadbalancertest",
"spring.cloud.openfeign.hystrix.enabled=false", "spring.cloud.openfeign.okhttp.enabled=false" })
@DirtiesContext @DirtiesContext
class FeignHttpClientUrlTestsWithRetryableLoadBalancer { class FeignHttpClientUrlTestsWithRetryableLoadBalancer {
@@ -66,7 +67,7 @@ class FeignHttpClientUrlTestsWithRetryableLoadBalancer {
@BeforeAll @BeforeAll
static void beforeClass() { static void beforeClass() {
port = SocketUtils.findAvailableTcpPort(); port = TestSocketUtils.findAvailableTcpPort();
System.setProperty("server.port", String.valueOf(port)); System.setProperty("server.port", String.valueOf(port));
} }
@@ -44,8 +44,9 @@ class FeignOkHttpConfigurationTests {
@BeforeEach @BeforeEach
void setUp() { void setUp() {
this.context = new SpringApplicationBuilder() this.context = new SpringApplicationBuilder()
.properties("debug=true", "feign.httpclient.disableSslValidation=true", "feign.okhttp.enabled=true", .properties("debug=true", "spring.cloud.openfeign.httpclient.disableSslValidation=true",
"feign.httpclient.enabled=false", "feign.httpclient.okhttp.read-timeout=9s") "spring.cloud.openfeign.okhttp.enabled=true", "spring.cloud.openfeign.httpclient.enabled=false",
"spring.cloud.openfeign.httpclient.okhttp.read-timeout=9s")
.web(WebApplicationType.NONE).sources(HttpClientConfiguration.class, FeignAutoConfiguration.class) .web(WebApplicationType.NONE).sources(HttpClientConfiguration.class, FeignAutoConfiguration.class)
.run(); .run();
} }
@@ -41,8 +41,10 @@ import static org.assertj.core.api.Assertions.assertThat;
*/ */
@SpringBootTest(classes = GzipDecodingTests.Application.class, @SpringBootTest(classes = GzipDecodingTests.Application.class,
webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT,
value = { "spring.application.name=defaultGzipDecoderTests", "feign.compression.response.enabled=true", value = { "spring.application.name=defaultGzipDecoderTests",
"feign.client.config.default.loggerLevel=none", "feign.metrics.enabled=false", "spring.cloud.openfeign.compression.response.enabled=true",
"spring.cloud.openfeign.client.config.default.loggerLevel=none",
"spring.cloud.openfeign.metrics.enabled=false",
"logging.level.org.springframework.cloud.openfeign=DEBUG" }) "logging.level.org.springframework.cloud.openfeign=DEBUG" })
@DirtiesContext @DirtiesContext
class GzipDecodingTests extends FeignClientFactoryBean { class GzipDecodingTests extends FeignClientFactoryBean {
@@ -28,7 +28,7 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.openfeign.test.NoSecurityConfiguration; import org.springframework.cloud.openfeign.test.NoSecurityConfiguration;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import; import org.springframework.context.annotation.Import;
@@ -52,8 +52,8 @@ import static org.assertj.core.api.Assertions.assertThat;
*/ */
@SpringBootTest(classes = BeansFeignClientTests.Application.class, webEnvironment = WebEnvironment.RANDOM_PORT, @SpringBootTest(classes = BeansFeignClientTests.Application.class, webEnvironment = WebEnvironment.RANDOM_PORT,
value = { "spring.application.name=feignclienttest", value = { "spring.application.name=feignclienttest",
"logging.level.org.springframework.cloud.openfeign.valid=DEBUG", "feign.httpclient.enabled=false", "logging.level.org.springframework.cloud.openfeign.valid=DEBUG",
"feign.okhttp.enabled=false" }) "spring.cloud.openfeign.httpclient.enabled=false", "spring.cloud.openfeign.okhttp.enabled=false" })
@DirtiesContext @DirtiesContext
public class BeansFeignClientTests { public class BeansFeignClientTests {
@@ -21,9 +21,8 @@ import java.util.Objects;
import java.util.UUID; import java.util.UUID;
import java.util.function.Function; import java.util.function.Function;
import javax.servlet.http.HttpServletRequest;
import feign.RequestInterceptor; import feign.RequestInterceptor;
import jakarta.servlet.http.HttpServletRequest;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.ObjectProvider; import org.springframework.beans.factory.ObjectProvider;
@@ -60,7 +59,7 @@ import static org.springframework.test.web.servlet.result.MockMvcResultMatchers.
* @author John Niang * @author John Niang
*/ */
@SpringBootTest(classes = AsyncCircuitBreakerTest.Application.class, webEnvironment = RANDOM_PORT, @SpringBootTest(classes = AsyncCircuitBreakerTest.Application.class, webEnvironment = RANDOM_PORT,
properties = "feign.circuitbreaker.enabled=true") properties = "spring.cloud.openfeign.circuitbreaker.enabled=true")
@AutoConfigureMockMvc @AutoConfigureMockMvc
class AsyncCircuitBreakerTest { class AsyncCircuitBreakerTest {
@@ -36,7 +36,8 @@ public class CircuitBreakerAutoConfigurationTests {
@SpringBootTest(classes = CircuitBreakerTests.Application.class, @SpringBootTest(classes = CircuitBreakerTests.Application.class,
webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT,
value = { "spring.application.name=springcircuittest", "spring.jmx.enabled=false", value = { "spring.application.name=springcircuittest", "spring.jmx.enabled=false",
"feign.circuitbreaker.enabled=true" }) "spring.cloud.openfeign.circuitbreaker.enabled=true",
"spring.cloud.openfeign.circuitbreaker.alphanumeric-ids.enabled=false" })
@Nested @Nested
class DefaultNamingStrategy { class DefaultNamingStrategy {
@@ -57,7 +58,7 @@ public class CircuitBreakerAutoConfigurationTests {
@SpringBootTest(classes = CircuitBreakerTests.Application.class, @SpringBootTest(classes = CircuitBreakerTests.Application.class,
webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT, webEnvironment = SpringBootTest.WebEnvironment.RANDOM_PORT,
value = { "spring.application.name=springcircuittest", "spring.jmx.enabled=false", value = { "spring.application.name=springcircuittest", "spring.jmx.enabled=false",
"feign.circuitbreaker.enabled=true", "feign.circuitbreaker.alphanumeric-ids.enabled=true" }) "spring.cloud.openfeign.circuitbreaker.enabled=true" })
@Nested @Nested
class AlphanumericNamingStrategy { class AlphanumericNamingStrategy {
@@ -38,12 +38,12 @@ import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.cloud.openfeign.FallbackFactory; import org.springframework.cloud.openfeign.FallbackFactory;
import org.springframework.cloud.openfeign.FeignClient; import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.cloud.openfeign.test.NoSecurityConfiguration; import org.springframework.cloud.openfeign.test.NoSecurityConfiguration;
import org.springframework.cloud.test.TestSocketUtils;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import; import org.springframework.context.annotation.Import;
import org.springframework.stereotype.Component; import org.springframework.stereotype.Component;
import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.annotation.DirtiesContext;
import org.springframework.util.SocketUtils;
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController; import org.springframework.web.bind.annotation.RestController;
@@ -53,8 +53,9 @@ import static org.assertj.core.api.Assertions.assertThatExceptionOfType;
/** /**
* @author Spencer Gibb * @author Spencer Gibb
*/ */
@SpringBootTest(classes = CircuitBreakerTests.Application.class, webEnvironment = WebEnvironment.DEFINED_PORT, value = { @SpringBootTest(classes = CircuitBreakerTests.Application.class, webEnvironment = WebEnvironment.DEFINED_PORT,
"spring.application.name=springcircuittest", "spring.jmx.enabled=false", "feign.circuitbreaker.enabled=true" }) value = { "spring.application.name=springcircuittest", "spring.jmx.enabled=false",
"spring.cloud.openfeign.circuitbreaker.enabled=true" })
@DirtiesContext @DirtiesContext
class CircuitBreakerTests { class CircuitBreakerTests {
@@ -72,7 +73,7 @@ class CircuitBreakerTests {
@BeforeAll @BeforeAll
static void beforeClass() { static void beforeClass() {
System.setProperty("server.port", String.valueOf(SocketUtils.findAvailableTcpPort())); System.setProperty("server.port", String.valueOf(TestSocketUtils.findAvailableTcpPort()));
} }
@AfterAll @AfterAll
@@ -35,11 +35,11 @@ import org.springframework.cloud.client.circuitbreaker.NoFallbackAvailableExcept
import org.springframework.cloud.openfeign.EnableFeignClients; import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.cloud.openfeign.FeignClient; import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.cloud.openfeign.test.NoSecurityConfiguration; import org.springframework.cloud.openfeign.test.NoSecurityConfiguration;
import org.springframework.cloud.test.TestSocketUtils;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import; import org.springframework.context.annotation.Import;
import org.springframework.test.annotation.DirtiesContext; import org.springframework.test.annotation.DirtiesContext;
import org.springframework.util.SocketUtils;
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.RestController; import org.springframework.web.bind.annotation.RestController;
@@ -54,7 +54,7 @@ import static org.assertj.core.api.Assertions.assertThatThrownBy;
@SpringBootTest(classes = CircuitBreakerWithNoFallbackTests.Application.class, @SpringBootTest(classes = CircuitBreakerWithNoFallbackTests.Application.class,
webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT, webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT,
value = { "spring.application.name=springcircuittest", "spring.jmx.enabled=false", value = { "spring.application.name=springcircuittest", "spring.jmx.enabled=false",
"feign.circuitbreaker.enabled=true" }) "spring.cloud.openfeign.circuitbreaker.enabled=true" })
@DirtiesContext @DirtiesContext
public class CircuitBreakerWithNoFallbackTests { public class CircuitBreakerWithNoFallbackTests {
@@ -66,7 +66,7 @@ public class CircuitBreakerWithNoFallbackTests {
@BeforeAll @BeforeAll
public static void beforeClass() { public static void beforeClass() {
System.setProperty("server.port", String.valueOf(SocketUtils.findAvailableTcpPort())); System.setProperty("server.port", String.valueOf(TestSocketUtils.findAvailableTcpPort()));
} }
@AfterAll @AfterAll
@@ -23,7 +23,7 @@ import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient;
import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier; import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
@@ -48,7 +48,7 @@ import static org.springframework.boot.test.context.SpringBootTest.WebEnvironmen
* @author Jakub Narloch * @author Jakub Narloch
*/ */
@SpringBootTest(classes = FeignAcceptEncodingTests.Application.class, webEnvironment = RANDOM_PORT, @SpringBootTest(classes = FeignAcceptEncodingTests.Application.class, webEnvironment = RANDOM_PORT,
value = { "feign.compression.response.enabled=true" }) value = { "spring.cloud.openfeign.compression.response.enabled=true" })
@DirtiesContext @DirtiesContext
class FeignAcceptEncodingTests { class FeignAcceptEncodingTests {
@@ -23,7 +23,7 @@ import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient;
import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier; import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
@@ -47,7 +47,7 @@ import static org.springframework.boot.test.context.SpringBootTest.WebEnvironmen
* @author Jakub Narloch * @author Jakub Narloch
*/ */
@SpringBootTest(classes = FeignContentEncodingTests.Application.class, webEnvironment = RANDOM_PORT, @SpringBootTest(classes = FeignContentEncodingTests.Application.class, webEnvironment = RANDOM_PORT,
value = { "feign.compression.request.enabled=true" }) value = { "spring.cloud.openfeign.compression.request.enabled=true" })
class FeignContentEncodingTests { class FeignContentEncodingTests {
@Autowired @Autowired
@@ -25,7 +25,7 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration; import org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient;
import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier; import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
@@ -55,7 +55,8 @@ import static org.springframework.boot.test.context.SpringBootTest.WebEnvironmen
* @author Hyeonmin Park * @author Hyeonmin Park
*/ */
@SpringBootTest(classes = FeignPageableEncodingTests.Application.class, webEnvironment = RANDOM_PORT, @SpringBootTest(classes = FeignPageableEncodingTests.Application.class, webEnvironment = RANDOM_PORT,
value = { "feign.compression.request.enabled=true", "feign.autoconfiguration.jackson.enabled=true" }) value = { "spring.cloud.openfeign.compression.request.enabled=true",
"spring.cloud.openfeign.autoconfiguration.jackson.enabled=true" })
class FeignPageableEncodingTests { class FeignPageableEncodingTests {
@Autowired @Autowired
@@ -27,9 +27,14 @@ import org.springframework.cloud.openfeign.encoding.app.domain.Invoice;
* Utility class used for testing. * Utility class used for testing.
* *
* @author Jakub Narloch * @author Jakub Narloch
* @author Olga Maciaszek-Sharma
*/ */
final class Invoices { final class Invoices {
private Invoices() {
throw new IllegalStateException("Can't instantiate a utility class");
}
public static List<Invoice> createInvoiceList(int count) { public static List<Invoice> createInvoiceList(int count) {
final List<Invoice> invoices = new ArrayList<>(); final List<Invoice> invoices = new ArrayList<>();
for (int ind = 0; ind < count; ind++) { for (int ind = 0; ind < count; ind++) {
@@ -74,21 +74,21 @@ public final class Request extends com.google.protobuf.GeneratedMessageV3 implem
while (!done) { while (!done) {
int tag = input.readTag(); int tag = input.readTag();
switch (tag) { switch (tag) {
case 0: case 0:
done = true;
break;
default:
if (!parseUnknownFieldProto3(input, unknownFields, extensionRegistry, tag)) {
done = true; done = true;
} break;
break; default:
case 8: if (!parseUnknownFieldProto3(input, unknownFields, extensionRegistry, tag)) {
this.id_ = input.readInt32(); done = true;
break; }
case 18: break;
String s = input.readStringRequireUtf8(); case 8:
this.msg_ = s; this.id_ = input.readInt32();
break; break;
case 18:
String s = input.readStringRequireUtf8();
this.msg_ = s;
break;
} }
} }
} }
@@ -18,7 +18,7 @@ package org.springframework.cloud.openfeign.hateoas.app;
import org.springframework.boot.autoconfigure.SpringBootApplication; import org.springframework.boot.autoconfigure.SpringBootApplication;
import org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration; import org.springframework.boot.autoconfigure.data.rest.RepositoryRestMvcAutoConfiguration;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient;
import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier; import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
@@ -21,9 +21,11 @@ import java.io.IOException;
import java.io.InputStreamReader; import java.io.InputStreamReader;
import java.net.URI; import java.net.URI;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Collection; import java.util.Collection;
import java.util.Collections; import java.util.Collections;
import java.util.HashMap; import java.util.HashMap;
import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.UUID; import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentHashMap;
@@ -65,9 +67,10 @@ import static org.mockito.Mockito.when;
* Commons project, so here we are only testing the interactions between * Commons project, so here we are only testing the interactions between
* {@link FeignBlockingLoadBalancerClient} and its delegates. * {@link FeignBlockingLoadBalancerClient} and its delegates.
* *
* @author Olga Maciaszek-Sharma
* @author changjin wei(魏昌进)
* @see <a href= * @see <a href=
* "https://github.com/spring-cloud/spring-cloud-commons/blob/main/spring-cloud-loadbalancer/src/test/java/org/springframework/cloud/loadbalancer/blocking/client/BlockingLoadBalancerClientTests.java">BlockingLoadBalancerClientTests</a> * "https://github.com/spring-cloud/spring-cloud-commons/blob/main/spring-cloud-loadbalancer/src/test/java/org/springframework/cloud/loadbalancer/blocking/client/BlockingLoadBalancerClientTests.java">BlockingLoadBalancerClientTests</a>
* @author Olga Maciaszek-Sharma
*/ */
@ExtendWith(MockitoExtension.class) @ExtendWith(MockitoExtension.class)
class FeignBlockingLoadBalancerClientTests { class FeignBlockingLoadBalancerClientTests {
@@ -80,8 +83,11 @@ class FeignBlockingLoadBalancerClientTests {
private final LoadBalancerProperties loadBalancerProperties = new LoadBalancerProperties(); private final LoadBalancerProperties loadBalancerProperties = new LoadBalancerProperties();
private final List<LoadBalancerFeignRequestTransformer> transformers = Arrays.asList(new InstanceIdTransformer(),
new ServiceIdTransformer());
private final FeignBlockingLoadBalancerClient feignBlockingLoadBalancerClient = new FeignBlockingLoadBalancerClient( private final FeignBlockingLoadBalancerClient feignBlockingLoadBalancerClient = new FeignBlockingLoadBalancerClient(
delegate, loadBalancerClient, loadBalancerClientFactory); delegate, loadBalancerClient, loadBalancerClientFactory, transformers);
@BeforeEach @BeforeEach
void setUp() { void setUp() {
@@ -133,9 +139,11 @@ class FeignBlockingLoadBalancerClientTests {
Request actualRequest = captor.getValue(); Request actualRequest = captor.getValue();
assertThat(actualRequest.httpMethod()).isEqualTo(Request.HttpMethod.GET); assertThat(actualRequest.httpMethod()).isEqualTo(Request.HttpMethod.GET);
assertThat(actualRequest.url()).isEqualTo(url); assertThat(actualRequest.url()).isEqualTo(url);
assertThat(actualRequest.headers()).hasSize(1); assertThat(actualRequest.headers()).hasSize(3);
assertThat(actualRequest.headers()).containsEntry(HttpHeaders.CONTENT_TYPE, assertThat(actualRequest.headers()).containsEntry(HttpHeaders.CONTENT_TYPE,
Collections.singletonList(MediaType.APPLICATION_JSON_VALUE)); Collections.singletonList(MediaType.APPLICATION_JSON_VALUE));
assertThat(actualRequest.headers()).containsEntry("X-ServiceId", Collections.singletonList("test"));
assertThat(actualRequest.headers()).containsEntry("X-InstanceId", Collections.singletonList("test-1"));
assertThat(new String(actualRequest.body())).isEqualTo("hello"); assertThat(new String(actualRequest.body())).isEqualTo("hello");
} }
@@ -253,4 +261,28 @@ class FeignBlockingLoadBalancerClientTests {
} }
private static class InstanceIdTransformer implements LoadBalancerFeignRequestTransformer {
@Override
public Request transformRequest(Request request, ServiceInstance instance) {
Map<String, Collection<String>> headers = new HashMap<>(request.headers());
headers.put("X-InstanceId", Collections.singletonList(instance.getInstanceId()));
return Request.create(request.httpMethod(), request.url(), headers, request.body(), request.charset(),
request.requestTemplate());
}
}
private static class ServiceIdTransformer implements LoadBalancerFeignRequestTransformer {
@Override
public Request transformRequest(Request request, ServiceInstance instance) {
Map<String, Collection<String>> headers = new HashMap<>(request.headers());
headers.put("X-ServiceId", Collections.singletonList(instance.getServiceId()));
return Request.create(request.httpMethod(), request.url(), headers, request.body(), request.charset(),
request.requestTemplate());
}
}
} }
@@ -43,7 +43,7 @@ class FeignLoadBalancerAutoConfigurationTests {
@Test @Test
void shouldInstantiateDefaultFeignBlockingLoadBalancerClientWhenHttpClientDisabled() { void shouldInstantiateDefaultFeignBlockingLoadBalancerClientWhenHttpClientDisabled() {
ConfigurableApplicationContext context = initContext("feign.httpclient.enabled=false", ConfigurableApplicationContext context = initContext("spring.cloud.openfeign.httpclient.enabled=false",
"spring.cloud.loadbalancer.retry.enabled=false"); "spring.cloud.loadbalancer.retry.enabled=false");
assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class); assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class);
assertLoadBalanced(context, Client.Default.class); assertLoadBalanced(context, Client.Default.class);
@@ -58,9 +58,9 @@ class FeignLoadBalancerAutoConfigurationTests {
@Test @Test
void shouldInstantiateOkHttpFeignClientWhenEnabled() { void shouldInstantiateOkHttpFeignClientWhenEnabled() {
ConfigurableApplicationContext context = initContext("feign.httpclient.enabled=false", ConfigurableApplicationContext context = initContext("spring.cloud.openfeign.httpclient.enabled=false",
"feign.okhttp.enabled=true", "spring.cloud.loadbalancer.retry.enabled=false", "spring.cloud.openfeign.okhttp.enabled=true", "spring.cloud.loadbalancer.retry.enabled=false",
"feign.httpclient.okhttp.read-timeout=9s"); "spring.cloud.openfeign.httpclient.okhttp.read-timeout=9s");
assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class); assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class);
Map<String, FeignBlockingLoadBalancerClient> beans = context Map<String, FeignBlockingLoadBalancerClient> beans = context
.getBeansOfType(FeignBlockingLoadBalancerClient.class); .getBeansOfType(FeignBlockingLoadBalancerClient.class);
@@ -75,8 +75,8 @@ class FeignLoadBalancerAutoConfigurationTests {
@Test @Test
void shouldInstantiateHttpFeignClient5WhenEnabled() { void shouldInstantiateHttpFeignClient5WhenEnabled() {
ConfigurableApplicationContext context = initContext("feign.httpclient.enabled=false", ConfigurableApplicationContext context = initContext("spring.cloud.openfeign.httpclient.enabled=false",
"feign.okhttp.enabled=false", "feign.httpclient.hc5.enabled=true", "spring.cloud.openfeign.okhttp.enabled=false", "spring.cloud.openfeign.httpclient.hc5.enabled=true",
"spring.cloud.loadbalancer.retry.enabled=false"); "spring.cloud.loadbalancer.retry.enabled=false");
assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class); assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class);
assertLoadBalanced(context, ApacheHttp5Client.class); assertLoadBalanced(context, ApacheHttp5Client.class);
@@ -84,8 +84,8 @@ class FeignLoadBalancerAutoConfigurationTests {
@Test @Test
void shouldInstantiateHttpFeignClient5WhenBothHttpClientAndHttpClient5Enabled() { void shouldInstantiateHttpFeignClient5WhenBothHttpClientAndHttpClient5Enabled() {
ConfigurableApplicationContext context = initContext("feign.httpclient.enabled=true", ConfigurableApplicationContext context = initContext("spring.cloud.openfeign.httpclient.enabled=true",
"feign.okhttp.enabled=false", "feign.httpclient.hc5.enabled=true", "spring.cloud.openfeign.okhttp.enabled=false", "spring.cloud.openfeign.httpclient.hc5.enabled=true",
"spring.cloud.loadbalancer.retry.enabled=false"); "spring.cloud.loadbalancer.retry.enabled=false");
assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class); assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class);
assertLoadBalanced(context, ApacheHttp5Client.class); assertLoadBalanced(context, ApacheHttp5Client.class);
@@ -93,7 +93,7 @@ class FeignLoadBalancerAutoConfigurationTests {
@Test @Test
void shouldInstantiateRetryableDefaultFeignBlockingLoadBalancerClientWhenHttpClientDisabled() { void shouldInstantiateRetryableDefaultFeignBlockingLoadBalancerClientWhenHttpClientDisabled() {
ConfigurableApplicationContext context = initContext("feign.httpclient.enabled=false"); ConfigurableApplicationContext context = initContext("spring.cloud.openfeign.httpclient.enabled=false");
assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class); assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class);
assertLoadBalancedWithRetries(context, Client.Default.class); assertLoadBalancedWithRetries(context, Client.Default.class);
} }
@@ -107,24 +107,24 @@ class FeignLoadBalancerAutoConfigurationTests {
@Test @Test
void shouldInstantiateRetryableOkHttpFeignClientWhenEnabled() { void shouldInstantiateRetryableOkHttpFeignClientWhenEnabled() {
ConfigurableApplicationContext context = initContext("feign.httpclient.enabled=false", ConfigurableApplicationContext context = initContext("spring.cloud.openfeign.httpclient.enabled=false",
"feign.okhttp.enabled=true"); "spring.cloud.openfeign.okhttp.enabled=true");
assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class); assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class);
assertLoadBalancedWithRetries(context, OkHttpClient.class); assertLoadBalancedWithRetries(context, OkHttpClient.class);
} }
@Test @Test
void shouldInstantiateRetryableHttpFeignClient5WhenEnabled() { void shouldInstantiateRetryableHttpFeignClient5WhenEnabled() {
ConfigurableApplicationContext context = initContext("feign.httpclient.enabled=false", ConfigurableApplicationContext context = initContext("spring.cloud.openfeign.httpclient.enabled=false",
"feign.okhttp.enabled=false", "feign.httpclient.hc5.enabled=true"); "spring.cloud.openfeign.okhttp.enabled=false", "spring.cloud.openfeign.httpclient.hc5.enabled=true");
assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class); assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class);
assertLoadBalancedWithRetries(context, ApacheHttp5Client.class); assertLoadBalancedWithRetries(context, ApacheHttp5Client.class);
} }
@Test @Test
void shouldInstantiateRetryableHttpFeignClient5WhenBothHttpClientAndHttpClient5Enabled() { void shouldInstantiateRetryableHttpFeignClient5WhenBothHttpClientAndHttpClient5Enabled() {
ConfigurableApplicationContext context = initContext("feign.httpclient.enabled=true", ConfigurableApplicationContext context = initContext("spring.cloud.openfeign.httpclient.enabled=true",
"feign.okhttp.enabled=false", "feign.httpclient.hc5.enabled=true"); "spring.cloud.openfeign.okhttp.enabled=false", "spring.cloud.openfeign.httpclient.hc5.enabled=true");
assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class); assertThatOneBeanPresent(context, BlockingLoadBalancerClient.class);
assertLoadBalancedWithRetries(context, ApacheHttp5Client.class); assertLoadBalancedWithRetries(context, ApacheHttp5Client.class);
} }
@@ -22,9 +22,11 @@ import java.io.IOException;
import java.io.InputStream; import java.io.InputStream;
import java.net.URI; import java.net.URI;
import java.nio.charset.StandardCharsets; import java.nio.charset.StandardCharsets;
import java.util.Arrays;
import java.util.Collection; import java.util.Collection;
import java.util.Collections; import java.util.Collections;
import java.util.HashMap; import java.util.HashMap;
import java.util.List;
import java.util.Map; import java.util.Map;
import java.util.UUID; import java.util.UUID;
import java.util.concurrent.ConcurrentHashMap; import java.util.concurrent.ConcurrentHashMap;
@@ -69,9 +71,10 @@ import static org.mockito.Mockito.when;
* Commons project, so here we are only testing the interactions between * Commons project, so here we are only testing the interactions between
* {@link RetryableFeignBlockingLoadBalancerClient} and its delegates. * {@link RetryableFeignBlockingLoadBalancerClient} and its delegates.
* *
* @author Olga Maciaszek-Sharma
* @author changjin wei(魏昌进)
* @see <a href= * @see <a href=
* "https://github.com/spring-cloud/spring-cloud-commons/blob/main/spring-cloud-loadbalancer/src/test/java/org/springframework/cloud/loadbalancer/blocking/client/BlockingLoadBalancerClientTests.java">BlockingLoadBalancerClientTests</a> * "https://github.com/spring-cloud/spring-cloud-commons/blob/main/spring-cloud-loadbalancer/src/test/java/org/springframework/cloud/loadbalancer/blocking/client/BlockingLoadBalancerClientTests.java">BlockingLoadBalancerClientTests</a>
* @author Olga Maciaszek-Sharma
*/ */
@ExtendWith(MockitoExtension.class) @ExtendWith(MockitoExtension.class)
class RetryableFeignBlockingLoadBalancerClientTests { class RetryableFeignBlockingLoadBalancerClientTests {
@@ -86,8 +89,11 @@ class RetryableFeignBlockingLoadBalancerClientTests {
private final LoadBalancerProperties properties = new LoadBalancerProperties(); private final LoadBalancerProperties properties = new LoadBalancerProperties();
private final List<LoadBalancerFeignRequestTransformer> transformers = Arrays.asList(new InstanceIdTransformer(),
new ServiceIdTransformer());
private final RetryableFeignBlockingLoadBalancerClient feignBlockingLoadBalancerClient = new RetryableFeignBlockingLoadBalancerClient( private final RetryableFeignBlockingLoadBalancerClient feignBlockingLoadBalancerClient = new RetryableFeignBlockingLoadBalancerClient(
delegate, loadBalancerClient, retryFactory, properties, loadBalancerClientFactory); delegate, loadBalancerClient, retryFactory, loadBalancerClientFactory, transformers);
private final ServiceInstance serviceInstance = new DefaultServiceInstance("test-a", "test", "testhost", 80, false); private final ServiceInstance serviceInstance = new DefaultServiceInstance("test-a", "test", "testhost", 80, false);
@@ -197,9 +203,11 @@ class RetryableFeignBlockingLoadBalancerClientTests {
Request actualRequest = captor.getValue(); Request actualRequest = captor.getValue();
assertThat(actualRequest.httpMethod()).isEqualTo(Request.HttpMethod.GET); assertThat(actualRequest.httpMethod()).isEqualTo(Request.HttpMethod.GET);
assertThat(actualRequest.url()).isEqualTo(url); assertThat(actualRequest.url()).isEqualTo(url);
assertThat(actualRequest.headers()).hasSize(1); assertThat(actualRequest.headers()).hasSize(3);
assertThat(actualRequest.headers()).containsEntry(HttpHeaders.CONTENT_TYPE, assertThat(actualRequest.headers()).containsEntry(HttpHeaders.CONTENT_TYPE,
Collections.singletonList(MediaType.APPLICATION_JSON_VALUE)); Collections.singletonList(MediaType.APPLICATION_JSON_VALUE));
assertThat(actualRequest.headers()).containsEntry("X-ServiceId", Collections.singletonList("test"));
assertThat(actualRequest.headers()).containsEntry("X-InstanceId", Collections.singletonList("test-1"));
assertThat(new String(actualRequest.body())).isEqualTo("hello"); assertThat(new String(actualRequest.body())).isEqualTo("hello");
} }
@@ -310,4 +318,28 @@ class RetryableFeignBlockingLoadBalancerClientTests {
} }
private static class InstanceIdTransformer implements LoadBalancerFeignRequestTransformer {
@Override
public Request transformRequest(Request request, ServiceInstance instance) {
Map<String, Collection<String>> headers = new HashMap<>(request.headers());
headers.put("X-InstanceId", Collections.singletonList(instance.getInstanceId()));
return Request.create(request.httpMethod(), request.url(), headers, request.body(), request.charset(),
request.requestTemplate());
}
}
private static class ServiceIdTransformer implements LoadBalancerFeignRequestTransformer {
@Override
public Request transformRequest(Request request, ServiceInstance instance) {
Map<String, Collection<String>> headers = new HashMap<>(request.headers());
headers.put("X-ServiceId", Collections.singletonList(instance.getServiceId()));
return Request.create(request.httpMethod(), request.url(), headers, request.body(), request.charset(),
request.requestTemplate());
}
}
} }
@@ -16,8 +16,7 @@
package org.springframework.cloud.openfeign.security; package org.springframework.cloud.openfeign.security;
import javax.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletRequest;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
@@ -44,8 +43,8 @@ import static org.springframework.boot.test.context.SpringBootTest.WebEnvironmen
webEnvironment = RANDOM_PORT, webEnvironment = RANDOM_PORT,
value = { "security.oauth2.client.id=test-service", "security.oauth2.client.client-id=test-service", value = { "security.oauth2.client.id=test-service", "security.oauth2.client.client-id=test-service",
"security.oauth2.client.client-secret=test-service", "security.oauth2.client.client-secret=test-service",
"security.oauth2.client.grant-type=client_credentials", "feign.oauth2.enabled=true", "security.oauth2.client.grant-type=client_credentials", "spring.cloud.openfeign.oauth2.enabled=true",
"feign.oauth2.load-balanced=true" }) "spring.cloud.openfeign.oauth2.load-balanced=true" })
@DirtiesContext @DirtiesContext
public class AccessTokenProviderWithLoadBalancerInterceptorTests { public class AccessTokenProviderWithLoadBalancerInterceptorTests {
@@ -16,8 +16,7 @@
package org.springframework.cloud.openfeign.security; package org.springframework.cloud.openfeign.security;
import javax.servlet.http.HttpServletRequest; import jakarta.servlet.http.HttpServletRequest;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
@@ -44,7 +43,7 @@ import static org.springframework.boot.test.context.SpringBootTest.WebEnvironmen
webEnvironment = RANDOM_PORT, webEnvironment = RANDOM_PORT,
value = { "security.oauth2.client.id=test-service", "security.oauth2.client.client-id=test-service", value = { "security.oauth2.client.id=test-service", "security.oauth2.client.client-id=test-service",
"security.oauth2.client.client-secret=test-service", "security.oauth2.client.client-secret=test-service",
"security.oauth2.client.grant-type=client_credentials", "feign.oauth2.enabled=true" }) "security.oauth2.client.grant-type=client_credentials", "spring.cloud.openfeign.oauth2.enabled=true" })
@DirtiesContext @DirtiesContext
public class AccessTokenProviderWithoutLoadBalancerInterceptorTests { public class AccessTokenProviderWithoutLoadBalancerInterceptorTests {
@@ -28,11 +28,11 @@ import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.cloud.openfeign.EnableFeignClients; import org.springframework.cloud.openfeign.EnableFeignClients;
import org.springframework.cloud.openfeign.FeignClient; import org.springframework.cloud.openfeign.FeignClient;
import org.springframework.cloud.openfeign.test.NoSecurityConfiguration; import org.springframework.cloud.openfeign.test.NoSecurityConfiguration;
import org.springframework.cloud.test.TestSocketUtils;
import org.springframework.context.annotation.Bean; import org.springframework.context.annotation.Bean;
import org.springframework.context.annotation.Configuration; import org.springframework.context.annotation.Configuration;
import org.springframework.context.annotation.Import; import org.springframework.context.annotation.Import;
import org.springframework.http.HttpHeaders; import org.springframework.http.HttpHeaders;
import org.springframework.util.SocketUtils;
import org.springframework.web.bind.annotation.GetMapping; import org.springframework.web.bind.annotation.GetMapping;
import org.springframework.web.bind.annotation.PostMapping; import org.springframework.web.bind.annotation.PostMapping;
import org.springframework.web.bind.annotation.RequestBody; import org.springframework.web.bind.annotation.RequestBody;
@@ -49,7 +49,7 @@ public class AbstractSpringMvcContractIntegrationTests {
@BeforeAll @BeforeAll
public static void beforeClass() { public static void beforeClass() {
System.setProperty("server.port", String.valueOf(SocketUtils.findAvailableTcpPort())); System.setProperty("server.port", String.valueOf(TestSocketUtils.findAvailableTcpPort()));
} }
@AfterAll @AfterAll
@@ -71,14 +71,18 @@ class FeignHttpClientPropertiesTests {
@Test @Test
void testCustomization() { void testCustomization() {
TestPropertyValues TestPropertyValues.of("spring.cloud.openfeign.httpclient.maxConnections=2",
.of("feign.httpclient.maxConnections=2", "feign.httpclient.connectionTimeout=2", "spring.cloud.openfeign.httpclient.connectionTimeout=2",
"feign.httpclient.maxConnectionsPerRoute=2", "feign.httpclient.timeToLive=2", "spring.cloud.openfeign.httpclient.maxConnectionsPerRoute=2",
"feign.httpclient.disableSslValidation=true", "feign.httpclient.followRedirects=false", "spring.cloud.openfeign.httpclient.timeToLive=2",
"feign.httpclient.disableSslValidation=true", "feign.httpclient.followRedirects=false", "spring.cloud.openfeign.httpclient.disableSslValidation=true",
"feign.httpclient.hc5.poolConcurrencyPolicy=lax", "feign.httpclient.hc5.poolReusePolicy=lifo", "spring.cloud.openfeign.httpclient.followRedirects=false",
"feign.httpclient.hc5.socketTimeout=200", "feign.httpclient.hc5.socketTimeoutUnit=milliseconds") "spring.cloud.openfeign.httpclient.disableSslValidation=true",
.applyTo(this.context); "spring.cloud.openfeign.httpclient.followRedirects=false",
"spring.cloud.openfeign.httpclient.hc5.poolConcurrencyPolicy=lax",
"spring.cloud.openfeign.httpclient.hc5.poolReusePolicy=lifo",
"spring.cloud.openfeign.httpclient.hc5.socketTimeout=200",
"spring.cloud.openfeign.httpclient.hc5.socketTimeoutUnit=milliseconds").applyTo(this.context);
setupContext(); setupContext();
assertThat(getProperties().getMaxConnections()).isEqualTo(2); assertThat(getProperties().getMaxConnections()).isEqualTo(2);
assertThat(getProperties().getConnectionTimeout()).isEqualTo(2); assertThat(getProperties().getConnectionTimeout()).isEqualTo(2);
@@ -21,7 +21,7 @@ import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient;
import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier; import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
@@ -30,7 +30,8 @@ import static org.assertj.core.api.Assertions.assertThat;
* @author Ram Anaswara * @author Ram Anaswara
*/ */
@SpringBootTest(classes = SpringMvcContractSlashEncodingIntegrationTests.Config.class, @SpringBootTest(classes = SpringMvcContractSlashEncodingIntegrationTests.Config.class,
webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT, properties = { "feign.client.decodeSlash=false" }) webEnvironment = SpringBootTest.WebEnvironment.DEFINED_PORT,
properties = { "spring.cloud.openfeign.client.decodeSlash=false" })
public class SpringMvcContractSlashEncodingIntegrationTests extends AbstractSpringMvcContractIntegrationTests { public class SpringMvcContractSlashEncodingIntegrationTests extends AbstractSpringMvcContractIntegrationTests {
@Autowired @Autowired
@@ -63,7 +63,8 @@ import static org.mockito.Mockito.mockingDetails;
* @author Ryan Baxter * @author Ryan Baxter
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
*/ */
@SpringBootTest(properties = { "feign.okhttp.enabled: false", "spring.cloud.loadbalancer.retry.enabled=false" }) @SpringBootTest(properties = { "spring.cloud.openfeign.okhttp.enabled: false",
"spring.cloud.loadbalancer.retry.enabled=false" })
@DirtiesContext @DirtiesContext
class ApacheHttpClientConfigurationTests { class ApacheHttpClientConfigurationTests {
@@ -24,8 +24,13 @@ import static org.assertj.core.api.Assertions.assertThat;
* {@link Object#equals(Object)} and {@link Object#hashCode()}. * {@link Object#equals(Object)} and {@link Object#hashCode()}.
* *
* @author Jonatan Ivanov * @author Jonatan Ivanov
* @author Olga Maciaszek-Sharma
*/ */
public class EqualsAndHashCodeAssert { public final class EqualsAndHashCodeAssert {
private EqualsAndHashCodeAssert() {
throw new IllegalStateException("Can't instantiate a utility class");
}
/** /**
* Checks if equals is reflexive: for any non-null reference value x, x.equals(x) * Checks if equals is reflexive: for any non-null reference value x, x.equals(x)
@@ -46,9 +46,9 @@ import static org.mockito.Mockito.mockingDetails;
* @author Ryan Baxter * @author Ryan Baxter
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
*/ */
@SpringBootTest(properties = { "feign.okhttp.enabled: true", "spring.cloud.httpclientfactories.ok.enabled: true", @SpringBootTest(properties = { "spring.cloud.openfeign.okhttp.enabled: true",
"feign.okhttp.enabled: true", "feign.httpclient.enabled: false", "spring.cloud.httpclientfactories.ok.enabled: true", "spring.cloud.openfeign.okhttp.enabled: true",
"spring.cloud.loadbalancer.retry.enabled=false" }) "spring.cloud.openfeign.httpclient.enabled: false", "spring.cloud.loadbalancer.retry.enabled=false" })
@DirtiesContext @DirtiesContext
class OkHttpClientConfigurationTests { class OkHttpClientConfigurationTests {
@@ -24,7 +24,7 @@ import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient;
import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier; import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
@@ -47,8 +47,8 @@ import static org.springframework.boot.test.context.SpringBootTest.WebEnvironmen
*/ */
@SpringBootTest(classes = FeignClientNotPrimaryTests.Application.class, webEnvironment = RANDOM_PORT, @SpringBootTest(classes = FeignClientNotPrimaryTests.Application.class, webEnvironment = RANDOM_PORT,
value = { "spring.application.name=feignclientnotprimarytest", value = { "spring.application.name=feignclientnotprimarytest",
"logging.level.org.springframework.cloud.openfeign.valid=DEBUG", "feign.httpclient.enabled=false", "logging.level.org.springframework.cloud.openfeign.valid=DEBUG",
"feign.okhttp.enabled=false" }) "spring.cloud.openfeign.httpclient.enabled=false", "spring.cloud.openfeign.okhttp.enabled=false" })
@DirtiesContext @DirtiesContext
class FeignClientNotPrimaryTests { class FeignClientNotPrimaryTests {
@@ -25,7 +25,7 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClients; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClients;
@@ -55,8 +55,8 @@ import static org.assertj.core.api.Assertions.assertThat;
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
*/ */
@SpringBootTest(classes = FeignHttpClientTests.Application.class, webEnvironment = WebEnvironment.RANDOM_PORT, @SpringBootTest(classes = FeignHttpClientTests.Application.class, webEnvironment = WebEnvironment.RANDOM_PORT,
value = { "spring.application.name=feignclienttest", "feign.circuitbreaker.enabled=false", value = { "spring.application.name=feignclienttest", "spring.cloud.openfeign.circuitbreaker.enabled=false",
"feign.okhttp.enabled=false", "spring.cloud.loadbalancer.retry.enabled=false" }) "spring.cloud.openfeign.okhttp.enabled=false", "spring.cloud.loadbalancer.retry.enabled=false" })
@DirtiesContext @DirtiesContext
class FeignHttpClientTests { class FeignHttpClientTests {
@@ -25,7 +25,7 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClients; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClients;
@@ -54,8 +54,8 @@ import static org.assertj.core.api.Assertions.assertThat;
* @author Olga Maciaszek-Sharma * @author Olga Maciaszek-Sharma
*/ */
@SpringBootTest(classes = FeignOkHttpTests.Application.class, webEnvironment = WebEnvironment.RANDOM_PORT, @SpringBootTest(classes = FeignOkHttpTests.Application.class, webEnvironment = WebEnvironment.RANDOM_PORT,
value = { "spring.application.name=feignclienttest", "feign.circuitbreaker.enabled=false", value = { "spring.application.name=feignclienttest", "spring.cloud.openfeign.circuitbreaker.enabled=false",
"feign.httpclient.enabled=false", "feign.okhttp.enabled=true", "spring.cloud.openfeign.httpclient.enabled=false", "spring.cloud.openfeign.okhttp.enabled=true",
"spring.cloud.httpclientfactories.ok.enabled=true", "spring.cloud.loadbalancer.retry.enabled=false" }) "spring.cloud.httpclientfactories.ok.enabled=true", "spring.cloud.loadbalancer.retry.enabled=false" })
@DirtiesContext @DirtiesContext
class FeignOkHttpTests { class FeignOkHttpTests {
@@ -24,7 +24,7 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient;
import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier; import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
@@ -47,8 +47,9 @@ import static org.assertj.core.api.Assertions.assertThat;
*/ */
@SpringBootTest(classes = IterableParameterTests.Application.class, webEnvironment = WebEnvironment.RANDOM_PORT, @SpringBootTest(classes = IterableParameterTests.Application.class, webEnvironment = WebEnvironment.RANDOM_PORT,
value = { "spring.application.name=iterableparametertest", value = { "spring.application.name=iterableparametertest",
"logging.level.org.springframework.cloud.openfeign.valid=DEBUG", "feign.httpclient.enabled=false", "logging.level.org.springframework.cloud.openfeign.valid=DEBUG",
"feign.okhttp.enabled=false", "feign.circuitbreaker.enabled=false" }) "spring.cloud.openfeign.httpclient.enabled=false", "spring.cloud.openfeign.okhttp.enabled=false",
"spring.cloud.openfeign.circuitbreaker.enabled=false" })
@DirtiesContext @DirtiesContext
class IterableParameterTests { class IterableParameterTests {
@@ -32,13 +32,12 @@ import java.util.Optional;
import java.util.UUID; import java.util.UUID;
import java.util.stream.Collectors; import java.util.stream.Collectors;
import javax.servlet.http.HttpServletRequest;
import javax.servlet.http.Part;
import feign.Client; import feign.Client;
import feign.Logger; import feign.Logger;
import feign.RequestInterceptor; import feign.RequestInterceptor;
import feign.codec.EncodeException; import feign.codec.EncodeException;
import jakarta.servlet.http.HttpServletRequest;
import jakarta.servlet.http.Part;
import org.junit.jupiter.api.Test; import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
@@ -47,7 +46,7 @@ import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.builder.SpringApplicationBuilder; import org.springframework.boot.builder.SpringApplicationBuilder;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.test.context.SpringBootTest.WebEnvironment; import org.springframework.boot.test.context.SpringBootTest.WebEnvironment;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClients; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClients;
@@ -99,9 +98,9 @@ import static org.springframework.http.MediaType.TEXT_PLAIN_VALUE;
*/ */
@SpringBootTest(classes = ValidFeignClientTests.Application.class, webEnvironment = WebEnvironment.RANDOM_PORT, @SpringBootTest(classes = ValidFeignClientTests.Application.class, webEnvironment = WebEnvironment.RANDOM_PORT,
value = { "spring.application.name=feignclienttest", value = { "spring.application.name=feignclienttest",
"logging.level.org.springframework.cloud.openfeign.valid=DEBUG", "feign.httpclient.enabled=false", "logging.level.org.springframework.cloud.openfeign.valid=DEBUG",
"feign.okhttp.enabled=false", "feign.circuitbreaker.enabled=true", "spring.cloud.openfeign.httpclient.enabled=false", "spring.cloud.openfeign.okhttp.enabled=false",
"spring.cloud.loadbalancer.retry.enabled=false" }) "spring.cloud.openfeign.circuitbreaker.enabled=true", "spring.cloud.loadbalancer.retry.enabled=false" })
@DirtiesContext @DirtiesContext
class ValidFeignClientTests { class ValidFeignClientTests {
@@ -21,7 +21,7 @@ import org.junit.jupiter.api.Test;
import org.springframework.beans.factory.annotation.Autowired; import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClient;
import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier; import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
@@ -43,7 +43,7 @@ import static org.springframework.boot.test.context.SpringBootTest.WebEnvironmen
* @author Ryan Baxter * @author Ryan Baxter
*/ */
@SpringBootTest(classes = FeignClientEnvVarTests.Application.class, webEnvironment = RANDOM_PORT, @SpringBootTest(classes = FeignClientEnvVarTests.Application.class, webEnvironment = RANDOM_PORT,
value = { "spring.application.name=feignclienttest", "feign.httpclient.enabled=false", value = { "spring.application.name=feignclienttest", "spring.cloud.openfeign.httpclient.enabled=false",
"basepackage=org.springframework.cloud.openfeign.testclients" }) "basepackage=org.springframework.cloud.openfeign.testclients" })
@DirtiesContext @DirtiesContext
class FeignClientEnvVarTests { class FeignClientEnvVarTests {
@@ -23,7 +23,7 @@ import org.springframework.beans.factory.annotation.Autowired;
import org.springframework.beans.factory.annotation.Value; import org.springframework.beans.factory.annotation.Value;
import org.springframework.boot.autoconfigure.EnableAutoConfiguration; import org.springframework.boot.autoconfigure.EnableAutoConfiguration;
import org.springframework.boot.test.context.SpringBootTest; import org.springframework.boot.test.context.SpringBootTest;
import org.springframework.boot.web.server.LocalServerPort; import org.springframework.boot.test.web.server.LocalServerPort;
import org.springframework.cloud.client.DefaultServiceInstance; import org.springframework.cloud.client.DefaultServiceInstance;
import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClients; import org.springframework.cloud.loadbalancer.annotation.LoadBalancerClients;
import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier; import org.springframework.cloud.loadbalancer.core.ServiceInstanceListSupplier;
@@ -45,7 +45,7 @@ import static org.springframework.boot.test.context.SpringBootTest.WebEnvironmen
* @author Spencer Gibb * @author Spencer Gibb
*/ */
@SpringBootTest(classes = FeignClientScanningTests.Application.class, webEnvironment = RANDOM_PORT, @SpringBootTest(classes = FeignClientScanningTests.Application.class, webEnvironment = RANDOM_PORT,
value = { "spring.application.name=feignclienttest", "feign.httpclient.enabled=false" }) value = { "spring.application.name=feignclienttest", "spring.cloud.openfeign.httpclient.enabled=false" })
@DirtiesContext @DirtiesContext
class FeignClientScanningTests { class FeignClientScanningTests {
@@ -24,8 +24,8 @@ management.endpoints.web.expose: '*'
--- ---
spring.config.activate.on-profile: no-metrics spring.config.activate.on-profile: no-metrics
feign.metrics.enabled: false spring.cloud.openfeign.metrics.enabled: false
--- ---
spring.config.activate.on-profile: no-foo-metrics spring.config.activate.on-profile: no-foo-metrics
feign.client.config.foo.metrics.enabled: false spring.cloud.openfeign.client.config.foo.metrics.enabled: false
@@ -1,27 +1,27 @@
# This configuration used by test class FeignClientUsingPropertiesTests # This configuration used by test class FeignClientUsingPropertiesTests
logging.level.org.springframework.cloud.openfeign=debug logging.level.org.springframework.cloud.openfeign=debug
feign.client.default-to-properties=true spring.cloud.openfeign.client.default-to-properties=true
feign.client.default-config=default spring.cloud.openfeign.client.default-config=default
feign.client.config.default.connectTimeout=5000 spring.cloud.openfeign.client.config.default.connectTimeout=5000
feign.client.config.default.readTimeout=5000 spring.cloud.openfeign.client.config.default.readTimeout=5000
feign.client.config.default.loggerLevel=full spring.cloud.openfeign.client.config.default.loggerLevel=full
feign.client.config.default.errorDecoder=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.DefaultErrorDecoder spring.cloud.openfeign.client.config.default.errorDecoder=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.DefaultErrorDecoder
feign.client.config.default.retryer=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.NoRetryer spring.cloud.openfeign.client.config.default.retryer=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.NoRetryer
feign.client.config.default.decode404=true spring.cloud.openfeign.client.config.default.decode404=true
feign.client.config.default.capabilities=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.NoOpCapability spring.cloud.openfeign.client.config.default.capabilities=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.NoOpCapability
feign.client.config.default.queryMapEncoder=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.NoOpQueryMapEncoder spring.cloud.openfeign.client.config.default.queryMapEncoder=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.NoOpQueryMapEncoder
feign.client.config.foo.requestInterceptors[0]=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.FooRequestInterceptor spring.cloud.openfeign.client.config.foo.requestInterceptors[0]=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.FooRequestInterceptor
feign.client.config.foo.requestInterceptors[1]=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.BarRequestInterceptor spring.cloud.openfeign.client.config.foo.requestInterceptors[1]=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.BarRequestInterceptor
feign.client.config.singleValue.defaultRequestHeaders[singleValueHeaders]=header spring.cloud.openfeign.client.config.singleValue.defaultRequestHeaders[singleValueHeaders]=header
feign.client.config.singleValue.defaultQueryParameters[singleValueParameters]=parameter spring.cloud.openfeign.client.config.singleValue.defaultQueryParameters[singleValueParameters]=parameter
feign.client.config.multipleValue.defaultRequestHeaders[multipleValueHeaders]=header1,header2 spring.cloud.openfeign.client.config.multipleValue.defaultRequestHeaders[multipleValueHeaders]=header1,header2
feign.client.config.multipleValue.defaultQueryParameters[multipleValueParameters]=parameter1,parameter2 spring.cloud.openfeign.client.config.multipleValue.defaultQueryParameters[multipleValueParameters]=parameter1,parameter2
feign.client.config.bar.connectTimeout=1000 spring.cloud.openfeign.client.config.bar.connectTimeout=1000
feign.client.config.bar.readTimeout=1000 spring.cloud.openfeign.client.config.bar.readTimeout=1000
feign.client.config.form.encoder=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.FormEncoder spring.cloud.openfeign.client.config.form.encoder=org.springframework.cloud.openfeign.FeignClientUsingPropertiesTests.FormEncoder
feign.client.config.unwrap.connectTimeout=1000 spring.cloud.openfeign.client.config.unwrap.connectTimeout=1000
feign.client.config.unwrap.readTimeout=1000 spring.cloud.openfeign.client.config.unwrap.readTimeout=1000
feign.client.config.unwrap.exceptionPropagationPolicy=unwrap spring.cloud.openfeign.client.config.unwrap.exceptionPropagationPolicy=unwrap
feign.client.config.readTimeout.readTimeout=1000 spring.cloud.openfeign.client.config.readTimeout.readTimeout=1000
feign.client.config.connectTimeout.connectTimeout=1000 spring.cloud.openfeign.client.config.connectTimeout.connectTimeout=1000
feign.client.config.default.followRedirects=false spring.cloud.openfeign.client.config.default.followRedirects=false
@@ -1,10 +1,10 @@
# This configuration used by test class FeignClientWithRefreshableOptionsTest # This configuration used by test class FeignClientWithRefreshableOptionsTest
logging.level.org.springframework.cloud.openfeign=debug logging.level.org.springframework.cloud.openfeign=debug
feign.client.default-to-properties=true spring.cloud.openfeign.client.default-to-properties=true
feign.client.default-config=default spring.cloud.openfeign.client.default-config=default
feign.client.refresh-enabled=true spring.cloud.openfeign.client.refresh-enabled=true
feign.client.config.default.connectTimeout=5000 spring.cloud.openfeign.client.config.default.connectTimeout=5000
feign.client.config.default.readTimeout=5000 spring.cloud.openfeign.client.config.default.readTimeout=5000
feign.client.config.default.loggerLevel=full spring.cloud.openfeign.client.config.default.loggerLevel=full
feign.client.config.connectTimeout.connectTimeout=2000 spring.cloud.openfeign.client.config.connectTimeout.connectTimeout=2000
feign.client.config.readTimeout.readTimeout=2000 spring.cloud.openfeign.client.config.readTimeout.readTimeout=2000
+8 -7
View File
@@ -6,18 +6,19 @@
<parent> <parent>
<artifactId>spring-cloud-dependencies-parent</artifactId> <artifactId>spring-cloud-dependencies-parent</artifactId>
<groupId>org.springframework.cloud</groupId> <groupId>org.springframework.cloud</groupId>
<version>3.1.3</version> <version>4.0.0-SNAPSHOT</version>
<relativePath/> <relativePath/>
</parent> </parent>
<artifactId>spring-cloud-openfeign-dependencies</artifactId> <artifactId>spring-cloud-openfeign-dependencies</artifactId>
<version>3.1.3</version> <version>4.0.0-SNAPSHOT</version>
<packaging>pom</packaging> <packaging>pom</packaging>
<name>spring-cloud-openfeign-dependencies</name> <name>spring-cloud-openfeign-dependencies</name>
<description>Spring Cloud OpenFeign Dependencies</description> <description>Spring Cloud OpenFeign Dependencies</description>
<properties> <properties>
<feign.version>11.8</feign.version> <feign.version>11.8</feign.version>
<feign-form.version>3.8.0</feign-form.version> <feign-form.version>3.8.0</feign-form.version>
<spring-security-oauth2-autoconfigure.version>2.1.2.RELEASE</spring-security-oauth2-autoconfigure.version> <!-- Deprecated - reached EOL -->
<spring-security-oauth2-autoconfigure.version>2.5.2</spring-security-oauth2-autoconfigure.version>
</properties> </properties>
<dependencyManagement> <dependencyManagement>
<dependencies> <dependencies>
@@ -57,7 +58,7 @@
<repository> <repository>
<id>spring-snapshots</id> <id>spring-snapshots</id>
<name>Spring Snapshots</name> <name>Spring Snapshots</name>
<url>https://repo.spring.io/libs-snapshot-local</url> <url>https://repo.spring.io/snapshot</url>
<snapshots> <snapshots>
<enabled>true</enabled> <enabled>true</enabled>
</snapshots> </snapshots>
@@ -68,7 +69,7 @@
<repository> <repository>
<id>spring-milestones</id> <id>spring-milestones</id>
<name>Spring Milestones</name> <name>Spring Milestones</name>
<url>https://repo.spring.io/libs-milestone-local</url> <url>https://repo.spring.io/milestone</url>
<snapshots> <snapshots>
<enabled>false</enabled> <enabled>false</enabled>
</snapshots> </snapshots>
@@ -86,7 +87,7 @@
<pluginRepository> <pluginRepository>
<id>spring-snapshots</id> <id>spring-snapshots</id>
<name>Spring Snapshots</name> <name>Spring Snapshots</name>
<url>https://repo.spring.io/libs-snapshot-local</url> <url>https://repo.spring.io/snapshot</url>
<snapshots> <snapshots>
<enabled>true</enabled> <enabled>true</enabled>
</snapshots> </snapshots>
@@ -97,7 +98,7 @@
<pluginRepository> <pluginRepository>
<id>spring-milestones</id> <id>spring-milestones</id>
<name>Spring Milestones</name> <name>Spring Milestones</name>
<url>https://repo.spring.io/libs-milestone-local</url> <url>https://repo.spring.io/milestone</url>
<snapshots> <snapshots>
<enabled>false</enabled> <enabled>false</enabled>
</snapshots> </snapshots>
+1 -1
View File
@@ -5,7 +5,7 @@
<parent> <parent>
<groupId>org.springframework.cloud</groupId> <groupId>org.springframework.cloud</groupId>
<artifactId>spring-cloud-openfeign</artifactId> <artifactId>spring-cloud-openfeign</artifactId>
<version>3.1.3</version> <version>4.0.0-SNAPSHOT</version>
<relativePath>..</relativePath> <relativePath>..</relativePath>
</parent> </parent>
<artifactId>spring-cloud-starter-openfeign</artifactId> <artifactId>spring-cloud-starter-openfeign</artifactId>
@@ -12,6 +12,8 @@
<suppress files=".*ProtobufSpringEncoderTest.*" checks="LineLengthCheck" /> <suppress files=".*ProtobufSpringEncoderTest.*" checks="LineLengthCheck" />
<suppress files=".*ProtobufTest.*" checks="LineLengthCheck" /> <suppress files=".*ProtobufTest.*" checks="LineLengthCheck" />
<suppress files=".*Hello.*" checks="RedundantModifier"/> <suppress files=".*Hello.*" checks="RedundantModifier"/>
<suppress files=".*test.*" checks="JavadocStyle"/>
<suppress files=".*test.*" checks="JavadocVariable"/>
<!-- Important --> <!-- Important -->
<suppress files=".*HttpEncoding.*" checks="InterfaceIsTypeCheck" /> <suppress files=".*HttpEncoding.*" checks="InterfaceIsTypeCheck" />
</suppressions> </suppressions>