src-openfeign/README.md

Feign makes writing java http clients easier

Feign is a java to http client binder inspired by Dagger, Retrofit, RxJava, JAXRS-2.0, and WebSocket. Feign's first goal was reducing the complexity of binding Denominator uniformly to http apis regardless of restfulness.

Why Feign and not X?

You can use tools like Jersey and CXF to write java clients for ReST or SOAP services. You can write your own code on top of http transport libraries like Apache HC. Feign aims to connect your code to http apis with minimal overhead and code. Via customizable decoders and error handling, you should be able to write to any text-based http api.

How does Feign work?

Feign works by processing annotations into a templatized request. Just before sending it off, arguments are applied to these templates in a straightforward fashion. While this limits Feign to only supporting text-based apis, it dramatically simplified system aspects such as replaying requests. It is also stupid easy to unit test your conversions knowing this.

Basics

Usage typically looks like this, an adaptation of the canonical Retrofit sample.

interface GitHub {
  @RequestLine("GET /repos/{owner}/{repo}/contributors")
  List<Contributor> contributors(@Named("owner") String owner, @Named("repo") String repo);
}

static class Contributor {
  String login;
  int contributions;
}

public static void main(String... args) {
  GitHub github = Feign.create(GitHub.class, "https://api.github.com", new GsonModule());

  // Fetch and print a list of the contributors to this library.
  List<Contributor> contributors = github.contributors("netflix", "feign");
  for (Contributor contributor : contributors) {
    System.out.println(contributor.login + " (" + contributor.contributions + ")");
  }
}

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

Request Interceptors

When you need to change all requests, regardless of their target, you'll want to configure a RequestInterceptor. For example, if you are acting as an intermediary, you might want to propagate the X-Forwarded-For header.

@Module(library = true)
static class ForwardedForInterceptor implements RequestInterceptor {
  @Provides(type = SET) RequestInterceptor provideThis() {
    return this;
  }

  @Override public void apply(RequestTemplate template) {
    template.header("X-Forwarded-For", "origin.host.com");
  }
}
...
GitHub github = Feign.create(GitHub.class, "https://api.github.com", new GsonModule(), new ForwardedForInterceptor());

Observable Methods

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. Here's how one looks:

Observable<Contributor> observable = github.contributorsObservable("netflix", "feign");
subscription = observable.subscribe(newObserver());
subscription = observable.subscribe(newObserver());

Observer<T> is fired as a background which adds new elements as they are decoded, or until subscription.unsubscribe() is called. Think of Observer<T> as an asynchronous equivalent to a lazy sequence.

Here's how one looks:

Observer<Contributor> printlnObserver = new Observer<Contributor>() {

  public int count;

  @Override public void onNext(Contributor element) {
    count++;
  }

  @Override public void onSuccess() {
    System.out.println("found " + count + " contributors");
  }

  @Override public void onFailure(Throwable cause) {
    cause.printStackTrace();
  }
};

For more robust integration with Observable check out RxJava.

Multiple Interfaces

Feign can produce multiple api interfaces. These are defined as Target<T> (default HardCodedTarget<T>), which allow for dynamic discovery and decoration of requests prior to execution.

For example, the following pattern might decorate each request with the current url and auth token from the identity service.

CloudDNS cloudDNS =  Feign.create().newInstance(new CloudIdentityTarget<CloudDNS>(user, apiKey));

You can find several examples in the test tree. Do take time to look at them, as seeing is believing!

Integrations

Feign intends to work well within Netflix and other Open Source communities. Modules are welcome to integrate with your favorite projects!

Gson

GsonModule adds default encoders and decoders so you get get started with a json api.

Integration requires you pass new GsonModule() to Feign.create(), or add it to your graph with Dagger:

GitHub github = Feign.create(GitHub.class, "https://api.github.com", new GsonModule());

JAX-RS

JAXRSModule overrides annotation processing to instead use standard ones supplied by the JAX-RS specification. This is currently targeted at the 1.1 spec.

Here's the example above re-written to use JAX-RS:

interface GitHub {
  @GET @Path("/repos/{owner}/{repo}/contributors")
  List<Contributor> contributors(@PathParam("owner") String owner, @PathParam("repo") String repo);
}

