feign.Feign Maven / Gradle / Ivy

Go to download
/*
 * 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;

import feign.InvocationHandlerFactory.MethodHandler;
import feign.Request.Options;
import feign.Target.HardCodedTarget;
import feign.codec.Decoder;
import feign.codec.Encoder;
import feign.codec.ErrorDecoder;
import java.io.IOException;
import java.lang.reflect.Method;
import java.lang.reflect.Type;

/**
 * Feign's purpose is to ease development against http apis that feign restfulness. 

 * In implementation, Feign is a {@link Feign#newInstance factory} for generating {@link Target
 * targeted} http apis.
 */
public abstract class Feign {

  public static Builder builder() {
    return new Builder();
  }

  /**
   * Configuration keys are formatted as unresolved see
   * tags. This method exposes that format, in case you need to create the same value as
   * {@link MethodMetadata#configKey()} for correlation purposes.
   *
   * 
   * Here are some sample encodings:
   *
   * 
   * 
   *   {@code
   * Route53
   * }: would match a class {@code
   * route53.Route53
   * }
   *   {@code Route53#list()}: would match a method {@code route53.Route53#list()}
   *   {@code Route53#listAt(Marker)}: would match a method {@code
   * route53.Route53#listAt(Marker)}
   *   {@code Route53#listByNameAndType(String, String)}: would match a method {@code
   * route53.Route53#listAt(String, String)}
   * 
   * 
   *
   * Note that there is no whitespace expected in a key!
   *
   * @param targetType {@link feign.Target#type() type} of the Feign interface.
   * @param method invoked method, present on {@code type} or its super.
   * @see MethodMetadata#configKey()
   */
  public static String configKey(Class targetType, Method method) {
    StringBuilder builder = new StringBuilder();
    builder.append(targetType.getSimpleName());
    builder.append('#').append(method.getName()).append('(');
    for (Type param : method.getGenericParameterTypes()) {
      param = Types.resolve(targetType, targetType, param);
      builder.append(Types.getRawType(param).getSimpleName()).append(',');
    }
    if (method.getParameterTypes().length > 0) {
      builder.deleteCharAt(builder.length() - 1);
    }
    return builder.append(')').toString();
  }

  /**
   * @deprecated use {@link #configKey(Class, Method)} instead.
   */
  @Deprecated
  public static String configKey(Method method) {
    return configKey(method.getDeclaringClass(), method);
  }

  /**
   * Returns a new instance of an HTTP API, defined by annotations in the {@link Feign Contract},
   * for the specified {@code target}. You should cache this result.
   */
  public abstract  T newInstance(Target target);

  public static class Builder extends BaseBuilder {

    private Client client = new Client.Default(null, null);

    @Override
    public Builder logLevel(Logger.Level logLevel) {
      return super.logLevel(logLevel);
    }

    @Override
    public Builder contract(Contract contract) {
      return super.contract(contract);
    }

    public Builder client(Client client) {
      this.client = client;

      return this;
    }

    @Override
    public Builder retryer(Retryer retryer) {
      return super.retryer(retryer);
    }

    @Override
    public Builder logger(Logger logger) {
      return super.logger(logger);
    }

    @Override
    public Builder encoder(Encoder encoder) {
      return super.encoder(encoder);
    }

    @Override
    public Builder decoder(Decoder decoder) {
      return super.decoder(decoder);
    }

    @Override
    public Builder queryMapEncoder(QueryMapEncoder queryMapEncoder) {
      return super.queryMapEncoder(queryMapEncoder);
    }

    @Override
    public Builder mapAndDecode(ResponseMapper mapper, Decoder decoder) {
      return super.mapAndDecode(mapper, decoder);
    }

    @Deprecated
    @Override
    public Builder decode404() {
      return super.decode404();
    }

    @Override
    public Builder errorDecoder(ErrorDecoder errorDecoder) {
      return super.errorDecoder(errorDecoder);
    }

    @Override
    public Builder options(Options options) {
      return super.options(options);
    }

    @Override
    public Builder requestInterceptor(RequestInterceptor requestInterceptor) {
      return super.requestInterceptor(requestInterceptor);
    }

    @Override
    public Builder requestInterceptors(Iterable requestInterceptors) {
      return super.requestInterceptors(requestInterceptors);
    }

    @Override
    public Builder invocationHandlerFactory(InvocationHandlerFactory invocationHandlerFactory) {
      return super.invocationHandlerFactory(invocationHandlerFactory);
    }

    @Override
    public Builder doNotCloseAfterDecode() {
      return super.doNotCloseAfterDecode();
    }

    @Override
    public Builder decodeVoid() {
      return super.decodeVoid();
    }

    @Override
    public Builder exceptionPropagationPolicy(ExceptionPropagationPolicy propagationPolicy) {
      return super.exceptionPropagationPolicy(propagationPolicy);
    }

    @Override
    public Builder addCapability(Capability capability) {
      return super.addCapability(capability);
    }

    public  T target(Class apiType, String url) {
      return target(new HardCodedTarget<>(apiType, url));
    }

    public  T target(Target target) {
      return build().newInstance(target);
    }

    @Override
    public Feign internalBuild() {
      final ResponseHandler responseHandler =
          new ResponseHandler(logLevel, logger, decoder, errorDecoder,
              dismiss404, closeAfterDecode, decodeVoid, responseInterceptorChain());
      MethodHandler.Factory