-
Notifications
You must be signed in to change notification settings - Fork 1.9k
Expand file tree
/
Copy pathAsyncFeign.java
More file actions
285 lines (245 loc) · 9.27 KB
/
Copy pathAsyncFeign.java
File metadata and controls
285 lines (245 loc) · 9.27 KB
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
/*
* Copyright © 2012 The Feign Authors (feign@commonhaus.dev)
*
* 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;
import feign.InvocationHandlerFactory.MethodHandler;
import feign.Logger.Level;
import feign.Request.Options;
import feign.Target.HardCodedTarget;
import feign.codec.Decoder;
import feign.codec.Encoder;
import feign.codec.ErrorDecoder;
import feign.interceptor.MethodInterceptor;
import java.util.concurrent.CompletableFuture;
import java.util.concurrent.ExecutorService;
import java.util.concurrent.Executors;
import java.util.function.Supplier;
/**
* Enhances {@link Feign} to provide support for asynchronous clients. Context (for example for
* session cookies or tokens) is explicit, as calls for the same session may be done across several
* threads. <br>
* <br>
* {@link Retryer} is not supported in this model, as that is a blocking API. {@link
* ExceptionPropagationPolicy} is made redundant as {@link RetryableException} is never thrown. <br>
* Alternative approaches to retrying can be handled through {@link AsyncClient clients}. <br>
* <br>
* Target interface methods must return {@link CompletableFuture} with a non-wildcard type. As the
* completion is done by the {@link AsyncClient}, it is important that any subsequent processing on
* the thread be short - generally, this should involve notifying some other thread of the work to
* be done (for example, creating and submitting a task to an {@link ExecutorService}).
*/
@Experimental
public final class AsyncFeign<C> {
public static <C> AsyncBuilder<C> builder() {
return new AsyncBuilder<>();
}
/**
* @deprecated use {@link #builder()} instead.
*/
@Deprecated()
public static <C> AsyncBuilder<C> asyncBuilder() {
return builder();
}
/**
* Creates the default {@link ExecutorService} used when neither a custom {@link AsyncClient} nor
* a custom executor is provided. The executor is created per built client (instance scoped)
* rather than being held in a static singleton, so that it - together with its daemon threads -
* becomes eligible for garbage collection once the owning client is discarded. This avoids the
* {@code ClassLoader} leak that a static singleton causes on application redeployments inside
* servlet containers (see gh-3178).
*/
private static ExecutorService defaultExecutorService() {
return Executors.newCachedThreadPool(
r -> {
final Thread result = new Thread(r);
result.setDaemon(true);
return result;
});
}
public static class AsyncBuilder<C> extends BaseBuilder<AsyncBuilder<C>, AsyncFeign<C>> {
private AsyncContextSupplier<C> defaultContextSupplier = () -> null;
private AsyncClient<C> client;
private ExecutorService executorService;
private MethodInfoResolver methodInfoResolver = MethodInfo::new;
@Deprecated
public AsyncBuilder<C> defaultContextSupplier(Supplier<C> supplier) {
this.defaultContextSupplier = supplier::get;
return this;
}
public AsyncBuilder<C> client(AsyncClient<C> client) {
this.client = client;
return this;
}
/**
* Sets the {@link ExecutorService} used by the default {@link AsyncClient} to run the
* (blocking) underlying client calls. When provided, the caller owns the executor's lifecycle
* and is responsible for shutting it down. This is the recommended way to avoid the {@code
* ClassLoader} leak described in gh-3178: supply a managed, shut-downable executor instead of
* relying on the built-in default. Ignored when a custom {@link #client(AsyncClient)} is
* supplied.
*/
public AsyncBuilder<C> executorService(ExecutorService executorService) {
this.executorService = executorService;
return this;
}
private AsyncClient<C> resolveClient() {
if (client != null) {
return client;
}
final ExecutorService executor =
executorService != null ? executorService : defaultExecutorService();
return new DefaultAsyncClient<>(new DefaultClient(null, null), executor);
}
public AsyncBuilder<C> methodInfoResolver(MethodInfoResolver methodInfoResolver) {
this.methodInfoResolver = methodInfoResolver;
return this;
}
@Override
public AsyncBuilder<C> mapAndDecode(ResponseMapper mapper, Decoder decoder) {
return super.mapAndDecode(mapper, decoder);
}
@Override
public AsyncBuilder<C> decoder(Decoder decoder) {
return super.decoder(decoder);
}
@Override
@Deprecated
public AsyncBuilder<C> decode404() {
return super.decode404();
}
@Override
public AsyncBuilder<C> dismiss404() {
return super.dismiss404();
}
@Override
public AsyncBuilder<C> errorDecoder(ErrorDecoder errorDecoder) {
return super.errorDecoder(errorDecoder);
}
@Override
public AsyncBuilder<C> doNotCloseAfterDecode() {
return super.doNotCloseAfterDecode();
}
@Override
public AsyncBuilder<C> decodeVoid() {
return super.decodeVoid();
}
public AsyncBuilder<C> defaultContextSupplier(AsyncContextSupplier<C> supplier) {
this.defaultContextSupplier = supplier;
return this;
}
public <T> T target(Class<T> apiType, String url) {
return target(new HardCodedTarget<>(apiType, url));
}
public <T> T target(Class<T> apiType, String url, C context) {
return target(new HardCodedTarget<>(apiType, url), context);
}
public <T> T target(Target<T> target) {
return build().newInstance(target);
}
public <T> T target(Target<T> target, C context) {
return build().newInstance(target, context);
}
@Override
public AsyncBuilder<C> logLevel(Level logLevel) {
return super.logLevel(logLevel);
}
@Override
public AsyncBuilder<C> contract(Contract contract) {
return super.contract(contract);
}
@Override
public AsyncBuilder<C> logger(Logger logger) {
return super.logger(logger);
}
@Override
public AsyncBuilder<C> encoder(Encoder encoder) {
return super.encoder(encoder);
}
@Override
public AsyncBuilder<C> queryMapEncoder(QueryMapEncoder queryMapEncoder) {
return super.queryMapEncoder(queryMapEncoder);
}
@Override
public AsyncBuilder<C> options(Options options) {
return super.options(options);
}
@Override
public AsyncBuilder<C> requestInterceptor(RequestInterceptor requestInterceptor) {
return super.requestInterceptor(requestInterceptor);
}
@Override
public AsyncBuilder<C> requestInterceptors(Iterable<RequestInterceptor> requestInterceptors) {
return super.requestInterceptors(requestInterceptors);
}
@Override
public AsyncBuilder<C> methodInterceptor(MethodInterceptor methodInterceptor) {
return super.methodInterceptor(methodInterceptor);
}
@Override
public AsyncBuilder<C> methodInterceptors(Iterable<MethodInterceptor> methodInterceptors) {
return super.methodInterceptors(methodInterceptors);
}
@Override
public AsyncBuilder<C> invocationHandlerFactory(
InvocationHandlerFactory invocationHandlerFactory) {
return super.invocationHandlerFactory(invocationHandlerFactory);
}
@Override
public AsyncFeign<C> internalBuild() {
final AsyncClient<C> client = resolveClient();
AsyncResponseHandler responseHandler =
(AsyncResponseHandler)
Capability.enrich(
new AsyncResponseHandler(
logLevel,
logger,
decoder,
errorDecoder,
dismiss404,
closeAfterDecode,
decodeVoid,
responseInterceptorChain()),
AsyncResponseHandler.class,
capabilities);
final MethodHandler.Factory<C> methodHandlerFactory =
new AsynchronousMethodHandler.Factory<>(
client,
retryer,
requestInterceptors,
methodInterceptors,
responseHandler,
logger,
logLevel,
propagationPolicy,
methodInfoResolver,
new RequestTemplateFactoryResolver(encoder, queryMapEncoder),
options);
final ReflectiveFeign<C> feign =
new ReflectiveFeign<>(
contract, methodHandlerFactory, invocationHandlerFactory, defaultContextSupplier);
return new AsyncFeign<>(feign);
}
}
private final ReflectiveFeign<C> feign;
private AsyncFeign(ReflectiveFeign<C> feign) {
this.feign = feign;
}
public <T> T newInstance(Target<T> target) {
return feign.newInstance(target);
}
public <T> T newInstance(Target<T> target, C context) {
return feign.newInstance(target, context);
}
}