Ribbon

RibbonModule overrides URL resolution of Feign's client, adding smart routing and resiliency capabilities provided by Ribbon.

Integration requires you to pass your ribbon client name as the host part of the url, for example myAppProd.

MyService api = Feign.create(MyService.class, "https://myAppProd", new RibbonModule());

Decoders

The last argument to Feign.create allows you to specify additional configuration such as how to decode a responses, modeled in Dagger.

If any methods in your interface return types besides void or String, you'll need to configure a Decoder.TextStream<T> or a general one for all types (Decoder.TextStream<Object>).

The GsonModule in the feign-gson extension configures a (Decoder.TextStream<Object>) which parses objects from json using reflection.

Here's how you could write this yourself, using whatever library you prefer:

@Module(library = true)
static class JsonModule {
  @Provides(type = SET) Decoder decoder(final JsonParser parser) {
    return new Decoder.TextStream<Object>() {

      @Override public Object decode(Reader reader, Type type) throws IOException {
        return parser.readJson(reader, type);
      }

    };
  }
}

Type-specific Decoders

The generic parameter of Decoder.TextStream<T> designates which The type parameter is either a concrete type, or Object, if your decoder can handle multiple types. To add a type-specific decoder, ensure your type parameter is correct. Here's an example of an xml decoder that will only apply to methods that return ZoneList.

@Provides(type = SET) Decoder zoneListDecoder(Provider<ListHostedZonesResponseHandler> handlers) {
  return new SAXDecoder<ZoneList>(handlers){};
}

Incremental Decoding

The last argument to Feign.create allows you to specify additional configuration such as how to decode a responses, modeled in Dagger.

When using an IncrementalCallback<T>, if T is not Void or String, you'll need to configure an IncrementalDecoder.TextStream<T> or a general one for all types (IncrementalDecoder.TextStream<Object>).

The GsonModule in the feign-gson extension configures a (IncrementalDecoder.TextStream<Object>) which parses objects from json using reflection.

Here's how you could write this yourself, using whatever library you prefer:

@Provides(type = SET) IncrementalDecoder incrementalDecoder(final JsonParser parser) {
  return new IncrementalDecoder.TextStream<Object>() {

    @Override
    public void decode(Reader reader, Type type, IncrementalCallback<? super Object> observer) throws IOException {
      jsonReader.beginArray();
      while (jsonReader.hasNext()) {
        observer.onNext(parser.readJson(reader, type));
      }
      jsonReader.endArray();
    }
  };
}

Advanced usage and Dagger

Dagger

Feign can be directly wired into Dagger which keeps things at compile time and Android friendly. As opposed to exposing builders for config, Feign intends users to embed their config in Dagger.

Where possible, Feign configuration uses normal Dagger conventions. For example, Decoder bindings are of Provider.Type.SET, meaning you can make multiple bindings for all the different types you return. Here's an example of multiple decoder bindings.

@Provides(type = SET) Decoder recordListDecoder(Provider<RecordListHandler> handlers) {
  return new SAXDecoder<List<Record>>(handlers){};
}

@Provides(type = SET) Decoder directionalRecordListDecoder(Provider<DirectionalRecordListHandler> handlers) {
  return new SAXDecoder<List<DirectionalRecord>>(handlers){};
}

Logging

You can log the http messages going to and from the target by setting up a Logger. Here's the easiest way to do that:

@Module(overrides = true)
class Overrides {
  @Provides @Singleton Logger.Level provideLoggerLevel() {
    return Logger.Level.FULL;
  }

  @Provides @Singleton Logger provideLogger() {
    return new Logger.JavaLogger().appendToFile("logs/http.log");
  }
}
GitHub github = Feign.create(GitHub.class, "https://api.github.com", new GsonGitHubModule(), new Overrides());

Pattern Decoders

If you have to only grab a single field from a server response, you may find regular expressions less maintenance than writing a type adapter.

Here's how our IAM example grabs only one xml element from a response.

@Module(library = true)
static class IAMModule {
  @Provides(type = SET) Decoder arnDecoder() {
    return Decoders.firstGroup("<Arn>([\\S&&[^<]]+)</Arn>");
  }
}