Skip to content

Commit 8c06dd0

Browse files
author
adriancole
committed
closes OpenFeign#35 add RequestInterceptor
1 parent 29839c9 commit 8c06dd0

8 files changed

Lines changed: 183 additions & 31 deletions

File tree

‎CHANGES.md‎

Lines changed: 3 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -1,3 +1,6 @@
1+
### Version 4.3
2+
* Add ability to configure zero or more RequestInterceptors.
3+
14
### Version 4.2/3.3
25
* Document and enforce JAX-RS annotation processing from server POV
36
* Skip query template parameters when corresponding java arg is null

‎README.md‎

Lines changed: 19 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -37,6 +37,25 @@ public static void main(String... args) {
3737

3838
Feign includes a fully functional json codec in the `feign-gson` extension. See the `Decoder` section for how to write your own.
3939

40+
### Request Interceptors
41+
When you need to change all requests, regardless of their target, you'll want to configure a `RequestInterceptor`.
42+
For example, if you are acting as an intermediary, you might want to propagate the `X-Forwarded-For` header.
43+
44+
```
45+
@Module(library = true)
46+
static class ForwardedForInterceptor implements RequestInterceptor {
47+
@Provides(type = SET) RequestInterceptor provideThis() {
48+
return this;
49+
}
50+
51+
@Override public void apply(RequestTemplate template) {
52+
template.header("X-Forwarded-For", "origin.host.com");
53+
}
54+
}
55+
...
56+
GitHub github = Feign.create(GitHub.class, "https://api.github.com", new GsonModule(), new ForwardedForInterceptor());
57+
```
58+
4059
### Observable Methods
4160
If specified as the last return type of a method `Observable<T>` will invoke a new http request for each call to `subscribe()`. This is the async equivalent to an `Iterable`.
4261
Here's how one looks:

‎core/src/main/java/feign/MethodHandler.java‎

Lines changed: 24 additions & 11 deletions
Original file line numberDiff line numberDiff line change
@@ -27,6 +27,7 @@
2727
import javax.inject.Provider;
2828
import java.io.IOException;
2929
import java.io.Reader;
30+
import java.util.Set;
3031
import java.util.concurrent.Executor;
3132
import java.util.concurrent.TimeUnit;
3233
import java.util.concurrent.atomic.AtomicBoolean;
@@ -44,29 +45,31 @@ static class Factory {
4445
private final Client client;
4546
private final Lazy<Executor> httpExecutor;
4647
private final Provider<Retryer> retryer;
48+
private final Set<RequestInterceptor> requestInterceptors;
4749
private final Logger logger;
4850
private final Provider<Logger.Level> logLevel;
4951

50-
@Inject Factory(Client client, @Named("http") Lazy<Executor> httpExecutor, Provider<Retryer> retryer, Logger logger,
51-
Provider<Logger.Level> logLevel) {
52+
@Inject Factory(Client client, @Named("http") Lazy<Executor> httpExecutor, Provider<Retryer> retryer,
53+
Set<RequestInterceptor> requestInterceptors, Logger logger, Provider<Logger.Level> logLevel) {
5254
this.client = checkNotNull(client, "client");
5355
this.httpExecutor = checkNotNull(httpExecutor, "httpExecutor");
5456
this.retryer = checkNotNull(retryer, "retryer");
57+
this.requestInterceptors = checkNotNull(requestInterceptors, "requestInterceptors");
5558
this.logger = checkNotNull(logger, "logger");
5659
this.logLevel = checkNotNull(logLevel, "logLevel");
5760
}
5861

5962
public MethodHandler create(Target<?> target, MethodMetadata md, BuildTemplateFromArgs buildTemplateFromArgs,
6063
Options options, Decoder.TextStream<?> decoder, ErrorDecoder errorDecoder) {
61-
return new SynchronousMethodHandler(target, client, retryer, logger, logLevel, md, buildTemplateFromArgs, options,
62-
decoder, errorDecoder);
64+
return new SynchronousMethodHandler(target, client, retryer, requestInterceptors, logger, logLevel, md,
65+
buildTemplateFromArgs, options, decoder, errorDecoder);
6366
}
6467

6568
public MethodHandler create(Target<?> target, MethodMetadata md, BuildTemplateFromArgs buildTemplateFromArgs,
6669
Options options, IncrementalDecoder.TextStream<?> incrementalDecoder,
6770
ErrorDecoder errorDecoder) {
68-
ObserverHandler observerHandler = new ObserverHandler(target, client, retryer, logger, logLevel, md,
69-
buildTemplateFromArgs, options, incrementalDecoder, errorDecoder, httpExecutor);
71+
ObserverHandler observerHandler = new ObserverHandler(target, client, retryer, requestInterceptors, logger,
72+
logLevel, md, buildTemplateFromArgs, options, incrementalDecoder, errorDecoder, httpExecutor);
7073
return new ObservableMethodHandler(observerHandler);
7174
}
7275
}
@@ -106,12 +109,14 @@ static class ObserverHandler extends BaseMethodHandler {
106109
private final Lazy<Executor> httpExecutor;
107110
private final IncrementalDecoder.TextStream<?> incrementalDecoder;
108111

109-
private ObserverHandler(Target<?> target, Client client, Provider<Retryer> retryer, Logger logger,
112+
private ObserverHandler(Target<?> target, Client client, Provider<Retryer> retryer,
113+
Set<RequestInterceptor> requestInterceptors, Logger logger,
110114
Provider<Logger.Level> logLevel, MethodMetadata metadata,
111115
BuildTemplateFromArgs buildTemplateFromArgs, Options options,
112116
IncrementalDecoder.TextStream<?> incrementalDecoder, ErrorDecoder errorDecoder,
113117
Lazy<Executor> httpExecutor) {
114-
super(target, client, retryer, logger, logLevel, metadata, buildTemplateFromArgs, options, errorDecoder);
118+
super(target, client, retryer, requestInterceptors, logger, logLevel, metadata, buildTemplateFromArgs, options,
119+
errorDecoder);
115120
this.httpExecutor = checkNotNull(httpExecutor, "httpExecutor for %s", target);
116121
this.incrementalDecoder = checkNotNull(incrementalDecoder, "incrementalDecoder for %s", target);
117122
}
@@ -185,11 +190,13 @@ private ObserverHandler(Target<?> target, Client client, Provider<Retryer> retry
185190
static class SynchronousMethodHandler extends BaseMethodHandler {
186191
private final Decoder.TextStream<?> decoder;
187192

188-
private SynchronousMethodHandler(Target<?> target, Client client, Provider<Retryer> retryer, Logger logger,
193+
private SynchronousMethodHandler(Target<?> target, Client client, Provider<Retryer> retryer,
194+
Set<RequestInterceptor> requestInterceptors, Logger logger,
189195
Provider<Logger.Level> logLevel, MethodMetadata metadata,
190196
BuildTemplateFromArgs buildTemplateFromArgs, Options options,
191197
Decoder.TextStream<?> decoder, ErrorDecoder errorDecoder) {
192-
super(target, client, retryer, logger, logLevel, metadata, buildTemplateFromArgs, options, errorDecoder);
198+
super(target, client, retryer, requestInterceptors, logger, logLevel, metadata, buildTemplateFromArgs, options,
199+
errorDecoder);
193200
this.decoder = checkNotNull(decoder, "decoder for %s", target);
194201
}
195202

@@ -215,18 +222,21 @@ static abstract class BaseMethodHandler implements MethodHandler {
215222
protected final Target<?> target;
216223
protected final Client client;
217224
protected final Provider<Retryer> retryer;
225+
protected final Set<RequestInterceptor> requestInterceptors;
218226
protected final Logger logger;
219227
protected final Provider<Logger.Level> logLevel;
220228
protected final BuildTemplateFromArgs buildTemplateFromArgs;
221229
protected final Options options;
222230
protected final ErrorDecoder errorDecoder;
223231

224-
private BaseMethodHandler(Target<?> target, Client client, Provider<Retryer> retryer, Logger logger,
232+
private BaseMethodHandler(Target<?> target, Client client, Provider<Retryer> retryer,
233+
Set<RequestInterceptor> requestInterceptors, Logger logger,
225234
Provider<Logger.Level> logLevel, MethodMetadata metadata,
226235
BuildTemplateFromArgs buildTemplateFromArgs, Options options, ErrorDecoder errorDecoder) {
227236
this.target = checkNotNull(target, "target");
228237
this.client = checkNotNull(client, "client for %s", target);
229238
this.retryer = checkNotNull(retryer, "retryer for %s", target);
239+
this.requestInterceptors = checkNotNull(requestInterceptors, "requestInterceptors for %s", target);
230240
this.logger = checkNotNull(logger, "logger for %s", target);
231241
this.logLevel = checkNotNull(logLevel, "logLevel for %s", target);
232242
this.metadata = checkNotNull(metadata, "metadata for %s", target);
@@ -294,6 +304,9 @@ protected long elapsedTime(long start) {
294304
}
295305

296306
protected Request targetRequest(RequestTemplate template) {
307+
for (RequestInterceptor interceptor : requestInterceptors) {
308+
interceptor.apply(template);
309+
}
297310
return target.apply(new RequestTemplate(template));
298311
}
299312

‎core/src/main/java/feign/ReflectiveFeign.java‎

Lines changed: 5 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -35,6 +35,7 @@
3535
import java.util.Collection;
3636
import java.util.HashMap;
3737
import java.util.LinkedHashMap;
38+
import java.util.LinkedHashSet;
3839
import java.util.List;
3940
import java.util.Map;
4041
import java.util.Map.Entry;
@@ -105,19 +106,17 @@ static class FeignInvocationHandler implements InvocationHandler {
105106
}
106107
}
107108

108-
@dagger.Module(complete = false, injects = Feign.class, library = true)
109+
@dagger.Module(complete = false, injects = {Feign.class, MethodHandler.Factory.class}, library = true)
109110
public static class Module {
111+
@Provides(type = Provides.Type.SET_VALUES) Set<RequestInterceptor> noRequestInterceptors() {
112+
return new LinkedHashSet<RequestInterceptor>();
113+
}
110114

111115
@Provides Feign provideFeign(ReflectiveFeign in) {
112116
return in;
113117
}
114118
}
115119

116-
private static IllegalStateException noConfig(String configKey, Class<?> type) {
117-
return new IllegalStateException(format("no configuration for %s present for %s!", configKey,
118-
type.getSimpleName()));
119-
}
120-
121120
static final class ParseHandlersByName {
122121
private final Contract contract;
123122
private final Options options;
Lines changed: 70 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -0,0 +1,70 @@
1+
/*
2+
* Copyright 2013 Netflix, Inc.
3+
*
4+
* Licensed under the Apache License, Version 2.0 (the "License");
5+
* you may not use this file except in compliance with the License.
6+
* You may obtain a copy of the License at
7+
*
8+
* http://www.apache.org/licenses/LICENSE-2.0
9+
*
10+
* Unless required by applicable law or agreed to in writing, software
11+
* distributed under the License is distributed on an "AS IS" BASIS,
12+
* WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
13+
* See the License for the specific language governing permissions and
14+
* limitations under the License.
15+
*/
16+
package feign;
17+
18+
/**
19+
* Zero or more {@code RequestInterceptors} may be configured for purposes
20+
* such as adding headers to all requests. No guarantees are give with regards
21+
* to the order that interceptors are applied. Once interceptors are applied,
22+
* {@link Target#apply(RequestTemplate)} is called to create the immutable http
23+
* request sent via {@link Client#execute(Request, feign.Request.Options)}.
24+
* <br>
25+
* <br>
26+
* For example:
27+
* <br>
28+
* <pre>
29+
* public void apply(RequestTemplate input) {
30+
* input.replaceHeader(&quot;X-Auth&quot;, currentToken);
31+
* }
32+
* </pre>
33+
* <br>
34+
* <br><b>Configuration</b><br>
35+
* <br>
36+
* {@code RequestInterceptors} are configured via Dagger
37+
* {@link dagger.Provides.Type#SET set} or
38+
* {@link dagger.Provides.Type#SET_VALUES set values}
39+
* {@link dagger.Provides provider} methods.
40+
* <br>
41+
* <br>
42+
* For example:
43+
* <br>
44+
* <pre>
45+
* {@literal @}Provides(Type = SET) RequestInterceptor addTimestamp(TimestampInterceptor in) {
46+
* return in;
47+
* }
48+
* </pre>
49+
* <br>
50+
* <br><b>Implementation notes</b><br>
51+
* <br>
52+
* Do not add parameters, such as {@code /path/{foo}/bar }
53+
* in your implementation of {@link #apply(RequestTemplate)}.
54+
* <br>
55+
* Interceptors are applied after the template's parameters are
56+
* {@link RequestTemplate#resolve(java.util.Map) resolved}. This is to ensure
57+
* that you can implement signatures are interceptors.
58+
* <br>
59+
* <br><br><b>Relationship to Retrofit 1.x</b><br>
60+
* <br>
61+
* This class is similar to {@code RequestInterceptor.intercept()},
62+
* except that the implementation can read, remove, or otherwise mutate any
63+
* part of the request template.
64+
*/
65+
public interface RequestInterceptor {
66+
/**
67+
* Called for every request. Add data using methods on the supplied {@link RequestTemplate}.
68+
*/
69+
void apply(RequestTemplate template);
70+
}

‎core/src/main/java/feign/RequestTemplate.java‎

Lines changed: 2 additions & 13 deletions
Original file line numberDiff line numberDiff line change
@@ -73,19 +73,8 @@ public RequestTemplate(RequestTemplate toCopy) {
7373
}
7474

7575
/**
76-
* Targets a template to this target, adding the {@link #url() base url} and
77-
* any authentication headers.
78-
* <br>
79-
* <br>
80-
* For example:
81-
* <br>
82-
* <pre>
83-
* public Request apply(RequestTemplate input) {
84-
* input.insert(0, url());
85-
* input.replaceHeader(&quot;X-Auth&quot;, currentToken);
86-
* return input.asRequest();
87-
* }
88-
* </pre>
76+
* Resolves any templated variables in the requests path, query, or headers
77+
* against the supplied unencoded arguments.
8978
* <br>
9079
* <br><br><b>relationship to JAXRS 2.0</b><br>
9180
* <br>

‎core/src/main/java/feign/Target.java‎

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -40,7 +40,7 @@ public interface Target<T> {
4040

4141
/**
4242
* Targets a template to this target, adding the {@link #url() base url} and
43-
* any authentication headers.
43+
* any target-specific headers or query parameters.
4444
* <br>
4545
* <br>
4646
* For example:

‎core/src/test/java/feign/FeignTest.java‎

Lines changed: 59 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -18,6 +18,7 @@
1818
import com.google.common.base.Joiner;
1919
import com.google.mockwebserver.MockResponse;
2020
import com.google.mockwebserver.MockWebServer;
21+
import com.google.mockwebserver.RecordedRequest;
2122
import com.google.mockwebserver.SocketPolicy;
2223
import dagger.Lazy;
2324
import dagger.Module;
@@ -308,6 +309,64 @@ public void postBodyParam() throws IOException, InterruptedException {
308309
}
309310
}
310311

312+
@Module(library = true)
313+
static class ForwardedForInterceptor implements RequestInterceptor {
314+
@Provides(type = SET) RequestInterceptor provideThis() {
315+
return this;
316+
}
317+
318+
@Override public void apply(RequestTemplate template) {
319+
template.header("X-Forwarded-For", "origin.host.com");
320+
}
321+
}
322+
323+
@Test
324+
public void singleInterceptor() throws IOException, InterruptedException {
325+
final MockWebServer server = new MockWebServer();
326+
server.enqueue(new MockResponse().setResponseCode(200).setBody("foo"));
327+
server.play();
328+
329+
try {
330+
TestInterface api = Feign.create(TestInterface.class, "http://localhost:" + server.getPort(),
331+
new TestInterface.Module(), new ForwardedForInterceptor());
332+
333+
api.post();
334+
assertEquals(server.takeRequest().getHeader("X-Forwarded-For"), "origin.host.com");
335+
} finally {
336+
server.shutdown();
337+
}
338+
}
339+
340+
@Module(library = true)
341+
static class UserAgentInterceptor implements RequestInterceptor {
342+
@Provides(type = SET) RequestInterceptor provideThis() {
343+
return this;
344+
}
345+
346+
@Override public void apply(RequestTemplate template) {
347+
template.header("User-Agent", "Feign");
348+
}
349+
}
350+
351+
@Test
352+
public void multipleInterceptor() throws IOException, InterruptedException {
353+
final MockWebServer server = new MockWebServer();
354+
server.enqueue(new MockResponse().setResponseCode(200).setBody("foo"));
355+
server.play();
356+
357+
try {
358+
TestInterface api = Feign.create(TestInterface.class, "http://localhost:" + server.getPort(),
359+
new TestInterface.Module(), new ForwardedForInterceptor(), new UserAgentInterceptor());
360+
361+
api.post();
362+
RecordedRequest request = server.takeRequest();
363+
assertEquals(request.getHeader("X-Forwarded-For"), "origin.host.com");
364+
assertEquals(request.getHeader("User-Agent"), "Feign");
365+
} finally {
366+
server.shutdown();
367+
}
368+
}
369+
311370
@Test public void toKeyMethodFormatsAsExpected() throws Exception {
312371
assertEquals(Feign.configKey(TestInterface.class.getDeclaredMethod("post")), "TestInterface#post()");
313372
assertEquals(Feign.configKey(TestInterface.class.getDeclaredMethod("uriParam", String.class, URI.class,

0 commit comments

Comments
 (0)