Skip to content

Commit b389ef0

Browse files
author
adriancole
committed
support Feign.builder() w/ SAX decoder
1 parent 50e3cf5 commit b389ef0

5 files changed

Lines changed: 87 additions & 60 deletions

File tree

‎README.md‎

Lines changed: 9 additions & 0 deletions
Original file line numberDiff line numberDiff line change
@@ -94,6 +94,15 @@ GitHub github = Feign.create(GitHub.class, "https://api.github.com", new GsonMod
9494
### Sax
9595
[SaxDecoder](https://github.com/Netflix/feign/tree/master/sax) allows you to decode XML in a way that is compatible with normal JVM and also Android environments.
9696

97+
Here's an example of how to configure Sax response parsing:
98+
```java
99+
api = Feign.builder()
100+
.decoder(SAXDecoder.builder()
101+
.registerContentHandler(UserIdHandler.class)
102+
.build())
103+
.target(Api.class, "https://apihost");
104+
```
105+
97106
### JAX-RS
98107
[JAXRSModule](https://github.com/Netflix/feign/tree/master/jaxrs) overrides annotation processing to instead use standard ones supplied by the JAX-RS specification. This is currently targeted at the 1.1 spec.
99108

‎sax/README.md‎

Lines changed: 5 additions & 15 deletions
Original file line numberDiff line numberDiff line change
@@ -6,19 +6,9 @@ This module adds support for decoding xml via SAX.
66
Add this to your object graph like so:
77

88
```java
9-
IAM iam = Feign.create(IAM.class, "https://iam.amazonaws.com", new DecodeWithSax());
10-
11-
--snip--
12-
@Module(addsTo = Feign.Defaults.class)
13-
static class DecodeWithSax {
14-
@Provides Decoder saxDecoder(Provider<UserIdHandler> userIdHandler) {
15-
return SAXDecoder.builder() //
16-
.addContentHandler(userIdHandler) //
17-
.build();
18-
}
19-
20-
@Provides Encoder defaultEncoder() {
21-
return new Encoder.Default();
22-
}
23-
}
9+
api = Feign.builder()
10+
.decoder(SAXDecoder.builder()
11+
.registerContentHandler(UserIdHandler.class)
12+
.build())
13+
.target(Api.class, "https://apihost");
2414
```

‎sax/src/main/java/feign/sax/SAXDecoder.java‎

Lines changed: 65 additions & 14 deletions
Original file line numberDiff line numberDiff line change
@@ -16,8 +16,8 @@
1616
package feign.sax;
1717

1818
import feign.Response;
19-
import feign.codec.Decoder;
2019
import feign.codec.DecodeException;
20+
import feign.codec.Decoder;
2121
import org.xml.sax.ContentHandler;
2222
import org.xml.sax.InputSource;
2323
import org.xml.sax.SAXException;
@@ -27,6 +27,7 @@
2727
import javax.inject.Provider;
2828
import java.io.IOException;
2929
import java.io.Reader;
30+
import java.lang.reflect.Constructor;
3031
import java.lang.reflect.Type;
3132
import java.util.LinkedHashMap;
3233
import java.util.Map;
@@ -37,17 +38,28 @@
3738
import static feign.Util.resolveLastTypeParameter;
3839

3940
/**
40-
* Decodes responses using SAX. Configure using the {@link SAXDecoder.Builder
41-
* builder}.
41+
* Decodes responses using SAX, which is supported both in normal JVM environments, as well Android.
42+
* <br>
43+
* <h4>Basic example with with Feign.Builder</h4>
44+
* <br>
45+
* <pre>
46+
* api = Feign.builder()
47+
* .decoder(SAXDecoder.builder()
48+
* .registerContentHandler(ContentHandlerForFoo.class)
49+
* .registerContentHandler(ContentHandlerForBar.class)
50+
* .build())
51+
* .target(MyApi.class, "http://api");
52+
* </pre>
4253
* <p/>
43-
*
54+
* <h4>Advanced example with Dagger</h4>
55+
* <br>
4456
* <pre>
4557
* &#064;Provides
4658
* Decoder saxDecoder(Provider&lt;ContentHandlerForFoo&gt; foo, //
4759
* Provider&lt;ContentHandlerForBar&gt; bar) {
4860
* return SAXDecoder.builder() //
49-
* .addContentHandler(foo) //
50-
* .addContentHandler(bar) //
61+
* .registerContentHandler(Foo.class, foo) //
62+
* .registerContentHandler(Bar.class, bar) //
5163
* .build();
5264
* }
5365
* </pre>
@@ -63,10 +75,48 @@ public static class Builder {
6375
private final Map<Type, Provider<? extends ContentHandlerWithResult<?>>> handlerProviders =
6476
new LinkedHashMap<Type, Provider<? extends ContentHandlerWithResult<?>>>();
6577

66-
public Builder addContentHandler(Provider<? extends ContentHandlerWithResult<?>> handler) {
67-
Type type = resolveLastTypeParameter(checkNotNull(handler, "handler").getClass(), Provider.class);
68-
type = resolveLastTypeParameter(type, ContentHandlerWithResult.class);
69-
this.handlerProviders.put(type, handler);
78+
/**
79+
* Will call {@link Constructor#newInstance(Object...)} on {@code handlerClass} for each content stream.
80+
* <p/>
81+
* <h3>Note</h3>
82+
* <br/>
83+
* While this is costly vs {@code new}, it may not affect real performance due to the high cost of reading streams.
84+
*
85+
* @throws IllegalArgumentException if there's no no-arg constructor on {@code handlerClass}.
86+
*/
87+
public <T extends ContentHandlerWithResult<?>> Builder registerContentHandler(Class<T> handlerClass) {
88+
Type type = resolveLastTypeParameter(checkNotNull(handlerClass, "handlerClass"), ContentHandlerWithResult.class);
89+
return registerContentHandler(type, new NewInstanceProvider(handlerClass));
90+
}
91+
92+
private static class NewInstanceProvider<T extends ContentHandlerWithResult<?>> implements Provider<T> {
93+
private final Constructor<T> ctor;
94+
95+
private NewInstanceProvider(Class<T> clazz) {
96+
try {
97+
this.ctor = clazz.getDeclaredConstructor();
98+
// allow private or package protected ctors
99+
ctor.setAccessible(true);
100+
} catch (NoSuchMethodException e) {
101+
throw new IllegalArgumentException("ensure " + clazz + " has a no-args constructor", e);
102+
}
103+
}
104+
105+
@Override public T get() {
106+
try {
107+
return ctor.newInstance();
108+
} catch (Exception e) {
109+
throw new IllegalArgumentException("exception attempting to instantiate " + ctor, e);
110+
}
111+
}
112+
}
113+
114+
/**
115+
* Will call {@link Provider#get()} on {@code handler} for each content stream.
116+
* The {@code handler} is expected to have a generic parameter of {@code type}.
117+
*/
118+
public Builder registerContentHandler(Type type, Provider<? extends ContentHandlerWithResult<?>> handler) {
119+
this.handlerProviders.put(checkNotNull(type, "type"), checkNotNull(handler, "handler"));
70120
return this;
71121
}
72122

@@ -75,11 +125,12 @@ public SAXDecoder build() {
75125
}
76126
}
77127

78-
/* Implementations are not intended to be shared across requests. */
128+
/**
129+
* Implementations are not intended to be shared across requests.
130+
*/
79131
public interface ContentHandlerWithResult<T> extends ContentHandler {
80-
/*
81-
* expected to be set following a call to {@link
82-
* XMLReader#parse(InputSource)}
132+
/**
133+
* expected to be set following a call to {@link XMLReader#parse(InputSource)}
83134
*/
84135
T result();
85136
}

‎sax/src/test/java/feign/sax/SAXDecoderTest.java‎

Lines changed: 4 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -17,9 +17,8 @@
1717

1818
import dagger.ObjectGraph;
1919
import dagger.Provides;
20-
import feign.codec.Decoder;
21-
import feign.codec.DecodeException;
2220
import feign.Response;
21+
import feign.codec.Decoder;
2322
import org.testng.annotations.BeforeClass;
2423
import org.testng.annotations.Test;
2524
import org.xml.sax.helpers.DefaultHandler;
@@ -39,11 +38,10 @@ public class SAXDecoderTest {
3938

4039
@dagger.Module(injects = SAXDecoderTest.class)
4140
static class Module {
42-
@Provides Decoder saxDecoder(Provider<NetworkStatusHandler> networkStatus, //
43-
Provider<NetworkStatusStringHandler> networkStatusAsString) {
41+
@Provides Decoder saxDecoder(Provider<NetworkStatusHandler> networkStatus) {
4442
return SAXDecoder.builder() //
45-
.addContentHandler(networkStatus) //
46-
.addContentHandler(networkStatusAsString) //
43+
.registerContentHandler(NetworkStatus.class, networkStatus) //
44+
.registerContentHandler(NetworkStatusStringHandler.class) //
4745
.build();
4846
}
4947
}

‎sax/src/test/java/feign/sax/examples/IAMExample.java‎

Lines changed: 4 additions & 25 deletions
Original file line numberDiff line numberDiff line change
@@ -15,29 +15,24 @@
1515
*/
1616
package feign.sax.examples;
1717

18-
import dagger.Module;
19-
import dagger.Provides;
2018
import feign.Feign;
2119
import feign.Request;
2220
import feign.RequestLine;
2321
import feign.RequestTemplate;
2422
import feign.Target;
25-
import feign.codec.Decoder;
26-
import feign.codec.Encoder;
2723
import feign.sax.SAXDecoder;
2824
import org.xml.sax.helpers.DefaultHandler;
2925

30-
import javax.inject.Inject;
31-
import javax.inject.Provider;
32-
3326
public class IAMExample {
3427

3528
interface IAM {
3629
@RequestLine("GET /?Action=GetUser&Version=2010-05-08") Long userId();
3730
}
3831

3932
public static void main(String... args) {
40-
IAM iam = Feign.create(new IAMTarget(args[0], args[1]), new DecodeWithSax());
33+
IAM iam = Feign.builder()//
34+
.decoder(SAXDecoder.builder().registerContentHandler(UserIdHandler.class).build())//
35+
.target(new IAMTarget(args[0], args[1]));
4136
System.out.println(iam.userId());
4237
}
4338

@@ -65,23 +60,7 @@ private IAMTarget(String accessKey, String secretKey) {
6560
}
6661
}
6762

68-
@Module(addsTo = Feign.Defaults.class)
69-
static class DecodeWithSax {
70-
@Provides Decoder saxDecoder(Provider<UserIdHandler> userIdHandler) {
71-
return SAXDecoder.builder() //
72-
.addContentHandler(userIdHandler) //
73-
.build();
74-
}
75-
76-
@Provides Encoder defaultEncoder() {
77-
return new Encoder.Default();
78-
}
79-
}
80-
81-
static class UserIdHandler extends DefaultHandler implements
82-
SAXDecoder.ContentHandlerWithResult<Long> {
83-
@Inject UserIdHandler() {
84-
}
63+
static class UserIdHandler extends DefaultHandler implements SAXDecoder.ContentHandlerWithResult<Long> {
8564

8665
private StringBuilder currentText = new StringBuilder();
8766

0 commit comments

Comments
 (0)