-
Notifications
You must be signed in to change notification settings - Fork 1.9k
New issue
Have a question about this project? Sign up for a free GitHub account to open an issue and contact its maintainers and the community.
By clicking “Sign up for GitHub”, you agree to our terms of service and privacy statement. We’ll occasionally send you account related emails.
Already on GitHub? Sign in to your account
Flux type response should be corresponding to List #2199
Changes from all commits
a7d8b92
ac5af83
bffdd7e
321cdc3
5535986
71e8125
dd2b4ae
File filter
Filter by extension
Conversations
Jump to
Diff view
Diff view
There are no files selected for viewing
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -14,24 +14,34 @@ implementation to your classpath. Then configure Feign to use the reactive stre | |
public interface GitHubReactor { | ||
|
||
@RequestLine("GET /repos/{owner}/{repo}/contributors") | ||
Flux<Contributor> contributors(@Param("owner") String owner, @Param("repo") String repo); | ||
Flux<Contributor> contributorsFlux(@Param("owner") String owner, @Param("repo") String repo); | ||
|
||
@RequestLine("GET /repos/{owner}/{repo}/contributors") | ||
Mono<List<Contributor>> contributorsMono(@Param("owner") String owner, @Param("repo") String repo); | ||
|
||
class Contributor { | ||
String login; | ||
|
||
public Contributor(String login) { | ||
this.login = login; | ||
} | ||
String login; | ||
|
||
public String getLogin() { | ||
return login; | ||
} | ||
|
||
public void setLogin(String login) { | ||
this.login = login; | ||
} | ||
} | ||
} | ||
|
||
public class ExampleReactor { | ||
public static void main(String args[]) { | ||
GitHubReactor gitHub = ReactorFeign.builder() | ||
GitHubReactor gitHub = ReactorFeign.builder() | ||
.decoder(new ReactorDecoder(new JacksonDecoder())) | ||
.target(GitHubReactor.class, "https://api.github.com"); | ||
|
||
List<Contributor> contributors = gitHub.contributors("OpenFeign", "feign") | ||
.collect(Collectors.toList()) | ||
List<GitHubReactor.Contributor> contributorsFromFlux = gitHub.contributorsFlux("OpenFeign", "feign") | ||
.collectList() | ||
.block(); | ||
List<GitHubReactor.Contributor> contributorsFromMono = gitHub.contributorsMono("OpenFeign", "feign") | ||
.block(); | ||
} | ||
} | ||
|
@@ -52,7 +62,8 @@ public interface GitHubReactiveX { | |
|
||
public class ExampleRxJava2 { | ||
public static void main(String args[]) { | ||
GitHubReactiveX gitHub = RxJavaFeign.builder() | ||
GitHubReactiveX gitHub = RxJavaFeign.builder() | ||
.decoder(new RxJavaDecoder(new JacksonDecoder())) | ||
.target(GitHub.class, "https://api.github.com"); | ||
|
||
List<Contributor> contributors = gitHub.contributors("OpenFeign", "feign") | ||
|
@@ -79,33 +90,5 @@ the wrapped in the appropriate reactive wrappers. | |
### Iterable and Collections responses | ||
|
||
Due to the Synchronous nature of Feign requests, methods that return `Iterable` types must specify the collection | ||
in the `Publisher`. For `Reactor` types, this limits the use of `Flux` as a response type. If you | ||
want to use `Flux`, you will need to manually convert the `Mono` or `Iterable` response types into | ||
`Flux` using the `fromIterable` method. | ||
|
||
in the `Publisher`. For `Reactor` types, this limits the use of `Flux` as a response type. | ||
Comment on lines
90
to
+93
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The removal of the example code that demonstrates how to manually convert |
||
|
||
```java | ||
public interface GitHub { | ||
|
||
@RequestLine("GET /repos/{owner}/{repo}/contributors") | ||
Mono<List<Contributor>> contributors(@Param("owner") String owner, @Param("repo") String repo); | ||
|
||
class Contributor { | ||
String login; | ||
|
||
public Contributor(String login) { | ||
this.login = login; | ||
} | ||
} | ||
} | ||
|
||
public class ExampleApplication { | ||
public static void main(String[] args) { | ||
GitHub gitHub = ReactorFeign.builder() | ||
.target(GitHub.class, "https://api.github.com"); | ||
|
||
Mono<List<Contributor>> contributors = gitHub.contributors("OpenFeign", "feign"); | ||
Flux<Contributor> contributorFlux = Flux.fromIterable(contributors.block()); | ||
} | ||
} | ||
``` |
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,50 @@ | ||
/* | ||
* Copyright 2012-2023 The Feign 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 | ||
* | ||
* http://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 feign.reactive; | ||
|
||
import feign.FeignException; | ||
import feign.Response; | ||
import feign.Types; | ||
import feign.codec.Decoder; | ||
import reactor.core.publisher.Flux; | ||
import reactor.core.publisher.Mono; | ||
|
||
import java.io.IOException; | ||
import java.lang.reflect.Type; | ||
import java.util.List; | ||
|
||
public class ReactorDecoder implements Decoder { | ||
|
||
private final Decoder delegate; | ||
|
||
public ReactorDecoder(Decoder decoder) { | ||
this.delegate = decoder; | ||
} | ||
|
||
@Override | ||
public Object decode(Response response, Type type) throws IOException, FeignException { | ||
Class<?> rawType = Types.getRawType(type); | ||
if (rawType.isAssignableFrom(Mono.class)) { | ||
Type lastType = Types.resolveLastTypeParameter(type, Mono.class); | ||
return delegate.decode(response, lastType); | ||
} | ||
if (rawType.isAssignableFrom(Flux.class)) { | ||
Type lastType = Types.resolveLastTypeParameter(type, Flux.class); | ||
Type listType = Types.parameterize(List.class, lastType); | ||
return delegate.decode(response, listType); | ||
} | ||
|
||
return delegate.decode(response, type); | ||
} | ||
Comment on lines
+36
to
+49
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The - Type listType = Types.parameterize(List.class, lastType);
- return delegate.decode(response, listType);
+ return Flux.from(delegate.decode(response, lastType)); |
||
} |
Original file line number | Diff line number | Diff line change |
---|---|---|
|
@@ -36,7 +36,7 @@ public class ReactorInvocationHandler extends ReactiveInvocationHandler { | |
protected Publisher invoke(Method method, MethodHandler methodHandler, Object[] arguments) { | ||
Publisher<?> invocation = this.invokeMethod(methodHandler, arguments); | ||
if (Flux.class.isAssignableFrom(method.getReturnType())) { | ||
return Flux.from(invocation).subscribeOn(scheduler); | ||
return Flux.from(invocation).flatMapIterable(e -> (Iterable) e).subscribeOn(scheduler); | ||
} else if (Mono.class.isAssignableFrom(method.getReturnType())) { | ||
return Mono.from(invocation).subscribeOn(scheduler); | ||
} | ||
Comment on lines
36
to
42
There was a problem hiding this comment. Choose a reason for hiding this commentThe reason will be displayed to describe this comment to others. Learn more. The change from - return Flux.from(invocation).flatMapIterable(e -> (Iterable) e).subscribeOn(scheduler);
+ return Flux.from(invocation).flatMapIterable(e -> e instanceof Iterable ? (Iterable) e : Collections.singletonList(e)).subscribeOn(scheduler); |
||
|
Original file line number | Diff line number | Diff line change |
---|---|---|
@@ -0,0 +1,43 @@ | ||
/* | ||
* Copyright 2012-2023 The Feign 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 | ||
* | ||
* http://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 feign.reactive; | ||
|
||
import feign.FeignException; | ||
import feign.Response; | ||
import feign.Types; | ||
import feign.codec.Decoder; | ||
import io.reactivex.Flowable; | ||
|
||
import java.io.IOException; | ||
import java.lang.reflect.Type; | ||
|
||
public class RxJavaDecoder implements Decoder { | ||
|
||
private final Decoder delegate; | ||
|
||
public RxJavaDecoder(Decoder decoder) { | ||
this.delegate = decoder; | ||
} | ||
|
||
@Override | ||
public Object decode(Response response, Type type) throws IOException, FeignException { | ||
Class<?> rawType = Types.getRawType(type); | ||
if (rawType.isAssignableFrom(Flowable.class)) { | ||
Type lastType = Types.resolveLastTypeParameter(type, Flowable.class); | ||
return delegate.decode(response, lastType); | ||
} | ||
|
||
return delegate.decode(response, type); | ||
} | ||
} |
There was a problem hiding this comment.
Choose a reason for hiding this comment
The reason will be displayed to describe this comment to others. Learn more.
The
contributorsFlux
andcontributorsMono
methods have the same@RequestLine
annotation. This could lead to confusion and potential errors. Consider renaming these methods to better reflect their return types or the data they are fetching.